Skip to content

Commit 07a538b

Browse files
iMicknlCopilot
andauthored
Document that ExecutionMode is Cloud API only (#2088)
## Summary Documents that `ExecutionMode` is only supported by the **Cloud API**. The local API (Somfy TaHoma Developer Mode) does not accept an execution mode and rejects the request. Added a note in three docs pages and the `execute_action_group` docstring, each linking the upstream issue. ## Changes - `docs/device-control.md` — warning admonition under the execution-modes example - `docs/core-concepts.md` — note under the execution-modes list - `docs/migration-v2.md` — appended caveat to the existing `ExecutionMode` mention - `pyoverkiz/client.py` — `execute_action_group` docstring `mode` arg ## Reference See Somfy-Developer/Somfy-TaHoma-Developer-Mode#227 --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 174617c commit 07a538b

4 files changed

Lines changed: 12 additions & 2 deletions

File tree

docs/core-concepts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ An optional `ExecutionMode` can be passed when executing an action group:
4848
- `GEOLOCATED` — Triggered by geolocation rules.
4949
- `INTERNAL` — Used for internal/system executions.
5050

51+
Execution modes are only supported by the **Cloud API**. The local API (Somfy TaHoma Developer Mode) does not accept an execution mode and will reject the request. See [Somfy-TaHoma-Developer-Mode#227](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode/issues/227).
52+
5153
## UI profiles and classifiers
5254

5355
Each device definition includes **UI profiles** and **UI classifiers** that describe what the device can do at a higher level than raw commands.

docs/device-control.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,12 @@ exec_id = await client.execute_action_group(
254254

255255
Available modes: `HIGH_PRIORITY`, `GEOLOCATED`, `INTERNAL`. When omitted, the default execution mode is used.
256256

257+
!!! warning
258+
Execution modes are only supported by the **Cloud API**. The local API
259+
(Somfy TaHoma Developer Mode) does not accept an execution mode and will
260+
reject the request. See
261+
[Somfy-TaHoma-Developer-Mode#227](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode/issues/227).
262+
257263
## Track and cancel executions
258264

259265
```python

docs/migration-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The command execution API has been consolidated into a single method.
110110
)
111111
```
112112

113-
v2 also supports sending actions to **multiple devices** in a single call and choosing an `ExecutionMode` (`HIGH_PRIORITY`, `GEOLOCATED`, `INTERNAL`).
113+
v2 also supports sending actions to **multiple devices** in a single call and choosing an `ExecutionMode` (`HIGH_PRIORITY`, `GEOLOCATED`, `INTERNAL`). Execution modes are only supported by the Cloud API; the local API rejects them (see [Somfy-TaHoma-Developer-Mode#227](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode/issues/227)).
114114

115115
## Diagnostics
116116

pyoverkiz/client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,9 @@ async def execute_action_group(
609609
actions: One or more actions to execute. Each action targets a
610610
single device and holds one or more commands.
611611
mode: Optional execution mode (``HIGH_PRIORITY``, ``GEOLOCATED``,
612-
or ``INTERNAL``).
612+
or ``INTERNAL``). Only supported by the Cloud API; the local
613+
API rejects requests that specify an execution mode (see
614+
https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode/issues/227).
613615
label: Human-readable label for the execution.
614616
615617
Returns:

0 commit comments

Comments
 (0)