homebridge-plc
Version:
Homebridge plugin for SIEMENS Step7 and compatible PLCs. (https://github.com/homebridge)
686 lines (630 loc) • 76.1 kB
Markdown
# homebridge-plc
Homebridge plugin for SIEMENS Step7 and compatible PLCs
[](https://www.npmjs.com/package/homebridge-plc)
[](https://www.npmjs.com/package/homebridge-plc)
[](https://www.npmjs.com/package/homebridge-plc)
[](https://www.paypal.me/OFeilner)
<!-- prettier-ignore -->
> [!NOTE]
> - Now compatible with the beta version of **Homebridge 2.0.0**
> - Now compatible with Node.js v22 and the latest Docker images of Homebridge
## SIEMENS S7 PLC plugin for [Homebridge](https://homebridge.io)
- This plugin uses [snap7](https://snap7.sourceforge.net) via [node-snap7](https://github.com/mathiask88/node-snap7), making it compatible with the following PLCs:
* S7 300
* S7 400
* S7 1200 (see [Snap7 notes](http://snap7.sourceforge.net/snap7_client.html#1200_1500))
* S7 1500 (see [Snap7 notes](http://snap7.sourceforge.net/snap7_client.html#1200_1500))
* Compatible PLCs such as YASKAWA / VIPA:
* SLIO e.g.
* 013-CCF0R00
* 014-CEF0R01
* 015-CEFNR00
* 015-CEFPR01
* 017-CEFPR00
* MICRO PLC
* 300S+
* The plugin uses PG-Communication (programming device communication) to connect to the PLC
* Optionally, OP-Communication (HMI or panel communication) can also be used to connect to the PLC
* **NOTE:** You may need to increase the connection resources for PG-Communication or OP-Communication within Siemens Simatic Manager or Siemens TIA Portal. The default value is 1, which may lead to connection problems when using the programming tool or panel and this plugin simultaneously.
- Tested with S7-300, S7-1200, and S7-300 compatible PLCs from YASKAWA and VIPA
- Implementation is based on the documentation of the [Homebridge API](https://developers.homebridge.io)
- Supports [**polling**](#poll) of the PLC from the homebridge-plc plugin with a per-accessory defined interval
- Supports [**push**](#push) from the PLC to the homebridge-plc plugin via HTTP PUT/GET
- Supports [**control**](#control) of PLC accessories via HTTP PUT/GET
- Supported Accessories:
* [LightBulb as `PLC_LightBulb`](#PLC_LightBulb)
* [Outlet as `PLC_Outlet`](#PLC_Outlet)
* [Switch as `PLC_Switch`](#PLC_Switch)
* [Temperature Sensor as `PLC_TemperatureSensor`](#PLC_TemperatureSensor)
* [Humidity Sensor as `PLC_HumiditySensor`](#PLC_HumiditySensor)
* [Thermostat as `PLC_Thermostat`](#PLC_Thermostat)
* [Humidifier/Dehumidifier as `PLC_HumidifierDehumidifier`](#PLC_HumidifierDehumidifier)
* [Shutter as `PLC_WindowCovering`](#PLC_Window)
* [Window as `PLC_Window`](#PLC_Window)
* [Door as `PLC_Door`](#PLC_Window)
* [Occupancy Sensor as `PLC_OccupancySensor`](#PLC_OccupancySensor)
* [Motion Sensor as `PLC_MotionSensor`](#PLC_MotionSensor)
* [Contact Sensor as `PLC_ContactSensor`](#PLC_ContactSensor)
* [Leak Sensor as `PLC_LeakSensor`](#PLC_LeakSensor)
* [Faucet as `PLC_Faucet`](#PLC_Faucet)
* [Valve as `PLC_Valve`](#PLC_Valve)
* [Security System as `PLC_SecuritySystem`](#PLC_SecuritySystem)
* [Push button attached to PLC as `PLC_StatelessProgrammableSwitch`](#PLC_StatelessProgrammableSwitch)
* [Doorbell push button attached to PLC as `PLC_Doorbell`](#PLC_StatelessProgrammableSwitch)
* [Lock mechanism as `PLC_LockMechanism`](#PLC_LockMechanism)
* [Boolean lock mechanism as `PLC_LockMechanismBool`](#PLC_LockMechanismBool)
* [Garage door as `PLC_GarageDoorOpener`](#PLC_GarageDoorOpener)
* [Smoke Sensor as `PLC_SmokeSensor`](#PLC_SmokeSensor)
* [Fan as `PLC_Fan`](#PLC_Fan)
* [Light Sensor as `PLC_LightSensor`](#PLC_LightSensor)
* [Air Purifier as `PLC_AirPurifier`](#PLC_AirPurifier)
* [Filter Maintenance as `PLC_FilterMaintenance`](#PLC_FilterMaintenance)
* [CarbonDioxideSensor as `PLC_CarbonDioxideSensor`](#PLC_CarbonDioxideSensor)
* [CarbonMonoxideSensor as `PLC_CarbonMonoxideSensor`](#PLC_CarbonMonoxideSensor)
# Installation
- Basic Installation
- Install this plugin using: `sudo npm install -g homebridge-plc`
- Edit `config.json` to add the PLC platform and its accessories.
- Run Homebridge
- Install via Homebridge UI (recommended)
- Search for `plc` on the plugin screen of [Homebridge UI](https://github.com/homebridge/homebridge-config-ui-x).
- Find `homebridge-plc`
- Click install.
- Edit configuration
# Homebridge configuration
## Platform
The plugin is configured as a single platform by defining a `PLC` platform.
Parameters:
- `ip`: the IPv4 address of the PLC
- `rack`: the rack number of the PLC (typically `0`)
- `slot`: the slot number of the PLC (S7 300/400 typically `2`, S7 1200/1500 typically `1`)
- `communicationOP`: **(optional)** when set to `true`, OP-Communication is used instead of PG-Communication. Default is `false` to use PG-Communication.
- `enablePolling`: **(optional)** when set to `true`, a background task is executed every second to enable polling for the accessories. Default is `false`.
- `defaultPollInterval`: **(optional)** default polling interval for all accessories in seconds. Default value is `10` seconds.
- `distributePolling`: **(optional)** when set to `true`, the polling of the accessories does not start at the same time to distribute the PLC load for the queries. Default is `false`.
- `enablePush`: **(optional)** when set to `true`, the configured `port` is opened to push updates of values from the PLC to the plugin. Default is `false`.
- `enableControl`: **(optional)** when set to `true`, the configured `port` is opened to control accessories by HTTP request. Default is `false`.
- `port`: **(optional)** port for HTTP server to handle incoming HTTP requests for push and control functionality. Default port is `8888`.
- **Experimental features**
- `forward`: **(optional)** there is a limit of a maximum of 149 supported accessories by Homebridge. To overcome this limit, you can create a second instance of Homebridge running homebridge-plc and forward all **push** and **control** with no matching `db` to the other instance. Set the destination address of the second instance e.g. `http:\\127.0.0.1:8889`.
- `mirror`: **(optional)** There are environments where it could make sense to share the same accessories on two Homebridge instances to allow pairing with another Home with Apple Home App or Home Assistant. This option mirrors all values read from the PLC by this instance to a second instance. It also forwards all **push** requests to the second instance. The option `enablePush` has to be enabled on the second instance. Set the destination address of the second instance e.g. `http:\\192.168.1.11:8888`.
## Accessories
- In the platform, you can declare different types of accessories.
- The notation **(push support)** identifies that the parameter supports direct updates from the PLC.
- The notation **(control support)** identifies parameters that can be controlled by HTTP request.
### <a name='PLC_LightBulb'></a>LightBulb as `PLC_LightBulb`
Normal light. See also simple PLC example for [single bit](doc/ligtbulb_plc_example_SingleBit.png) and [separate bits](doc/ligtbulb_plc_example_SeperatedBit.png).
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_On`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_On`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_On)
- Separate Bits for on/off:
- `set_On`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Off`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
- `get_Brightness`: **(optional)** **(push support)** get brightness value S7 type `Byte` e.g. `56` for `DB4DBB56`
- `set_Brightness`: **(optional but required when `get_Brightness` is defined)** **(control support)** set brightness value S7 type `Byte` e.g. `57` for `DB4DBB57`
- Brightness range definitions **(optional)**
- `minBrightnessValue` default value: 0
- `maxBrightnessValue` default value: 100
- `minBrightnessStep` default value: 1
### <a name='PLC_Outlet'></a>Outlet as `PLC_Outlet`
Outlet, possible to show also as ventilator or light.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_On`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_On`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_On)
- Separate Bits for on/off:
- `set_On_Set`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_On_Reset`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
### <a name='PLC_Switch'></a>Switch as `PLC_Switch`
Switch, possible to show also as ventilator or light.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_On`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_On`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_On)
- Separate Bits for on/off:
- `set_On`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Off`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
### <a name='PLC_TemperatureSensor'></a>Temperature Sensor as `PLC_TemperatureSensor`
Normal temperature sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current Temperature:
- `get_CurrentTemperature`: **(push support)** offset to get current temperature S7 type `Real` e.g. `55` for `DB4DBD55`
- Temperature range **(optional)**
- `minTemperatureValue` default value: -270
- `maxTemperatureValue` default value: 100
- `minTemperatureStep` default value: 0.1
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_HumiditySensor'></a>Humidity Sensor as `PLC_HumiditySensor`
Normal humidity sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current Humidity:
- `get_CurrentRelativeHumidity`: **(push support)** offset to get current humidity S7 type `Real` e.g. `55` for `DB4DBD55`
- Humidity range **(optional)**
- `minHumidityValue` default value: 0
- `maxHumidityValue` default value: 100
- `minHumidityStep` default value: 1
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_Thermostat'></a>Thermostat as `PLC_Thermostat`
Temperature/humidity sensor with regulation.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current Temperature:
- `get_CurrentTemperature`: **(push support)** offset to get current temperature S7 type `Real` e.g. `0` for `DB4DBD0`
- Temperature range **(optional)**
- `minTemperatureValue` default value: -270
- `maxTemperatureValue` default value: 100
- `minTemperatureStep` default value: 0.1
- Target Temperature:
- `get_TargetTemperature`: **(push support)** offset to get target temperature S7 type `Real` e.g. `4` for `DB4DBD4`
- `set_TargetTemperature`: **(control support)** offset to set target temperature S7 type `Real` e.g. `4` for `DB4DBD4` (can have the same value as get_TargetTemperature)
- Target temperature range definitions **(optional)**
- `minTargetTemperatureValue` default value: 10
- `maxTargetTemperatureValue` default value: 38
- `minTargetTemperatureStep` default value: 0.1 **Note:** lower values may not be supported by Homekit
- Current Humidity:
- `get_CurrentRelativeHumidity`: **(optional)** **(push support)** offset to get current humidity S7 type `Real` e.g. `0` for `DB4DBD0`
- Humidity range **(optional)**
- `minHumidityValue` default value: 0
- `maxHumidityValue` default value: 100
- `minHumidityStep` default value: 1
- Target Humidity:
- `get_TargetRelativeHumidity`: **(optional)** **(push support)** offset to get target humidity S7 type `Real` e.g. `4` for `DB4DBD4`
- `set_TargetRelativeHumidity`: **(optional)** **(control support)** offset to set target humidity S7 type `Real` e.g. `4` for `DB4DBD4` (can have the same value as get_TargetRelativeHumidity)
- Target relative humidity range definitions **(optional)**
- `minTargetHumidityValue` default value: 0
- `maxTargetHumidityValue` default value: 100
- `minTargetHumidityStep` default value: 1
- Current State:
- `get_CurrentHeatingCoolingState`: **(optional)** **(push support)** 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)
- `mapGetCurrentHeatingCoolingState`: **(optional)** 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`.
- Target State:
- `get_TargetHeatingCoolingState`: **(optional)** **(push support)** 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
- `mapGetTargetHeatingCoolingState`: **(optional)** 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`.
- `set_TargetHeatingCoolingState`: **(optional)** **(control support)** 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, writes changes are ignored. S7 type `Byte` e.g. `9` for `DB4DBB9`.
- `0`: off
- `1`: heat
- `2`: cool
- `3`: automatic
- `mapSetTargetHeatingCoolingState`: **(optional)** 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.
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_HumidifierDehumidifier'></a>Humidifier/Dehumidifier as `PLC_HumidifierDehumidifier`
Humidifier and/or Dehumidifier.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_CurrentRelativeHumidity`: **(push support)** offset to get current humidity S7 type `Real` e.g. `55` for `DB4DBD55`
- `get_Active`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_Active`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_Active)
- Separate Bits for on/off:
- `set_Active_Set`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Active_Reset`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
- Current State:
- `get_CurrentHumidifierDehumidifierState`: **(optional)** **(push support)** 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`: **(optional)** 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`.
- Target State:
- `default_TargetHumidifierDehumidifierState`: **(optional)** 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`: **(optional)** **(push support)** 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`: **(optional)** **(control support)** 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`: **(optional)** 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`: **(optional)** 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.
- Rotation Speed:
- Byte:
- `get_RotationSpeedByte`: **(optional)** **(push support)** offset to get rotation speed state S7 type `Byte` e.g. `8` for `DB4DBB8`.
- `set_RotationSpeedByte`: **(optional but required when `get_RotationSpeedByte` is defined)** **(push support)** offset to get set speed state. S7 type `Byte` e.g. `9` for `DB4DBB9`.
- Real:
- `get_RotationSpeed`: **(optional)** **(push support)** offset to get rotation speed state S7 type `Real` e.g. `8` for `DB4DBB8`.
- `set_RotationSpeed`: **(optional but required when `get_RotationSpeed` is defined)** **(push support)** offset to get set speed state. S7 type `Real` e.g. `9` for `DB4DBB9`.
- Swing Mode:
- `get_SwingMode`: **(optional)** **(push support)** offset to get swing mode. S7 type `Byte` e.g. `8` for `DB4DBB8`.
- `0`: swing disabled
- `1`: swing enabled
- `set_SwingMode`: **(optional)** **(control support)** offset to set swing mode. S7 type `Byte` e.g. `9` for `DB4DBB9`.
- `0`: swing disabled
- `1`: swing enabled
- Water Level:
- `get_WaterLevel`: **(optional)** **(push support)** offset to water level S7 type `Real` e.g. `8` for `DB4DBD8`.
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_Window'></a>Shutters as `PLC_WindowCovering`, windows as `PLC_Window`, and doors as `PLC_Door`
Motor-driven blinds, windows, and doors. Supports also manually driven blinds, windows, and doors to show just the current position in percent. **Note:** If your sensor shows only open/close, you may also have a look at [`PLC_ContactSensor`](#PLC_ContactSensor).
  
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `adaptivePolling`: **(optional)** 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. This allows showing the shutter as opening... or closing... in the home app during movement.
- `adaptivePollingInterval`: **(optional)** poll interval in seconds during high-frequency polling. Default value is `1` second.
- `forceCurrentPosition`: **(optional)** when set to `true`, the position set by `set_TargetPosition` is directly used as the current position. By this, it seems in the home app as the target position was directly reached. This is recommended when not using `adaptivePolling` or pushing the value from the PLC.
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current position:
- `get_CurrentPosition`: **(push support)** 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`: **(optional)** set to `true` to invert the values of current and target position from `0:closed 100:open` to `100:closed 0:open`
- `mapGetCurrentPosition`: **(optional)** 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.
- Target position:
- If one of the **(optional)** target position settings is specified, all are needed. If not specified, it is not movable and sticks to the current position.
- `get_TargetPosition`: **(optional)** **(push support)** 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`: **(optional)** **(control support)** offset to set current 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`: **(optional)** **(push support)** 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`: **(optional)** **(control support)** offset and bit to set to 1 to stop movement. (Seems not to be used by HomeApp) When not defined, writes will be ignored. S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
### <a name='PLC_OccupancySensor'></a>Occupancy Sensor as `PLC_OccupancySensor`
Presence detection sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `invertOccupancy`: **(optional)** set to `true` to invert the bit to `false:presence` and `true:no-presence`.
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_OccupancyDetected`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- `false`: no occupancy
- `true`: occupancy detected
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_MotionSensor'></a>Motion Sensor as `PLC_MotionSensor`
Movement detection sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `invertMotionDetected`: **(optional)** set to `true` to invert the bit to `false:motion` and `true:no-motion`.
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_MotionDetected`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- `false`: no motion
- `true`: motion detected
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_ContactSensor'></a>Contact Sensor as `PLC_ContactSensor`
Generic contact sensor. The home app allows displaying as window, door, blind/shutter, garage door, or contact sensor.
    
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `invertContactSensorState`: **(optional)** set to `true` to invert the bit to `false:closed` and `true:open`.
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_ContactSensorState`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- `false`: closed
- `true`: open
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_LeakSensor'></a>Leak Sensor as `PLC_LeakSensor`
Leak sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `invertLeakDetected`: **(optional)** set to `true` to invert the bit to `false:leak detected` and `true:no leak detected`.
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_LeakDetected`: **(push support)** 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
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_Faucet'></a>Faucet as `PLC_Faucet`
Watering for the garden.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_Active`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_Active`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_Active)
- Separate Bits for on/off:
- `set_Active`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Deactivate`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
### <a name='PLC_Valve'></a>Valve as `PLC_Valve`
Valve configurable as generic valve, irrigation, shower head, or water faucet.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `ValveType`: configures the valve type that is returned
- `0`: generic valve
- `1`: irrigation
- `2`: shower head
- `3`: water faucet
- `get_Active`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_Active`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_Active)
- Separate Bits for on/off:
- `set_Active`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Deactivate`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
- If one of the **(optional)** duration settings is specified, all are needed:
- `get_SetDuration`: **(optional)** **(push support)** offset to get duration 0..3600 sec S7 type `Time` e.g. `10` for `DB4DBD10`
- `set_SetDuration`: **(optional)** **(control support)** offset to set duration 0..3600 sec S7 type `Time` e.g. `14` for `DB4DBD14`
- `get_RemainingDuration`: **(optional)** **(push support)** offset to get remaining duration 0..3600 sec S7 type `Time` e.g. `18` for `DB4DBD18`
### <a name='PLC_SecuritySystem'></a>Security System as `PLC_SecuritySystem`
Alarm system.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state of the security system will be polled.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current State:
- `get_SecuritySystemCurrentState`: **(push support)** 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
- `mapGetSecuritySystemCurrentState`: **(optional)** 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`.
- Target State:
- `set_SecuritySystemTargetState`: **(control support)** offset to set target security system state S7 type `Byte` e.g. `5` for `DB4DBB4`
- `get_SecuritySystemTargetState`: **(push support)** 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
- `mapSetSecuritySystemTargetState`: **(optional)** 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`: **(optional)** 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`.
### <a name='PLC_StatelessProgrammableSwitch'></a>Button as `PLC_StatelessProgrammableSwitch`, Doorbell as `PLC_Doorbell`
Stateless switch from PLC to home app.
Trigger actions in the home app only works with control center e.g. AppleTV or HomePod. [**Polling**](#poll) or [**push**](#push) from PLC required!\
[**Polling mode**](#poll) homebridge-plc polls `isEvent`. The PLC sets the bit to `true`. homebridge-plc reads `get_ProgrammableSwitchEvent` and sets the `isEvent` bit to `false`.\
[**Push mode**](#push) PLC informs homebridge-plc by HTTP request with the value for `get_ProgrammableSwitchEvent`.\
[**Control**](#control) External simulates event by HTTP request with the value for `get_ProgrammableSwitchEvent`.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `isEvent`: offset and bit that is polled by homebridge-plc. **PLC has to set to `true`.** When `true`, the event is read from `get_ProgrammableSwitchEvent` and 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`: **(push support)** **(control support)** offset to read current event of the switch. This is reported towards the home app S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: single press
- `1`: double press
- `2`: long press
### <a name='PLC_LockMechanism'></a>Lock mechanism as `PLC_LockMechanism`
Lock mechanism.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `forceCurrentLockState`: **(optional)** when set to `true`, the position set by `set_LockTargetState` is directly used as the current state. By this, it seems in the home app as the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC.
- `get_LockCurrentState`: **(push support)** offset to read current state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: unsecured
- `1`: secured
- `2`: jammed
- `3`: unknown
- `get_LockTargetState`: **(push support)** offset to read target state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: unsecured
- `1`: secured
- `set_LockTargetState`: **(control support)** offset to write target state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: unsecured
- `1`: secured
### <a name='PLC_LockMechanismBool'></a>Boolean lock mechanism as `PLC_LockMechanismBool`
Lock mechanism implemented as bool on the PLC.
**NOTE: The convention `0`=`false`: closed/secured `1`=`true`: open/unsecured**
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `forceCurrentLockState`: **(optional)** when set to `true`, the state set by `set_LockTargetState` is directly used as the current state. By this, it seems in the home app as the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC.
- `invertLockState`: **(optional)** when set to `true`, all states are inverted (current and target state) `false`: **unsecured** and `true`: **secured**.
- `get_LockCurrentStateBool`: **(push support)** offset to read current state S7 type `Bool` e.g. `3.1` for `DB4DBB3`
- `false`: secured
- `true`: unsecured
- `get_LockTargetStateBool`: **(push support)** offset to read target state S7 type `Bool` e.g. `3.1` for `DB4DBB3`
- `false`: secured
- `true`: unsecured
- Single Bit for secure/unsecured:
- `set_LockTargetStateBool`: **(control support)** offset to write target state S7 type `Bool` e.g. `3.1` for `DB4DBB3`
- `false`: secured
- `true`: unsecured
- Separate Bits for secure/unsecured:
- `set_LockTargetStateBool_Secured`: **(control support)** offset and bit to set to `true` when switching to target state secured S7 type `Bool` **PLC has to set to `false`** e.g. `3.3` for `DB4DBX55.1`
- `set_LockTargetStateBool_Unsecured`: offset and bit to set to `true` when switching to target state unsecured S7 type `Bool` **PLC has to set to `false`** e.g. `3.4` for `DB4DBX55.2`
### <a name='PLC_GarageDoorOpener'></a>Garage door as `PLC_GarageDoorOpener`
Garage door.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `forceCurrentDoorState`: **(optional)** when set to `true`, the position set by `set_TargetDoorState` is directly used as the current state. By this, it seems in the home app as the target state was directly reached. This is recommended when not using `enablePolling` or pushing the value from the PLC.
- `get_ObstructionDetected`: **(optional)** **(push support)** offset and bit for obstruction detection. True means that the door was blocked. S7 type `Bool` e.g. `55.1` for `DB4DBX55.1`
- `get_CurrentDoorState`: **(push support)** offset to read current state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: open
- `1`: closed
- `2`: opening
- `3`: closing
- `4`: stopped
- `get_TargetDoorState`: **(push support)** offset to read target state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: open
- `1`: closed
- `set_TargetDoorState`: **(control support)** offset to write target state S7 type `Byte` e.g. `3` for `DB4DBB3`
- `0`: open
- `1`: closed
### <a name='PLC_SmokeSensor'></a>Smoke Sensor as `PLC_SmokeSensor`
Fire alarm.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- `get_SmokeDetected`: **(push support)** offset and bit for smoke detection. S7 type `Bool` e.g. `55.1` for `DB4DBX55.1`
- `false`: ok
- `true`: smoke detected
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit for tamper detection S7 type `Bool` (e.g., `55.2` for `DB4DBX55.2`) (Home app shows this only within the options)
- `false`: ok
- `true`: tampered
- `get_StatusLowBattery`: **(optional)** **(push support)** offset and bit for battery low detection S7 type `Bool` (e.g., `55.3` for `DB4DBX55.3`) (Home app does not inform with push notification)
- `false`: ok
- `true`: battery low
### <a name='PLC_Fan'></a>Fan as `PLC_Fan`
Ventilator.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- Current State:
- `default_CurrentFanState`: **(optional)** defines an alternative value that's returned when `get_CurrentFanState` is not defined. Default value `0:inactive`
- `get_CurrentFanState`: **(optional)** **(push support)** offset to get current heating/cooling state S7 type `Byte` e.g. `8` for `DB4DBB8`.
- `0`: inactive
- `1`: idle
- `2`: blowing
- `mapCurrentFanStateGet`: **(optional)** 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`.
- Target State:
- `default_TargetFanState`: **(optional)** defines an alternative value that's returned when `get_TargetFanState` is not defined. Default value `0:manual`
- `0`: manual
- `1`: automatic
- `get_TargetFanState`: **(optional)** **(push support)** 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
- `set_TargetFanState`: **(optional but required when `get_TargetFanState` is defined)** **(control support)** 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`: **(optional)** define mapping array for `get_TargetFanState`. The PLC value is used as an index into the table. e.g. `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0:automatic` and `1:manual`.
- `mapTargetFanStateSet`: **(optional)** define mapping array for `set_TargetFanState`. The home app value is used as an index into the table. e.g. `[1, 0]` which maps the PLC value `0->1 1->0` when the PLC supports only two states with `0:automatic` and `1:manual`.
- Rotation Direction:
- `get_RotationDirection`: **(optional)** **(push support)** offset to get rotation direction state. S7 type `Byte` e.g. `9` for `DB4DBB9`. When not defined, fixed `0`: clockwise is used.
- `0`: clockwise
- `1`: counterclockwise
- `set_RotationDirection`: **(optional)** **(control support)** offset to set rotation direction state. S7 type `Byte` e.g. `9` for `DB4DBB9`.
- `0`: clockwise
- `1`: counterclockwise
- `mapRotationDirectionGet`: **(optional)** define mapping array for `get_RotationDirection`. The PLC value is used as an index into the table. e.g. `[1, 0]` inverts the direction.
- `mapRotationDirectionSet`: **(optional)** define mapping array for `set_RotationDirection`. The home app value is used as an index into the table. e.g. `[1, 0]` inverts the direction.
- Rotation Speed:
- Byte:
- `get_RotationSpeedByte`: **(optional)** **(push support)** offset to get rotation speed state S7 type `Byte` e.g. `8` for `DB4DBB8`.
- `set_RotationSpeedByte`: **(optional but required when `get_RotationSpeedByte` is defined)** **(push support)** offset to get set speed state. S7 type `Byte` e.g. `9` for `DB4DBB9`.
- Real:
- `get_RotationSpeed`: **(optional)** **(push support)** offset to get rotation speed state S7 type `Real` e.g. `8` for `DB4DBB8`.
- `set_RotationSpeed`: **(optional but required when `get_RotationSpeed` is defined)** **(push support)** offset to get set speed state. S7 type `Real` e.g. `9` for `DB4DBB9`.
- `get_Active`: **(push support)** offset and bit to get the current status S7 type `Bool` e.g. `55.0` for `DB4DBX55.0`
- Single Bit for on/off:
- `set_Active`: **(control support)** offset and bit to set on/off S7 type `Bool` e.g. `55.0` for `DB4DBX55.0` (could be the same as get_Active)
- Separate Bits for on/off:
- `set_Active_Set`: **(control support)** offset and bit to set on S7 type `Bool` **PLC has to set to 0** e.g. `55.1` for `DB4DBX55.1`
- `set_Active_Reset`: offset and bit to set off S7 type `Bool` **PLC has to set to 0** e.g. `55.2` for `DB4DBX55.2`
### <a name='PLC_LightSensor'></a>Light Sensor as `PLC_LightSensor` or `PLC_LightSensor_DInt`
Illuminance sensor.
- `name`: unique name of the accessory
- `manufacturer`: **(optional)** description
- `db`: S7 data base number e.g. `4` for `DB4`
- `enablePolling`: **(optional)** when set to `true`, the current state will be polled. It is mandatory to enable polling mode on the platform level.
- `pollInterval`: **(optional)** poll interval in seconds. Default value is defined in the platform definition.
- AmbientLightLevel:
- DInt:
- `get_CurrentAmbientLightLevelDInt`: **(push support)** offset to get current illumination in LUX S7 type `DInt` value limited to 0.0001 ~ 100,000 e.g. `55` for `DB4DBD55`
- Real:
- `get_CurrentAmbientLightLevel`: **(push support)** offset to get current illumination in LUX S7 type `Real` value