diff --git a/docs/USAGE.md b/docs/USAGE.md index a0f5da68..80429095 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -24,9 +24,14 @@ If you have any issues, questions or an idea for additional features, please tak ## Latest Changes ::: tip State of this document -This documentation refers to release [v3.6.5](https://github.com/openhab/openhab-google-assistant/releases/tag/v3.6.5) of [openHAB Google Assistant](https://github.com/openhab/openhab-google-assistant) published on 2023-07-17 +This documentation refers to release [v3.7.0](https://github.com/openhab/openhab-google-assistant/releases/tag/v3.7.0) of [openHAB Google Assistant](https://github.com/openhab/openhab-google-assistant) published on 2023-10-10 ::: +### v3.7.0 + +- Adjusted [`Fan`](#fan-hood-airpurifier) to use `supportsFanSpeedPercent` option +- Inverted `lightColorTemperature` percentage range when using `colorUnit="percent"` with [`SpecialColorLight`](#light-as-group-with-separate-controls) + ### v3.6.0 - Added new device types [`HumiditySensor`](#humiditysensor) & [`ClimateSensor`](#climatesensor) @@ -94,7 +99,7 @@ Color { ga="Light" [ colorTemperatureRange="2000,9000" ] } | **Device Type** | [Light](https://developers.home.google.com/cloud-to-cloud/guides/light) | | **Supported Traits** | [OnOff](https://developers.home.google.com/cloud-to-cloud/traits/onoff), [ColorSetting](https://developers.home.google.com/cloud-to-cloud/traits/colorsetting), [Brightness](https://developers.home.google.com/cloud-to-cloud/traits/brightness) | | **Supported Items** | Group as `SpecialColorLight` with the following members:
(optional) Number or Dimmer as `lightBrightness`
(optional) Number or Dimmer as `lightColorTemperature`
(optional) Color as `lightColor`
(optional) Switch as `lightPower` | -| **Configuration** | (optional) `colorUnit=percent/kelvin/mired`
(optional) `checkState=true/false`
(optional) `colorTemperatureRange="minK,maxK"`
_Hint: if you want to use `lightColorTemperature`, you must either set `colorUnit` to `kelvin` or `mired` or define a `colorTemperatureRange`, because `colorUnit` defaults to `percent`_ | +| **Configuration** | (optional) `colorUnit="percent/kelvin/mired"`
(optional) `checkState=true/false`
(optional) `colorTemperatureRange="minK,maxK"`
_Hint: if you want to use `lightColorTemperature`, you must either set `colorUnit` to `kelvin` or `mired` or define a `colorTemperatureRange`, because `colorUnit` defaults to `percent`_ | ```shell Group lightGroup { ga="SpecialColorLight" [ colorUnit="kelvin", colorTemperatureRange="2000,9000" ] } @@ -200,7 +205,7 @@ Switch { ga="Lock" [ pinNeeded="1234" ] } | **Device Type** | [SecuritySystem](https://developers.home.google.com/cloud-to-cloud/guides/securitysystem) | | **Supported Traits** | [ArmDisarm](https://developers.home.google.com/cloud-to-cloud/traits/armdisarm) | | **Supported Items** | Switch | -| **Configuration** | (optional) `inverted=true/false`
(optional) `checkState=true/false`
(optional) `ackNeeded=true/false`
(optional) `pinNeeded="1234"`
(optional) `pinOnDisarmOnly=true/false`
(optional) `waitForStateChange=2` | +| **Configuration** | (optional) `inverted=true/false`
(optional) `checkState=true/false`
(optional) `ackNeeded=true/false`
(optional) `pinNeeded="1234"`
(optional) `pinOnDisarmOnly=true/false`
(optional) `waitForStateChange="2"` | When used as a Switch, you will be limited to arming and disarming the system. @@ -219,7 +224,7 @@ Switch houseAlarm "House Alarm" { ga="SecuritySystem", pinNeeded="1234" } | **Device Type** | [SecuritySystem](https://developers.home.google.com/cloud-to-cloud/guides/securitysystem) | | **Supported Traits** | [ArmDisarm](https://developers.home.google.com/cloud-to-cloud/traits/armdisarm)
[StatusReport](https://developers.home.google.com/cloud-to-cloud/traits/statusreport) | | **Supported Items** | Group as `SecuritySystem` with the following members:
Switch as `securitySystemArmed`
(optional) String as `securitySystemArmLevel`
(optional) Switch as `securitySystemTrouble`
(optional) String as `securitySystemTroubleCode`
(optional) Contact as `securitySystemZone` | -| **Configuration** | (optional) `inverted=true/false`
(optional) `checkState=true/false`
(optional) `ackNeeded=true/false`
(optional) `pinNeeded="1234"`
(optional) `pinOnDisarmOnly=true/false`
(optional) `waitForStateChange=2`
(optional) `armLevels="L1=Level 1,L2=Level 2"`

Specifically on Zone Contacts:
(required) `zoneType=OpenClose/Motion`
(optional) `blocking=true/false`| +| **Configuration** | (optional) `inverted=true/false`
(optional) `checkState=true/false`
(optional) `ackNeeded=true/false`
(optional) `pinNeeded="1234"`
(optional) `pinOnDisarmOnly=true/false`
(optional) `waitForStateChange="2"`
(optional) `armLevels="L1=Level 1,L2=Level 2"`

Specifically on Zone Contacts:
(required) `zoneType="OpenClose/Motion"`
(optional) `blocking=true/false`| Configuring the `SecuritySystem` as a Group will enable a lot of advanced functionality. @@ -243,7 +248,7 @@ When arming and not using arm levels or disarming, Google will send ON/OFF to th If arming fails and blocking zones have been configured with `securitySystemZone` and `blocking=true`, Google will attempt to check for zones that are causing the arming to fail. -`ga=securitySystemTrouble` and `ga=securitySystemTroubleCode` are used in a `StatusReport` to report any errors on the alarm, e.g. a flat battery. +`ga="securitySystemTrouble"` and `ga="securitySystemTroubleCode"` are used in a `StatusReport` to report any errors on the alarm, e.g. a flat battery. ```shell Group gHouseAlarm "House Alarm" { ga="SecuritySystem" [ pinNeeded="1234", armLevels="L1=Level 1,L2=Level 2" ] }