From 72b878f1d9afa7b3beaad0e87bc8d78da6a91e05 Mon Sep 17 00:00:00 2001 From: Manuel Bleichenbacher Date: Sat, 31 Jul 2021 12:36:47 +0200 Subject: [PATCH] Update README with info for v4.0 --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8eb181a..eeb5023 100644 --- a/README.md +++ b/README.md @@ -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