Skip to content

Commit d719a83

Browse files
committed
docs: document all Shortcuts actions including Toggle, Player, DateTime, Location and Set Active Home
Signed-off-by: Tim Mueller-Seydlitz <timbms@gmail.com>
1 parent 2037302 commit d719a83

1 file changed

Lines changed: 23 additions & 7 deletions

File tree

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -257,17 +257,20 @@ Also see [Action Syntax](#action-syntax) for more information on actions that ca
257257

258258
## Shortcuts
259259

260-
The app supports exposes several actions that let you control your openHAB installation from the Shortcuts app.
260+
The app exposes several actions that let you control your openHAB installation from the Shortcuts app.
261+
262+
All actions accept an optional **Home** parameter. When omitted the active home is used; when set it overrides the home for that step, which is useful in multi-home shortcuts.
261263

262264
**Supported actions**
263265

264266
- **Get Item State** – Retrieves the current state of any item.
265267
- Returns the item’s state text so it can be used by later steps in a shortcut.
266268

267-
- **Set Switch State** – Sends an `ON` or `OFF` command to a Switch item.
268-
- Action – `ON` / `OFF`
269+
- **Set Switch State** – Sends a command to a Switch item.
270+
- Action – `On` / `Off` / `Toggle`
271+
- `Toggle` flips the current state without needing to know it in advance.
269272

270-
- **Set Dimmer or Roller Shutter Value** – Sends an integer value (0-100) to Dimmer or Rollershutter items.
273+
- **Set Dimmer or Roller Shutter Value** – Sends an integer value (0100) to Dimmer or Rollershutter items.
271274
- Value – 0 … 100
272275

273276
- **Set Number Item Value** – Writes a decimal value to any Number item.
@@ -277,10 +280,23 @@ The app supports exposes several actions that let you control your openHAB insta
277280
- Value – text
278281

279282
- **Set Color Item Value** – Sends a color command in HSB format `Hue,Saturation,Brightness` (e.g. `240,100,100` for blue) to a Color item.
280-
- Value – HSB string
283+
- Value – HSB string (hue 0–360, saturation 0–100, brightness 0–100)
284+
285+
- **Set Contact Item State** – Sets a Contact item to `Open` or `Closed` (contacts are typically read-only however).
286+
- State – `Open` / `Closed`
287+
288+
- **Set Player Control Value** – Sends a transport command to a Player item.
289+
- Action – `Play` / `Pause` / `Next` / `Previous` / `Rewind` / `Fast Forward`
290+
291+
- **Set DateTime Control Value** – Sets the date and time of a DateTime item using the system date/time picker.
292+
- Value – date and time
293+
294+
- **Set Location Control Value** – Sends a GPS coordinate to a Location item.
295+
- Latitude – decimal degrees (−90 … 90)
296+
- Longitude – decimal degrees (−180 … 180)
281297

282-
- **Set Contact Item State**Sets a Contact item to `OPEN` or `CLOSED` (contacts are typically read-only however).
283-
- State`OPEN` / `CLOSED`
298+
- **Set Active Home**Switches the active home in the app, equivalent to selecting a home from the side menu.
299+
- Homehome name
284300

285301
## Setting up development environment
286302

0 commit comments

Comments
 (0)