Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(BLE): Fixed broken links to cordio docs #991

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Examples/MAX32655/Bluetooth/BLE4_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 4.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE4_ctr](../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.
Refer to the [BLE4_ctr](../../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.

## Software

Expand Down Expand Up @@ -36,4 +36,4 @@ external USB-to-UART adapter configured to the following settings:
- HW Flow Control : No
- SW Flow Control : No
* HCI commands can be send to Controller by BLE tester, or from PC as illustrated in
Tools/Bluetooth/BLE_hci.py. The script has built in help options to describe the usage.
Tools/Bluetooth/BLE_hci.py. The script has built in help options to describe the usage.
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE5_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 5.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE5_ctr](../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.
Refer to the [BLE5_ctr](../../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.

## Software

Expand Down
4 changes: 2 additions & 2 deletions Examples/MAX32655/Bluetooth/BLE_FreeRTOS/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_FreeRTOS

A basic getting started application for BLE and FreeRTOS.
Refer to the [BLE_FreeRTOS](../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.
Refer to the [BLE_FreeRTOS](../../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.

## Software

Expand All @@ -26,4 +26,4 @@ viewing the trace messages and interacting with the application. Port uses setti
- Stop bits : 1
- HW Flow Control : No
- SW Flow Control : No
* Enabling tickless mode in **FreeRTOSConfig.h** allows the device to enter deep sleep/stanby when idle
* Enabling tickless mode in **FreeRTOSConfig.h** allows the device to enter deep sleep/stanby when idle
3 changes: 1 addition & 2 deletions Examples/MAX32655/Bluetooth/BLE_datc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_datc

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand All @@ -26,4 +26,3 @@ An arbitrary pin can be entered in the format `pin (connId) passkey`
* The server is expected to enter the same connId and passkey to establish a secure connection
and share bonding information
* ***Note***: *Either the client or server can enter the passkey first. The peer device must then match.*

2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_dats/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_dats

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_fcc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_fcc

Simple serial port console for FCC testing.
Refer to [BLE_fcc](../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.
Refer to [BLE_fcc](../../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_fit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_fit
Bluetooth fitness device. Showcases heart rate, battery level, running speed and cadence.
Refer to [BLE_fit](../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.
Refer to [BLE_fit](../../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_mcs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Maxim custom Bluetooth profile and service that advertises as "MCS" and accepts
connection requests.
Refer to the [BLE_mcs](../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.
Refer to the [BLE_mcs](../../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_otac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data client that scans for and connects to advertisers with the name o
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_otas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data server that advertises as "OTAS" and accepts connection requests.
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32655/Bluetooth/BLE_periph/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BLE_periph
Refer to the [BLE_periph](../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.
Refer to the [BLE_periph](../../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE4_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 4.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE4_ctr](../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.
Refer to the [BLE4_ctr](../../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE5_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 5.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE5_ctr](../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.
Refer to the [BLE5_ctr](../../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.

## Software

Expand Down
4 changes: 2 additions & 2 deletions Examples/MAX32665/Bluetooth/BLE_FreeRTOS/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_FreeRTOS

A basic getting started application for BLE and FreeRTOS.
Refer to the [BLE_FreeRTOS](../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.
Refer to the [BLE_FreeRTOS](../../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.

## Software

Expand All @@ -26,4 +26,4 @@ viewing the trace messages and interacting with the application. Port uses setti
- Stop bits : 1
- HW Flow Control : No
- SW Flow Control : No
* Enabling tickless mode in **FreeRTOSConfig.h** allows the device to enter deep sleep/stanby when idle
* Enabling tickless mode in **FreeRTOSConfig.h** allows the device to enter deep sleep/stanby when idle
3 changes: 1 addition & 2 deletions Examples/MAX32665/Bluetooth/BLE_datc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_datc

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand All @@ -26,4 +26,3 @@ An arbitrary pin can be entered in the format `pin (connId) passkey`
* The server is expected to enter the same connId and passkey to establish a secure connection
and share bonding information
* ***Note***: *Either the client or server can enter the passkey first. The peer device must then match.*

2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_dats/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_dats

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_fcc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_fcc

Simple serial port console for FCC testing.
Refer to [BLE_fcc](../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.
Refer to [BLE_fcc](../../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.

## Software

Expand Down
3 changes: 1 addition & 2 deletions Examples/MAX32665/Bluetooth/BLE_fit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_fit
Bluetooth fitness device. Showcases heart rate, battery level, running speed and cadence.
Refer to [BLE_fit](../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.
Refer to [BLE_fit](../../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.

## Software

Expand All @@ -24,4 +24,3 @@ viewing the trace messages and interacting with the application. Port uses setti
- Stop bits : 1
- HW Flow Control : No
- SW Flow Control : No

2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_mcs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Maxim custom Bluetooth profile and service that advertises as "MCS" and accepts
connection requests.
Refer to the [BLE_mcs](../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.
Refer to the [BLE_mcs](../../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_otac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data client that scans for and connects to advertisers with the name o
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_otas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data server that advertises as "OTAS" and accepts connection requests.
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32665/Bluetooth/BLE_periph/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BLE_periph
Refer to the [BLE_periph](../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.
Refer to the [BLE_periph](../../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE4_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 4.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE4_ctr](../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.
Refer to the [BLE4_ctr](../../../../Libraries/Cordio/docs/Applications/BLE4_ctr.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE5_ctr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Bluetooth version 5.2 controller, accepts HCI commands via Serial Port.

Refer to the [BLE5_ctr](../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.
Refer to the [BLE5_ctr](../../../../Libraries/Cordio/docs/Applications/BLE5_ctr.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_FreeRTOS/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_FreeRTOS

A basic getting started application for BLE and FreeRTOS.
Refer to the [BLE_FreeRTOS](../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.
Refer to the [BLE_FreeRTOS](../../../../Libraries/Cordio/docs/Applications/BLE_FreeRTOS.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_datc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_datc

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_dats/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_dats

Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.
Refer to the [BLE_datc_dats](../../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_fcc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BLE_fcc

Simple serial port console for FCC testing.
Refer to [BLE_fcc](../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.
Refer to [BLE_fcc](../../../../Libraries/Cordio/docs/Applications/BLE_fcc.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_fit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BLE_fit
Bluetooth fitness device. Showcases heart rate, battery level, running speed and cadence.
Refer to [BLE_fit](../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.
Refer to [BLE_fit](../../../../Libraries/Cordio/docs/Applications/BLE_fit.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_mcs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Maxim custom Bluetooth profile and service that advertises as "MCS" and accepts
connection requests.
Refer to the [BLE_mcs](../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.
Refer to the [BLE_mcs](../../../../Libraries/Cordio/docs/Applications/BLE_mcs.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_otac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data client that scans for and connects to advertisers with the name o
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_otas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Bluetooth data server that advertises as "OTAS" and accepts connection requests.
The Wireless Data Exchange profile is used to transfer files from the client to the server.
A CRC32 value is used to check the integrity of the transferred file.

Refer to the [BLE_otac_otas](../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.
Refer to the [BLE_otac_otas](../../../../Libraries/Cordio/docs/Applications/BLE_otac_otas.md) documentation in the Cordio Library.

## Software

Expand Down
2 changes: 1 addition & 1 deletion Examples/MAX32690/Bluetooth/BLE_periph/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BLE_periph
Refer to the [BLE_periph](../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.
Refer to the [BLE_periph](../../../../Libraries/Cordio/docs/Applications/BLE_periph.md) documentation in the Cordio Library.

## Software

Expand Down
Loading