Plugin ‚modbus_tcp‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin modbus_tcp konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Es handelt sich bei diesem Plugin um ein gateway Plugin.

Beschreibung

Plugin zur Geräte-Anbindung über ModBus an SmartHomeNG

Anforderungen

  • Minimum SmartHomeNG Version: 1.10

  • Minimum Python Version: 3.6

Konfiguration

Im folgenden ist beschrieben, wie das Plugin modbus_tcp konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

crontab

Update mit Festlegung via Crontab

  • Datentyp: str

cycle

Update Zyklus in Sekunden. Wenn der Wert 0 ist, wird keine Abfrage über cycle ausgeführt

  • Datentyp: int

  • Standardwert: 300

  • Minimalwert: 0

host

IP Adresse des Modbus-Geraetes

  • Datentyp: ipv4

pause_item

Item, um die Ausführung des Plugins zu steuern

  • Datentyp: str

port

modbus Port

  • Datentyp: int

  • Minimalwert: 0

  • Maximalwert: 65535

slaveUnit

Slave-Addresse der zu lesenden Modbus-Einheit

  • Datentyp: int

  • Standardwert: 1

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

modBusAddress

Register Adresse welche gelesen werden soll

  • Datentyp: num

modBusByteOrder

Endian.BIG oder Endian.LITTLE

  • Datentyp: str

  • Standardwert: Endian.BIG

  • Mögliche Werte:

    • Endian.BIG

    • Endian.LITTLE

modBusDataType

Datentyp vom zu lesenden Register (bit, int16 uint16 int32 uint32 float32 string16 stringNN)

  • Datentyp: str

  • Standardwert: uint16

modBusDirection

Datenrichtung

  • Datentyp: str

  • Standardwert: read

  • Mögliche Werte:

    • read

    • read_write

    • write

modBusFactor

Faktor mit dem der gelesene Register-Wert multipliziert wird

  • Datentyp: num

  • Standardwert: 1

modBusObjectType

Auswahl welcher Objekt-Type gelesen werden soll

  • Datentyp: str

  • Standardwert: HoldingRegister

  • Mögliche Werte:

    • Coil

    • DiscreteInput

    • InputRegister

    • HoldingRegister

modBusUnit

Slave-Addresse der zu lesenden Modbus-Einheit (Unit aus der plugin-Konfig wird überschrieben)

  • Datentyp: num

  • Standardwert: 1

modBusWordOrder

Endian.BIG oder Endian.LITTLE

  • Datentyp: str

  • Standardwert: Endian.BIG

  • Mögliche Werte:

    • Endian.BIG

    • Endian.LITTLE

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

Keine