From 337003c76e3d3f44bc1a395daa882d1ce82e8687 Mon Sep 17 00:00:00 2001 From: Jerome Luckenbach Date: Sat, 26 Nov 2022 14:53:04 +0100 Subject: [PATCH] Mention refresh command and update Tables. (#1922) Signed-off-by: Jerome Luckenbach Signed-off-by: Jerome Luckenbach --- concepts/items.md | 32 +++++++++++++++++--------------- configuration/items.md | 30 ++++++++++++++++-------------- 2 files changed, 33 insertions(+), 29 deletions(-) diff --git a/concepts/items.md b/concepts/items.md index de879e80a..66d296058 100644 --- a/concepts/items.md +++ b/concepts/items.md @@ -12,21 +12,22 @@ Items have a state and are used through events. The following Item types are currently available (alphabetical order): -| Item Name | Description | Command Types | -|--------------------|--------------------------------------------------------------------|--------------------------------------------| -| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB | -| Contact | Item storing status of e.g. door/window contacts | OpenClosed | -| DateTime | Stores date and time | - | -| Dimmer | Item carrying a percentage value for dimmers | OnOff, IncreaseDecrease, Percent | -| Group | Item to nest other Items / collect them in Groups | - | -| Image | Holds the binary data of an image | - | -| Location | Stores GPS coordinates | Point | -| Number | Stores values in number format, takes an optional dimension suffix | Decimal | -| Number: | like Number, additional dimension information for unit support | Quantity | -| Player | Allows to control players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward | -| Rollershutter | Typically used for blinds | UpDown, StopMove, Percent | -| String | Stores texts | String | -| Switch | Typically used for lights (on/off) | OnOff | +| Item Name | Description | Command Types | +|--------------------|--------------------------------------------------------------------|-----------------------------------------------------| +| Call | Identify phone calls | Refresh | +| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB, Refresh | +| Contact | Item storing status of e.g. door/window contacts | OpenClosed, Refresh | +| DateTime | Stores date and time | DateTime | +| Dimmer | Item carrying a percentage value for dimmers | OnOff, IncreaseDecrease, Percent, Refresh | +| Group | Item to nest other Items / collect them in Groups | - | +| Image | Holds the binary data of an image | Refresh | +| Location | Stores GPS coordinates | Point, Refresh | +| Number | Stores values in number format, takes an optional dimension suffix | Decimal, Refresh | +| Number: | like Number, additional dimension information for unit support | Quantity, Refresh | +| Player | Allows to control players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward, Refresh | +| Rollershutter | Typically used for blinds | UpDown, StopMove, Percent, Refresh | +| String | Stores texts | String, Refresh | +| Switch | Typically used for lights (on/off) | OnOff, Refresh | ## Group Items @@ -103,6 +104,7 @@ HSB string values consist of three comma-separated values for hue (0-360°), sat | OpenClosedType | `OPEN`, `CLOSED` | | PlayPauseType | `PLAY`, `PAUSE` | | RewindFastforwardType | `REWIND`, `FASTFORWARD` | +| RefreshType | `REFRESH` | | StopMoveType | `STOP`, `MOVE` | | UpDownType | `UP`, `DOWN` | diff --git a/configuration/items.md b/configuration/items.md index 6a2de1917..07390fac3 100644 --- a/configuration/items.md +++ b/configuration/items.md @@ -91,20 +91,22 @@ This optimization is reflected in the data and command types. Available Item types are: -| Type Name | Description | Command Types | -|---------------|-----------------------------------------------------------------------------------------------|--------------------------------------------| -| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB | -| Contact | Status of contacts, e.g. door/window contacts. Does not accept commands, only status updates. | OpenClosed | -| DateTime | Stores date and time | - | -| Dimmer | Percentage value for dimmers | OnOff, IncreaseDecrease, Percent | -| Group | Item to nest other items / collect them in groups | - | -| Image | Binary data of an image | - | -| Location | GPS coordinates | Point | -| Number | Values in number format | Decimal | -| Player | Allows control of players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward | -| Rollershutter | Roller shutter Item, typically used for blinds | UpDown, StopMove, Percent | -| String | Stores texts | String | -| Switch | Switch Item, used for anything that needs to be switched ON and OFF | OnOff | +| Item Name | Description | Command Types | +|--------------------|--------------------------------------------------------------------|-----------------------------------------------------| +| Call | Identify phone calls | Refresh | +| Color | Color information (RGB) | OnOff, IncreaseDecrease, Percent, HSB, Refresh | +| Contact | Item storing status of e.g. door/window contacts | OpenClosed, Refresh | +| DateTime | Stores date and time | DateTime | +| Dimmer | Item carrying a percentage value for dimmers | OnOff, IncreaseDecrease, Percent, Refresh | +| Group | Item to nest other Items / collect them in Groups | - | +| Image | Holds the binary data of an image | Refresh | +| Location | Stores GPS coordinates | Point, Refresh | +| Number | Stores values in number format, takes an optional dimension suffix | Decimal, Refresh | +| Number: | like Number, additional dimension information for unit support | Quantity, Refresh | +| Player | Allows to control players (e.g. audio players) | PlayPause, NextPrevious, RewindFastforward, Refresh | +| Rollershutter | Typically used for blinds | UpDown, StopMove, Percent, Refresh | +| String | Stores texts | String, Refresh | +| Switch | Typically used for lights (on/off) | OnOff, Refresh | More details about all of the available Item types and their commands are available under Concepts, see: [Item Types Overview]({{base}}/concepts/items.html)