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

Shorter README

Browse Source
This commit is contained in:
Manuel Bleichenbacher
2018-07-21 17:02:41 +02:00
parent c89b83c121
commit c284eb841c
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,19 +1,19 @@
# ttn-esp32
**The Things Network device library for ESP-IDF (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.
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 and saving the EUIs and key in non-volatile memory.
## Installation
The library is based on the LMIC library from IBM and provides a high-level API specifically targeted at The Things Network.
Install the component by adding it as a git submodule:
## Get Started
git submodule add https://github.com/manuelbl/ttn-esp32.git components/ttn-esp32
git submodule update --init --recursive
Follow the detailed [Get Started Guide](https://github.com/manuelbl/ttn-esp32/wiki/Get-Started) in the Wiki.
The frequency plan must be configured by running `make menuconfig`. Otherwise the component will not compile. In the menu it can be found at *Components* / *The Things Network*.
## Supported Boards
All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF.
More to follow...
## Resources