homebridge-plc

{ "pluginAlias": "PLC", "headerDisplay": "Homebridge plugin for Siemens Step7 and compatible PLCs. Information about push and control support mentioned in the description.", "footerDisplay": "Please visit https://github.com/Feilner/homebridge-plc for more details.", "pluginType": "platform", "singular": true, "schema": { "type": "object", "properties": { "ip": { "title": "PLC IPv4 Address (ip)", "type": "string", "default": "192.168.1.100", "format": "ipv4", "required": true, "description": "IPv4 address of the PLC." }, "rack": { "title": "PLC Rack Number (rack)", "description": "Rack number of the PLC, typically 0.", "type": "integer", "default": 0, "minimum": 0, "required": true }, "slot": { "title": "PLC Slot Number (slot)", "description": "Slot number of the PLC. For S7 300/400 typically 2, for 1200/1500 typically 1.", "type": "integer", "default": 2, "minimum": 0, "required": true }, "communicationOP": { "title": "Use OP-Communication (communicationOP)", "description": "Switch to OP-Communication if PG connections are limited on some PLCs.", "type": "boolean", "placeholder": false }, "enablePolling": { "title": "Enable Polling (enablePolling)", "description": "Executes a background task every second to enable polling for the accessories.", "type": "boolean", "placeholder": false }, "defaultPollInterval": { "title": "Default Polling Interval (seconds) (defaultPollInterval)", "description": "Defines the default polling interval when no interval is set per accessory.", "type": "integer", "minimum": 1, "placeholder": 10 }, "distributePolling": { "title": "Distribute Polling (distributePolling)", "description": "Distributes the polling of accessories to avoid simultaneous queries and reduce PLC load.", "type": "boolean", "placeholder": false }, "enablePush": { "title": "Enable Push Server (enablePush)", "description": "Starts an HTTP server to receive push updates from the PLC. The PLC must send an HTTP request, e.g., 'http://homebridgeIp:8888/?push&db=6096&offset=1.1&value=1'.", "type": "boolean", "placeholder": false }, "enableControl": { "title": "Enable Control Server (enableControl)", "description": "Starts an HTTP server to allow control of accessories via HTTP, e.g., 'http://homebridgeIp:8888/?control&db=1014&offset=1&value=3'.", "type": "boolean", "placeholder": false }, "port": { "title": "Server Port (port)", "description": "Port for the HTTP server to handle incoming requests for push and control functionality. Default port is 8888.", "type": "integer", "minimum": 1, "placeholder": 8888 }, "forward": { "title": "Enable Forwarding of Push and Control Requests (forward)", "description": "Forward requests to another instance if the accessory limit is reached. Set the destination address of the second instance, e.g., 'http://127.0.0.1:8889'.", "type": "boolean", "placeholder": false }, "mirror": { "title": "Mirror Readings and Push Requests (mirror)", "description": "Share the same accessories on two Homebridge instances for pairing with another Home or Home Assistant. Set the destination address of the second instance, e.g., 'http://192.168.1.11:8888'. (Experimental feature)", "type": "boolean", "placeholder": false }, "accessories": { "type": "array", "items": { "title": "Accessory", "type": "object", "properties": { "accessory": { "title": "PLC Accessory (accessory)", "type": "string", "required": true, "default": "PLC_Dummy", "oneOf": [ { "title": "Select...", "enum": ["PLC_Dummy"] }, { "title": "PLC_LightBulb", "enum": ["PLC_LightBulb"] }, { "title": "PLC_Outlet", "enum": ["PLC_Outlet"] }, { "title": "PLC_Switch", "enum": ["PLC_Switch"] }, { "title": "PLC_TemperatureSensor", "enum": ["PLC_TemperatureSensor"] }, { "title": "PLC_HumiditySensor", "enum": ["PLC_HumiditySensor"] }, { "title": "PLC_Thermostat", "enum": ["PLC_Thermostat"] }, { "title": "PLC_HumidifierDehumidifier", "enum": ["PLC_HumidifierDehumidifier"] }, { "title": "PLC_WindowCovering", "enum": ["PLC_WindowCovering"] }, { "title": "PLC_Window", "enum": ["PLC_Window"] }, { "title": "PLC_Door", "enum": ["PLC_Door"] }, { "title": "PLC_OccupancySensor", "enum": ["PLC_OccupancySensor"] }, { "title": "PLC_MotionSensor", "enum": ["PLC_MotionSensor"] }, { "title": "PLC_ContactSensor", "enum": ["PLC_ContactSensor"] }, { "title": "PLC_LeakSensor", "enum": ["PLC_LeakSensor"] }, { "title": "PLC_Faucet", "enum": ["PLC_Faucet"] }, { "title": "PLC_Valve", "enum": ["PLC_Valve"] }, { "title": "PLC_SecuritySystem", "enum": ["PLC_SecuritySystem"] }, { "title": "PLC_StatelessProgrammableSwitch", "enum": ["PLC_StatelessProgrammableSwitch"] }, { "title": "PLC_Doorbell", "enum": ["PLC_Doorbell"] }, { "title": "PLC_LockMechanism", "enum": ["PLC_LockMechanism"] }, { "title": "PLC_LockMechanismBool", "enum": ["PLC_LockMechanismBool"] }, { "title": "PLC_GarageDoorOpener", "enum": ["PLC_GarageDoorOpener"] }, { "title": "PLC_SmokeSensor", "enum": ["PLC_SmokeSensor"] }, { "title": "PLC_Fan", "enum": ["PLC_Fan"] }, { "title": "PLC_LightSensor", "enum": ["PLC_LightSensor"] }, { "title": "PLC_LightSensor_DInt", "enum": ["PLC_LightSensor_DInt"] }, { "title": "PLC_AirPurifier", "enum": ["PLC_AirPurifier"] }, { "title": "PLC_FilterMaintenance", "enum": ["PLC_FilterMaintenance"] }, { "title": "PLC_CarbonDioxideSensor", "enum": ["PLC_CarbonDioxideSensor"] }, { "title": "PLC_CarbonMonoxideSensor", "enum": ["PLC_CarbonMonoxideSensor"] } ] }, "name": { "title": "Name (name)", "type": "string", "required": true, "description": "Define the unique name for the accessory.", "placeholder": "Enter unique name..." }, "db": { "title": "S7 Database Number (db)", "type": "integer", "minimum": 1, "required": true, "description": "S7 database number, e.g., 4 for DB4." }, "manufacturer": { "title": "Manufacturer (manufacturer)", "type": "string", "placeholder": "Homebridge", "description": "Set the manufacturer name for display in the Home app." }, "disable": { "title": "Disable acessory (disable)", "description": "Disable acessory.", "type": "boolean", "placeholder": false }, "enablePolling": { "title": "Enable Polling (enablePolling)", "description": "Effective only when polling is enabled at the platform level.", "type": "boolean", "placeholder": false }, "pollInterval": { "title": "Polling Interval (seconds) (pollInterval)", "description": "Overrides the platform-defined default polling interval.", "type": "integer", "minimum": 1, "placeholder": 10 }, "adaptivePolling": { "title": "Adaptive Polling (adaptivePolling) (optional)", "description": "When set to `true`, the current position will be polled until the target position is reached. Polling starts with the set target position from the Home app, allowing the shutter to show as opening or closing during movement.", "type": "boolean", "placeholder": false, "condition": { "functionBody": "return ['PLC_WindowCovering','PLC_Window','PLC_Door'].includes(model.accessories[arrayIndices[0]].accessory);" } }, "adaptivePollingInterval": { "title": "Adaptive Polling Interval (seconds) (adaptivePollingInterval) (optional)", "description": "Poll interval in seconds during high-frequency polling. Default value is `1` second.", "type": "integer", "minimum": 1, "placeholder": 1, "condition": { "functionBody": "return ['PLC_WindowCovering','PLC_Window','PLC_Door'].includes(model.accessories[arrayIndices[0]].accessory);" } }, "get_On": { "title": "Get On (get_On) (push support)", "description": "Offset and bit to read the current on/off state from the PLC. S7 type Bool, e.g., 55.1.", "type": "number", "required": true }, "set_On": { "title": "Single Bit Mode: Set on or off (set_On) (control support)", "description": "Single Bit Mode: Offset and bit to set to 1/0 to the PLC when switching on/off. S7 type `Bool`, e.g., 55.1 for DB4DBX55.1. Note: Could be identical to get_On.", "type": "number", "required": true, "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_On_Set && !model.accessories[arrayIndices[0]].set_On_Reset);" } }, "set_On_Set": { "title": "Separate Bits Mode: Set On Set (set_On_Set) (control support)", "description": "Separate Bits Mode: Offset and bit set to 1 when switching on. S7 type `Bool`, e.g., 55.2 for DB4DBX55.2. NOTE: PLC has to set to 0 after handling the request.", "type": "number", "required": true, "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_On);" } }, "set_On_Reset": { "title": "Separate Bits Mode: Set On Reset (set_On_Reset)", "description": "Separate Bits Mode: Offset and bit set to 1 when switching off. S7 type `Bool`, e.g., 55.3 for DB4DBX55.3. NOTE: PLC has to set to 0 after handling the request.", "type": "number", "required": true, "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_On);" } }, "get_Active": { "title": "Get Active (get_Active) (push support)", "description": "Offset and bit to get the current status. S7 type `Bool`, e.g., `55.0` for `DB4DBX55.0`.", "type": "number", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_Active_Set && !model.accessories[arrayIndices[0]].set_Active_Reset);" } }, "set_Active": { "title": "Single Bit Mode: Set Active (set_Active) (control support)", "description": "Single Bit Mode: Offset and bit to set to 1/0 to the PLC when switching on/off. S7 type `Bool`, e.g., 55.1 for DB4DBX55.1. Could be the same as get_Active. Separate Bits Mode: Offset and bit set to 1 when switching off. NOTE: PLC has to set to 0 after handling the request.", "type": "number", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_Active_Set && !model.accessories[arrayIndices[0]].set_Active_Reset);" } }, "set_Active_Set": { "title": "Separate Bits Mode: Set Active Set (set_Active_Set) (control support)", "description": "Separate Bits Mode: Offset and bit set to 1 when switching on. S7 type `Bool`, e.g., 55.2 for DB4DBX55.2. NOTE: PLC has to set to 0 after handling the request.", "type": "number", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_Active);" } }, "set_Active_Reset": { "title": "Separate Bits Mode: Set Active Reset (set_Active_Reset)", "description": "Separate Bits Mode: Offset and bit set to 1 when switching off. S7 type `Bool`, e.g., 55.3 for DB4DBX55.3. NOTE: PLC has to set to 0 after handling the request.", "type": "number", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_Active);" } }, "get_Brightness": { "title": "Get Brightness (get_Brightness)", "description": "Get brightness value. S7 type `Byte`, e.g., 56 for DB4DBB56.", "type": "number" }, "set_Brightness": { "title": "Set Brightness (set_Brightness)", "description": "Set brightness value. S7 type `Byte`, e.g., 57 for DB4DBB57.", "type": "number" }, "minTemperatureValue": { "title": "Minimum Temperature Value (minTemperatureValue)", "description": "Minimum temperature value.", "type": "number", "placeholder": -270 }, "maxTemperatureValue": { "title": "Maximum Temperature Value (maxTemperatureValue)", "description": "Maximum temperature value.", "type": "number", "placeholder": 100 }, "minTemperatureStep": { "title": "Minimum Temperature Step (minTemperatureStep)", "description": "Minimum temperature step.", "type": "number", "placeholder": 0.1 }, "minHumidityValue": { "title": "Minimum Humidity Value (minHumidityValue)", "description": "Minimum humidity value.", "type": "number", "placeholder": 0 }, "maxHumidityValue": { "title": "Maximum Humidity Value (maxHumidityValue)", "description": "Maximum humidity value.", "type": "number", "placeholder": 100 }, "minHumidityStep": { "title": "Minimum Humidity Step (minHumidityStep)", "description": "Minimum humidity step.", "type": "number", "placeholder": 1 }, "minTargetTemperatureValue": { "title": "Minimum Target Temperature Value (minTargetTemperatureValue)", "description": "Minimum target temperature value.", "type": "number", "placeholder": 10 }, "maxTargetTemperatureValue": { "title": "Maximum Target Temperature Value (maxTargetTemperatureValue)", "description": "Maximum target temperature value.", "type": "number", "placeholder": 38 }, "minTargetTemperatureStep": { "title": "Minimum Target Temperature Step (minTargetTemperatureStep)", "description": "Minimum target temperature step.", "type": "number", "placeholder": 0.1 }, "mapGetCurrentHeatingCoolingState": { "title": "Map Get Current Heating Cooling State (mapGetCurrentHeatingCoolingState) (optional)", "description": "Define mapping array for `get_CurrentHeatingCoolingState`. The PLC value is used as an index into the table. e.g., `[0, 2]` which maps the PLC value `0->0 1->2` when the PLC supports only two states with `0:inactive` and `1:cooling`.", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "mapSetTargetHeatingCoolingState": { "title": "Map Set Target Heating Cooling State (mapSetTargetHeatingCoolingState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for `set_TargetHeatingCoolingState`. The home app value is used as an index into the table. e.g., `[0, 1, 0, 3]` which maps the PLC value `0->0 1->1 2->0, 3->3` when the PLC supports only two states with `0:off` and `1:heat` and `3:automatic`. The state cool is mapped to off." }, "mapGetTargetHeatingCoolingState": { "title": "Map Get Target Heating Cooling State (mapGetTargetHeatingCoolingState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for `get_TargetHeatingCoolingState`. The PLC value is used as an index into the table. e.g., `[0, 3]` which maps the PLC value `0->0 1->3` when the PLC supports only two states with `0:off` and `1:automatic`." }, "minTargetHumidityValue": { "title": "Minimum Target Humidity Value (minTargetHumidityValue)", "type": "number", "placeholder": 0, "description": "Minimum target humidity value." }, "maxTargetHumidityValue": { "title": "Maximum Target Humidity Value (maxTargetHumidityValue)", "type": "number", "placeholder": 100, "description": "Maximum target humidity value." }, "minTargetHumidityStep": { "title": "Minimum Target Humidity Step (minTargetHumidityStep)", "type": "number", "placeholder": 1, "description": "Minimum target humidity step." }, "minBrightnessValue": { "title": "Minimum Brightness Value (minBrightnessValue)", "type": "number", "placeholder": 0, "description": "Minimum brightness value." }, "maxBrightnessValue": { "title": "Maximum Brightness Value (maxBrightnessValue)", "type": "number", "placeholder": 100, "description": "Maximum brightness value." }, "minBrightnessStep": { "title": "Minimum Brightness Step (minBrightnessStep)", "type": "number", "placeholder": 1, "description": "Minimum brightness step." }, "get_CurrentTemperature": { "title": "Get Current Temperature (get_CurrentTemperature) (push support)", "type": "number", "description": "Offset to get current temperature. S7 type Real, e.g., 55 for DB4DBD55." }, "get_CurrentRelativeHumidity": { "title": "Get Current Relative Humidity (get_CurrentRelativeHumidity) (push support)", "type": "number", "description": "Offset to get current humidity. S7 type Real, e.g., 55 for DB4DBD55." }, "get_TargetTemperature": { "title": "Get Target Temperature (get_TargetTemperature) (push support)", "type": "number", "description": "Offset to get target temperature. S7 type Real, e.g., 4 for DB4DBD4." }, "set_TargetTemperature": { "title": "Set Target Temperature (set_TargetTemperature) (control support)", "type": "number", "description": "Offset to set target temperature. S7 type Real, e.g., 4 for DB4DBD4. Can have the same value as get_TargetTemperature." }, "get_TargetRelativeHumidity": { "title": "Get Target Relative Humidity (get_TargetRelativeHumidity) (push support)", "type": "number", "description": "Offset to get target humidity. S7 type Real, e.g., 4 for DB4DBD4." }, "set_TargetRelativeHumidity": { "title": "Set Target Relative Humidity (set_TargetRelativeHumidity) (control support)", "type": "number", "description": "Offset to set target humidity. S7 type Real, e.g., 4 for DB4DBD4. Can have the same value as get_TargetRelativeHumidity." }, "get_CurrentHeatingCoolingState": { "title": "Get Current Heating Cooling State (get_CurrentHeatingCoolingState) (push support)", "type": "number", "description": "Offset to get current heating/cooling state. S7 type Byte, e.g., 8 for DB4DBB8. When not defined, fixed 1: heating is used. - 0: inactive (shown as green in Home app) - 1: heating (shown as orange in Home app) - 2: cooling (shown as blue in Home app)" }, "get_TargetHeatingCoolingState": { "title": "Get Target Heating Cooling State (get_TargetHeatingCoolingState) (push support)", "type": "number", "description": "Offset to get target heating/cooling state. S7 type Byte, e.g., 9 for DB4DBB9. When not defined, fixed 3: automatic is used. - 0: off - 1: heat - 2: cool - 3: automatic" }, "set_TargetHeatingCoolingState": { "title": "Set Target Heating Cooling State (set_TargetHeatingCoolingState) (control support)", "type": "number", "description": "Offset to set target heating/cooling state. Can be identical with get_TargetHeatingCoolingState. Has to be defined when get_TargetHeatingCoolingState is defined. When not defined, write changes are ignored. S7 type Byte, e.g., 9 for DB4DBB9. - 0: off - 1: heat - 2: cool - 3: automatic" }, "get_CurrentHumidifierDehumidifierState": { "title": "Get Current Humidifier Dehumidifier State (get_CurrentHumidifierDehumidifierState) (optional) (push support)", "type": "number", "description": "Offset to get current state. Default value 1: idle. S7 type Byte, e.g., 55 for DB4DBD55. - 0: inactive - 1: idle - 2: humidifying - 3: dehumidifying" }, "mapGetCurrentHumidifierDehumidifierState": { "title": "Map Get Current Humidifier Dehumidifier State (mapGetCurrentHumidifierDehumidifierState) (optional)", "type": "array", "description": "Define mapping array for get_CurrentHumidifierDehumidifierState. The PLC value is used as an index into the table. e.g., [1, 3] which maps the PLC value 0->1 1->3 when the PLC supports only two states with 0: idle and 1: dehumidifying." }, "default_TargetHumidifierDehumidifierState": { "title": "Default Target Humidifier Dehumidifier State (default_TargetHumidifierDehumidifierState) (optional)", "type": "number", "description": "Defines an alternative value that's returned when get_TargetHumidifierDehumidifierState is not defined. Default value 0: auto. - 0: auto (humidifier or dehumidifier) - 1: humidifier - 2: dehumidifier" }, "get_TargetHumidifierDehumidifierState": { "title": "Get Target Humidifier Dehumidifier State (get_TargetHumidifierDehumidifierState) (optional) (push support)", "type": "number", "description": "Offset to get current target state. S7 type Byte, e.g., 55 for DB4DBD55. - 0: auto (humidifier or dehumidifier) - 1: humidifier - 2: dehumidifier" }, "set_TargetHumidifierDehumidifierState": { "title": "Set Target Humidifier Dehumidifier State (set_TargetHumidifierDehumidifierState) (optional) (control support)", "type": "number", "description": "Offset to set current target state. Needs to be defined when get_TargetHumidifierDehumidifierState is set. S7 type Byte, e.g., 55 for DB4DBD55. - 0: auto (humidifier or dehumidifier) - 1: humidifier - 2: dehumidifier" }, "mapGetTargetHumidifierDehumidifierState": { "title": "Map Get Target Humidifier Dehumidifier State (mapGetTargetHumidifierDehumidifierState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for get_TargetHumidifierDehumidifierState. The PLC value is used as an index into the table. e.g., [2, 1] which maps the PLC value 0->1 1->2 when the PLC supports only one state with 0: dehumidifier 1: humidifier." }, "mapSetTargetHumidifierDehumidifierState": { "title": "Map Set Target Humidifier Dehumidifier State (mapSetTargetHumidifierDehumidifierState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for set_TargetHumidifierDehumidifierState. The Home app value is used as an index into the table. e.g., [2, 2, 2] writes always the value 2 to the PLC regardless of what's set in the Home app." }, "get_SwingMode": { "title": "Get Swing Mode (get_SwingMode) (optional) (push support)", "type": "number", "description": "Offset to get swing mode. S7 type Byte, e.g., 8 for DB4DBB8. - 0: swing disabled - 1: swing enabled" }, "set_SwingMode": { "title": "Set Swing Mode (set_SwingMode) (optional but required when get_SwingMode is defined) (push support)", "type": "number", "description": "Offset to set swing mode. S7 type Byte, e.g., 9 for DB4DBB9. - 0: swing disabled - 1: swing enabled" }, "get_WaterLevel": { "title": "Get Water Level (get_WaterLevel) (optional) (push support)", "type": "number", "description": "Offset to get water level. S7 type Real, e.g., 8 for DB4DBD8." }, "get_CurrentPosition": { "title": "Get Current Position (get_CurrentPosition) (push support)", "type": "number", "description": "Offset to get current position 0: closed 100: open. S7 type Byte, e.g., 0 for DB4DBB0. - 0: closed - in between: partly open - 100: open" }, "invertPosition": { "title": "Invert Position (invertPosition) (optional)", "type": "boolean", "placeholder": false, "description": "Set to true to invert the values of current and target position from 0: closed 100: open to 100: closed 0: open." }, "forceCurrentPosition": { "title": "Force Current Position (forceCurrentPosition) (optional)", "type": "boolean", "placeholder": false, "description": "When set to true, the position set by set_TargetPosition is directly used as the current position. This makes it appear in the Home app as if the target position was directly reached. This is recommended when not using adaptivePolling or pushing the value from the PLC." }, "mapGetCurrentPosition": { "title": "Map Get Current Position (mapGetCurrentPosition) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for get position. The PLC value is used as an index into the table. e.g., [0, 25, 100] which maps the PLC value 0->0 1->25 2->100. This is useful, e.g., for window open state." }, "get_TargetPosition": { "title": "Get Target Position (get_TargetPosition) (optional) (push support)", "type": "number", "description": "Offset to get target position. S7 type Byte, e.g., 1 for DB4DBB1. Can have the same value as set_TargetPosition. - 0: closed - in between: partly open - 100: open" }, "set_TargetPosition": { "title": "Set Target Position (set_TargetPosition) (optional) (control support)", "type": "number", "description": "Offset to set target position 0: closed 100: open. S7 type Byte, e.g., 2 for DB4DBB2. Can have the same value as get_TargetPosition. - 0: closed - in between: partly open - 100: open" }, "get_PositionState": { "title": "Get Position State (get_PositionState) (optional) (push support)", "type": "number", "description": "Offset to current movement state. If not defined, fixed 2 is returned. S7 type Byte, e.g., 3 for DB4DBB3. - 0: down - 1: up - 2: stop" }, "set_HoldPosition": { "title": "Set Hold Position (set_HoldPosition) (optional) (control support)", "type": "number", "description": "Offset and bit set to 1 to stop movement. (Seems not to be used by Home app) When not defined, writes will be ignored. S7 type Bool, e.g., 55.1 for DB4DBX55.1. NOTE: PLC has to set to 0 after handling the request." }, "get_OccupancyDetected": { "title": "Get Occupancy Detected (get_OccupancyDetected) (push support)", "type": "number", "description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0. - false: no occupancy - true: occupancy detected" }, "invertOccupancy": { "title": "Invert Occupancy (invertOccupancy)", "type": "boolean", "placeholder": false, "description": "When enabled, it inverts the logic of get_OccupancyDetected to false: motion detected and true: no motion." }, "get_MotionDetected": { "title": "Get Motion Detected (get_MotionDetected) (push support)", "type": "number", "description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0. - false: no occupancy - true: occupancy detected" }, "invertMotionDetected": { "title": "Invert Motion Detected (invertMotionDetected)", "type": "boolean", "placeholder": false, "description": "When enabled, it inverts the logic of get_MotionDetected to false: closed and true: no motion." }, "get_ContactSensorState": { "title": "Get Contact Sensor State (get_ContactSensorState) (push support)", "type": "number", "description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0. - false: closed - true: open" }, "invertContactSensorState": { "title": "Invert Contact Sensor State (invertContactSensorState)", "type": "boolean", "placeholder": false, "description": "When enabled, it inverts the logic of get_ContactSensorState to false: open and true: closed." }, "get_LeakDetected": { "title": "Get Leak Detected (get_LeakDetected) (push support)", "type": "number", "description": "Offset and bit to get the current status. S7 type Bool, e.g., 55.0 for DB4DBX55.0. - false: no leak detected - true: leak detected" }, "invertLeakDetected": { "title": "Invert Leak Detected (invertLeakDetected)", "type": "boolean", "placeholder": false, "description": "When enabled, it inverts the logic of get_LeakDetected to false: leak detected and true: no leak detected." }, "get_SetDuration": { "title": "Get Set Duration (get_SetDuration) (push support)", "type": "number", "description": "Offset to get duration 0..3600 sec. S7 type Time, e.g., 10 for DB4DBD10." }, "set_SetDuration": { "title": "Set Set Duration (set_SetDuration) (control support)", "type": "number", "description": "Offset to set duration 0..3600 sec. S7 type Time, e.g., 14 for DB4DBD10." }, "get_RemainingDuration": { "title": "Get Remaining Duration (get_RemainingDuration) (push support)", "type": "number", "description": "Offset to get remaining duration 0..3600 sec. S7 type Time, e.g., 18 for DB4DBD10." }, "get_CurrentAmbientLightLevel": { "title": "Get Current Ambient Light Level (get_CurrentAmbientLightLevel) (push support)", "type": "number", "description": "Offset to get current illumination in LUX. S7 type Real, value limited to 0.0001 ~ 100,000, e.g., 55 for DB4DBD55." }, "get_CurrentAmbientLightLevelDInt": { "title": "Get Current Ambient Light Level (get_CurrentAmbientLightLevelDInt) (push support)", "type": "number", "description": "Offset to get current illumination in LUX. S7 type DInt, value limited to 0.0001 ~ 100,000, e.g., 55 for DB4DBD55." }, "get_SecuritySystemCurrentState": { "title": "Get Security System Current State (get_SecuritySystemCurrentState) (push support)", "type": "number", "description": "Offset to current security system state. S7 type Byte, e.g., 3 for DB4DBB3. - 0: armed stay at home - 1: armed away from home - 2: armed night - 3: disarmed - 4: alarm triggered" }, "get_SecuritySystemTargetState": { "title": "Get Security System Target State (get_SecuritySystemTargetState) (push support)", "type": "number", "description": "Offset to set target security system state. S7 type Byte, e.g., 5 for DB4DBB4. - 0: armed stay at home - 1: armed away from home - 2: armed night - 3: disarmed" }, "set_SecuritySystemTargetState": { "title": "Set Security System Target State (set_SecuritySystemTargetState) (control support)", "type": "number", "description": "Offset to set target security system state. S7 type Byte, e.g., 6 for DB4DBB6. - 0: armed stay at home - 1: armed away from home - 2: armed night - 3: disarmed" }, "mapGetSecuritySystemCurrentState": { "title": "Map Get Security System Current State (mapGetSecuritySystemCurrentState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for get security system state. The PLC value is used as an index into the table. e.g., [3, 1] which maps the PLC value 0->3 1->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm." }, "mapSetSecuritySystemTargetState": { "title": "Map Set Security System Target State (mapSetSecuritySystemTargetState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for set security system state. The home app value is used as an index into the table. e.g., [1, 1, 1, 0, 2] which maps the PLC value 0->1 1->1 2->1, 3->0, 4->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm." }, "mapGetSecuritySystemTargetState": { "title": "Map Get Security System Target State (mapGetSecuritySystemTargetState) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for get security system state. The PLC value is used as an index into the table. e.g., [3, 1] which maps the PLC value 0->3 1->2 when the PLC supports only two states with 0: disarmed and 1: armed and 2: alarm." }, "isEvent": { "title": "Is Event (isEvent) (optional)", "type": "number", "description": "Offset and bit that is polled by homebridge-plc. NOTE: PLC has to set to `true`. When polled with value `true` the actual event is read from `get_ProgrammableSwitchEvent` and this flag is set to `false` by homebridge-plc to confirm that the event is handled. S7 type `Bool`, e.g., 55.1 for `DB4DBX55.1` (polling only, not used for push)" }, "get_ProgrammableSwitchEvent": { "title": "Get Programmable Switch Event (get_ProgrammableSwitchEvent) (push support) (control support)", "type": "number", "description": "Offset to read current event of the switch. This is reported towards Home app. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: single press - 1: double press - 2: long press - 3: unknown" }, "get_LockCurrentState": { "title": "Get Lock Current State (get_LockCurrentState) (push support)", "type": "number", "description": "Offset to read current state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`. - false: secured - true: unsecured" }, "forceCurrentLockState": { "title": "Force Current Lock State (forceCurrentLockState) (optional)", "type": "boolean", "placeholder": false, "description": "When set to `true`, the state set by `set_LockTargetState` is directly used as current state. This makes it appear in the Home app as if the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC." }, "get_LockTargetState": { "title": "Get Lock Target State (get_LockTargetState) (push support)", "type": "number", "description": "Offset to read current state. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: unsecured - 1: secured - 2: jammed - 3: unknown" }, "set_LockTargetState": { "title": "Set Lock Target State (set_LockTargetState) (control support)", "type": "number", "description": "Offset to write target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: unsecured - 1: secured" }, "get_LockCurrentStateBool": { "title": "Get Lock Current State (get_LockCurrentStateBool) (push support)", "type": "number", "description": "Offset to read current state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`. - false: secured - true: unsecured" }, "invertLockState": { "title": "Invert Lock State (invertLockState) (optional)", "type": "boolean", "description": "When set to `true`, all states are inverted (current and target state). - false: unsecured - true: secured" }, "get_LockTargetStateBool": { "title": "Get Lock Target State (get_LockTargetStateBool) (push support)", "type": "number", "description": "Offset to read target state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`. - false: secured - true: unsecured" }, "set_LockTargetStateBool": { "title": "Single Bit Mode: Set Lock Target State (set_LockTargetStateBool) (control support)", "type": "number", "description": "Offset to write target state. S7 type `Bool`, e.g., 3.1 for `DB4DBB3`. - false: secured - true: unsecured", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool_Secured && !model.accessories[arrayIndices[0]].set_LockTargetStateBool_Unsecured);" } }, "set_LockTargetStateBool_Secured": { "title": "Separate Bits Mode: Set Lock Target State Secured (set_LockTargetStateBool_Secured) (control support)", "type": "number", "description": "Offset and bit set to `true` when switching to target state secured. S7 type `Bool`, e.g., 3.3 for `DB4DBX3.3`. NOTE: PLC has to set to 0 after handling the request.", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool);" } }, "set_LockTargetStateBool_Unsecured": { "title": "Separate Bits Mode: Set Lock Target State Unsecured (set_LockTargetStateBool_Unsecured)", "type": "number", "description": "Offset and bit set to `true` when switching to target state unsecured. S7 type `Bool`, e.g., 3.3 for `DB4DBX3.3`. NOTE: PLC has to set to 0 after handling the request.", "condition": { "functionBody": "return (!model.accessories[arrayIndices[0]].set_LockTargetStateBool);" } }, "get_CurrentDoorState": { "title": "Get Current Door State (get_CurrentDoorState) (push support)", "type": "number", "description": "Offset to read current state. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: open - 1: closed - 2: opening - 3: closing - 4: stopped" }, "forceCurrentDoorState": { "title": "Force Current Door State (forceCurrentDoorState) (optional)", "type": "boolean", "placeholder": false, "description": "When set to `true`, the position set by `set_TargetDoorState` is directly used as current state. This makes it appear in the Home app as if the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC." }, "get_TargetDoorState": { "title": "Get Target Door State (get_TargetDoorState) (push support)", "type": "number", "description": "Offset to read target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: open - 1: closed" }, "set_TargetDoorState": { "title": "Set Target Door State (set_TargetDoorState) (control support)", "type": "number", "description": "Offset to write target state. S7 type `Byte`, e.g., 3 for `DB4DBB3`. - 0: open - 1: closed" }, "get_SmokeDetected": { "title": "Get Smoke Detected (get_SmokeDetected) (push support)", "type": "number", "description": "Offset and bit to smoke detection. S7 type `Bool`, e.g., 55.1 for `DB4DBX55.1`. - false: ok - true: smoke detected" }, "get_CurrentFanState": { "title": "Get Current Fan State (get_CurrentFanState) (optional) (push support)", "type": "number", "description": "Offset to get current heating/cooling state. S7 type `Byte`, e.g., 8 for `DB4DBB8`. - 0: inactive - 1: idle - 2: blowing" }, "default_CurrentFanState": { "title": "Default Current Fan State (default_CurrentFanState) (optional)", "type": "number", "description": "Defines an alternative value that's returned when `get_CurrentFanState` is not defined. Default value `0: inactive`." }, "mapCurrentFanStateGet": { "title": "Map Current Fan State Get (mapCurrentFanStateGet) (optional)", "type": "array", "items": { "type": "integer", "minimum": 0 }, "description": "Define mapping array for `get_CurrentFanState`. The PLC value is used as an index into the table. e.g., `[0, 2]` which maps the PLC value `0->1 1->2` when the PLC supports only two states with `0: idle` and `1: blowing`." }, "default_TargetFanState": { "title": "Default Target Fan State (default_TargetFanState) (optional)", "type": "number", "description": "Defines an alternative value that's returned when `get_TargetFanState` is not defined. Default value `0: manual`. - 0: manual - 1: automatic" }, "get_TargetFanState": { "title": "Get Target Fan State (get_TargetFanState) (push support)", "type": "number", "description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used." }, "set_TargetFanState": { "title": "Set Target Fan State (set_TargetFanState) (optional but required when `get_TargetFanState` is defined) (control support)", "type": "number", "description": "Offset to get target heating/cooling state. S7 type `Byte`, e.g., 9 for `DB4DBB9`. When not defined, fixed `1: automatic` is used. - 0: manual - 1: automatic" }, "mapTargetFanStateGet": { "title": "Map Target Fan State Get (mapTargetFanStateGet) (optional) (push support)", "type": "array", "items": { "type": "integer", "minimum": 0 },