Skip to content

Commit

Permalink
continue working on config.schema.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Feilner committed May 4, 2022
1 parent 70f11c7 commit e50bab1
Show file tree
Hide file tree
Showing 5 changed files with 531 additions and 414 deletions.
31 changes: 27 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# Changelog

## [1.1.0-beta.2] 2022-05-01
## [1.1.0-beta.1] 2022-04-30
## [1.1.0-beta.0] 2022-04-28
### Changed
**Action required** Breaking changes!
In order to support configuration by GUI some configuration options needs to be adapted.
In order to support configuration by GUI some configuration options needs to be renamed.
- `PLC_LightBulb`:
- renamed option `set_On` -> `set_On_
- renamed option `minValue` -> `minBrightnessValue` and changed default value from `20` to `0`
- renamed option `maxValue` -> `maxBrightnessValue`
- renamed option `minStep` -> `minBrightnessStep`
- `PLC_LightBulb`, `PLC_Outlet`, and `PLC_Switch`
- renamed options for separate set and reset bits. (Single bit option `set_On` is still functional)
- renamed option `set_Off` -> `set_On_Reset` and `set_On` -> `set_On_Set`
- `PLC_Fan`, `PLC_HumidifierDehumidifier`, `PLC_Faucet`, `PLC_Valve`
- renamed options for separate set and reset bits. (Single bit option `set_Active` is still functional)
- renamed option `set_Deactivate` -> `set_Active_Reset` and `set_Active` -> `set_Active_Set`
-`PLC_TemperatureSensor`
- renamed option `minValue` -> `minTemperatureValue` and changed default value from `-50` to `-270`
- renamed option `maxValue` -> `maxTemperatureValue` and changed default value from `110` to `100`
Expand All @@ -31,11 +37,17 @@ In order to support configuration by GUI some configuration options needs to be
- renamed option `mapGetCurrent` -> `mapGetSecuritySystemCurrentState`
- renamed option `mapGetTarget` -> `mapGetSecuritySystemTargetState`
- renamed option `mapSetTarget` -> `mapSetSecuritySystemTargetState`
- the obsolete options `mapGet` and `mapSet` are no longer supported
- the obsolete options `mapGet` and `mapSet` are no longer supported use above map functions.
- `PLC_HumidifierDehumidifier`
- renamed option `mapGetCurrent` -> `mapGetCurrentHumidifierDehumidifierState`
- renamed option `mapGetTarget` -> `mapGetTargetHumidifierDehumidifierState`
- renamed option `mapSetTarget` -> `mapSetTargetHumidifierDehumidifierState`
- `PLC_Window`, `PLC_WindowCovering`, `PLC_Door`
- removed option `mapGet`
- added option `mapGetCurrentPosition`
- added option `mapGetTargetPosition`
- added option `mapSetTargetPosition`
- renamed option `invert` -> `invertPosition`
- `PLC_LockMechanismBool`
- renamed option `invert` -> `invertLockState`
- renamed option `get_LockCurrentState` -> `get_LockCurrentStateBool`
Expand All @@ -48,6 +60,17 @@ In order to support configuration by GUI some configuration options needs to be
- renamed option `forceCurrentState` -> `forceCurrentLockState`
- `PLC_GarageDoorOpener`
- renamed option `forceCurrentState` -> `forceCurrentGarageDoorState`
- `PLC_LockMechanismBool`
- renamed option `invert` -> `invertLockState`
- `PLC_OccupancySensor`
- renamed option `invert` -> `invertOccupancy`
- `PLC_MotionSensor`
- renamed option `invert` -> `invertMotionDetected`
- `PLC_LeakSensor`
- renamed option `invert` -> `invertLeakDetected`
- `PLC_ContactSensor`
- renamed option `invert` -> `invertContactSensorState`


- ### Added
- `PLC_Thermostat`
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,8 @@ Humidifier and/or Dehumidifier
- `0`: auto (humidifier or dehumidifier)
- `1`: humidifier
- `2`: dehumidifier
- `mapGetTargetHumidifierDehumidifierState`: **(optional)** define mapping array for `get_TargetHumidifierDehumidifierState`. The PLC value is used as index into the table. e.g. `[0]` which maps the PLC value `0->2 1->3` when the PLC supports only one states with `0:dehumidifier.
- `mapSetTargetHumidifierDehumidifierState`: **(optional)** define mapping array for `set_TargetHumidifierDehumidifierState`. The home app value is used as index into the table. e.g. `[2, 2, 2
- `mapGetTargetHumidifierDehumidifierState`: **(optional)** define mapping array for `get_TargetHumidifierDehumidifierState`. The PLC value is used as index into the table. e.g. `[2,1]` which maps the PLC value `0->1 1->2` when the PLC supports only one states with `0:dehumidifier 1:humidifier.
- `mapSetTargetHumidifierDehumidifierState`: **(optional)** define mapping array for `set_TargetHumidifierDehumidifierState`. The home app value is used as index into the table. e.g. `[2, 2, 2] writes always the value 2 to the plc regardless whats 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`.
Expand All @@ -290,10 +290,14 @@ Humidifier and/or Dehumidifier
- `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 rotation speed state S7 type `Bool` e.g. `8` for `DB4DBB8`.
- `set_SwingMode` **(optional)** **(push support)** offset to get set speed state. S7 type `Bool` e.g. `9` for `DB4DBB9`.
- `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 get rotation speed state S7 type `Real` e.g. `8` for `DB4DBB8`.
- `get_WaterLevel`: **(optional)** **(push support)** offset to get rotation speed state S7 type `Real` e.g. `8` for `DB4DBD8`.
- `get_StatusTampered`: **(optional)** **(push support)** offset and bit to tamper detection. (Home app shows this only within the options) S7 type `Bool` e.g. `55.2` for `DB4DBX55.2`
- `false`: ok
- `true`: tampered
Expand Down
Loading

0 comments on commit e50bab1

Please sign in to comment.