This commit is contained in:
Mateusz Gruszczyński
2026-09-02 09:02:56 +02:00
parent 9c6e51fc35
commit 43441d2fb7
16 changed files with 555 additions and 60 deletions
+29 -4
View File
@@ -1,6 +1,6 @@
# GREE Controller API reference
HTTP and WebSocket API for GREE Controller **0.9.9**.
HTTP and WebSocket API for GREE Controller **0.9.11**.
[← Main documentation](../README.md)
@@ -179,6 +179,7 @@ Common statuses:
| GET | `/api/debug` | Read debug overlay settings. |
| PUT | `/api/debug` | Update debug overlay settings. |
| POST | `/api/integrations/home-assistant/test` | Test HA temperature read. |
| POST | `/api/integrations/home-assistant/entity` | Read raw HA entity state/attributes for shared Flow input diagnostics. |
| POST | `/api/integrations/notifications/test` | Send a test notification. |
### Access tokens and restricted Home Assistant API
@@ -212,7 +213,7 @@ Response:
{
"status": "ok",
"name": "gree-controller",
"version": "0.9.9",
"version": "0.9.11",
"uptime_seconds": 1234,
"control_ready": true,
"time": "2026-08-30T06:54:00Z"
@@ -236,7 +237,7 @@ Returns the initial Web UI snapshot:
"settings": {},
"outdoor_temperature": null,
"system": {
"version": "0.9.9",
"version": "0.9.11",
"uptime_seconds": 1234,
"auth_required": false,
"control_ready": true,
@@ -1201,6 +1202,30 @@ The Web UI can display **All**, **Requests** or **GREE** subsets.
}
```
### `POST /api/integrations/home-assistant/entity`
Reads the current raw Home Assistant entity document used by the shared-Flow-input diagnostics UI.
```json
{
"entity_id": "climate.gas_boiler"
}
```
Response includes the raw state, availability, attributes and timestamps:
```json
{
"ok": true,
"entity_id": "climate.gas_boiler",
"state": "heat",
"available": true,
"attributes": { "hvac_action": "heating" },
"last_changed": "2026-09-02T06:30:00Z",
"last_updated": "2026-09-02T06:30:05Z"
}
```
### `POST /api/integrations/notifications/test`
Accepts a `NotificationSettings` object. Blank secret/webhook fields reuse saved secrets for the test.
@@ -1512,4 +1537,4 @@ Cancellation suppresses the same pending intent until a new explicit thermostat/
Existing Flow updates require `expected_revision`. A mismatched revision returns HTTP 409 to prevent stale editor tabs from overwriting newer graphs. Source Flow plus generated outputs are replaced atomically in one database transaction while configuration/automation/schedule/thermostat-cycle operations are serialized.
Additional Flow condition blocks are `house_mode`, `device_state`, `zone_state`, `group_state`, `night_mode`, `ha_attribute`, `ha_available`, `constant` and `shared_input`, alongside weekday/time/date, temperature, Home Assistant state/numeric and AND/OR/NOT blocks. `device_state` can inspect enabled/online/power/mode/fan/swing/quiet/turbo/light/air/xfan/health/sleep state. The editor ships 37 categorized editable templates covering comfort, energy, safety, night, reliability, Home Assistant heat-source coordination and advanced multi-branch logic.
Additional Flow condition blocks are `house_mode`, `device_state`, `zone_state`, `group_state`, `night_mode`, `ha_attribute`, `ha_available`, `constant` and `shared_input`, alongside weekday/time/date, temperature, Home Assistant state/numeric and AND/OR/NOT blocks. `device_state` can inspect enabled/online/power/mode/fan/swing/quiet/turbo/light/air/xfan/health/sleep state. The editor ships 37 categorized editable templates covering comfort, energy, safety, night, reliability, Home Assistant heat-source coordination and advanced multi-branch logic. The template UI adds search, favorites/recent history, a graph preview and runtime requirement checks; shared inputs expose usage links and HA-backed inputs can be tested against live entity state.