From 576d95e9414554a5fbcbb1cbd7fd613f4d5b1ac2 Mon Sep 17 00:00:00 2001 From: Leonel Lopes Parente Date: Wed, 21 Apr 2021 01:53:36 +0200 Subject: [PATCH] Add board docs URL to Board Support File --- src/boards/adafruit_feather_m0_lora.h | 4 ++++ src/boards/blackpill_f103c8.h | 3 +++ src/boards/bluepill_f103c8.h | 3 +++ src/boards/disco_l072cz_lrwan1.h | 2 ++ src/boards/heltec_wifi_lora_32.h | 16 +++------------- src/boards/heltec_wifi_lora_32_v2.h | 2 ++ src/boards/heltec_wireless_stick.h | 2 ++ src/boards/heltec_wireless_stick_lite.h | 4 +++- src/boards/lolin32.h | 4 +++- src/boards/lolin_d32.h | 4 +++- src/boards/lolin_d32_pro.h | 4 +++- src/boards/lopy4.h | 2 ++ src/boards/lora32u4II.h | 4 +++- src/boards/nodemcu_32s.h | 2 ++ src/boards/nodemcuv2.h | 6 ++++-- src/boards/pro8mhzatmega328.h | 6 ++++-- src/boards/ttgo_lora32_v1.h | 4 +++- src/boards/ttgo_lora32_v2.h | 2 ++ src/boards/ttgo_lora32_v21.h | 4 +++- src/boards/ttgo_tbeam.h | 4 +++- src/boards/ttgo_tbeam_v1.h | 4 +++- src/boards/zerousb.h | 4 +++- 22 files changed, 63 insertions(+), 27 deletions(-) diff --git a/src/boards/adafruit_feather_m0_lora.h b/src/boards/adafruit_feather_m0_lora.h index 2e0b8be..01646bb 100644 --- a/src/boards/adafruit_feather_m0_lora.h +++ b/src/boards/adafruit_feather_m0_lora.h @@ -45,7 +45,11 @@ * DIO0 <――――――――――> 3 * DIO1 <----------> 5 ██ NOT WIRED on PCB ██ * DIO2 - Not needed for LoRa + * + * Docs: https://docs.platformio.org/en/latest/boards/atmelsam/adafruit_feather_m0.html * + * Docs: + * * Identifiers: LMIC-node * board-id: adafruit_feather_m0_lora * PlatformIO diff --git a/src/boards/blackpill_f103c8.h b/src/boards/blackpill_f103c8.h index 6e2a620..36fb467 100644 --- a/src/boards/blackpill_f103c8.h +++ b/src/boards/blackpill_f103c8.h @@ -70,6 +70,9 @@ * D- <――――――――――> PA11 / 9 * D+ <――――――――――> PA12 / 8 * + * Docs: https://docs.platformio.org/en/latest/boards/ststm32/blackpill_f103c8.html + * https://docs.platformio.org/en/latest/boards/ststm32/blackpill_f103c8_128.html + * * Identifiers: LMIC-node * board-id: blackpill_f103c8 (64k version) * blackpill_f103c8_128k (128k version) diff --git a/src/boards/bluepill_f103c8.h b/src/boards/bluepill_f103c8.h index d811c0a..15b92ea 100644 --- a/src/boards/bluepill_f103c8.h +++ b/src/boards/bluepill_f103c8.h @@ -70,6 +70,9 @@ * D- <――――――――――> PA11 / 9 * D+ <――――――――――> PA12 / 8 * + * Docs: https://docs.platformio.org/en/latest/boards/ststm32/bluepill_f103c8.html + * https://docs.platformio.org/en/latest/boards/ststm32/bluepill_f103c8_128k.html + * * Identifiers: LMIC-node * board-id: bluepill_f103c8 (64k version) * bluepill_f103c8_128k (128k version) diff --git a/src/boards/disco_l072cz_lrwan1.h b/src/boards/disco_l072cz_lrwan1.h index dcb0b02..2de0133 100644 --- a/src/boards/disco_l072cz_lrwan1.h +++ b/src/boards/disco_l072cz_lrwan1.h @@ -76,6 +76,8 @@ * ------ ---- * USER <――――――――――> PB2 / 6 (USER_BTN) * + * Docs: https://docs.platformio.org/en/latest/boards/ststm32/disco_l072cz_lrwan1.html + * * Definitions: LMIC-node * board-id: disco_l072cz_lrwan1 * PlatformIO diff --git a/src/boards/heltec_wifi_lora_32.h b/src/boards/heltec_wifi_lora_32.h index 4500bc2..626ade0 100644 --- a/src/boards/heltec_wifi_lora_32.h +++ b/src/boards/heltec_wifi_lora_32.h @@ -47,7 +47,9 @@ * DIO1 <――――――――――> 33 (DIO1) * DIO2 <――――――――――> 32 (DIO2) * - * Definitions: LMIC-node: + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/heltec_wifi_lora_32.html + * + * Identifiers: LMIC-node: * board-id: heltec_wifi_lora_32 * PlatformIO * board: heltec_wifi_lora_32 @@ -56,18 +58,6 @@ * board: ARDUINO_HELTEC_WIFI_LORA_32 * architecture: ARDUINO_ARCH_ESP32 * - * Warning: In the Arduino BSP the values of SDA and SCL are incorrectly - * defined for this board. This requires special precautions. - * SDA is defined as GPIO21 and SCL as GPIO22 but these are not - * the pins where the display is connected to. - * - * When initializing the Wire (I2C) interface with Wire.begin() - * without parameters this will by default use pin definitions SDA and SCL. - * Most libraries (including U8x8) will call Wire.begin() without parameters. - * It is not possible to change the pins of the Wire interface - * after it has been initialized. Therefore the Wire interface must be - * initialized with the correct pins before initializing any other library. - * ******************************************************************************/ #pragma once diff --git a/src/boards/heltec_wifi_lora_32_v2.h b/src/boards/heltec_wifi_lora_32_v2.h index 2dddd7e..2ebcc31 100644 --- a/src/boards/heltec_wifi_lora_32_v2.h +++ b/src/boards/heltec_wifi_lora_32_v2.h @@ -53,6 +53,8 @@ * ----- ---- * VExt <――――――――――> 21 (Vext, SDA) Active-low * + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/heltec_wifi_lora_32_V2.html + * * Identifiers: LMIC-node: * board-id: heltec_wifi_lora_32_v2 * PlatformIO diff --git a/src/boards/heltec_wireless_stick.h b/src/boards/heltec_wireless_stick.h index 4c9e6b8..6449bc7 100644 --- a/src/boards/heltec_wireless_stick.h +++ b/src/boards/heltec_wireless_stick.h @@ -54,6 +54,8 @@ * ----- ---- * VExt <――――――――――> 21 (Vext, SDA) Active-low - see remarks * + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/heltec_wireless_stick.html + * * Identifiers: LMIC-node: * board-id: heltec_wireless_stick * PlatformIO diff --git a/src/boards/heltec_wireless_stick_lite.h b/src/boards/heltec_wireless_stick_lite.h index 7a26d37..0828379 100644 --- a/src/boards/heltec_wireless_stick_lite.h +++ b/src/boards/heltec_wireless_stick_lite.h @@ -55,7 +55,9 @@ * ----- ---- * VExt <――――――――――> 21 (Vext, SDA) Active-low * - * Definitions: LMIC-node: + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/heltec_wireless_stick_lite.html + * + * Identifiers: LMIC-node: * board-id: heltec_wireless_stick_lite * PlatformIO * board: heltec_wireless_stick_lite diff --git a/src/boards/lolin32.h b/src/boards/lolin32.h index d2f2e77..f1ed6ad 100644 --- a/src/boards/lolin32.h +++ b/src/boards/lolin32.h @@ -43,7 +43,9 @@ * DIO1 <――――――――――> 35 * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/lolin32.html + * + * Identifiers: LMIC-node * board: lolin32 * PlatformIO * board: lolin32 diff --git a/src/boards/lolin_d32.h b/src/boards/lolin_d32.h index bfe6b50..be4cad0 100644 --- a/src/boards/lolin_d32.h +++ b/src/boards/lolin_d32.h @@ -43,7 +43,9 @@ * DIO1 <――――――――――> 34 * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/lolin_d32.html + * + * Identifiers: LMIC-node * board-id: lolin_d32 * PlatformIO * board: lolin_d32 diff --git a/src/boards/lolin_d32_pro.h b/src/boards/lolin_d32_pro.h index ee09e89..9454190 100644 --- a/src/boards/lolin_d32_pro.h +++ b/src/boards/lolin_d32_pro.h @@ -43,7 +43,9 @@ * DIO1 <――――――――――> 34 * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/lolin_d32_pro.html + * + * Identifiers: LMIC-node * board-id: lolin_d32_pro * PlatformIO * board: lolin_d32_pro diff --git a/src/boards/lopy4.h b/src/boards/lopy4.h index 3f71eca..40a1d20 100644 --- a/src/boards/lopy4.h +++ b/src/boards/lopy4.h @@ -83,6 +83,8 @@ * RX <――――――――――> 3 (RX) pin labeled '0' on the PCB. * TX <――――――――――> 1 (TX) pin labeled '1' on the PCB. * + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/lopy4.html + * * Identifiers: LMIC-node * board-id: lopy4 * PlatformIO diff --git a/src/boards/lora32u4II.h b/src/boards/lora32u4II.h index 2595de9..551fe04 100644 --- a/src/boards/lora32u4II.h +++ b/src/boards/lora32u4II.h @@ -42,7 +42,9 @@ * DIO1 <----------> 5 ██ NOT WIRED on PCB for versions < 1.3 ██ * DIO2 - Not needed for LoRa * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/atmelavr/lora32u4II.html + * + * Identifiers: LMIC-node * board-id: lora32u4II * PlatformIO * board: lora32u4II diff --git a/src/boards/nodemcu_32s.h b/src/boards/nodemcu_32s.h index 0dbc227..ea99d34 100644 --- a/src/boards/nodemcu_32s.h +++ b/src/boards/nodemcu_32s.h @@ -42,6 +42,8 @@ * DIO1 <――――――――――> 35 * DIO2 - Not needed for LoRa. * + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/nodemcu-32s.html + * * Identifiers: LMIC-node * board: nodemcu_32s * PlatformIO diff --git a/src/boards/nodemcuv2.h b/src/boards/nodemcuv2.h index 09048e1..5b7de3a 100644 --- a/src/boards/nodemcuv2.h +++ b/src/boards/nodemcuv2.h @@ -2,7 +2,7 @@ * * File: nodemcuv2.h * - * Function: Board Support File for NodeMCU V2 (aka v1.0) with + * Function: Board Support File for NodeMCU V2 (aka NodeMCU 1.0) with * external SPI LoRa module. * * Copyright: Copyright (c) 2021 Leonel Lopes Parente @@ -47,7 +47,9 @@ * DIO1 <――――――――――> D2 / 6 (SDA) * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif8266/nodemcuv2.html + * + * Identifiers: LMIC-node * board: nodemcuv2 * PlatformIO * board: nodemcuv2 diff --git a/src/boards/pro8mhzatmega328.h b/src/boards/pro8mhzatmega328.h index ce16205..b6615e2 100644 --- a/src/boards/pro8mhzatmega328.h +++ b/src/boards/pro8mhzatmega328.h @@ -2,7 +2,7 @@ * * File: pro8mhzatmega328.h * - * Description: Board Support File for Arduino Pro Mini ATmega328 8MHz + * Description: Board Support File for Arduino Pro Mini ATmega328 3.3V 8MHz * with external SPI LoRa module. * * Copyright: Copyright (c) 2021 Leonel Lopes Parente @@ -45,7 +45,9 @@ * DIO1 <――――――――――> 9 * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/atmelavr/pro8MHzatmega328.html + * + * Identifiers: LMIC-node * board: pro8mhzatmega328 * PlatformIO * board: pro8MHzatmega328 diff --git a/src/boards/ttgo_lora32_v1.h b/src/boards/ttgo_lora32_v1.h index 9b426b6..9be9db4 100644 --- a/src/boards/ttgo_lora32_v1.h +++ b/src/boards/ttgo_lora32_v1.h @@ -60,7 +60,9 @@ * ------- ---- * VBAT <――――――――――> 35 Battery voltage via 50% voltage divider * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/ttgo-lora32-v1.html + * + * Identifiers: LMIC-node * board: ttgo_lora32_v1 * PlatformIO * board: ttgo-lora32-v1 diff --git a/src/boards/ttgo_lora32_v2.h b/src/boards/ttgo_lora32_v2.h index 25c4c1a..47caaec 100644 --- a/src/boards/ttgo_lora32_v2.h +++ b/src/boards/ttgo_lora32_v2.h @@ -47,6 +47,8 @@ * DIO1 <----------> 33 ██ NOT WIRED on PCB ██ * DIO2 - Not needed for LoRa * + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/ttgo-lora32-v2.html + * * Identifiers: LMIC-node * board: ttgo_lora32_v2 * PlatformIO diff --git a/src/boards/ttgo_lora32_v21.h b/src/boards/ttgo_lora32_v21.h index 83de0f7..24c58f1 100644 --- a/src/boards/ttgo_lora32_v21.h +++ b/src/boards/ttgo_lora32_v21.h @@ -41,7 +41,9 @@ * DIO1 <――――――――――> 33 (LORA_D1) * DIO2 <――――――――――> 32 (LORA_D2) * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/ttgo-lora32-v21.html + * + * Identifiers: LMIC-node * board: ttgo_lora32_v21 * PlatformIO * board: ttgo-lora32-v21 diff --git a/src/boards/ttgo_tbeam.h b/src/boards/ttgo_tbeam.h index 6c77328..17c01f3 100644 --- a/src/boards/ttgo_tbeam.h +++ b/src/boards/ttgo_tbeam.h @@ -48,7 +48,9 @@ * RX <――――――――――> 15 * TX <――――――――――> 12 * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/ttgo-t-beam.html + * + * Identifiers: LMIC-node * board: ttgo_tbeam * PlatformIO * board: ttgo-t-beam diff --git a/src/boards/ttgo_tbeam_v1.h b/src/boards/ttgo_tbeam_v1.h index 2d0f492..f9688ac 100644 --- a/src/boards/ttgo_tbeam_v1.h +++ b/src/boards/ttgo_tbeam_v1.h @@ -62,7 +62,9 @@ * ------ ---- * USR_SW <――――――――――> 39 (KEY_BUILTIN) * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/espressif32/ttgo-t-beam.html + * + * Identifiers: LMIC-node * board: ttgo_tbeam_v1 * PlatformIO * board: ttgo-t-beam diff --git a/src/boards/zerousb.h b/src/boards/zerousb.h index ce49516..2c7f547 100644 --- a/src/boards/zerousb.h +++ b/src/boards/zerousb.h @@ -49,7 +49,9 @@ * DIO1 <――――――――――> PA07 / 9 * DIO2 - Not needed for LoRa. * - * Definitions: LMIC-node + * Docs: https://docs.platformio.org/en/latest/boards/atmelsam/zeroUSB.html + * + * Identifiers: LMIC-node * board: zerousb * PlatformIO * board: zeroUSB