Merge pull request #734 from recrof/lilygo_techo_refactor

lilygo t-echo enhancements and cleanup

variants/lilygo_techo/TechoBoard.cpp

@@ -0,0 +1,90 @@
+#include <Arduino.h>
+#include "TechoBoard.h"
+
+#ifdef LILYGO_TECHO
+
+#include <bluefruit.h>
+#include <Wire.h>
+
+static BLEDfu bledfu;
+
+static void connect_callback(uint16_t conn_handle) {
+  (void)conn_handle;
+  MESH_DEBUG_PRINTLN("BLE client connected");
+}
+
+static void disconnect_callback(uint16_t conn_handle, uint8_t reason) {
+  (void)conn_handle;
+  (void)reason;
+
+  MESH_DEBUG_PRINTLN("BLE client disconnected");
+}
+
+void TechoBoard::begin() {
+  // for future use, sub-classes SHOULD call this from their begin()
+  startup_reason = BD_STARTUP_NORMAL;
+
+  Wire.begin();
+
+  pinMode(SX126X_POWER_EN, OUTPUT);
+  digitalWrite(SX126X_POWER_EN, HIGH);
+  delay(10);   // give sx1262 some time to power up
+}
+
+uint16_t TechoBoard::getBattMilliVolts() {
+  int adcvalue = 0;
+
+  analogReference(AR_INTERNAL_3_0);
+  analogReadResolution(12);
+  delay(10);
+
+  // ADC range is 0..3000mV and resolution is 12-bit (0..4095)
+  adcvalue = analogRead(PIN_VBAT_READ);
+  // Convert the raw value to compensated mv, taking the resistor-
+  // divider into account (providing the actual LIPO voltage)
+  return (uint16_t)((float)adcvalue * REAL_VBAT_MV_PER_LSB);
+}
+
+bool TechoBoard::startOTAUpdate(const char* id, char reply[]) {
+  // Config the peripheral connection with maximum bandwidth
+  // more SRAM required by SoftDevice
+  // Note: All config***() function must be called before begin()
+  Bluefruit.configPrphBandwidth(BANDWIDTH_MAX);
+  Bluefruit.configPrphConn(92, BLE_GAP_EVENT_LENGTH_MIN, 16, 16);
+
+  Bluefruit.begin(1, 0);
+  // Set max power. Accepted values are: -40, -30, -20, -16, -12, -8, -4, 0, 4
+  Bluefruit.setTxPower(4);
+  // Set the BLE device name
+  Bluefruit.setName("TECHO_OTA");
+
+  Bluefruit.Periph.setConnectCallback(connect_callback);
+  Bluefruit.Periph.setDisconnectCallback(disconnect_callback);
+
+  // To be consistent OTA DFU should be added first if it exists
+  bledfu.begin();
+
+  // Set up and start advertising
+  // Advertising packet
+  Bluefruit.Advertising.addFlags(BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE);
+  Bluefruit.Advertising.addTxPower();
+  Bluefruit.Advertising.addName();
+
+  /* Start Advertising
+    - Enable auto advertising if disconnected
+    - Interval:  fast mode = 20 ms, slow mode = 152.5 ms
+    - Timeout for fast mode is 30 seconds
+    - Start(timeout) with timeout = 0 will advertise forever (until connected)
+
+    For recommended advertising interval
+    https://developer.apple.com/library/content/qa/qa1931/_index.html
+  */
+  Bluefruit.Advertising.restartOnDisconnect(true);
+  Bluefruit.Advertising.setInterval(32, 244); // in unit of 0.625 ms
+  Bluefruit.Advertising.setFastTimeout(30);   // number of seconds in fast mode
+  Bluefruit.Advertising.start(0);             // 0 = Don't stop advertising after n seconds
+
+  strcpy(reply, "OK - started");
+  return true;
+}
+#endif

variants/lilygo_techo/TechoBoard.h

@@ -0,0 +1,55 @@
+#pragma once
+
+#include <MeshCore.h>
+#include <Arduino.h>
+
+// built-ins
+#define VBAT_MV_PER_LSB   (0.73242188F)   // 3.0V ADC range and 12-bit ADC resolution = 3000mV/4096
+
+#define VBAT_DIVIDER      (0.5F)          // 150K + 150K voltage divider on VBAT
+#define VBAT_DIVIDER_COMP (2.0F)          // Compensation factor for the VBAT divider
+
+#define PIN_VBAT_READ     (4)
+#define REAL_VBAT_MV_PER_LSB (VBAT_DIVIDER_COMP * VBAT_MV_PER_LSB)
+
+class TechoBoard : public mesh::MainBoard {
+protected:
+  uint8_t startup_reason;
+
+public:
+
+  void begin();
+  uint16_t getBattMilliVolts() override;
+  bool startOTAUpdate(const char* id, char reply[]) override;
+
+  uint8_t getStartupReason() const override {
+    return startup_reason;
+  }
+
+  const char* getManufacturerName() const override {
+    return "LilyGo T-Echo";
+  }
+
+  void powerOff() override {
+    #ifdef LED_RED
+    digitalWrite(LED_RED, LOW);
+    #endif
+    #ifdef LED_GREEN
+    digitalWrite(LED_GREEN, LOW);
+    #endif
+    #ifdef LED_BLUE
+    digitalWrite(LED_BLUE, LOW);
+    #endif
+    #ifdef DISP_BACKLIGHT
+    digitalWrite(DISP_BACKLIGHT, LOW);
+    #endif
+    #ifdef PIN_PWR_EN
+    digitalWrite(PIN_PWR_EN, LOW);
+    #endif
+    sd_power_system_off();
+  }
+
+  void reboot() override {
+    NVIC_SystemReset();
+  }
+};

variants/lilygo_techo/platformio.ini

@@ -1,24 +1,26 @@
-[nrf52840_techo]
+[LilyGo_T-Echo]
 extends = nrf52_base
-platform_packages = framework-arduinoadafruitnrf52
+board = t-echo
+board_build.ldscript = boards/nrf52840_s140_v6.ld
 build_flags = ${nrf52_base.build_flags}
+  -I variants/lilygo_techo
   -I src/helpers/nrf52
   -I lib/nrf52/s140_nrf52_6.1.1_API/include
   -I lib/nrf52/s140_nrf52_6.1.1_API/include/nrf52
-lib_deps =
-  ${nrf52_base.lib_deps}
-  rweather/Crypto @ ^0.4.0
-
-[LilyGo_Techo]
-extends = nrf52840_techo
-board = t-echo
-board_build.ldscript = boards/nrf52840_s140_v6.ld
-build_flags = ${nrf52840_techo.build_flags}
-  -I variants/techo
-  -DLILYGO_TECHO
+  -D LILYGO_TECHO
   -D RADIO_CLASS=CustomSX1262
   -D WRAPPER_CLASS=CustomSX1262Wrapper
   -D LORA_TX_POWER=22
+  -D P_LORA_DIO_1=20
+  -D P_LORA_NSS=24
+  -D P_LORA_RESET=25
+  -D P_LORA_BUSY=17
+  -D P_LORA_SCLK=19
+  -D P_LORA_MISO=23
+  -D P_LORA_MOSI=22
+  -D SX126X_POWER_EN=37
+  -D SX126X_DIO2_AS_RF_SWITCH=true
+  -D SX126X_DIO3_TCXO_VOLTAGE=1.8
   -D SX126X_CURRENT_LIMIT=140
   -D SX126X_RX_BOOSTED_GAIN=1
   -D P_LORA_TX_LED=LED_GREEN
@@ -28,23 +30,31 @@ build_flags = ${nrf52840_techo.build_flags}
   -D GPS_BAUD_RATE=9600
   -D PIN_GPS_EN=GPS_EN
   -D TELEM_BME280_ADDRESS=0x77
-build_src_filter = ${nrf52840_techo.build_src_filter}
+  -D DISPLAY_CLASS=GxEPDDisplay
+  -D BACKLIGHT_BTN=PIN_BUTTON2
+  -D AUTO_OFF_MILLIS=0
+build_src_filter = ${nrf52_base.build_src_filter}
   +<helpers/*.cpp>
-  +<helpers/nrf52/TechoBoard.cpp>
+  +<TechoBoard.cpp>
   +<helpers/sensors/EnvironmentSensorManager.cpp>
-  +<../variants/techo>
+  +<helpers/ui/GxEPDDisplay.cpp>
+  +<helpers/ui/MomentaryButton.cpp>
+  +<../variants/lilygo_techo>
 lib_deps =
-  ${nrf52840_techo.lib_deps}
+  ${nrf52_base.lib_deps}
   stevemarple/MicroNMEA @ ^2.0.6
   adafruit/Adafruit BME280 Library @ ^2.3.0
+  zinggjm/GxEPD2 @ 1.6.2
+  bakercp/CRC32 @ ^2.0.0
 debug_tool = jlink
 upload_protocol = nrfutil
 
 [env:LilyGo_T-Echo_repeater]
-extends = LilyGo_Techo
-build_src_filter = ${LilyGo_Techo.build_src_filter} +<../examples/simple_repeater/main.cpp>
+extends = LilyGo_T-Echo
+build_src_filter = ${LilyGo_T-Echo.build_src_filter}
+  +<../examples/simple_repeater>
 build_flags =
-  ${LilyGo_Techo.build_flags}
+  ${LilyGo_T-Echo.build_flags}
   -D ADVERT_NAME='"T-Echo Repeater"'
   -D ADVERT_LAT=0.0
   -D ADVERT_LON=0.0
@@ -54,10 +64,11 @@ build_flags =
 ;  -D MESH_DEBUG=1
 
 [env:LilyGo_T-Echo_room_server]
-extends = LilyGo_Techo
-build_src_filter = ${LilyGo_Techo.build_src_filter} +<../examples/simple_room_server/main.cpp>
+extends = LilyGo_T-Echo
+build_src_filter = ${LilyGo_T-Echo.build_src_filter}
+  +<../examples/simple_room_server>
 build_flags =
-  ${LilyGo_Techo.build_flags}
+  ${LilyGo_T-Echo.build_flags}
   -D ADVERT_NAME='"T-Echo Room"'
   -D ADVERT_LAT=0.0
   -D ADVERT_LON=0.0
@@ -66,31 +77,41 @@ build_flags =
 ;  -D MESH_DEBUG=1
 
 [env:LilyGo_T-Echo_companion_radio_ble]
-extends = LilyGo_Techo
+extends = LilyGo_T-Echo
 build_flags =
-  ${LilyGo_Techo.build_flags}
+  ${LilyGo_T-Echo.build_flags}
   -I src/helpers/ui
   -I examples/companion_radio/ui-new
   -D MAX_CONTACTS=100
   -D MAX_GROUP_CHANNELS=8
   -D BLE_PIN_CODE=123456
 ;  -D BLE_DEBUG_LOGGING=1
-  -D DISPLAY_CLASS=GxEPDDisplay
   -D OFFLINE_QUEUE_SIZE=256
-  -D UI_RECENT_LIST_SIZE=9
-  -D BACKLIGHT_BTN=PIN_BUTTON2
-  -D AUTO_OFF_MILLIS=0
 ;  -D MESH_PACKET_LOGGING=1
 ;  -D MESH_DEBUG=1
-build_src_filter = ${LilyGo_Techo.build_src_filter}
-  +<helpers/nrf52/TechoBoard.cpp>
+  -D AUTO_SHUTDOWN_MILLIVOLTS=3300
+build_src_filter = ${LilyGo_T-Echo.build_src_filter}
   +<helpers/nrf52/SerialBLEInterface.cpp>
-  +<helpers/ui/GxEPDDisplay.cpp>
-  +<helpers/ui/MomentaryButton.cpp>
   +<../examples/companion_radio/*.cpp>
   +<../examples/companion_radio/ui-new/*.cpp>
 lib_deps =
-  ${LilyGo_Techo.lib_deps}
+  ${LilyGo_T-Echo.lib_deps}
+  densaugeo/base64 @ ~1.4.0
+
+[env:LilyGo_T-Echo_companion_radio_usb]
+extends = LilyGo_T-Echo
+build_flags =
+  ${LilyGo_T-Echo.build_flags}
+  -I src/helpers/ui
+  -I examples/companion_radio/ui-new
+  -D MAX_CONTACTS=100
+  -D MAX_GROUP_CHANNELS=8
+  -D OFFLINE_QUEUE_SIZE=256
+  -D UI_RECENT_LIST_SIZE=9
+  -D AUTO_SHUTDOWN_MILLIVOLTS=3300
+build_src_filter = ${LilyGo_T-Echo.build_src_filter}
+  +<../examples/companion_radio/*.cpp>
+  +<../examples/companion_radio/ui-new/*.cpp>
+lib_deps =
+  ${LilyGo_T-Echo.lib_deps}
   densaugeo/base64 @ ~1.4.0
-  zinggjm/GxEPD2 @ 1.6.2
-  bakercp/CRC32 @ ^2.0.0

variants/lilygo_techo/target.h

@@ -3,7 +3,7 @@
 #define RADIOLIB_STATIC_ONLY 1
 #include <RadioLib.h>
 #include <helpers/radiolib/RadioLibWrappers.h>
-#include <helpers/nrf52/TechoBoard.h>
+#include <TechoBoard.h>
 #include <helpers/radiolib/CustomSX1262Wrapper.h>
 #include <helpers/AutoDiscoverRTCClock.h>
 #include <helpers/SensorManager.h>