modbus_tcp

SmarthomeNG plugin, zum Lesen von Register über ModBusTCP

Anforderungen

Python >= 3.8 (zusätzlich gelten die Anforderungen von SmartHomeNG und pymodbus)
pymodbus >= 3.9, < 3.10
SmartHomeNG >= 1.11

Version 2.0 verwendet den asyncio-Support von SmartHomeNG. Die synchrone Version 1.1.0 ist weiterhin über plugin_version: 1.1.0 auswählbar. Für diese alte Version gelten weiterhin deren pymodbus-Anforderungen (< 3.10).

Abfragemodi

cycle > 0: Eine vollständige Abfrage pro Scheduler-Aufruf.
cycle: 0: Keine periodische Abfrage; Crontab oder Poll-Item können weiterhin abfragen.
cycle: -1: Kontinuierliche Abfragen mit kurzer Pause zwischen Registern.

Die Werte werden nach jeder erfolgreichen Abfrage direkt in die Items geschrieben; es gibt keinen separaten Flush-Puffer. Ein boolesches Item mit modbusPoll: true löst bei einem externen Wechsel auf true eine vollständige Abfrage aus. Vor erneutem Auslösen das Item auf false zurücksetzen. Überlappende Abfragen werden übersprungen. Ohne Abfragemodus, Poll-Item oder Schreib-Items wird keine TCP-Verbindung geöffnet.

pymodbus

das Paket sollte automatisch von SH installiert werden.

pymodbus - manuelle Installation:

python3 -m pip install pymodbus --user --upgrade

Konfiguration

plugin.yaml

solaredge:
    plugin_name: modbus_tcp
    instance: solaredge
    host: 192.168.0.50
    port: 502
    cycle: 60
    plugin_enabled: true

logoMB:
    plugin_name: modbus_tcp
    instance: logomb
    host: 192.168.0.80
    port: 502
    cycle: 20
    plugin_enabled: true

‚instance‘ = Name der Instanz, sollen mehrer Geräte angesprochen werden (Multiinstanz)

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.

items.yaml

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.

logic.yaml

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.

Beispiel: In der Datei example.yaml sind ein paar Items für einen Solaredge-Wechselrichter SE6000 angelegt.

Funktionen

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.

Beispiele

Beispiel für SH-Item’s

siehe auch example.yaml

mydevice:
    AI1:
        type: num
        name: AI1
        modBusObjectType: InputRegister     #(optional) default: HoldingRegister
        modBusAddress: 0
        modBusDataType: int16               #(optional) default: uint16
        #modBusByteOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        #modBusWordOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        modBusDirection: 'read_write'       #(optional) default: 'read'
        modBusUnit: '71'                    #(optional) default: slaveUnit aus der Plugin-Konfig
        #modBusFactor: 0.1                  #(optional) default: 1
        #modBusDirection: read_write        #(optional) default: 'read'
    AM1:
        type: num
        name: AM1
        modBusObjectType: HoldingRegister
        modBusAddress: 528
        modBusDirection: read_write
        #modBusFactor: 1
        #modBusDataType: int16
    M1:
        type: bool
        name: M1
        modBusObjectType: Coil
        modBusAddress: 8256
        modBusDataType: bit
        modBusDirection: read_write
    I1:
        type: bool
        name: I1
        modBusObjectType: DiscreteInput
        modBusAddress: 0
        modBusDataType: bit
    VM0:
        type: num
        name: VM0
        modBusObjectType: HoldingRegister
        modBusAddress: 0
        modBusDirection: read_write
        modBusFactor: 0.01

    geraetename:
        type: str
        #modBusObjectType: HoldingRegister  #(optional) default: HoldingRegister
        modBusAddress: 40030
        modBusDataType: 'string16'          #(optional) default: uint16
        #modBusFactor: '1000'               #(optional) default: 1
        modBusByteOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        modBusWordOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        modBusDirection: 'read_write'       #(optional) default: 'read'
        modBusUnit: '71'                    #(optional) default: slaveUnit aus der Plugin-Konfig
    temperatur:
        type: num
        modBusAddress: 40052
        modBusDataType: 'float32            #(optional) default: uint16
        #modBusFactor: '1'                  #(optional) default: 1
        modBusByteOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        modBusWordOrder: 'Endian.Little'    #(optional) default: 'Endian.Big'
        modBusUnit: '71'                    #(optional) default: slaveUnit aus der Plugin-Konfig

    # Multiinstanz:
    # Jedes Attribut mit der @<instance> ergänzen. Der Name der Instance muss in der Plugin Konfiguration festgelegt werden.
    M1:
        type: bool
        name: M1
        modBusObjectType@logomb: Coil
        modBusAddress@logomb: 8256
        modBusDataType@logomb: bit
        modBusDirection@logomb: read_write

Changelog

V1.0.15 Item Attribut modBusDirection erweitert: ‚write‘ hinzugefügt für Register

die nicht gelesen werden können aber beschrieben werden dürfen

pymodbus auf Version < 3.10 beschränkt

V1.0.14 Fehlerwerte hinzugefügt, Exception Handling verbessert, an aktuelle Pymodbus Version

angepasst und minimal notwendige Python Version auf 3.8 gesetzt

V1.0.13 pause_item wird nun unterstützt

V1.0.12 Problem beim Schreiben ohne modBusObjectTyp behoben: bei wiederholten Verbindungsproblemen Ausgabe vom Logger reduziert Verbindungstop mit supend/resume steuerbar
V1.0.11 Verbesserung Umwandlung Byte/Wordorder in Endian-Konstante: Fehler beim Schreiben von Register behoben

V1.0.10 Mindestversion für pymodbus ist nun 3.5.2

V1.0.9 Zusätzlich zu cycle für Geräteabfrage ‚crontab‘ Einträge erlaubt, Logeinträge abgeändert in Python f-strings

V1.0.8 Neuere Pymodbus Versionen können nun verwendet werden.: Di minimale Version für Pymodbus ist jetzt 2.5.3
V1.0.7 Verbindung offen halten und lock nutzen um Thread Sicherheit zu erreichen (CaeruleusAqua and bmxp): Fehler behoben: nicht deklarierte Variable „TypeStr“ und „bitstr“

V1.0.6 schreiben von Register (HoldingRegister, Coil)

V1.0.5 kleine Fehler behoben

V1.0.4 ObjectType hinzugefügt (HoldingRegister, InputRegister, DiscreteInput, Coil): Multiinstanz hinzugefügt Verbindung schliessen nach Abruf aller Register
V1.0.3 slaveUnit - Fehler behoben (_regToRead-key (adress.unit)): Bug Web Interface (Anzeige der Adresse) example.yaml verbessert

V1.0.2 slaveUnit zu Items hinzugefügt

V1.0.1 slaveUnit zu plugin-Paramter hinzugefügt

V1.0.0 Initial plugin version

Web Interface

Das Plugin kann aus dem Admin Interface aufgerufen werden. Dazu auf der Seite Plugins in der entsprechenden Zeile das Icon in der Spalte Web Interface anklicken.