mirror of
https://github.com/manuelbl/ttn-esp32.git
synced 2025-06-14 20:14:27 +02:00
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# ttn-esp32
|
||
|
||
**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
|
||
|
||
- 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
|
||
|
||
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 3.3
|
||
|
||
- Verified compatibility with ESP-IDF v4.2
|
||
- Upgraded underlying library mcci-catena/arduino-lmic to v3.3.0 (no relevant changes)
|
||
- Ensure interrupt code is in IRAM
|
||
|
||
|
||
## Get Started
|
||
|
||
Follow the detailed [Get Started Guide](https://github.com/manuelbl/ttn-esp32/wiki/Get-Started) in the Wiki.
|
||
|
||
## Supported Boards
|
||
|
||
All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF.
|
||
|
||
## API Documentation
|
||
|
||
See the Wiki page: [API Documentation](https://github.com/manuelbl/ttn-esp32/wiki/API-Documentation)
|
||
|
||
## More information
|
||
|
||
More information can be found on the [Wiki pages](https://github.com/manuelbl/ttn-esp32/wiki).
|