diff --git a/README.md b/README.md index bc5e0d8..f944878 100644 --- a/README.md +++ b/README.md @@ -7,56 +7,54 @@ One example to rule them all ## Contents -- [LMIC-node](#lmic-node) - - [Contents](#contents) - - [1 Introduction](#1-introduction) - - [1.1 What does it do?](#11-what-does-it-do) - - [1.2 Implemented features](#12-implemented-features) - - [1.3 Requirements](#13-requirements) - - [2 Supported Boards](#2-supported-boards) - - [2.1 LoRa development boards](#21-lora-development-boards) - - [2.2 Development boards with external SPI LoRa module](#22-development-boards-with-external-spi-lora-module) - - [3 Details](#3-details) - - [3.1 Uplink messages](#31-uplink-messages) - - [3.2 Downlink messages](#32-downlink-messages) - - [3.2.1 Reset-counter downlink command](#321--reset-counter-downlink-command) - - [3.3 Status information](#33-status-information) - - [3.3.1 Serial port and display](#331-serial-port-and-display) - - [3.3.2 LED](#332-led) - - [3.4 User modifiable code](#34-user-modifiable-code) - - [3.5 Board-id](#35-board-id) - - [3.6 Device-id](#36-device-id) - - [3.7 platformio.ini](#37-platformioini) - - [3.8 lorawan-keys.h](#38-lorawan-keysh) - - [3.9 Board Support Files (BSF)](#39-board-support-files-bsf) - - [3.10 Payload formatters](#310-payload-formatters) - - [3.10.1 Uplink decoder](#3101-uplink-decoder) - - [4 Settings](#4-settings) - - [4.1 Board selection](#41-board-selection) - - [4.2 Common settings](#42-common-settings) - - [4.3 LoRaWAN library settings](#43-lorawan-library-settings) - - [4.3.1 MCCI LoRaWAN LMIC library settings](#431-mcci-lorawan-lmic-library-settings) - - [4.3.2 IBM LMIC framework settings](#432-ibm-lmic-framework-settings) - - [4.4 Board specific settings](#44-board-specific-settings) - - [4.5 Board Support Files](#45-board-support-files) - - [5 Instructions](#5-instructions) - - [5.1 Select your board](#51-select-your-board) - - [5.2 Select your LoRaWAN region](#52-select-your-lorawan-region) - - [5.3 Provide the LoRaWAN keys for your node](#53-provide-the-lorawan-keys-for-your-node) - - [5.4 Compile and upload](#54-compile-and-upload) - - [5.5 Add uplink decoder function in TTN Console](#55-add-uplink-decoder-function-in-ttn-console) - - [6 Some tips](#6-some-tips) - - [6.1 Serial Monitor](#61-serial-monitor) - - [6.2 Antenna](#62-antenna) - - [6.3 Distance to gateway](#63-distance-to-gateway) - - [7 Additional information](#7-additional-information) - - [7.1 External libraries](#71-external-libraries) - - [7.2 Known issues](#72-known-issues) - - [7.3 Not yet tested](#73-not-yet-tested) - - [8 Example output](#8-example-output) - - [8.1 Serial Monitor](#81-serial-monitor) - - [8.2 Display](#82-display) - - [9 Release History](#9-release-history) +- [1 Introduction](#1-introduction) + - [1.1 What does it do?](#11-what-does-it-do) + - [1.2 Implemented features](#12-implemented-features) + - [1.3 Requirements](#13-requirements) +- [2 Supported Boards](#2-supported-boards) + - [2.1 LoRa development boards](#21-lora-development-boards) + - [2.2 Development boards with external SPI LoRa module](#22-development-boards-with-external-spi-lora-module) +- [3 Details](#3-details) + - [3.1 Uplink messages](#31-uplink-messages) + - [3.2 Downlink messages](#32-downlink-messages) + - [3.2.1 Reset-counter downlink command](#321--reset-counter-downlink-command) + - [3.3 Status information](#33-status-information) + - [3.3.1 Serial port and display](#331-serial-port-and-display) + - [3.3.2 LED](#332-led) + - [3.4 User modifiable code](#34-user-modifiable-code) + - [3.5 Board-id](#35-board-id) + - [3.6 Device-id](#36-device-id) + - [3.7 platformio.ini](#37-platformioini) + - [3.8 lorawan-keys.h](#38-lorawan-keysh) + - [3.9 Board Support Files (BSF)](#39-board-support-files-bsf) + - [3.10 Payload formatters](#310-payload-formatters) + - [3.10.1 Uplink decoder](#3101-uplink-decoder) +- [4 Settings](#4-settings) + - [4.1 Board selection](#41-board-selection) + - [4.2 Common settings](#42-common-settings) + - [4.3 LoRaWAN library settings](#43-lorawan-library-settings) + - [4.3.1 MCCI LoRaWAN LMIC library settings](#431-mcci-lorawan-lmic-library-settings) + - [4.3.2 IBM LMIC framework settings](#432-ibm-lmic-framework-settings) + - [4.4 Board specific settings](#44-board-specific-settings) + - [4.5 Board Support Files](#45-board-support-files) +- [5 Instructions](#5-instructions) + - [5.1 Select your board](#51-select-your-board) + - [5.2 Select your LoRaWAN region](#52-select-your-lorawan-region) + - [5.3 Provide the LoRaWAN keys for your node](#53-provide-the-lorawan-keys-for-your-node) + - [5.4 Compile and upload](#54-compile-and-upload) + - [5.5 Add uplink decoder function in TTN Console](#55-add-uplink-decoder-function-in-ttn-console) +- [6 Some tips](#6-some-tips) + - [6.1 Serial Monitor](#61-serial-monitor) + - [6.2 Antenna](#62-antenna) + - [6.3 Distance to gateway](#63-distance-to-gateway) +- [7 Additional information](#7-additional-information) + - [7.1 External libraries](#71-external-libraries) + - [7.2 Known issues](#72-known-issues) + - [7.3 Not yet tested](#73-not-yet-tested) +- [8 Example output](#8-example-output) + - [8.1 Serial Monitor](#81-serial-monitor) + - [8.2 Display](#82-display) +- [9 Release History](#9-release-history) ## 1 Introduction @@ -142,12 +140,12 @@ The following LoRa development boards have onboard LoRa support. Most have onboa | Heltec Wireless Stick | ESP32 | no | yes | yes | yes _\*6_ | heltec_wireless_stick | | Heltec Wireless Stick Lite | ESP32 | no | yes | yes | no | heltec_wireless_stick_lite | | Pycom LoPy4 | ESP32 | no | no _\*4_ | no | no | lopy4 | -| BSFrance LoRa32u4 II | ATmega32u4 | yes _\*2_ | yes | yes | no | lora32u4II | +| BSFrance LoRa32u4 II V1.0 - v1.3 | ATmega32u4 | yes _\*2_ | yes | yes | no | lora32u4II | | TTGO LoRa32 V1.3 | ESP32 | no | yes | no | yes | ttgo_lora32_v1 | | TTGO LoRa32 V2.0 | ESP32 | yes _\*3_ | yes | no _\*5_ | yes | ttgo_lora32_v2 | | TTGO LoRa32 V2.1.6 | ESP32 | no | yes | no | yes | ttgo_lora32_v21 | -| TTGO T-Beam V0.7 | ESP32 | no | yes | yes | no | ttgo_tbeam | -| TTGO T-Beam V1.0 | ESP32 | no | yes | no | no | ttgo_tbeam_v1 | +| TTGO T-Beam V0.5 - V0.7 | ESP32 | no | yes | yes | no | ttgo_tbeam | +| TTGO T-Beam V1.0, V1.1 | ESP32 | no | yes | no | no | ttgo_tbeam_v1 | _\*1_: DIO1 must be manually wired to GPIO6. _\*2_: For versions 1.0, 1.1 and 1.2 DIO1 must be manually wired to GPIO5 (version 1.3 is already wired on the PCB).