Skip to content

Commit 72ef340

Browse files
committed
Add some description to README.md
1 parent 81dd256 commit 72ef340

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# LoRaMac-node-esp32
2-
ESP32 port of LoRaMac-node
2+
#### ESP32 port of LoRaMac-node
3+
Creates an ESP32 component that pulls in all LoRaMac-node sources allowing for a custom ESP32 board definition to be used.
34

4-
This is work in progress - not usable yet
5+
## Compatibility
6+
This library is written for and is currently only compatible with Semtech SX126x LoRaWAN chips.
7+
8+
## Configuration
9+
- Running menuconfig with LoRaMac-node-esp32 added as a component will allow for configuration of SPI pins and the host to be used.
10+
- Region(s) of operation must be selected by pulling in one of the pre-processor definitions used by LoRaMac-node, e.g. `REGION_US915`.
11+
- Regions are listed in `src/LoRaMac-node/src/mac/region/Region.h`
12+
13+
## Notes
14+
- `SX126xWaitOnBusy()` indefinitely blocks with a busy wait, waiting for a low BUSY signal
15+
- This is work in progress - not usable yet

0 commit comments

Comments
 (0)