369 lines
13 KiB
Python
369 lines
13 KiB
Python
#!/usr/bin/env python
|
|
"""
|
|
Hiking DDS238-2 ZN/S Energy Meter
|
|
Author: Xavier Beaudouin
|
|
Requirements:
|
|
1. modbus over TCP adapter like PW21
|
|
2. pymodbus AND pymodbusTCP
|
|
"""
|
|
"""
|
|
<plugin key="DS238_ModbusTCP" name="DS238-2 ZN/S ModbusTCP" author="Xavier Beaudouin" version="0.0.3" externallink="https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp">
|
|
<params>
|
|
<param field="Address" label="IP Address" width="150px" required="true" />
|
|
<param field="Port" label="Port Number" width="100px" required="true" default="502" />
|
|
<param field="Mode3" label="Modbus address" width="100px" required="true" default="1" />
|
|
<param field="Mode6" label="Debug" width="100px">
|
|
<options>
|
|
<option label="True" value="Debug"/>
|
|
<option label="False" value="Normal" default="true" />
|
|
</options>
|
|
</param>
|
|
</params>
|
|
</plugin>
|
|
"""
|
|
|
|
import Domoticz
|
|
import sys
|
|
|
|
sys.path.append('/usr/local/lib/python3.4/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.5/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.6/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.7/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.8/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.9/dist-packages')
|
|
sys.path.append('/usr/local/lib/python3.10/dist-packages')
|
|
|
|
import pymodbus
|
|
|
|
from pyModbusTCP.client import ModbusClient
|
|
from pymodbus.constants import Endian
|
|
from pymodbus.payload import BinaryPayloadDecoder
|
|
|
|
#
|
|
# Domoticz shows graphs with intervals of 5 minutes.
|
|
# When collecting information from the inverter more frequently than that, then it makes no sense to only show the last value.
|
|
#
|
|
# The Average class can be used to calculate the average value based on a sliding window of samples.
|
|
# The number of samples stored depends on the interval used to collect the value from the inverter itself.
|
|
#
|
|
|
|
class Average:
|
|
|
|
def __init__(self):
|
|
self.samples = []
|
|
self.max_samples = 30
|
|
|
|
def set_max_samples(self, max):
|
|
self.max_samples = max
|
|
if self.max_samples < 1:
|
|
self.max_samples = 1
|
|
|
|
def update(self, new_value, scale = 0):
|
|
self.samples.append(new_value * (10 ** scale))
|
|
while (len(self.samples) > self.max_samples):
|
|
del self.samples[0]
|
|
|
|
Domoticz.Debug("Average: {} - {} values".format(self.get(), len(self.samples)))
|
|
|
|
def get(self):
|
|
return sum(self.samples) / len(self.samples)
|
|
|
|
#
|
|
# Domoticz shows graphs with intervals of 5 minutes.
|
|
# When collecting information from the inverter more frequently than that, then it makes no sense to only show the last value.
|
|
#
|
|
# The Maximum class can be used to calculate the highest value based on a sliding window of samples.
|
|
# The number of samples stored depends on the interval used to collect the value from the inverter itself.
|
|
#
|
|
|
|
class Maximum:
|
|
|
|
def __init__(self):
|
|
self.samples = []
|
|
self.max_samples = 30
|
|
|
|
def set_max_samples(self, max):
|
|
self.max_samples = max
|
|
if self.max_samples < 1:
|
|
self.max_samples = 1
|
|
|
|
def update(self, new_value, scale = 0):
|
|
self.samples.append(new_value * (10 ** scale))
|
|
while (len(self.samples) > self.max_samples):
|
|
del self.samples[0]
|
|
|
|
Domoticz.Debug("Maximum: {} - {} values".format(self.get(), len(self.samples)))
|
|
|
|
def get(self):
|
|
return max(self.samples)
|
|
|
|
# Plugin itself
|
|
class BasePlugin:
|
|
#enabled = False
|
|
def __init__(self):
|
|
# Voltage for last 5 minutes
|
|
self.voltage=Average()
|
|
# Current for last 5 minutes
|
|
self.current=Average()
|
|
# Active power for last 5 minutes
|
|
self.active_power=Average()
|
|
# Reactive power for last 5 minutes
|
|
self.reactive_power=Average()
|
|
# Power factor for last 5 minutes
|
|
self.power_factor=Average()
|
|
# Frequency for last 5 minutes
|
|
self.frequency=Average()
|
|
|
|
return
|
|
|
|
def onStart(self):
|
|
try:
|
|
Domoticz.Log("DS238-2 ZN/S Energy Meter TCP loaded!, using python v" + sys.version[:6] + " and pymodbus v" + pymodbus.__version__)
|
|
except:
|
|
Domoticz.Log("DS238-2 ZN/S Energy Meter TCP loaded!")
|
|
|
|
# Check dependancies
|
|
try:
|
|
if (float(Parameters["DomoticzVersion"][:6]) < float("2020.2")): Domoticz.Error("WARNING: Domoticz version is outdated or not supported. Please update!")
|
|
if (float(sys.version[:1]) < 3): Domoticz.Error("WARNING: Python3 should be used !")
|
|
if (float(pymodbus.__version__[:3]) < float("2.3")): Domoticz.Error("WARNING: pymodbus version is outdated, please update!")
|
|
except:
|
|
Domoticz.Error("Warning ! Dependancies could not be checked !")
|
|
|
|
# Parse parameters
|
|
|
|
# Debug
|
|
if Parameters["Mode6"] == "Debug":
|
|
Domoticz.Debugging(1)
|
|
else:
|
|
Domoticz.Debugging(0)
|
|
|
|
self.IPAddress = Parameters["Address"]
|
|
self.IPPort = Parameters["Port"]
|
|
self.MBAddr = int(Parameters["Mode3"])
|
|
|
|
Domoticz.Debug("Query IP " + self.IPAddress + ":" + str(self.IPPort) +" on device : "+str(self.MBAddr))
|
|
|
|
# Create the devices if they does not exists
|
|
# TODO: refactor this.
|
|
if 1 not in Devices:
|
|
Domoticz.Device(Name="Total Energy", Unit=1, Type=0xfa, Subtype=0x01, Used=0).Create()
|
|
if 2 not in Devices:
|
|
Domoticz.Device(Name="Export Energy", Unit=2, Type=0xfa, Subtype=0x01, Used=0).Create()
|
|
if 3 not in Devices:
|
|
Domoticz.Device(Name="Import Energy", Unit=3, Type=0xfa, Subtype=0x01, Used=0).Create()
|
|
if 4 not in Devices:
|
|
Domoticz.Device(Name="Voltage", Unit=4, TypeName="Voltage", Used=0).Create()
|
|
if 5 not in Devices:
|
|
Domoticz.Device(Name="Current", Unit=5, TypeName="Current (Single)", Used=0).Create()
|
|
if 6 not in Devices:
|
|
Options = { "Custom": "1;W" }
|
|
Domoticz.Device(Name="Active Power", Unit=6, TypeName="Custom", Used=0, Options=Options).Create()
|
|
if 7 not in Devices:
|
|
Options = { "Custom": "1;VAr" }
|
|
Domoticz.Device(Name="Reactive Power", Unit=7, TypeName="Custom", Used=0, Options=Options).Create()
|
|
if 8 not in Devices:
|
|
Options = { "Custom": "1;PF" }
|
|
Domoticz.Device(Name="Power Factor", Unit=8, TypeName="Custom", Used=0, Options=Options).Create()
|
|
if 9 not in Devices:
|
|
Options = { "Custom": "1;Hz" }
|
|
Domoticz.Device(Name="Frequency", Unit=9, TypeName="Custom", Used=0, Options=Options).Create()
|
|
if 10 not in Devices:
|
|
Domoticz.Device(Name="Total Power Meter",Unit=10,Type=0xfa, Subtype=0x01, Used=0).Create()
|
|
|
|
return
|
|
|
|
|
|
def onStop(self):
|
|
Domoticz.Debugging(0)
|
|
|
|
def onConnect(self, Connection, Status, Description):
|
|
Domoticz.Log("onConnect called")
|
|
return
|
|
|
|
def onMessage(self, Connection, Data):
|
|
Domoticz.Log("onMessage called")
|
|
|
|
def onCommand(self, Unit, Command, Level, Hue):
|
|
Domoticz.Log("onCommand called for Unit " + str(Unit) + ": Parameter '" + str(Command) + "', Level: " + str(Level))
|
|
|
|
def onNotification(self, Name, Subject, Text, Status, Priority, Sound, ImageFile):
|
|
Domoticz.Log("Notification: " + Name + "," + Subject + "," + Text + "," + Status + "," + str(Priority) + "," + Sound + "," + ImageFile)
|
|
|
|
def onDisconnect(self, Connection):
|
|
Domoticz.Log("onDisconnect called")
|
|
|
|
def onHeartbeat(self):
|
|
Domoticz.Debug(" Interface : IP="+self.IPAddress +", Port="+str(self.IPPort)+" ID="+str(self.MBAddr))
|
|
try:
|
|
client = ModbusClient(host=self.IPAddress, port=self.IPPort, unit_id=self.MBAddr, auto_open=True, auto_close=True, timeout=2)
|
|
except:
|
|
Domoticz.Error("Error connecting to TCP/Interface on address : "+self.IPaddress+":"+str(self.IPPort))
|
|
# Set value to 0 -> Error on all devices
|
|
Devices[1].Update(1, "0")
|
|
Devices[2].Update(1, "0")
|
|
Devices[3].Update(1, "0")
|
|
Devices[4].Update(1, "0")
|
|
Devices[5].Update(1, "0")
|
|
Devices[6].Update(1, "0")
|
|
Devices[7].Update(1, "0")
|
|
Devices[8].Update(1, "0")
|
|
Devices[9].Update(1, "0")
|
|
Devices[10].Update(1, "0")
|
|
|
|
# 3 counters
|
|
total_e = "0"
|
|
export_e = "0"
|
|
import_e = "0"
|
|
export_w = 0
|
|
import_w = 0
|
|
power = "0"
|
|
|
|
# Total Energy
|
|
total_e = str(getmodbus32(0, client))
|
|
|
|
# Export Energy
|
|
export_e = str(getmodbus32(0x8, client))
|
|
|
|
# Import Energy
|
|
import_e = str(getmodbus32(0xA, client))
|
|
|
|
# Voltage
|
|
value = round (getmodbus16(0xC,client) / 10, 3)
|
|
self.voltage.update(value)
|
|
value = self.voltage.get()
|
|
Devices[4].Update(1, str(value))
|
|
|
|
# Current
|
|
value = round (getmodbus16(0xD,client) / 100, 3)
|
|
self.current.update(value)
|
|
value = self.current.get()
|
|
Devices[5].Update(1, str(value))
|
|
|
|
# Active Power
|
|
value = getmodbus16(0xE, client)
|
|
self.active_power.update(value)
|
|
value = self.active_power.get()
|
|
Devices[6].Update(1, str(value))
|
|
if value > 0.0:
|
|
import_w = value
|
|
if value < 0.0:
|
|
export_w = value
|
|
power = str(abs(value))
|
|
|
|
# Reactive Power
|
|
value = getmodbus16(0xF, client)
|
|
self.reactive_power.update(value)
|
|
value = self.reactive_power.get()
|
|
Devices[7].Update(1, str(value))
|
|
|
|
# Power Factor
|
|
value = round (getmodbus16(0x10,client) / 1000, 3)
|
|
self.power_factor.update(value)
|
|
value = self.power_factor.get()
|
|
Devices[8].Update(1, str(value))
|
|
|
|
# Frequency
|
|
value = round (getmodbus16(0x11, client) / 100, 3)
|
|
self.frequency.update(value)
|
|
value = self.frequency.get()
|
|
Devices[9].Update(1, str(value))
|
|
|
|
# Do insert data on counters
|
|
Devices[1].Update(1, sValue=total_e+"0;0;0;0;"+power+";0")
|
|
Devices[2].Update(1, sValue=export_e+"0;0;0;0;"+str(abs(export_w))+";0")
|
|
Devices[3].Update(1, sValue=import_e+"0;0;0;0;"+str(abs(import_w))+";0")
|
|
Devices[10].Update(1, sValue=import_e+"0;0;"+export_e+"0;0;"+str(abs(import_w))+";"+str(abs(export_w)))
|
|
|
|
|
|
global _plugin
|
|
_plugin = BasePlugin()
|
|
|
|
def onStart():
|
|
global _plugin
|
|
_plugin.onStart()
|
|
|
|
def onStop():
|
|
global _plugin
|
|
_plugin.onStop()
|
|
|
|
def onConnect(Connection, Status, Description):
|
|
global _plugin
|
|
_plugin.onConnect(Connection, Status, Description)
|
|
|
|
def onMessage(Connection, Data):
|
|
global _plugin
|
|
_plugin.onMessage(Connection, Data)
|
|
|
|
def onCommand(Unit, Command, Level, Hue):
|
|
global _plugin
|
|
_plugin.onCommand(Unit, Command, Level, Hue)
|
|
|
|
def onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile):
|
|
global _plugin
|
|
_plugin.onNotification(Name, Subject, Text, Status, Priority, Sound, ImageFile)
|
|
|
|
def onDisconnect(Connection):
|
|
global _plugin
|
|
_plugin.onDisconnect(Connection)
|
|
|
|
def onHeartbeat():
|
|
global _plugin
|
|
_plugin.onHeartbeat()
|
|
|
|
# Generic helper functions
|
|
def DumpConfigToLog():
|
|
for x in Parameters:
|
|
if Parameters[x] != "":
|
|
Domoticz.Debug( "'" + x + "':'" + str(Parameters[x]) + "'")
|
|
Domoticz.Debug("Device count: " + str(len(Devices)))
|
|
for x in Devices:
|
|
Domoticz.Debug("Device: " + str(x) + " - " + str(Devices[x]))
|
|
Domoticz.Debug("Device ID: '" + str(Devices[x].ID) + "'")
|
|
Domoticz.Debug("Device Name: '" + Devices[x].Name + "'")
|
|
Domoticz.Debug("Device nValue: " + str(Devices[x].nValue))
|
|
Domoticz.Debug("Device sValue: '" + Devices[x].sValue + "'")
|
|
Domoticz.Debug("Device LastLevel: " + str(Devices[x].LastLevel))
|
|
return
|
|
|
|
# get Modbus 32 bits values
|
|
def getmodbus32(register, client):
|
|
value = 0
|
|
try:
|
|
data = client.read_holding_registers(register, 2)
|
|
Domoticz.Debug("Data from register "+str(register)+": "+str(data))
|
|
decoder = BinaryPayloadDecoder.fromRegisters(data, byteorder=Endian.Big, wordorder=Endian.Big)
|
|
value = decoder.decode_32bit_int()
|
|
except:
|
|
Domoticz.Error("Error getting data from "+str(register) + ", try 1")
|
|
try:
|
|
data = client.read_holding_registers(register, 2)
|
|
Domoticz.Debug("Data from register "+str(register)+": "+str(data))
|
|
decoder = BinaryPayloadDecoder.fromRegisters(data, byteorder=Endian.Big, wordorder=Endian.Big)
|
|
value = decoder.decode_32bit_int()
|
|
except:
|
|
Domoticz.Error("Error getting data from "+str(register) + ", try 2")
|
|
|
|
return value
|
|
|
|
# get Modbug 16 bits values
|
|
def getmodbus16(register, client):
|
|
value = 0
|
|
try:
|
|
data = client.read_holding_registers(register, 1)
|
|
Domoticz.Debug("Data from register "+str(register)+": "+str(data))
|
|
decoder = BinaryPayloadDecoder.fromRegisters(data, byteorder=Endian.Big, wordorder=Endian.Big)
|
|
value = decoder.decode_16bit_int()
|
|
except:
|
|
Domoticz.Error("Error getting data from "+str(register) + ", try 1")
|
|
try:
|
|
data = client.read_holding_registers(register, 1)
|
|
Domoticz.Debug("Data from register "+str(register)+": "+str(data))
|
|
decoder = BinaryPayloadDecoder.fromRegisters(data, byteorder=Endian.Big, wordorder=Endian.Big)
|
|
value = decoder.decode_16bit_int()
|
|
except:
|
|
Domoticz.Error("Error getting data from "+str(register) + ", try 2")
|
|
|
|
return value
|
|
|