- Moved non-default value for GEIGER_SUPPORT from feature to sensor.

- Integrated Geiger Counter
- Adapted sensor.ino to read and publish values.
- Modified html to add local dose rate into web page.
- Tested with influxDB.
- Tested with MQTT.

code/espurna/config/arduino.h

@@ -117,7 +117,6 @@
 //#define THINGSPEAK_SUPPORT     0
 //#define UART_MQTT_SUPPORT      1
 //#define WEB_SUPPORT            0
-//#define GEIGER_SUPPORT         1
 
 //--------------------------------------------------------------------------------
 // Sensors (values below are non-default values)
@@ -146,3 +145,4 @@
 //#define SI7021_SUPPORT         1
 //#define TMP3X_SUPPORT          1
 //#define V9261F_SUPPORT         1
+//#define GEIGER_SUPPORT         1

code/espurna/config/progmem.h

@@ -35,7 +35,8 @@ PROGMEM const unsigned char magnitude_decimals[] = {
     3, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0,
     0, 0, 0,
-    0, 0, 3, 3
+    0, 0, 3, 3,
+    4, 4 // Geiger Counter decimals
 };
 
 PROGMEM const char magnitude_unknown_topic[] = "unknown";
@@ -61,6 +62,8 @@ PROGMEM const char magnitude_lux_topic[] = "lux";
 PROGMEM const char magnitude_uv_topic[] = "uv";
 PROGMEM const char magnitude_distance_topic[] = "distance";
 PROGMEM const char magnitude_hcho_topic[] = "hcho";
+PROGMEM const char magnitude_geiger_cpm_topic[] = "ldr_cpm";  // local dose rate [Counts per minute]
+PROGMEM const char magnitude_geiger_sv_topic[] = "ldr_uSvh";  // local dose rate [µSievert per hour]
 
 PROGMEM const char* const magnitude_topics[] = {
     magnitude_unknown_topic, magnitude_temperature_topic, magnitude_humidity_topic,
@@ -70,7 +73,8 @@ PROGMEM const char* const magnitude_topics[] = {
     magnitude_analog_topic, magnitude_digital_topic, magnitude_events_topic,
     magnitude_pm1dot0_topic, magnitude_pm2dot5_topic, magnitude_pm10_topic,
     magnitude_co2_topic, magnitude_lux_topic, magnitude_uv_topic,
-    magnitude_distance_topic, magnitude_hcho_topic
+    magnitude_distance_topic, magnitude_hcho_topic,
+    magnitude_geiger_cpm_topic, magnitude_geiger_sv_topic   // Geiger Counter topics
 };
 
 PROGMEM const char magnitude_empty[] = "";
@@ -90,6 +94,9 @@ PROGMEM const char magnitude_lux[] = "lux";
 PROGMEM const char magnitude_uv[] = "uv";
 PROGMEM const char magnitude_distance[] = "m";
 PROGMEM const char magnitude_mgm3[] = "mg/m³";
+PROGMEM const char magnitude_geiger_cpm[] = "cpm";    // Counts per Minute: Unit of local dose rate (Geiger counting)
+PROGMEM const char magnitude_geiger_sv[] = "µSv/h";   // µSievert per hour: 2nd unit of local dose rate (Geiger counting)
+
 
 PROGMEM const char* const magnitude_units[] = {
     magnitude_empty, magnitude_celsius, magnitude_percentage,
@@ -99,8 +106,8 @@ PROGMEM const char* const magnitude_units[] = {
     magnitude_empty, magnitude_empty, magnitude_empty,
     magnitude_ugm3, magnitude_ugm3, magnitude_ugm3,
     magnitude_ppm, magnitude_lux, magnitude_uv,
-    magnitude_distance, magnitude_mgm3
-
+    magnitude_distance, magnitude_mgm3,
+    magnitude_geiger_cpm, magnitude_geiger_sv       // Geiger counter units
 };
 
 #endif

code/espurna/config/sensors.h

@@ -285,7 +285,36 @@
 #define EVENTS_INTERRUPT_MODE           RISING  // RISING, FALLING, BOTH
 #endif
 
-#define EVENTS_DEBOUNCE                 50      // Do not register events within less than 10 millis
+#define EVENTS_DEBOUNCE                 50      // Do not register events within less than 50 millis
+
+//------------------------------------------------------------------------------
+// Geiger sensor
+// Enable support by passing GEIGER_SUPPORT=1 build flag
+//------------------------------------------------------------------------------
+
+#ifndef GEIGER_SUPPORT
+#define GEIGER_SUPPORT                  0       // Do not build with geiger support by default
+#endif
+
+#ifndef GEIGER_PIN
+#define GEIGER_PIN                      D1       // GPIO to monitor "D1" => "GPIO5"
+#endif
+
+#ifndef GEIGER_PIN_MODE
+#define GEIGER_PIN_MODE                 INPUT   // INPUT, INPUT_PULLUP
+#endif
+
+#ifndef GEIGER_INTERRUPT_MODE
+#define GEIGER_INTERRUPT_MODE           RISING  // RISING, FALLING, BOTH
+#endif
+
+#define GEIGER_DEBOUNCE                 25      // Do not register events within less than 25 millis.
+                                                // Value derived here: Debounce time 25ms, because https://github.com/Trickx/espurna/wiki/Geiger-counter
+
+#define GEIGER_CPM2SIEVERT              240     // CPM to µSievert per hour conversion factor
+                                                // Typically the literature uses the invers, but I find an integer type more convienient.
+#define GEIGER_REPORT_SIEVERTS          1       // Enabler for local dose rate reports in µSv/h
+#define GEIGER_REPORT_CPM               1       // Enabler for local dose rate reports in counts per minute
 
 //------------------------------------------------------------------------------
 // GUVAS12SD UV Sensor (analog)
@@ -527,6 +556,7 @@
     EMON_ADS1X15_SUPPORT || \
     EMON_ANALOG_SUPPORT || \
     EVENTS_SUPPORT || \
+    GEIGER_SUPPORT || \
     GUVAS12SD_SUPPORT || \
     HCSR04_SUPPORT || \
     HLW8012_SUPPORT || \
@@ -639,6 +669,10 @@
     #include "../sensors/EventSensor.h"
 #endif
 
+#if GEIGER_SUPPORT
+    #include "../sensors/GeigerSensor.h"       // The main file for geiger counting module
+#endif
+
 #if GUVAS12SD_SUPPORT
     #include "../sensors/GUVAS12SDSensor.h"
 #endif

code/espurna/config/types.h

@@ -251,6 +251,7 @@
 #define SENSOR_TMP3X_ID             0x22
 #define SENSOR_HCSR04_ID            0x23
 #define SENSOR_SENSEAIR_ID          0x24
+#define SENSOR_GEIGER_ID            0x25
 
 //--------------------------------------------------------------------------------
 // Magnitudes
@@ -279,5 +280,7 @@
 #define MAGNITUDE_UV                20
 #define MAGNITUDE_DISTANCE          21
 #define MAGNITUDE_HCHO              22
+#define MAGNITUDE_GEIGER_CPM        23
+#define MAGNITUDE_GEIGER_SIEVERT    24
 
-#define MAGNITUDE_MAX               23
+#define MAGNITUDE_MAX               25

code/espurna/sensor.ino

@@ -59,6 +59,7 @@ unsigned char _magnitudeDecimals(unsigned char type) {
         type == MAGNITUDE_POWER_REACTIVE) {
         if (_sensor_power_units == POWER_KILOWATTS) return 3;
     }
+    if (type == MAGNITUDE_GEIGER_SIEVERT) return 4;        // TODO: Is this required? "magnitude_decimals" are defined in progmem.h
     if (type < MAGNITUDE_MAX) return pgm_read_byte(magnitude_decimals + type);
     return 0;
 
@@ -450,6 +451,18 @@ void _sensorLoad() {
     }
     #endif
 
+    #if GEIGER_SUPPORT
+    {
+        GeigerSensor * sensor = new GeigerSensor();        // Create instance of thr Geiger module.
+        sensor->setGPIO(GEIGER_PIN);                       // Interrupt pin of the attached geiger counter board.
+        sensor->setMode(GEIGER_PIN_MODE);                  // This pin is an input.
+        sensor->setDebounceTime(GEIGER_DEBOUNCE);          // Debounce time 25ms, because https://github.com/Trickx/espurna/wiki/Geiger-counter
+        sensor->setInterruptMode(GEIGER_INTERRUPT_MODE);   // Interrupt triggering: edge detection rising.
+        sensor->setCPM2SievertFactor(GEIGER_CPM2SIEVERT);  // Conversion factor from counts per minute to µSv/h
+        _sensors.push_back(sensor);
+    }
+    #endif
+
     #if GUVAS12SD_SUPPORT
     {
         GUVAS12SDSensor * sensor = new GUVAS12SDSensor();
@@ -592,7 +605,7 @@ void _sensorInit() {
             new_magnitude.min_change = 0;
             if (type == MAGNITUDE_DIGITAL) {
                 new_magnitude.filter = new MaxFilter();
-            } else if (type == MAGNITUDE_EVENTS) {
+            } else if (type == MAGNITUDE_EVENTS || type == MAGNITUDE_GEIGER_CPM|| type == MAGNITUDE_GEIGER_SIEVERT) {  // For geiger counting moving average filter is the most appropriate if needed at all.
                 new_magnitude.filter = new MovingAverageFilter();
             } else {
                 new_magnitude.filter = new MedianFilter();

code/html/custom.js

@@ -40,7 +40,7 @@ function sensorName(id) {
         "HLW8012", "V9261F", "ECH1560", "Analog", "Digital",
         "Events", "PMSX003", "BMX280", "MHZ19", "SI7021",
         "SHT3X I2C", "BH1750", "PZEM004T", "AM2320 I2C", "GUVAS12SD",
-        "TMP3X", "HC-SR04", "SenseAir"
+        "TMP3X", "HC-SR04", "SenseAir", "GeigerTicks", "GeigerCPM"
     ];
     if (1 <= id && id <= names.length) {
         return names[id - 1];
@@ -54,7 +54,8 @@ function magnitudeType(type) {
         "Current", "Voltage", "Active Power", "Apparent Power",
         "Reactive Power", "Power Factor", "Energy", "Energy (delta)",
         "Analog", "Digital", "Events",
-        "PM1.0", "PM2.5", "PM10", "CO2", "Lux", "UV", "Distance" , "HCHO"
+        "PM1.0", "PM2.5", "PM10", "CO2", "Lux", "UV", "Distance" , "HCHO",
+        "Local Dose Rate", "Local Dose Rate"
     ];
     if (1 <= type && type <= types.length) {
         return types[type - 1];