Update comments

This commit is contained in:
Leonel Lopes Parente 2021-04-22 15:13:41 +02:00
parent b170cac690
commit 4f40905263

View file

@ -116,8 +116,6 @@ build_flags =
-D DISABLE_PING
-D DISABLE_BEACONS
; If LMIC_DEBUG_LEVEL is set to value > 0 then LMIC_PRINTF_TO will
; be automatically set to serial (do not set it explicitly).
; -D LMIC_DEBUG_LEVEL=1 ; 0, 1 or 2
; -D CFG_sx1272_radio=1 ; Use for SX1272 radio
@ -185,8 +183,8 @@ build_flags =
[env:adafruit_feather_m0_lora]
; Adafruit Feather M0 with RF9x LoRa (SAMD21)
; Be aware that this board needs pin (D)IO0 to be manually wired to GPIO pin 6.
; No onboard display.
; Requires manual wiring of DIO1 to GPIO6
; No display
platform = atmelsam
board = adafruit_feather_m0
framework = arduino
@ -201,20 +199,19 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:disco_l072cz_lrwan1]
; ST B-L072Z-LRWAN1 Discovery kit (STM32L072CZ)
; Note: When using upload_protocol mbed then upload_port must be set manually (HW and OS dependent).
; No onboard display
; No display
platform = ststm32
board = disco_l072cz_lrwan1
framework = arduino
upload_protocol = stlink ; If this fails then try mbed
; upload_protocol = jlink ; Requires onboard programmer firmware upgrade with Segger STLinkReflash utility
; upload_protocol = mbed ; On Windows PlatformIO fails to recognize DIS_L072Z as drive volume
; upload_port = E: ; drive much be explicitly specified for upload port (HA and OS dependent)
upload_protocol = stlink ; If this fails then try mbed
; upload_protocol = jlink ; Requires onboard programmer firmware upgrade
; upload_protocol = mbed ; If selected, also set the correct upload_port
; upload_port = E: ; Used for mbed, value is hardware and OS dependent
monitor_speed = ${common.monitor_speed}
lib_deps =
${common.lib_deps}
@ -226,7 +223,7 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:heltec_wifi_lora_32_v2]
@ -251,7 +248,7 @@ build_flags =
[env:heltec_wifi_lora_32]
; Heltec WiFi LoRa 32 versions 1.x (ESP32)
; Heltec WiFi LoRa 32 version 1.3 (ESP32)
; Onboard OLED display SSD1306 0.96" 128x64
platform = espressif32
board = heltec_wifi_lora_32
@ -289,13 +286,13 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:heltec_wireless_stick]
; Heltec Wireless Stick (ESP32)
; Onboard OLED display SSD1306 0.49" 64x32
; Display is not supported by LMIC-node because resolution is too low.
; Display not supported by LMIC-node (resolution too low)
platform = espressif32
board = heltec_wireless_stick
framework = arduino
@ -311,18 +308,15 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; NOT SUPPORTED because resolution too low
; -D USE_DISPLAY ; NOT SUPPORTED
[env:lopy4]
; Pycom LoPy4 (ESP32)
; Onboard LED is not supported by lmic-node because WS2812 RGB LED.
; No onboard display.
; Requires a Pycom Expansion Board (preferred) or USB to Serial adapter
; for firmware upload and serial port monitoring. See BSP for pin details.
; To put board in upload mode: Manually connect GPIO0 to GND
; with a wire, then press reset and then remove wire from GPIO0 to GND again.
; After upload press the reset button again to start.
; Onboard WS2812 RGB LED is not supported by LMIC-node
; Requires a Pycom Expansion Board or USB to Serial adapter
; See Board Support File for details
; No display
platform = espressif32
board = lopy4
framework = arduino
@ -337,40 +331,38 @@ build_flags =
-D BSFILE=\"boards/lopy4.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
; -D USE_LED ; Onboard LED type is not supported
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_LED ; NOT SUPPORTED
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:lora32u4II]
; BSFrance LoRa32u4 II (ATmega32u4)
; Depending on the version this board may require additional wiring for DIO1.
; lmic-node will not work with MCCI LMIC for this board because not enough memory.
; Therefore Classic LMIC is hardcoded here (independent of setting in [common]).
; No onboard display.
; This is an 8-bit MCU with limited memory, therefore IBM LMIC framework library is used.
; Board versions 1.0 to 1.2 require manual wiring of DIO1 to GPIO5
; 8-bit AVR MCU with limited memory, therefore IBM LMIC framework is used
; No display
platform = atmelavr
board = lora32u4II
framework = arduino
monitor_speed = ${common.monitor_speed}
lib_deps =
${common.lib_deps}
${classic_lmic.lib_deps}
; ${mcci_lmic.lib_deps} ; MCCI LMIC better LoRaWAN compliance but uses more memory
${classic_lmic.lib_deps} ; [deprecated] IBM LMIC Framework
; ${mcci_lmic.lib_deps} ; MCCI LoRaWAN LMIC (uses more memory)
build_flags =
${common.build_flags}
${classic_lmic.build_flags}
; ${mcci_lmic.build_flags} ; MCCI LMIC better LoRaWAN compliance but uses more memory
${classic_lmic.build_flags} ; [deprecated] IBM LMIC Framework
; ${mcci_lmic.build_flags} ; MCCI LoRaWAN LMIC (uses more memory)
-D BSFILE=\"boards/lora32u4II.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:ttgo_lora32_v1]
; TTGO LoRa32 v1.3 (ESP32)
; Onboard OLED display SSD1306 0.96" 128x64
; Currently unknown if board has programmable onboard LED
; Unknown if this has a usable onboard LED therefore USE_LED not supported
platform = espressif32
board = ttgo-lora32-v1
framework = arduino
@ -385,15 +377,16 @@ build_flags =
-D BSFILE=\"boards/ttgo_lora32_v1.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
; -D USE_LED ; Not supported, boards appears to have no user LED
; -D USE_LED ; NOT SUPPORTED
-D USE_DISPLAY
[env:ttgo_lora32_v2]
; TTGO LoRa32 v2.0 (ESP32)
; This board requires manual wiring of DIO1.
; Requires manual wiring of DIO1 to GPIO33
; Onboard OLED display SSD1306 0.96" 128x64
; Onboard LED is not usable because LED GPIO is shared with I2C SCL used for display
; GPIO22 is used for both onboard LED and I2C SCL
; therefore USE_LED and USE_DISPLAY cannot be used together
platform = espressif32
board = ttgo-lora32-v2
framework = arduino
@ -408,14 +401,13 @@ build_flags =
-D BSFILE=\"boards/ttgo_lora32_v2.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
; -D USE_LED ; Not usable because of conflict with I2C
-D USE_DISPLAY
; -D USE_LED ; Cannot be used together with USE_DISPLAY
-D USE_DISPLAY ; Cannot be used together with USE_LED
[env:ttgo_lora32_v21]
; TTGO LoRa32 v2.1.6 (ESP32)
; Onboard OLED display SSD1306 0.96" 128x64 SSD1306 0.96" 128x64
; Onboard LED is not usable because LED GPIO is shared with I2C SCL used for display
; Onboard OLED display SSD1306 0.96" 128x64
platform = espressif32
board = ttgo-lora32-v21
framework = arduino
@ -430,13 +422,13 @@ build_flags =
-D BSFILE=\"boards/ttgo_lora32_v21.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
; -D USE_LED ; Not usable because of conflict with I2C
-D USE_LED
-D USE_DISPLAY
[env:ttgo_tbeam]
; TTGO T-Beam versions 0.x (ESP32)
; No onboard display
; TTGO T-Beam v0.7 (ESP32)
; No display
platform = espressif32
board = ttgo-t-beam
framework = arduino
@ -452,13 +444,13 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:ttgo_tbeam_v1]
; TTGO T-Beam version 1.0 (aka T22_08) (ESP32)
; Requires additional library for its AXP192 power management chip
; No onboard display
; Requires additional library and setup for AXP192 power management chip
; No display
platform = espressif32
board = ttgo-t-beam
framework = arduino
@ -467,7 +459,7 @@ monitor_speed = ${common.monitor_speed}
lib_deps =
${common.lib_deps}
${mcci_lmic.lib_deps}
lewisxhe/AXP202X_Library ; Power management chip library
lewisxhe/AXP202X_Library ; Power management chip library
build_flags =
${common.build_flags}
${mcci_lmic.build_flags}
@ -475,7 +467,7 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
; ------------------------------------------------------------------------------
@ -487,7 +479,8 @@ build_flags =
[env:blackpill_f103c8_128k]
; Blackill F103C8 128k (STMF103C8T6)
; Select the upload protocol to use below.
; Select preferred upload protocol below
; No display
platform = ststm32
board = blackpill_f103c8_128
framework = arduino
@ -505,12 +498,13 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:blackpill_f103c8]
; Blackpill F103C8 (64k) (STMF103C8T6)
; Select the upload protocol to use below.
; Select preferred upload protocol below
; No display
platform = ststm32
board = blackpill_f103c8
framework = arduino
@ -528,12 +522,13 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:bluepill_f103c8_128k]
; Bluepill F103C8 128k (STMF103C8T6)
; Select the upload protocol to use below.
; Select preferred upload protocol below
; No display
platform = ststm32
board = bluepill_f103c8_128k
framework = arduino
@ -551,12 +546,13 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:bluepill_f103c8]
; Bluepill F103C8 (64k) (STMF103C8T6)
; Select the upload protocol to use below.
; Select preferred upload protocol below
; No display
platform = ststm32
board = bluepill_f103c8
framework = arduino
@ -574,11 +570,12 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:lolin_d32_pro]
; Wemos Lolin D32 Pro (ESP32)
; No display
platform = espressif32
board = lolin_d32_pro
framework = arduino
@ -594,11 +591,12 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:lolin_d32]
; Wemos Lolin D32 (ESP32)
; No display
platform = espressif32
board = lolin_d32
framework = arduino
@ -614,11 +612,12 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:lolin32]
; Wemos Lolin32 (ESP32)
; No display
platform = espressif32
board = lolin32
framework = arduino
@ -634,11 +633,12 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:nodemcu_32s]
; NodeMCU-32S (ESP32)
; No display
platform = espressif32
board = nodemcu-32s
framework = arduino
@ -654,19 +654,19 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:nodemcuv2]
; NodeMCU V2 (aka NodeMCU 1.0) (ESP8266)
; I2C and external OLED display cannot be used due to shortage of GPIO pins.
; monitor_speed is set to 74880 (independent of setting in [common])
; to be able to read ESP8266 boot messages.
; I2C and external OLED display cannot be used due to shortage of GPIO pins
; Monitor speed is set to 74880 to be able to read ESP8266 boot messages
; No display
platform = espressif8266
board = nodemcuv2
framework = arduino
upload_speed = 921600
monitor_speed = 74880 ; 74880 so we can read ESP8266 boot messages
monitor_speed = 74880 ; 74880 so we can read ESP8266 boot messages
lib_deps =
${common.lib_deps}
${mcci_lmic.lib_deps}
@ -677,35 +677,37 @@ build_flags =
-D MONITOR_SPEED=${env:nodemcuv2.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; NOT SUPPORTED
[env:pro8mhzatmega328]
; Arduino Pro Mini 8 MHz (ATmega328)
; Onboard LED is not usable because GPIO is shared with SPI SCK needed for LoRa module.
; This is an 8-bit MCU with limited memory, therefore IBM LMIC framework library is used.
; Onboard LED not usable because GPIO13 is used for both onboard LED and SPI SCK
; 8-bit AVR MCU with limited memory, therefore IBM LMIC framework is used
; No display
platform = atmelavr
board = pro8MHzatmega328
framework = arduino
monitor_speed = ${common.monitor_speed}
lib_deps =
${common.lib_deps}
${classic_lmic.lib_deps}
; ${mcci_lmic.lib_deps} ; MCCI LMIC better LoRaWAN compliance but uses more memory
${classic_lmic.lib_deps} ; [deprecated] IBM LMIC Framework
; ${mcci_lmic.lib_deps} ; MCCI LoRaWAN LMIC (uses more memory)
build_flags =
${common.build_flags}
${classic_lmic.build_flags}
; ${mcci_lmic.build_flags} ; MCCI LMIC better LoRaWAN compliance but uses more memory
${classic_lmic.build_flags} ; [deprecated] IBM LMIC Framework
; ${mcci_lmic.build_flags} ; MCCI LoRaWAN LMIC (uses more memory)
-D BSFILE=\"boards/pro8mhzatmega328.h\"
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
; -D USE_LED ; Not usable because of conflict with SPI
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_LED ; NOT SUPPORTED
; -D USE_DISPLAY ; Requires external I2C OLED display
[env:zerousb]
; Arduino Zero USB (SAMD21)
; For SPI use the ICSP connector on top of the board. It provides
; the SCK, MOSI and MISO pins needed for connecting the LoRa module.
; The SPI pins are available on the ICSP connector pins on top of the PCB
; No display
platform = atmelsam
board = zeroUSB
framework = arduino
@ -720,7 +722,7 @@ build_flags =
-D MONITOR_SPEED=${common.monitor_speed}
-D USE_SERIAL
-D USE_LED
; -D USE_DISPLAY ; Requires external I2C OLED display
; -D USE_DISPLAY ; Requires external I2C OLED display
; end of file