Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit babc252

Browse files
committed
doc: enhance readability using alerts format
Signed-off-by: Frederic Pillon <[email protected]>
1 parent d06247f commit babc252

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

README.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,34 +26,40 @@ as a simple LoRa® radio module.
2626

2727
* The module supports only class A.
2828
* Sleep mode is not supported in OTAA mode with the version 2.6 of the firmware.
29-
* Important note for Nucleo64:
30-
31-
By default, D0/D1 of CN9 board connector are respectively not connected to
32-
PA3 and PA2 (SB62 and SB63 opened).
33-
Those pins are connected to STLink USART thanks to SB13, SB14.
34-
35-
To use the shield:
36-
- Connect shield D0(Tx) to a free U(S)ARTn Rx pin
37-
- Connect shield D1(Rx) to a free U(S)ARTn Tx pin
38-
39-
Where 'n' are the same U(S)ART number.
40-
41-
- Update the Serial instance definition used for LoRa using the chosen Rx/Tx
42-
43-
or
44-
45-
- Close SB62 and SB63 to connect D0/D1 of CN9 connector to PA3 and PA2
46-
- Open SB13 and SB14 to disconnect PA3 and PA2 from STLink UART
47-
48-
but in this case, you will have to wire STLink Rx/Tx of CN3 connector to
49-
another pins and update Serial instance before call `Serial.begin(115200);`
50-
using:
51-
```
52-
Serial.setRx(Rx pin);
53-
Serial.setTx(Tx pin);
54-
```
55-
56-
See [UM1724](https://www.st.com/resource/en/user_manual/dm00105823.pdf), §6.8 section for more information.
29+
> [!IMPORTANT]
30+
> Usage with a Nucleo 64:
31+
>
32+
> By default, D0/D1 of CN9 board connector are respectively not connected to
33+
> PA3 and PA2 (SB62 and SB63 opened).
34+
> Those pins are connected to STLink USART thanks to SB13, SB14.
35+
>
36+
> To use the shield, two options:
37+
> * First option:
38+
> - Connect shield D0(Tx) to a free U(S)ARTn Rx pin
39+
> - Connect shield D1(Rx) to a free U(S)ARTn Tx pin
40+
>
41+
> Where 'n' are the same U(S)ART number.
42+
>
43+
> - Update the Serial instance definition used for LoRa using the chosen Rx/Tx
44+
> Example:
45+
> ```c++
46+
> HardwareSerial SerialLora(PC11, PC10);
47+
> ```
48+
>
49+
> * Second option:
50+
>
51+
> - Close SB62 and SB63 to connect D0/D1 of CN9 connector to PA3 and PA2
52+
> - Open SB13 and SB14 to disconnect PA3 and PA2 from STLink UART
53+
>
54+
> but in this case, you will have to wire STLink Rx/Tx of CN3 connector to
55+
> another pins and update Serial instance before call `Serial.begin(115200);`
56+
> using:
57+
> ```c++
58+
> Serial.setRx(Rx pin);
59+
> Serial.setTx(Tx pin);
60+
> ```
61+
>
62+
> See [UM1724](https://www.st.com/resource/en/user_manual/dm00105823.pdf), §6.8 section for more information.
5763
5864
## Examples
5965

0 commit comments

Comments
 (0)