[PluginID] Add support for over 255 pluginIDs

misc/CacheController/ParseCacheReaderBulkUpload.py

@@ -1,108 +1,110 @@
-import csv
-import ctypes
-import datetime
-
-
-
-def isNewSampleSet(data):
-    # Each sample on a new CSV line as is done by dump8.htm
-    return True
-
-    # We trigger on the event of the GPS to flush all values
-    # Thus consider this the start of a new row
-    #return data.pluginID == 82 # GPS plugin
-    #return data.TaskIndex == 1
-
-
-def decode(bytestream):
-
-    #    struct C016_binary_element
-    #    {
-    #        float             values[VARS_PER_TASK]{};
-    #        unsigned long     _timestamp{}; // Unix timestamp
-    #        taskIndex_t       TaskIndex{INVALID_TASK_INDEX};
-    #        pluginID_t        pluginID{INVALID_PLUGIN_ID};
-    #        Sensor_VType      sensorType{Sensor_VType::SENSOR_TYPE_NONE};
-    #        uint8_t           valueCount{};
-    #    };
-
-    class C016_binary_element(ctypes.Structure):
-        _fields_ = (
-            ('val1', ctypes.c_float),
-            ('val2', ctypes.c_float),
-            ('val3', ctypes.c_float),
-            ('val4', ctypes.c_float),
-            ('timestamp', ctypes.c_ulong),
-            ('TaskIndex', ctypes.c_uint8),
-            ('pluginID', ctypes.c_uint8),
-            ('sensorType', ctypes.c_uint8),
-            ('valueCount', ctypes.c_uint8)
-        )
-
-        def __str__(self):
-            return "{}: {{{}}}".format(self.__class__.__name__,
-                                       ", ".join(["{}: {}".format(field[0],
-                                                                  getattr(self,
-                                                                          field[0]))
-                                                  for field in self._fields_]))
-
-    ex1 = C016_binary_element.from_buffer_copy(bytestream)
-    return ex1
-
-
-def processFile(filename):
-    # Some example header, used for testing
-    # Should use the output sent by cachereader.sendtaskinfo command
-    header = "UNIX timestamp;UTC timestamp;task index;plugin ID;pms5003#cnt1.0;pms5003#cnt2.5;pms5003#cnt5.0;pms5003#cnt10;sunrise#co2;sunrise#T;sunrise#;sunrise#;bme280#Temperature;bme280#Humidity;bme280#Pressure;bme280#;bat#Analog;bat#;bat#;bat#;gps#long;gps#lat;gps#alt;gps#spd;batBackup#Analog;batBackup#;batBackup#;batBackup#;cachereader#FileNr;cachereader#FilePos;cachereader#;cachereader#;ADXL345#Pitch;ADXL345#Roll;ADXL345#Z;ADXL345#X;sysinfo#uptime;sysinfo#freeheap;sysinfo#rssi;sysinfo#load;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;bme2#Temperature;bme2#Humidity;bme2#Pressure;bme2#;pms1#pm1_0;pms1#pm2_5;pms1#pm10;pms1#cnt5_0;pms2#cnt0_3;pms2#cnt0_5;pms2#cnt1_0;pms2#cnt2_5;CO2#co2;CO2#temp;CO2#co2_prev;CO2#temp_prev;analog#carBat;analog#backupBat;analog#;analog#;gps2#hdop;gps2#satvis;gps2#sattracked;gps2#chksumfail"
-    csvheader = header.split(';')
-    nrcols = len(csvheader)
-    fileIn = open(filename, "r")
-
-    firstline = True
-
-    with open('decoded.csv', 'w', newline='') as fileOut:
-        writer = csv.writer(fileOut)
-        writer.writerow(csvheader)
-
-        row_out = [0] * nrcols
-
-        for line in fileIn:
-            samples = line.split(';')
-            length = len(samples)
-
-            # Skip the first 2 elements on the line
-            # filenr and filepos
-            i = 2
-
-            while i < length:
-                if len(samples[i]) == 48:
-                    data = decode(bytes.fromhex(samples[i]))
-                    if data.TaskIndex < 32: # and data.timestamp > 1674485061:
-                        if isNewSampleSet(data):
-                            if firstline:
-                                firstline = False
-                            else:
-                                writer.writerow(row_out)
-
-                        baseIndex = data.TaskIndex * 4 + 4
-                        row_out[baseIndex + 0] = data.val1
-                        row_out[baseIndex + 1] = data.val2
-                        row_out[baseIndex + 2] = data.val3
-                        row_out[baseIndex + 3] = data.val4
-
-                        row_out[0] = data.timestamp
-                        dt = datetime.datetime.fromtimestamp(data.timestamp)
-                        row_out[1] = dt
-                        row_out[2] = data.TaskIndex
-                        row_out[3] = data.pluginID
-
-                        print("{}: {}".format(samples[i], data))
-                i += 1
-
-        writer.writerow(row_out)
-        fileOut.close()
-
-
-if __name__ == '__main__':
-    processFile("upload_18.csv")
-
+import csv
+import ctypes
+import datetime
+
+
+
+def isNewSampleSet(data):
+    # Each sample on a new CSV line as is done by dump8.htm
+    return True
+
+    # We trigger on the event of the GPS to flush all values
+    # Thus consider this the start of a new row
+    #return data.pluginID == 82 # GPS plugin
+    #return data.TaskIndex == 1
+
+
+def decode(bytestream):
+
+    #    struct C016_binary_element
+    #    {
+    #        float             values[VARS_PER_TASK]{};
+    #        unsigned long     _timestamp{}; // Unix timestamp
+    #        taskIndex_t       TaskIndex{INVALID_TASK_INDEX};
+    #        pluginID_t        pluginID{INVALID_PLUGIN_ID};
+    #        Sensor_VType      sensorType{Sensor_VType::SENSOR_TYPE_NONE};
+    #        uint8_t           valueCount{};
+    #    };
+
+    # FIXME TD-er: Must fix fetching pluginID > 255. See C016_binary_element
+
+    class C016_binary_element(ctypes.Structure):
+        _fields_ = (
+            ('val1', ctypes.c_float),
+            ('val2', ctypes.c_float),
+            ('val3', ctypes.c_float),
+            ('val4', ctypes.c_float),
+            ('timestamp', ctypes.c_ulong),
+            ('TaskIndex', ctypes.c_uint8),
+            ('pluginID', ctypes.c_uint8),
+            ('sensorType', ctypes.c_uint8),
+            ('valueCount', ctypes.c_uint8)
+        )
+
+        def __str__(self):
+            return "{}: {{{}}}".format(self.__class__.__name__,
+                                       ", ".join(["{}: {}".format(field[0],
+                                                                  getattr(self,
+                                                                          field[0]))
+                                                  for field in self._fields_]))
+
+    ex1 = C016_binary_element.from_buffer_copy(bytestream)
+    return ex1
+
+
+def processFile(filename):
+    # Some example header, used for testing
+    # Should use the output sent by cachereader.sendtaskinfo command
+    header = "UNIX timestamp;UTC timestamp;task index;plugin ID;pms5003#cnt1.0;pms5003#cnt2.5;pms5003#cnt5.0;pms5003#cnt10;sunrise#co2;sunrise#T;sunrise#;sunrise#;bme280#Temperature;bme280#Humidity;bme280#Pressure;bme280#;bat#Analog;bat#;bat#;bat#;gps#long;gps#lat;gps#alt;gps#spd;batBackup#Analog;batBackup#;batBackup#;batBackup#;cachereader#FileNr;cachereader#FilePos;cachereader#;cachereader#;ADXL345#Pitch;ADXL345#Roll;ADXL345#Z;ADXL345#X;sysinfo#uptime;sysinfo#freeheap;sysinfo#rssi;sysinfo#load;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;#;bme2#Temperature;bme2#Humidity;bme2#Pressure;bme2#;pms1#pm1_0;pms1#pm2_5;pms1#pm10;pms1#cnt5_0;pms2#cnt0_3;pms2#cnt0_5;pms2#cnt1_0;pms2#cnt2_5;CO2#co2;CO2#temp;CO2#co2_prev;CO2#temp_prev;analog#carBat;analog#backupBat;analog#;analog#;gps2#hdop;gps2#satvis;gps2#sattracked;gps2#chksumfail"
+    csvheader = header.split(';')
+    nrcols = len(csvheader)
+    fileIn = open(filename, "r")
+
+    firstline = True
+
+    with open('decoded.csv', 'w', newline='') as fileOut:
+        writer = csv.writer(fileOut)
+        writer.writerow(csvheader)
+
+        row_out = [0] * nrcols
+
+        for line in fileIn:
+            samples = line.split(';')
+            length = len(samples)
+
+            # Skip the first 2 elements on the line
+            # filenr and filepos
+            i = 2
+
+            while i < length:
+                if len(samples[i]) == 48:
+                    data = decode(bytes.fromhex(samples[i]))
+                    if data.TaskIndex < 32: # and data.timestamp > 1674485061:
+                        if isNewSampleSet(data):
+                            if firstline:
+                                firstline = False
+                            else:
+                                writer.writerow(row_out)
+
+                        baseIndex = data.TaskIndex * 4 + 4
+                        row_out[baseIndex + 0] = data.val1
+                        row_out[baseIndex + 1] = data.val2
+                        row_out[baseIndex + 2] = data.val3
+                        row_out[baseIndex + 3] = data.val4
+
+                        row_out[0] = data.timestamp
+                        dt = datetime.datetime.fromtimestamp(data.timestamp)
+                        row_out[1] = dt
+                        row_out[2] = data.TaskIndex
+                        row_out[3] = data.pluginID
+
+                        print("{}: {}".format(samples[i], data))
+                i += 1
+
+        writer.writerow(row_out)
+        fileOut.close()
+
+
+if __name__ == '__main__':
+    processFile("upload_18.csv")
+

src/_C013.cpp

@@ -124,7 +124,7 @@ void C013_SendUDPTaskInfo(uint8_t destUnit, uint8_t sourceTaskIndex, uint8_t des
   infoReply.sourceUnit      = Settings.Unit;
   infoReply.sourceTaskIndex = sourceTaskIndex;
   infoReply.destTaskIndex   = destTaskIndex;
-  infoReply.deviceNumber    = pluginID;
+  infoReply.setPluginID(pluginID);
   infoReply.destUnit        = destUnit;
 
   if (destUnit == 0)
@@ -149,7 +149,7 @@ void C013_SendUDPTaskData(struct EventStruct *event, uint8_t destUnit, uint8_t d
   dataReply.sourceUnit      = Settings.Unit;
   dataReply.sourceTaskIndex = event->TaskIndex;
   dataReply.destTaskIndex   = destTaskIndex;
-  dataReply.deviceNumber    = Settings.getPluginID_for_task(event->TaskIndex);
+  dataReply.setPluginID(Settings.getPluginID_for_task(event->TaskIndex));
 
   // FIXME TD-er: We should check for sensorType and pluginID on both sides.
   // For example sending different sensor type data from one dummy to another is probably not going to work well
@@ -264,7 +264,7 @@ void C013_Receive(struct EventStruct *event) {
           const pluginID_t currentPluginID = Settings.getPluginID_for_task(infoReply.destTaskIndex);
           bool mustUpdateCurrentTask       = false;
 
-          if (currentPluginID == infoReply.deviceNumber) {
+          if (currentPluginID == infoReply.getPluginID()) {
             // Check to see if task already is set to receive from this host
             if ((Settings.TaskDeviceDataFeed[infoReply.destTaskIndex] == infoReply.sourceUnit) &&
                 Settings.TaskDeviceEnabled[infoReply.destTaskIndex]) {
@@ -273,10 +273,11 @@ void C013_Receive(struct EventStruct *event) {
           }
 
           if ((mustUpdateCurrentTask || !validPluginID_fullcheck(currentPluginID)) &&
-              supportedPluginID(infoReply.deviceNumber))
+              supportedPluginID(infoReply.getPluginID()))
           {
             taskClear(infoReply.destTaskIndex, false);
-            Settings.TaskDeviceNumber[infoReply.destTaskIndex]   = infoReply.deviceNumber.value;
+            // FIXME TD-er: Must find some extra bits to extend the pluginID beyond 255
+            Settings.setPluginID_for_task(infoReply.destTaskIndex, infoReply.getPluginID());
             Settings.TaskDeviceDataFeed[infoReply.destTaskIndex] = infoReply.sourceUnit; // remote feed store unit nr sending the data
 
             if (mustUpdateCurrentTask) {
@@ -285,7 +286,7 @@ void C013_Receive(struct EventStruct *event) {
 
             constexpr pluginID_t DUMMY_PLUGIN_ID{ 33 };
 
-            if ((infoReply.deviceNumber == DUMMY_PLUGIN_ID) && (infoReply.sensorType != Sensor_VType::SENSOR_TYPE_NONE)) {
+            if ((infoReply.getPluginID() == DUMMY_PLUGIN_ID) && (infoReply.sensorType != Sensor_VType::SENSOR_TYPE_NONE)) {
               // Received a dummy device and the sensor type is actually set
               Settings.TaskDevicePluginConfig[infoReply.destTaskIndex][0] = static_cast<int16_t>(infoReply.sensorType);
             }
@@ -372,7 +373,7 @@ void C013_Receive(struct EventStruct *event) {
             if (loglevelActiveFor(LOG_LEVEL_ERROR)) {
               String log = concat(F("P2P data : PluginID mismatch for task "), dataReply.destTaskIndex + 1);
               log += concat(F(" from unit "), dataReply.sourceUnit);
-              log += concat(F(" remote: "), dataReply.deviceNumber.value);
+              log += concat(F(" remote: "), dataReply.getPluginID().value);
               log += concat(F(" local: "), Settings.getPluginID_for_task(dataReply.destTaskIndex).value);
               addLogMove(LOG_LEVEL_ERROR, log);
             }

src/_P082_GPS.ino

@@ -50,6 +50,11 @@ boolean Plugin_082(uint8_t function, struct EventStruct *event, String& string)
       dev.TimerOption    = true;
       dev.PluginStats    = true;
       dev.CustomVTypeVar = true;
+# if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
+
+      // Allow to use double type for improved accuracy
+      dev.HasFormatUserVar = true;
+# endif // if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
       break;
     }
 
@@ -68,7 +73,7 @@ boolean Plugin_082(uint8_t function, struct EventStruct *event, String& string)
           switch (choice) {
             case P082_query::P082_QUERY_LONG:
             case P082_query::P082_QUERY_LAT:
-              ExtraTaskSettings.TaskDeviceValueDecimals[i] = 6;
+              ExtraTaskSettings.TaskDeviceValueDecimals[i] = P082_MAX_NR_DECIMALS;
               break;
             default:
               ExtraTaskSettings.TaskDeviceValueDecimals[i] = 2;
@@ -133,6 +138,37 @@ boolean Plugin_082(uint8_t function, struct EventStruct *event, String& string)
       break;
     }
 
+# if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
+    case PLUGIN_FORMAT_USERVAR:
+    {
+      P082_data_struct *P082_data =
+        static_cast<P082_data_struct *>(getPluginTaskData(event->TaskIndex));
+
+      if ((nullptr != P082_data) && P082_data->isInitialized()) {
+        if (event->idx < P082_NR_OUTPUT_VALUES) {
+          const uint8_t pconfigIndex = event->idx + P082_QUERY1_CONFIG_POS;
+          const P082_query query     = static_cast<P082_query>(PCONFIG(pconfigIndex));
+
+          if ((query == P082_query::P082_QUERY_LONG) ||
+              (query == P082_query::P082_QUERY_LAT))
+          {
+            const uint8_t nrDecimals = Cache.getTaskDeviceValueDecimals(event->TaskIndex, event->idx);
+
+            if (nrDecimals > 5) {
+              const ESPEASY_RULES_FLOAT_TYPE value = P082_data->_cache[static_cast<uint8_t>(query)];
+
+              if (!isnan(value)) {
+                string  = doubleToString(value, nrDecimals);
+                success = true;
+              }
+            }
+          }
+        }
+      }
+      break;
+    }
+# endif // if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
+
     case PLUGIN_GET_CONFIG_VALUE:
     {
       P082_data_struct *P082_data =
@@ -142,19 +178,22 @@ boolean Plugin_082(uint8_t function, struct EventStruct *event, String& string)
         const P082_query query = Plugin_082_from_valuename(string);
 
         if (query != P082_query::P082_NR_OUTPUT_OPTIONS) {
-          const float value = P082_data->_cache[static_cast<uint8_t>(query)];
-          int nrDecimals    = 2;
+          const ESPEASY_RULES_FLOAT_TYPE value = P082_data->_cache[static_cast<uint8_t>(query)];
+          int nrDecimals                       = 2;
 
           if ((query == P082_query::P082_QUERY_LONG) || (query == P082_query::P082_QUERY_LAT)) {
-            nrDecimals = 6;
+            nrDecimals = P082_MAX_NR_DECIMALS;
           } else if ((query == P082_query::P082_QUERY_SATVIS) ||
                      (query == P082_query::P082_QUERY_SATUSE) ||
                      (query == P082_query::P082_QUERY_FIXQ) ||
                      (query == P082_query::P082_QUERY_CHKSUM_FAIL)) {
             nrDecimals = 0;
           }
-
-          string  = toString(value, nrDecimals);
+# if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
+          string = doubleToString(value, nrDecimals);
+# else // if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
+          string = toString(value, nrDecimals);
+# endif // if FEATURE_USE_DOUBLE_AS_ESPEASY_RULES_FLOAT_TYPE
           success = true;
         }
       }
@@ -417,8 +456,8 @@ boolean Plugin_082(uint8_t function, struct EventStruct *event, String& string)
 
         if (curFixStatus) {
           if (P082_data->gps->location.isUpdated()) {
-            const float lng = P082_data->gps->location.lng();
-            const float lat = P082_data->gps->location.lat();
+            const ESPEASY_RULES_FLOAT_TYPE lng = P082_data->gps->location.lng();
+            const ESPEASY_RULES_FLOAT_TYPE lat = P082_data->gps->location.lat();
             P082_setOutputValue(event, static_cast<uint8_t>(P082_query::P082_QUERY_LONG),     lng);
             P082_setOutputValue(event, static_cast<uint8_t>(P082_query::P082_QUERY_LAT),      lat);
 
@@ -584,7 +623,7 @@ bool P082_referencePointSet(struct EventStruct *event) {
            && (P082_LAT_REF < 0.1f) && (P082_LAT_REF > -0.1f));
 }
 
-void P082_setOutputValue(struct EventStruct *event, uint8_t outputType, float value) {
+void P082_setOutputValue(struct EventStruct *event, uint8_t outputType, ESPEASY_RULES_FLOAT_TYPE value) {
   P082_data_struct *P082_data =
     static_cast<P082_data_struct *>(getPluginTaskData(event->TaskIndex));
 
@@ -755,6 +794,7 @@ void P082_html_show_stats(struct EventStruct *event) {
                     P082_data->gps->passedChecksum(),
                     P082_data->gps->failedChecksum(),
                     P082_data->gps->invalidData()));
+
 # ifndef BUILD_NO_DEBUG
 
   /*