disable the new station_name field by default to avoid breaking existing installs

Author: jertel

CHANGELOG.md

@@ -6,7 +6,7 @@
 ## New features
 - Refactor and improve history and detailed data collection including consistent timezone usage - @cooldil
 - Add --dryrun CLI arg for skipping writes to InfluxDB - @garthweb
-- Include station_name field in all new InfluxDB datapoints, to distinguish similarly named channel devices within a single account - @garthweb
+- New configuration option to include station_name field in all new InfluxDB datapoints, to distinguish similarly named channel devices within a single account - @garthweb
 
 ## Other changes
 - Upgrade to pyemvue 0.18.6 - @jertel

README.md

@@ -157,6 +157,12 @@ Be aware that the included dashboard assumes your device name contains the word
             ]
 ```
 
+### Station Names
+
+If you intend to run multiple Vue systems under the same account, where the channel names duplicate or look similar across those Vue systems then you may want to consider enabling the `addStationField` config parameter. This will include an additional field named 'station_name' in the InfluxDB event record, to help distinguish channel names across those Vue systems or 'stations'.
+
+Note that enabling this at a later time will cause issues due to queries matching multiple records. Therefore if you are installing Vuegraf for the first time and think this could be useful then enable it at the start.
+
 # Running
 Vuegraf can be run either as a container (recommended), or as a host process.
 

src/vuegraf/vuegraf.py

@@ -111,17 +111,17 @@ def createDataPoint(accountName, deviceName, chanName, watts, timestamp, detaile
     if influxVersion == 2:
         dataPoint = influxdb_client.Point('energy_usage') \
             .tag('account_name', accountName) \
-            .tag('station_name', deviceName) \
             .tag('device_name', chanName) \
             .tag(tagName, detailed) \
             .field('usage', watts) \
             .time(time=timestamp)
+        if addStationField:
+            dataPoint.tag('station_name', deviceName)
     else:
         dataPoint = {
             'measurement': 'energy_usage',
             'tags': {
                 'account_name': accountName,
-                'station_name': deviceName,
                 'device_name': chanName,
                 tagName: detailed,
             },
@@ -130,6 +130,9 @@ def createDataPoint(accountName, deviceName, chanName, watts, timestamp, detaile
             },
             'time': timestamp
         }
+        if addStationField:
+            dataPoint['tags']['station_name'] = deviceName
+
     return dataPoint
 
 def dumpPoints(label, usageDataPoints):
@@ -146,22 +149,27 @@ def getLastDBTimeStamp(deviceName, chanName, pointType, fooStartTime, fooStopTim
     # Get timestamp of last record in database
     # Influx v2
     if influxVersion == 2:
+        stationFilter = ""
+        if addStationField: 
+            stationFilter = '  r.station_name == "' + deviceName + '" and '
         timeCol = '_time'
         result = query_api.query('from(bucket:"' + bucket + '") ' +
              '|> range(start: -3w) ' +
              '|> filter(fn: (r) => ' +
              '  r._measurement == "energy_usage" and ' +
              '  r.' + tagName + ' == "' + pointType + '" and ' +
-             '  r._field == "usage" and ' +
-             '  r.station_name == "' + deviceName + '" and ' +
+             '  r._field == "usage" and ' + stationFilter +
              '  r.device_name == "' + chanName + '")' +
              '|> last()')
 
         if len(result) > 0 and len(result[0].records) > 0:
             lastRecord = result[0].records[0]
             timeStr = lastRecord['_time'].isoformat()
     else: # Influx v1
-        result = influx.query('select last(usage), time from energy_usage where (station_name = \'' + station_name + '\' AND device_name = \'' + chanName + '\' AND ' + tagName + ' = \'' + pointType + '\')')
+        stationFilter = ""
+        if addStationField: 
+            stationFilter = 'station_name = \'' + station_name + '\' AND '
+        result = influx.query('select last(usage), time from energy_usage where (' + stationFilter + 'device_name = \'' + chanName + '\' AND ' + tagName + ' = \'' + pointType + '\')')
         if len(result) > 0:
             timeStr = next(result.get_points())['time']
 
@@ -437,6 +445,7 @@ def extractDataPoints(device, usageDataPoints, pointType=None, historyStartTime=
     if 'tagValue_day' in config['influxDb']:
         tagValue_day = config['influxDb']['tagValue_day']
 
+    addStationField = getConfigValue('addStationField', False)
     maxHistoryDays = getConfigValue('maxHistoryDays', 720)
     historyDays = min(args.historydays, maxHistoryDays)
     history = historyDays > 0

vuegraf.json.sample

@@ -7,6 +7,7 @@
         "token": "<my-secret-token>"
     },
     "updateIntervalSecs": 60,
+    "addStationField": false,
     "detailedDataEnabled": true,
     "detailedDataSecondsEnabled": true,
     "detailedDataHoursEnabled": true,