Code Sanitization

include/globals.h

@@ -1,97 +1,97 @@
-#ifndef _GLOBALS_H
+#ifndef _GLOBALS_H
-#define _GLOBALS_H
+#define _GLOBALS_H
-
+
-// The mother of all embedded development...
+// The mother of all embedded development...
-#include <Arduino.h>
+#include <Arduino.h>
-
+
-// std::set for unified array functions
+// std::set for unified array functions
-#include <set>
+#include <set>
-#include <array>
+#include <array>
-#include <algorithm>
+#include <algorithm>
-
+
-// Struct holding devices's runtime configuration
+// Struct holding devices's runtime configuration
-typedef struct {
+typedef struct {
-  uint8_t lorasf;      // 7-12, lora spreadfactor
+  uint8_t lorasf;      // 7-12, lora spreadfactor
-  uint8_t txpower;     // 2-15, lora tx power
+  uint8_t txpower;     // 2-15, lora tx power
-  uint8_t adrmode;     // 0=disabled, 1=enabled
+  uint8_t adrmode;     // 0=disabled, 1=enabled
-  uint8_t screensaver; // 0=disabled, 1=enabled
+  uint8_t screensaver; // 0=disabled, 1=enabled
-  uint8_t screenon;    // 0=disabled, 1=enabled
+  uint8_t screenon;    // 0=disabled, 1=enabled
-  uint8_t countermode; // 0=cyclic unconfirmed, 1=cumulative, 2=cyclic confirmed
+  uint8_t countermode; // 0=cyclic unconfirmed, 1=cumulative, 2=cyclic confirmed
-  int16_t rssilimit;   // threshold for rssilimiter, negative value!
+  int16_t rssilimit;   // threshold for rssilimiter, negative value!
-  uint8_t sendcycle;   // payload send cycle [seconds/2]
+  uint8_t sendcycle;   // payload send cycle [seconds/2]
-  uint8_t wifichancycle; // wifi channel switch cycle [seconds/100]
+  uint8_t wifichancycle; // wifi channel switch cycle [seconds/100]
-  uint8_t blescantime;   // BLE scan cycle duration [seconds]
+  uint8_t blescantime;   // BLE scan cycle duration [seconds]
-  uint8_t blescan;       // 0=disabled, 1=enabled
+  uint8_t blescan;       // 0=disabled, 1=enabled
-  uint8_t wifiant;       // 0=internal, 1=external (for LoPy/LoPy4)
+  uint8_t wifiant;       // 0=internal, 1=external (for LoPy/LoPy4)
-  uint8_t vendorfilter;  // 0=disabled, 1=enabled
+  uint8_t vendorfilter;  // 0=disabled, 1=enabled
-  uint8_t rgblum;        // RGB Led luminosity (0..100%)
+  uint8_t rgblum;        // RGB Led luminosity (0..100%)
-  uint8_t gpsmode;       // 0=disabled, 1=enabled
+  uint8_t gpsmode;       // 0=disabled, 1=enabled
-  uint8_t monitormode;   // 0=disabled, 1=enabled
+  uint8_t monitormode;   // 0=disabled, 1=enabled
-  uint8_t runmode;       // 0=normal, 1=update
+  uint8_t runmode;       // 0=normal, 1=update
-  char version[10];      // Firmware version
+  char version[10];      // Firmware version
-} configData_t;
+} configData_t;
-
+
-// Struct holding payload for data send queue
+// Struct holding payload for data send queue
-typedef struct {
+typedef struct {
-  uint8_t MessageSize;
+  uint8_t MessageSize;
-  uint8_t MessagePort;
+  uint8_t MessagePort;
-  uint8_t Message[PAYLOAD_BUFFER_SIZE];
+  uint8_t Message[PAYLOAD_BUFFER_SIZE];
-} MessageBuffer_t;
+} MessageBuffer_t;
-
+
-// global variables
+// global variables
-extern configData_t cfg;                      // current device configuration
+extern configData_t cfg;                      // current device configuration
-extern char display_line6[], display_line7[]; // screen buffers
+extern char display_line6[], display_line7[]; // screen buffers
-extern uint8_t volatile channel;              // wifi channel rotation counter
+extern uint8_t volatile channel;              // wifi channel rotation counter
-extern uint16_t volatile macs_total, macs_wifi, macs_ble,
+extern uint16_t volatile macs_total, macs_wifi, macs_ble,
-    batt_voltage;               // display values
+    batt_voltage;               // display values
-extern std::set<uint16_t> macs; // temp storage for MACs
+extern std::set<uint16_t> macs; // temp storage for MACs
-extern hw_timer_t *channelSwitch, *sendCycle;
+extern hw_timer_t *channelSwitch, *sendCycle;
-
+
-extern std::array<uint64_t, 0xff>::iterator it;
+extern std::array<uint64_t, 0xff>::iterator it;
-extern std::array<uint64_t, 0xff> beacons;
+extern std::array<uint64_t, 0xff> beacons;
-
+
-extern TaskHandle_t irqHandlerTask, wifiSwitchTask;
+extern TaskHandle_t irqHandlerTask, wifiSwitchTask;
-
+
-#ifdef HAS_GPS
+#ifdef HAS_GPS
-#include "gps.h"
+#include "gps.h"
-#endif
+#endif
-
+
-#if (HAS_LED != NOT_A_PIN) || defined(HAS_RGB_LED)
+#if (HAS_LED != NOT_A_PIN) || defined(HAS_RGB_LED)
-#include "led.h"
+#include "led.h"
-#endif
+#endif
-
+
-#include "payload.h"
+#include "payload.h"
-
+
-#ifdef HAS_LORA
+#ifdef HAS_LORA
-#include "lorawan.h"
+#include "lorawan.h"
-#endif
+#endif
-
+
-#ifdef HAS_SPI
+#ifdef HAS_SPI
-#include "spi.h"
+#include "spi.h"
-#endif
+#endif
-
+
-#ifdef HAS_DISPLAY
+#ifdef HAS_DISPLAY
-#include "display.h"
+#include "display.h"
-#endif
+#endif
-
+
-#ifdef HAS_BUTTON
+#ifdef HAS_BUTTON
-#include "button.h"
+#include "button.h"
-#endif
+#endif
-
+
-#ifdef BLECOUNTER
+#ifdef BLECOUNTER
-#include "blescan.h"
+#include "blescan.h"
-#endif
+#endif
-
+
-#ifdef HAS_BATTERY_PROBE
+#ifdef HAS_BATTERY_PROBE
-#include "battery.h"
+#include "battery.h"
-#endif
+#endif
-
+
-#ifdef HAS_ANTENNA_SWITCH
+#ifdef HAS_ANTENNA_SWITCH
-#include "antenna.h"
+#include "antenna.h"
-#endif
+#endif
-
+
-void reset_counters(void);
+void reset_counters(void);
-void blink_LED(uint16_t set_color, uint16_t set_blinkduration);
+void blink_LED(uint16_t set_color, uint16_t set_blinkduration);
-uint64_t uptime();
+uint64_t uptime();
-
+
 #endif

include/readme.txt

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

src/main.cpp

@@ -285,7 +285,7 @@ void setup() {
   ESP_LOGI(TAG, "Starting GPSloop...");
   xTaskCreatePinnedToCore(gps_loop,  // task function
                           "gpsloop", // name of task
-                          1024,      // stack size of task
+                          2048,      // stack size of task
                           (void *)1, // parameter of the task
                           2,         // priority of the task
                           &GpsTask,  // task handle