gru/gree-controller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

v0.8.2

Browse Source
This commit is contained in:
Mateusz Gruszczyński
2026-09-01 12:07:04 +02:00
parent 6207bc4de6
commit e496f911da
25 changed files with 227 additions and 309 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+10 -10
View File
@@ -1,6 +1,6 @@
# GREE Controller API reference
HTTP and WebSocket API for GREE Controller **0.8.22**.
HTTP and WebSocket API for GREE Controller **0.8.24**.
[← Main documentation](../README.md)
@@ -137,7 +137,7 @@ Common statuses:
| GET | `/api/groups/{id}` | Read a group. |
| PUT | `/api/groups/{id}` | Replace group definition. |
| DELETE | `/api/groups/{id}` | Delete a group. |
| POST | `/api/groups/{id}/control` | Group power/mode/preset/custom-temperature control. |
| POST | `/api/groups/{id}/control` | Group control enable/mode/preset/custom-temperature control. |
| POST | `/api/house/control` | Set global thermostat mode. |
| POST | `/api/house/power` | Set whole-house master power. |
| POST | `/api/house/preset` | Set/clear whole-house preset override. |
@@ -212,7 +212,7 @@ Response:
{
"status": "ok",
"name": "gree-controller",
"version": "0.8.22",
"version": "0.8.24",
"uptime_seconds": 1234,
"control_ready": true,
"time": "2026-08-30T06:54:00Z"
@@ -236,7 +236,7 @@ Returns the initial Web UI snapshot:
"settings": {},
"outdoor_temperature": null,
"system": {
"version": "0.8.22",
"version": "0.8.24",
"uptime_seconds": 1234,
"auth_required": false,
"control_ready": true,
@@ -517,7 +517,7 @@ Semantics:
- `preset`: `auto`, `comfort`, `sleep`, `away`, `custom`; `auto` clears the profile override.
- `mode`: `house`, `cool`, `heat`; `house` restores global mode inheritance.
- `enabled`: zone automation enable state.
- `power:true`: local Quick Thermostat ownership — this zone can run through full thermostat logic even if its climate group is off.
- `power:true`: local Quick Thermostat ownership — this zone can run through full thermostat logic regardless of whether group-level control is enabled for its climate group.
- `power:false`: turns this zone off and creates a fresh backend-owned local hand-back timer (currently 15 minutes).
- `clear_local_thermostat_override:true`: immediately return local Quick Thermostat ownership to normal group/schedule control.
- `clear_device_manual_override:true`: explicitly hand a physical/direct manual takeover back to the thermostat.
@@ -662,14 +662,14 @@ Read, replace or delete a group. `DELETE` returns `204`.
All fields optional:
- `power`: group gate,
- `power`: enable/disable group-level control (legacy field name; this is not a device power gate),
- `mode`: `house`, `cool`, `heat`,
- `preset`: `auto`, `comfort`, `sleep`, `away`, `custom`,
- `setpoint`: custom group target in the `8–30°C` range; requires `preset: "custom"`.
A custom setpoint creates the same temporary manual override for every member zone and normally expires at that zone's next schedule boundary. Returns a group control/result object including updated members/state.
Group power is a per-group gate. Whole-house `power=false` closes all group gates. If one group is later switched back on, only that group is reopened; other groups remain off and their own member zones stay disabled. A zone is never blocked merely because a different, unrelated group is on. If a zone belongs to multiple groups, any disabled membership remains authoritative.
Group `power` is a scoped bulk-power/control action. `power=false` immediately powers member units off and releases `group:*` ownership; members are stored as individually-off thermostats rather than being blocked by membership in an OFF group, so a user can turn a thermostat back on independently. `power=true` clears that scoped thermostat-OFF state and immediately re-runs group thermostat arbitration. Explicit Web/Home Assistant group power actions take over older member manual/temporary ownership; scheduled group automations still respect higher-priority manual/local ownership. Group mode/preset/setpoint changes are accepted only while the group is ON. Whole-house power remains independent and authoritative.
---
@@ -687,7 +687,7 @@ House thermostat mode and master power are intentionally separate.
Valid modes: `cool`, `heat`, `off`.
- `cool`/`heat` are explicit whole-house activation requests: master power is enabled, group gates are enabled and the thermostat arbiter starts eligible managed zones.
- `cool`/`heat` are explicit whole-house activation requests: master power is enabled and the thermostat arbiter starts eligible managed zones. Existing per-group control enable/disable settings are preserved.
- `off` means **do not perform house-level thermostat control** for inherited zones. It does not itself change master power and does not forcibly power direct/manual devices down.
Returns public runtime settings.
@@ -700,7 +700,7 @@ Returns public runtime settings.
}
```
`false` is authoritative: it disables group gates, clears local/manual ownership markers as required and powers every enabled physical device down. `true` resumes thermostat arbitration rather than blindly sending a bare ON frame.
`false` is authoritative: it clears local/manual ownership markers as required and powers every enabled physical device down. It does **not** modify per-group control enable/disable settings. `true` resumes thermostat arbitration rather than blindly sending a bare ON frame.
Response includes:
@@ -724,7 +724,7 @@ Response includes:
Valid: `auto`, `comfort`, `sleep`, `away`.
A non-`auto` preset creates zone overrides that normally expire at each zone's next schedule boundary. `auto` clears them. Selecting a house preset also explicitly re-enables master power/group gates.
A non-`auto` preset creates zone overrides that normally expire at each zone's next schedule boundary. `auto` clears them. Selecting a house preset explicitly re-enables master power while preserving each group's control enable/disable setting.
---