Switch project from Arduino to PlatformIO (#52)

* Moved to platformio

* Moved cad models and schematics under extras

* Update README.md

* Added .gitignore

* Specify upload protocol

* Refactor platformio.ini

* Allow building igate mode from platformio file

* Move images to extras

* Update readme

* Update readme

* Use specific arduinoespressif version

* Added ttgo-lora32-v1

* Rename file and update gitignore

* Fix warnings

* Update readme

* Update readme

* Do not send telemetry in igate mode and send battery level every minute

.gitignore

@@ -1,33 +1,2 @@
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
-*.log
+.pio
+.vscode

README.md

@@ -1,5 +1,5 @@
 # ESP32 LoRa APRS Modem 
-![Modes of operation](images/diagram.png)
+![Modes of operation](extras/images/diagram.png)
 
 This project is amateur radio ESP32 based LoRa **KISS Bluetooth/BLE/USB/TCPIP** modem + LoRa **APRS-IS RX/TX iGate** server over WiFI + LoRa **APRS digipeater** + **Codec2 DV modem** (with Codec2 Talkie Android application). 
 
@@ -22,18 +22,12 @@ Modules, which are used by users and known to work
   - RA-02 (SX1276)
   - TTGO T-Beam (SX1276)
 
-# Dependencies
-Install via board manager:
-- Arduino ESP32 (search for esp32): https://github.com/espressif/arduino-esp32
-  - Use latest 2.0.5+ version, if board manager does not list it then update "Additional boards manager URL" to https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json 
-
-Install via libraries:
-- RadioLib library: https://github.com/jgromes/RadioLib
-- Arduino Timer library: https://github.com/contrem/arduino-timer
-- CircularBuffer library: https://github.com/rlogiacco/CircularBuffer
-- DebugLog library: https://github.com/hideakitai/DebugLog
+# Building
+- Update `include/config.h`
+- Build for client/tracker mode `pio run -e esp32dev`
+- Build for iGate `pio run -e esp32dev_igate`
 
 # Development board
-Development board schematics, case and antenna models are available under `cad` and `schematics`.
+Development board schematics, case and antenna models are available under `extras/cad` and `extras/schematics`.
 
-![Modes of operation](images/device.png)
+![Modes of operation](extras/images/device.png)

include/config.h

@@ -18,7 +18,9 @@
 #define CFG_LOG_LEVEL         DebugLogLevel::LVL_INFO
 
 // select between client mode and APRS-IS gate mode
+#ifndef CFG_IS_CLIENT_MODE
 #define CFG_IS_CLIENT_MODE    true        // false - server mode (APRS-IS gate mode)
+#endif
 
 // change pinouts if not defined through native board LORA_* definitions
 #ifndef LORA_RST

include/kiss_processor.h

@@ -46,7 +46,8 @@ protected:
   enum DataType {
       Raw = 0,
       Control,
-      Reboot
+      Reboot,
+      None = 0x80
   };
 
   static const int CfgSerialToRigQueueSize = 4096;

include/loraprs_service.h

@@ -125,7 +125,7 @@ private:
   const int CfgConnRetryMs = 500;             // connection retry delay, e.g. wifi
   const int CfgPollDelayMs = 20;              // main loop delay
   const int CfgConnRetryMaxTimes = 10;        // number of connection retries
-  const int CfgTelemetryPeriodMs = 30000;     // how often to send telemetry event
+  const int CfgTelemetryPeriodMs = 60000;     // how often to send telemetry event
 
   static const int CfgMaxPacketSize = 256;    // maximum packet size
   static const int CfgRadioQueueSize = 1024;  // radio queue size

platformio.ini

@@ -0,0 +1,36 @@
+[platformio]
+description = ESP32 LoRA APRS modem
+default_envs = esp32dev
+
+[env]
+platform = espressif32 @ 5.2.0
+framework = arduino
+monitor_speed = 115200
+board_build.partitions = min_spiffs.csv
+board_build.f_cpu = 80000000L
+upload_protocol = esptool
+lib_deps =
+  hideakitai/DebugLog @ 0.6.6
+  contrem/arduino-timer @ 2.3.1
+  jgromes/RadioLib @ 5.5.0
+  rlogiacco/CircularBuffer @ 1.3.3
+check_tool = cppcheck
+check_flags =
+  cppcheck: --suppress=*:*.pio\* --inline-suppr -DCPPCHECK
+check_skip_packages = yes
+
+[env:esp32dev]
+board = esp32dev
+build_flags =
+  '-D CFG_IS_CLIENT_MODE=true'
+
+[env:esp32dev_igate]
+board = esp32dev
+board_build.f_cpu = 240000000L
+build_flags =
+  '-D CFG_IS_CLIENT_MODE=false'
+
+[env:ttgo-lora32-v1]
+board = ttgo-lora32-v1
+build_flags =
+  '-D CFG_IS_CLIENT_MODE=true'

src/ble_serial.cpp

@@ -43,6 +43,8 @@ class BLESerialCharacteristicCallbacks: public BLECharacteristicCallbacks {
 // Constructor
 
 BLESerial::BLESerial()
+  : pService(NULL)
+  , pTxCharacteristic(NULL)
 {
   // create instance  
   receiveBuffer = "";

src/kiss_processor.cpp

@@ -7,6 +7,7 @@ Processor::Processor()
   , usePrefix3_(false)
   , isRawIdle_(true)
   , state_(State::GetStart)
+  , dataType_(DataType::None)
 {
 }
 

src/loraprs_service.cpp

@@ -8,11 +8,14 @@ volatile bool Service::rigIsRxIsrEnabled_ = true;
 
 Service::Service()
   : Kiss::Processor()
+  , config_()
   , csmaP_(CfgCsmaPersistence)
   , csmaSlotTime_(CfgCsmaSlotTimeMs)
   , csmaSlotTimePrev_(0)
+  , beaconLastTimestampMs_(0)
   , rigCurrentTxPacketSize_(0)
   , isIsrInstalled_(false)
+  , rigIsImplicitMode_(false)
   , serialBt_()
   , serialBLE_()
   , kissServer_(new WiFiServer(CfgKissPort))
@@ -89,7 +92,7 @@ void Service::setup(const Config &conf)
   }
 
   // telemetry event
-  if (config_.TlmEnable) {
+  if (config_.TlmEnable && config_.IsClientMode) {
     LOG_INFO("Telemetry event is enabled");
     telemetryTimer_.every(CfgTelemetryPeriodMs, sendModemTelemetryTimer, this);
   }

src/main.cpp

@@ -105,6 +105,11 @@ LoraPrs::Service loraPrsService;
 
 auto watchdogLedTimer = timer_create_default();
 
+bool toggleWatchdogLed(void *) {
+  digitalWrite(BUILTIN_LED, !digitalRead(BUILTIN_LED));
+  return true;
+}
+
 void setup() {
   pinMode(BUILTIN_LED, OUTPUT);
   digitalWrite(BUILTIN_LED, 1);
@@ -124,8 +129,3 @@ void loop() {
   loraPrsService.loop();
   watchdogLedTimer.tick();
 }
-
-bool toggleWatchdogLed(void *) {
-  digitalWrite(BUILTIN_LED, !digitalRead(BUILTIN_LED));
-  return true;
-}