Skip to content

Commit

Permalink
document script profile
Browse files Browse the repository at this point in the history
openhab/openhab-core#3135

Signed-off-by: Cody Cutrer <cody@cutrer.us>
  • Loading branch information
ccutrer committed Oct 26, 2022
1 parent ecb1157 commit ab5c393
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions configuration/items.md
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,7 @@ You can find the documentation of these Profiles within the [Add-On documentatio
| `hysteresis` | State | Switch | The `hysteresis` Profile can be configured via three parameters: `lower` (**mandatory**) `QuantityType` or `DecimalType`, `upper` (optional) `QuantityType` or `DecimalType`, `inverted` (optional) `boolean`. This Profile can be used to trigger alarms when number values exceed a given `lower` bound - sends `ON` to the Switch Item. By defining an additional `upper` bound it can provide kind of anti-flapping. The `inverted` parameter negates the resulting State of the Switch. |
| `offset` | State | Number | An offset can be specified via the parameter `offset` which has to be a `QuantityType` or `DecimalType`. The specified offset will be applied to the value from the device before it arrives at the Item. |
| `range` | State | Switch | The `range` Profile can be used to trigger alarms when number values exceed given limits (`lower` and `upper` bounds). It sends ON to a Switch Item. There are three parameters: `lower` and `upper` (**mandatory**) `QuantityType` or `DecimalType` and `inverted` (optional) `boolean`. |
| `script` | State | All | The `script` Profile can be used to implement custom logic for profiles in user-provided scripts. Each parameter is the ID of a script to be called for that particular callback. The script will be called with `callback` and `command` or `state` variables set. If your script returns `true` the default action will still be taken. Parameters are `onCommandFromItem`, `onStateUpdateFromHandler`, `onCommandFromHandler`, and `onStateUpdateFromItem`. |
| `timestamp-change` | State | DateTime | This Profile will update a DateTime Item to track every change of the state of a given Channel. |
| `timestamp-offset` | State | DateTime | This Profile can be specified via the parameter `offset` (in seconds) which has to be a `DecimalType`. The specified offset will be applied to the date time before it is passed to the Item. Additionally it allows to modify the timezone by setting the parameter of the same name (e.g. "Europe / Berlin"). |
| `timestamp-update` | State | DateTime | This Profile will update a DateTime Item to track every update of the state of a given Channel, whatever the state is. |
Expand Down

0 comments on commit ab5c393

Please sign in to comment.