localhorst/ttn-esp32
1
0
Fork 0
mirror of https://github.com/manuelbl/ttn-esp32.git synced 2025-10-31 18:50:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README with info for v4.0

Browse Source
This commit is contained in:
Manuel Bleichenbacher
2021-07-31 12:36:47 +02:00
parent 17e432d714
commit 72b878f1d9
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,20 +2,26 @@
**The Things Network device library for ESP-IDF (ESP32) supporting devices with Semtech SX127x chips**
This ESP32 component provides LoRaWAN communication with [The Things Network](https://www.thethingsnetwork.org/). It supports
This ESP32 component provides LoRaWAN communication with
[The Things Network](https://www.thethingsnetwork.org/). It supports
- OTAA (over-the-air activation)
- uplink and downlink messages
- saving the EUIs and key in non-volatile memory
- [AT commands](https://github.com/manuelbl/ttn-esp32/wiki/AT-Commands) for provisioning EUIs and key (so the same code can be flashed to several devices)
- support for regions Eurpe, North and South America, Australia, Korea, Asia and India
- [AT commands](https://github.com/manuelbl/ttn-esp32/wiki/AT-Commands) for provisioning EUIs and key
(so the same code can be flashed to several devices)
- support for regions Europe, North and South America, Australia, Korea, Asia and India
- C and C++ API
The library is based on the LMIC library from IBM (specifically the well-maintained version by MCCI – see their [GitHub repository](https://github.com/mcci-catena/arduino-lmic)) and provides a high-level API specifically targeted at The Things Network.
The library is based on the LMIC library from IBM (specifically the well-maintained version by MCCI
– see their [GitHub repository](https://github.com/mcci-catena/arduino-lmic)) and provides a high-level API specifically targeted at The Things Network.
## New in version 4.0
## New in version 4.0 (prerelease)
- Verified compatibility with ESP-IDF v4.3
- Upgraded underlying library mcci-catena/arduino-lmic to v4.0.1 (improved channel shuffling)
- C API
- Support for sub-bands
## Get Started
@ -24,7 +30,7 @@ Follow the detailed [Get Started Guide](https://github.com/manuelbl/ttn-esp32/wi
## Supported Boards
All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF.
All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF. For several of them, the [Pin Configuration](https://github.com/manuelbl/ttn-esp32/wiki/Boards-and-Pins) is described in detail.
## API Documentation