intermediate: BME280 reading

lib/iictask/GwIicTask.cpp

@@ -59,14 +59,35 @@ class QMP6988Config{
 
 class BME280Config{
     public:
-    bool active=true;
+    bool pressureActive=true;
+    bool tempActive=true;
+    bool humidActive=true;
+    tN2kTempSource tempSource=tN2kTempSource::N2kts_InsideTemperature;
+    tN2kHumiditySource humidSource=tN2kHumiditySource::N2khs_InsideHumidity;
+    tN2kPressureSource pressureSource=tN2kPressureSource::N2kps_Atmospheric;
     int iid=99;
     long interval=2000;
+    String tempXdrName="Temperature";
+    String humidXdrName="Humidity";
+    String pressXdrName="Pressure";
+    float tempOffset=0;
+    float pressureOffset=0;
     BME280Config(GwConfigHandler *config){
-
+        pressureActive=config->getBool(GwConfigDefinitions::iicBME280Press);
+        tempActive=config->getBool(GwConfigDefinitions::iicBME280Temp);
+        humidActive=config->getBool(GwConfigDefinitions::iicBME280Humid);
+        tempSource=(tN2kTempSource)config->getInt(GwConfigDefinitions::BME280TSource);
+        humidSource=(tN2kHumiditySource)config->getInt(GwConfigDefinitions::BME280HumSource);
+        iid=config->getInt(GwConfigDefinitions::BME280iid);
+        interval=1000*config->getInt(GwConfigDefinitions::BME280interval);
+        tempXdrName=config->getString(GwConfigDefinitions::BME280TempName);
+        humidXdrName=config->getString(GwConfigDefinitions::BME280HumidName);
+        pressXdrName=config->getString(GwConfigDefinitions::BME280PressName);
+        //TODO: offsets
     }
 };
 void runIicTask(GwApi *api);
+
 void initIicTask(GwApi *api){
     GwLog *logger=api->getLogger();
     #ifndef _GWIIC
@@ -127,12 +148,50 @@ void initIicTask(GwApi *api){
     #ifdef GWBME280
         api->addCapability("BME280","true");
         BME280Config bme280Config(api->getConfig());
-        if (bme280Config.active){
+        bool bme280Active=false;
-            LOG_DEBUG(GwLog::DEBUG,"BME280 configured and active, adding capability and xdr mapping");
+        if (bme280Config.pressureActive){
-            addTask=true;
+            LOG_DEBUG(GwLog::DEBUG,"BME280 pressure active, adding capability and xdr mapping");
+            bme280Active=true;
+            GwXDRMappingDef xdr;
+            xdr.category=GwXDRCategory::XDRPRESSURE;
+            xdr.direction=GwXDRMappingDef::M_FROM2K;
+            xdr.selector=(int)bme280Config.pressureSource;
+            xdr.instanceId=bme280Config.iid;
+            xdr.instanceMode=GwXDRMappingDef::IS_SINGLE;
+            xdr.xdrName=bme280Config.pressXdrName;
+            api->addXdrMapping(xdr);
+        }
+        if (bme280Config.tempActive){
+            LOG_DEBUG(GwLog::DEBUG,"BME280 temperature active, adding capability and xdr mapping");
+            bme280Active=true;
+            GwXDRMappingDef xdr;
+            xdr.category=GwXDRCategory::XDRTEMP;
+            xdr.direction=GwXDRMappingDef::M_FROM2K;
+            xdr.field=GWXDRFIELD_TEMPERATURE_ACTUALTEMPERATURE;
+            xdr.selector=(int)bme280Config.tempSource;
+            xdr.instanceMode=GwXDRMappingDef::IS_SINGLE;
+            xdr.instanceId=bme280Config.iid;
+            xdr.xdrName=bme280Config.tempXdrName;
+            api->addXdrMapping(xdr);
+        }
+        if (bme280Config.humidActive){
+            LOG_DEBUG(GwLog::DEBUG,"BME280 humidity active, adding capability and xdr mapping");
+            bme280Active=true;
+            GwXDRMappingDef xdr;
+            xdr.category=GwXDRCategory::XDRHUMIDITY;
+            xdr.direction=GwXDRMappingDef::M_FROM2K;
+            xdr.field=GWXDRFIELD_HUMIDITY_ACTUALHUMIDITY;
+            xdr.selector=(int)bme280Config.humidSource;
+            xdr.instanceMode=GwXDRMappingDef::IS_SINGLE;
+            xdr.instanceId=bme280Config.iid;
+            xdr.xdrName=bme280Config.humidXdrName;
+            api->addXdrMapping(xdr);
+        }
+        if (! bme280Active){
+            LOG_DEBUG(GwLog::DEBUG,"BME280 configured but disabled");
         }
         else{
-            LOG_DEBUG(GwLog::DEBUG,"BME280 configured but disabled");
+            addTask=true;
         }
     #endif
     if (addTask){
@@ -217,21 +276,51 @@ void runIicTask(GwApi *api){
         int baddr=GWBME280;
         if (baddr < 0) baddr=0x76;
         BME280Config bme280Config(api->getConfig());
-        if (bme280Config.active){
+        if (bme280Config.tempActive || bme280Config.pressureActive|| bme280Config.humidActive){
             Adafruit_BME280 *bme280=new Adafruit_BME280();
             if (bme280->begin(baddr,&Wire)){
                 uint32_t sensorId=bme280->sensorID();
                 bool hasHumidity=sensorId == 0x60; //BME280, else BMP280
+                if (bme280Config.tempOffset != 0){
+                    bme280->setTemperatureCompensation(bme280Config.tempOffset);
+                }
+                if (hasHumidity || bme280Config.tempActive || bme280Config.pressureActive)
+                {
                     LOG_DEBUG(GwLog::LOG, "initialized BME280 at %d, sensorId 0x%x", baddr, sensorId);
                     timers.addAction(bme280Config.interval, [logger, api, bme280, bme280Config, counterId, hasHumidity](){
+                        if (bme280Config.pressureActive){
                             float pressure=bme280->readPressure();
-                    float temperature=bme280->readTemperature();
+                            float computed=pressure+bme280Config.pressureOffset;
-                    float humidity=-1;
+                            LOG_DEBUG(GwLog::DEBUG,"BME280 measure %2.0fPa, computed %2.0fPa",pressure,computed);
-                    if (hasHumidity) humidity=bme280->readHumidity();
+                            tN2kMsg msg;
-                    LOG_DEBUG(GwLog::DEBUG,"BME280 read press=%.0f, temp=%.1f, humid=%02.0f",pressure,temperature,humidity);
+                            SetN2kPressure(msg,1,bme280Config.iid,bme280Config.pressureSource,computed);
+                            api->sendN2kMessage(msg);
+                            api->increment(counterId,"BME280press");
+                        }
+                        if (bme280Config.tempActive){
+                            float temperature=bme280->readTemperature(); //offset is handled internally
+                            temperature=CToKelvin(temperature);
+                            LOG_DEBUG(GwLog::DEBUG,"BME280 measure temp=%2.1f",temperature);
+                            tN2kMsg msg;
+                            SetN2kTemperature(msg,1,bme280Config.iid,bme280Config.tempSource,temperature);
+                            api->sendN2kMessage(msg);
+                            api->increment(counterId,"BME280temp");
+                        }
+                        if (bme280Config.humidActive && hasHumidity){
+                            float humidity=bme280->readHumidity();
+                            LOG_DEBUG(GwLog::DEBUG,"BME280 read humid=%02.0f",humidity);
+                            tN2kMsg msg; 
+                            SetN2kHumidity(msg,1,bme280Config.iid,bme280Config.humidSource,humidity);
+                            api->sendN2kMessage(msg);
+                            api->increment(counterId,"BME280hum");
+                        }
                     });
                     runLoop = true;
                 }
+                else{
+                    LOG_DEBUG(GwLog::ERROR,"BME280 only humidity active, but sensor does not have it");
+                }
+            }
             else{
                 LOG_DEBUG(GwLog::ERROR,"unable to initialize BME280 sensor at address %d",baddr);
             }

lib/iictask/config.json

@@ -224,5 +224,192 @@
         "capabilities": {
             "QMP6988":"true"
         }
+    },
+    {
+        "name": "iicBME280Temp",
+        "label": "BME280 Temp",
+        "type": "boolean",
+        "default": "true",
+        "description": "Enable the I2C BME280 temp sensor",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280TSource",
+        "label": "BME280 Temp Type",
+        "type": "list",
+        "default": "2",
+        "description": "the NMEA2000 source type for the temperature",
+        "list": [
+            {
+                "l": "SeaTemperature",
+                "v": "0"
+            },
+            {
+                "l": "OutsideTemperature",
+                "v": "1"
+            },
+            {
+                "l": "InsideTemperature",
+                "v": "2"
+            },
+            {
+                "l": "EngineRoomTemperature",
+                "v": "3"
+            },
+            {
+                "l": "MainCabinTemperature",
+                "v": "4"
+            },
+            {
+                "l": "LiveWellTemperature",
+                "v": "5"
+            },
+            {
+                "l": "BaitWellTemperature",
+                "v": "6"
+            },
+            {
+                "l": "RefridgerationTemperature",
+                "v": "7"
+            },
+            {
+                "l": "HeatingSystemTemperature",
+                "v": "8"
+            },
+            {
+                "l": "DewPointTemperature",
+                "v": "9"
+            },
+            {
+                "l": "ApparentWindChillTemperature",
+                "v": "10"
+            },
+            {
+                "l": "TheoreticalWindChillTemperature",
+                "v": "11"
+            },
+            {
+                "l": "HeatIndexTemperature",
+                "v": "12"
+            },
+            {
+                "l": "FreezerTemperature",
+                "v": "13"
+            },
+            {
+                "l": "ExhaustGasTemperature",
+                "v": "14"
+            },
+            {
+                "l": "ShaftSealTemperature",
+                "v": "15"
+            }
+        ],
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "iicBME280Humid",
+        "label": "BME280 Humidity",
+        "type": "boolean",
+        "default": "true",
+        "description": "Enable the I2C BME280 humidity sensor",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280HumSource",
+        "label": "BME280 Humid Type",
+        "type": "list",
+        "description": "the NMEA2000 source type for the humidity",
+        "default": "0",
+        "list":[
+            {"l":"InsideHumidity","v":"0"},
+            {"l":"OutsideHumidity","v":"1"},
+            {"l":"Undef","v":"0xff"}  
+        ],
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "iicBME280Press",
+        "label": "BME280 Pressure",
+        "type": "boolean",
+        "default": "true",
+        "description": "Enable the I2C BME280 pressure sensor",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280iid",
+        "label": "BME280 N2K iid",
+        "type": "number",
+        "default": 99,
+        "description": "the N2K instance id for the BME280 Temperature and Humidity ",
+        "category": "sensors",
+        "min": 0,
+        "max": 253,
+        "check": "checkMinMax",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280interval",
+        "label": "BME280 Interval",
+        "type": "number",
+        "default": 2,
+        "description": "Interval(s) to query BME280 Temperature and Humidity (1...300)",
+        "category": "sensors",
+        "min": 1,
+        "max": 300,
+        "check": "checkMinMax",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280TempName",
+        "label": "BME280 Temp XDR",
+        "type": "String",
+        "default": "Temp",
+        "description": "set the XDR transducer name for the BME280 Temperature, leave empty to disable NMEA0183 XDR ",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280HumidName",
+        "label": "BME280 Humid XDR",
+        "type": "String",
+        "default": "Humidity",
+        "description": "set the XDR transducer name for the BME280 Humidity, leave empty to disable NMEA0183 XDR",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
+    },
+    {
+        "name": "BME280PressName",
+        "label": "BME280 Pressure XDR",
+        "type": "String",
+        "default": "Pressure",
+        "description": "set the XDR transducer name for the BME280 Pressure, leave empty to disable NMEA0183 XDR",
+        "category": "sensors",
+        "capabilities": {
+            "BME280":"true"
+        }
     }
 ]