Add Heltec tower v2

boards/heltec_tower_v2.json

@@ -0,0 +1,61 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52840_s140_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DNRF52840_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [
+      ["0x239A","0x4405"],
+      ["0x239A","0x0029"],
+      ["0x239A","0x002A"],
+      ["0x239A","0x0071"]
+    ],
+    "usb_product": "HT-n5262",
+    "mcu": "nrf52840",
+    "variant": "heltec_tower_v2",
+    "bsp": {
+      "name": "adafruit"
+    },
+    "softdevice": {
+      "sd_flags": "-DS140",
+      "sd_name": "s140",
+      "sd_version": "6.1.1",
+      "sd_fwid": "0x00B6"
+    },
+    "bootloader": {
+      "settings_addr": "0xFF000"
+    }
+  },
+  "connectivity": [
+    "bluetooth"
+  ],
+  "debug": {
+    "jlink_device": "nRF52840_xxAA",
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52.cfg"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "Heltec Tower V2 Board",
+  "upload": {
+    "maximum_ram_size": 235520,
+    "maximum_size": 815104,
+    "speed": 115200,
+    "protocol": "nrfutil",
+    "protocols": [
+      "jlink",
+      "nrfjprog",
+      "nrfutil",
+      "stlink"
+    ],
+    "use_1200bps_touch": true,
+    "require_upload_port": true,
+    "wait_for_upload_port": true
+  },
+  "url": "https://heltec.org/",
+  "vendor": "Heltec"
+}

variants/heltec_tower_v2/HeltecTowerV2Board.cpp

@@ -0,0 +1,103 @@
+#include "HeltecTowerV2Board.h"
+
+#include <Arduino.h>
+#include <Wire.h>
+
+extern void variant_shutdown();
+
+#ifdef NRF52_POWER_MANAGEMENT
+const PowerMgtConfig power_config = {
+  .lpcomp_ain_channel = PWRMGT_LPCOMP_AIN,
+  .lpcomp_refsel = PWRMGT_LPCOMP_REFSEL,
+  .voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK
+};
+
+void HeltecTowerV2Board::initiateShutdown(uint8_t reason) {
+  pinMode(PIN_GPS_EN, OUTPUT);
+  digitalWrite(PIN_GPS_EN, !PIN_GPS_EN_ACTIVE);
+  pinMode(PIN_GPS_STANDBY, OUTPUT);
+  digitalWrite(PIN_GPS_STANDBY, LOW);
+  pinMode(PIN_GPS_RESET, OUTPUT);
+  digitalWrite(PIN_GPS_RESET, GPS_RESET_MODE);
+  loRaFEMControl.setSleepModeEnable();
+
+  bool enable_lpcomp = (reason == SHUTDOWN_REASON_LOW_VOLTAGE ||
+                        reason == SHUTDOWN_REASON_BOOT_PROTECT);
+  pinMode(PIN_BAT_CTL, OUTPUT);
+  digitalWrite(PIN_BAT_CTL, enable_lpcomp ? HIGH : LOW);
+
+  if (enable_lpcomp) {
+    configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);
+  }
+
+  variant_shutdown();
+  enterSystemOff(reason);
+}
+#endif
+
+void HeltecTowerV2Board::begin() {
+  NRF52Board::begin();
+
+  pinMode(P_LORA_TX_LED, OUTPUT);
+  digitalWrite(P_LORA_TX_LED, !LED_STATE_ON);
+
+  pinMode(PIN_BAT_CTL, OUTPUT);
+  digitalWrite(PIN_BAT_CTL, LOW);
+
+#ifdef NRF52_POWER_MANAGEMENT
+  checkBootVoltage(&power_config);
+#endif
+
+  Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL);
+  Wire.begin();
+
+  pinMode(PIN_GPS_EN, OUTPUT);
+  digitalWrite(PIN_GPS_EN, !PIN_GPS_EN_ACTIVE);
+  pinMode(PIN_GPS_RESET, OUTPUT);
+  digitalWrite(PIN_GPS_RESET, GPS_RESET_MODE);
+  pinMode(PIN_GPS_STANDBY, OUTPUT);
+  digitalWrite(PIN_GPS_STANDBY, HIGH);
+  loRaFEMControl.init();
+}
+
+void HeltecTowerV2Board::onBeforeTransmit() {
+  digitalWrite(P_LORA_TX_LED, LED_STATE_ON);
+  loRaFEMControl.setTxModeEnable();
+}
+
+void HeltecTowerV2Board::onAfterTransmit() {
+  digitalWrite(P_LORA_TX_LED, !LED_STATE_ON);
+  loRaFEMControl.setRxModeEnable();
+}
+
+uint16_t HeltecTowerV2Board::getBattMilliVolts() {
+  analogReadResolution(12);
+  analogReference(VBAT_AR_INTERNAL);
+  pinMode(PIN_VBAT_READ, INPUT);
+  pinMode(PIN_BAT_CTL, OUTPUT);
+  digitalWrite(PIN_BAT_CTL, HIGH);
+
+  delay(10);
+  int adcvalue = analogRead(PIN_VBAT_READ);
+  digitalWrite(PIN_BAT_CTL, LOW);
+
+  return (uint16_t)((float)adcvalue * MV_LSB * ADC_MULTIPLIER);
+}
+
+const char* HeltecTowerV2Board::getManufacturerName() const {
+  return "Heltec Tower V2";
+}
+
+void HeltecTowerV2Board::powerOff() {
+  pinMode(PIN_GPS_EN, OUTPUT);
+  digitalWrite(PIN_GPS_EN, !PIN_GPS_EN_ACTIVE);
+  pinMode(PIN_GPS_STANDBY, OUTPUT);
+  digitalWrite(PIN_GPS_STANDBY, LOW);
+  pinMode(PIN_GPS_RESET, OUTPUT);
+  digitalWrite(PIN_GPS_RESET, GPS_RESET_MODE);
+  loRaFEMControl.setSleepModeEnable();
+  pinMode(PIN_BAT_CTL, OUTPUT);
+  digitalWrite(PIN_BAT_CTL, LOW);
+  variant_shutdown();
+  sd_power_system_off();
+}

variants/heltec_tower_v2/HeltecTowerV2Board.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <Arduino.h>
+#include <MeshCore.h>
+#include <helpers/NRF52Board.h>
+#include "LoRaFEMControl.h"
+
+class HeltecTowerV2Board : public NRF52BoardDCDC {
+protected:
+#ifdef NRF52_POWER_MANAGEMENT
+  void initiateShutdown(uint8_t reason) override;
+#endif
+
+public:
+  LoRaFEMControl loRaFEMControl;
+
+  HeltecTowerV2Board() : NRF52Board("TOWER_V2_OTA") {}
+  void begin();
+  void onBeforeTransmit() override;
+  void onAfterTransmit() override;
+  uint16_t getBattMilliVolts() override;
+  const char* getManufacturerName() const override;
+  void powerOff() override;
+};

variants/heltec_tower_v2/LoRaFEMControl.cpp

@@ -0,0 +1,40 @@
+#include "LoRaFEMControl.h"
+
+#include <Arduino.h>
+#include "variant.h"
+
+static void enableFEMPower() {
+  bool wasOff = digitalRead(LORA_KCT8103L_EN) != HIGH;
+  digitalWrite(LORA_KCT8103L_EN, HIGH);
+  if (wasOff) {
+    delay(5);
+  }
+}
+
+void LoRaFEMControl::init() {
+  pinMode(LORA_KCT8103L_EN, OUTPUT);
+  digitalWrite(LORA_KCT8103L_EN, HIGH);
+  delay(1);
+  pinMode(LORA_KCT8103L_TX_RX, OUTPUT);
+  digitalWrite(LORA_KCT8103L_TX_RX, LOW);
+}
+
+void LoRaFEMControl::setSleepModeEnable() {
+  pinMode(LORA_KCT8103L_EN, OUTPUT);
+  digitalWrite(LORA_KCT8103L_EN, LOW);
+}
+
+void LoRaFEMControl::setTxModeEnable() {
+  enableFEMPower();
+  digitalWrite(LORA_KCT8103L_TX_RX, HIGH);
+}
+
+void LoRaFEMControl::setRxModeEnable() {
+  enableFEMPower();
+  digitalWrite(LORA_KCT8103L_TX_RX, LOW);
+}
+
+void LoRaFEMControl::setRxModeEnableWhenMCUSleep() {
+  enableFEMPower();
+  digitalWrite(LORA_KCT8103L_TX_RX, LOW);
+}

variants/heltec_tower_v2/LoRaFEMControl.h

@@ -0,0 +1,13 @@
+#pragma once
+
+class LoRaFEMControl {
+public:
+  LoRaFEMControl() {}
+  virtual ~LoRaFEMControl() {}
+
+  void init();
+  void setSleepModeEnable();
+  void setTxModeEnable();
+  void setRxModeEnable();
+  void setRxModeEnableWhenMCUSleep();
+};

variants/heltec_tower_v2/platformio.ini

@@ -0,0 +1,104 @@
+[Heltec_tower_v2]
+extends = nrf52_base
+board = heltec_tower_v2
+board_build.ldscript = boards/nrf52840_s140_v6.ld
+build_flags = ${nrf52_base.build_flags}
+  -D ENV_INCLUDE_GPS=1
+  -I lib/nrf52/s140_nrf52_6.1.1_API/include
+  -I lib/nrf52/s140_nrf52_6.1.1_API/include/nrf52
+  -I variants/heltec_tower_v2
+  -D HELTEC_TOWER_V2
+  -D NRF52_POWER_MANAGEMENT
+  -D RADIO_CLASS=CustomSX1262
+  -D WRAPPER_CLASS=CustomSX1262Wrapper
+  -D LORA_TX_POWER=12
+  -D MAX_LORA_TX_POWER=22 ; Max SX1262 output -> ~29dBm at antenna
+  -D SX126X_CURRENT_LIMIT=140
+  -D SX126X_RX_BOOSTED_GAIN=1
+build_src_filter = ${nrf52_base.build_src_filter}
+  +<helpers/*.cpp>
+  +<helpers/sensors>
+  +<../variants/heltec_tower_v2>
+lib_deps =
+  ${nrf52_base.lib_deps}
+  stevemarple/MicroNMEA @ ^2.0.6
+debug_tool = jlink
+upload_protocol = nrfutil
+
+[env:Heltec_tower_v2_repeater]
+extends = Heltec_tower_v2
+build_src_filter = ${Heltec_tower_v2.build_src_filter}
+  +<../examples/simple_repeater>
+build_flags =
+  ${Heltec_tower_v2.build_flags}
+  -D ADVERT_NAME='"Heltec_Tower_V2 Repeater"'
+  -D ADVERT_LAT=0.0
+  -D ADVERT_LON=0.0
+  -D ADMIN_PASSWORD='"password"'
+  -D MAX_NEIGHBOURS=50
+;  -D MESH_PACKET_LOGGING=1
+;  -D MESH_DEBUG=1
+
+[env:Heltec_tower_v2_room_server]
+extends = Heltec_tower_v2
+build_src_filter = ${Heltec_tower_v2.build_src_filter}
+  +<../examples/simple_room_server>
+build_flags =
+  ${Heltec_tower_v2.build_flags}
+  -D ADVERT_NAME='"Heltec_Tower_V2 Room"'
+  -D ADVERT_LAT=0.0
+  -D ADVERT_LON=0.0
+  -D ADMIN_PASSWORD='"password"'
+  -D ROOM_PASSWORD='"hello"'
+;  -D MESH_PACKET_LOGGING=1
+;  -D MESH_DEBUG=1
+
+[env:Heltec_tower_v2_companion_radio_ble]
+extends = Heltec_tower_v2
+board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
+board_upload.maximum_size = 712704
+build_flags =
+  ${Heltec_tower_v2.build_flags}
+  -I examples/companion_radio/ui-new
+  -D DISPLAY_CLASS=NullDisplayDriver
+  -D MAX_CONTACTS=350
+  -D MAX_GROUP_CHANNELS=40
+  -D BLE_PIN_CODE=123456
+;  -D BLE_DEBUG_LOGGING=1
+  -D OFFLINE_QUEUE_SIZE=256
+;  -D MESH_PACKET_LOGGING=1
+;  -D MESH_DEBUG=1
+build_src_filter = ${Heltec_tower_v2.build_src_filter}
+  +<helpers/nrf52/SerialBLEInterface.cpp>
+  +<../examples/companion_radio/*.cpp>
+  +<../examples/companion_radio/ui-new/*.cpp>
+lib_deps =
+  ${Heltec_tower_v2.lib_deps}
+  densaugeo/base64 @ ~1.4.0
+
+[env:Heltec_tower_v2_companion_radio_usb]
+extends = Heltec_tower_v2
+board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld
+board_upload.maximum_size = 712704
+build_flags =
+  ${Heltec_tower_v2.build_flags}
+  -I examples/companion_radio/ui-new
+  -D DISPLAY_CLASS=NullDisplayDriver
+  -D MAX_CONTACTS=350
+  -D MAX_GROUP_CHANNELS=40
+;  -D BLE_PIN_CODE=123456
+;  -D BLE_DEBUG_LOGGING=1
+;  -D MESH_PACKET_LOGGING=1
+;  -D MESH_DEBUG=1
+build_src_filter = ${Heltec_tower_v2.build_src_filter}
+  +<helpers/nrf52/*.cpp>
+  +<../examples/companion_radio/*.cpp>
+  +<../examples/companion_radio/ui-new/*.cpp>
+lib_deps =
+  ${Heltec_tower_v2.lib_deps}
+  densaugeo/base64 @ ~1.4.0
+
+[env:Heltec_tower_v2_kiss_modem]
+extends = Heltec_tower_v2
+build_src_filter = ${Heltec_tower_v2.build_src_filter}
+  +<../examples/kiss_modem/>

variants/heltec_tower_v2/target.cpp

@@ -0,0 +1,31 @@
+#include "target.h"
+
+#include <Arduino.h>
+#include <helpers/ArduinoHelpers.h>
+#include <helpers/sensors/MicroNMEALocationProvider.h>
+
+HeltecTowerV2Board board;
+
+RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, SPI);
+
+WRAPPER_CLASS radio_driver(radio, board);
+
+VolatileRTCClock fallback_clock;
+AutoDiscoverRTCClock rtc_clock(fallback_clock);
+MicroNMEALocationProvider nmea = MicroNMEALocationProvider(Serial1, &rtc_clock);
+EnvironmentSensorManager sensors = EnvironmentSensorManager(nmea);
+
+#ifdef DISPLAY_CLASS
+DISPLAY_CLASS display;
+MomentaryButton user_btn(PIN_USER_BTN, 1000, true);
+#endif
+
+bool radio_init() {
+  rtc_clock.begin(Wire);
+  return radio.std_init(&SPI);
+}
+
+mesh::LocalIdentity radio_new_identity() {
+  RadioNoiseListener rng(radio);
+  return mesh::LocalIdentity(&rng);
+}