v0.15.18
This commit is contained in:
1 parent
0148daf410
commit
f08613a254
23 files changed
+290
-70
No files matched your search
+7
-5
@@ -1,6 +1,6 @@
|
||||
# GREE Controller API reference
|
||||
|
||||
HTTP and WebSocket API for GREE Controller **0.15.17**.
|
||||
HTTP and WebSocket API for GREE Controller **0.15.18**.
|
||||
|
||||
[← Main documentation](../README.md)
|
||||
|
||||
@@ -243,7 +243,7 @@ Response:
|
||||
{
|
||||
"status": "ok",
|
||||
"name": "gree-controller",
|
||||
"version": "0.15.17",
|
||||
"version": "0.15.18",
|
||||
"uptime_seconds": 1234,
|
||||
"control_ready": true,
|
||||
"time": "2026-08-30T06:54:00Z"
|
||||
@@ -306,7 +306,7 @@ Returns the initial Web UI snapshot:
|
||||
"control_plan": {"generated_at": "2026-09-04T08:00:00Z", "zones": [], "rules": []},
|
||||
"control_plan_revision": 42,
|
||||
"system": {
|
||||
"version": "0.15.17",
|
||||
"version": "0.15.18",
|
||||
"uptime_seconds": 1234,
|
||||
"auth_required": false,
|
||||
"control_ready": true,
|
||||
@@ -955,7 +955,7 @@ Action target is either:
|
||||
- direct device: `action_device_id` + full `DeviceCommand`, or
|
||||
- group: `action_group_id`; group automation supports only power, `house`/`cool`/`heat` mode and optional `action_preset` (`auto|comfort|sleep|away`).
|
||||
|
||||
The response also contains runtime `last_fired_at`, `created_at`, `updated_at`.
|
||||
The response also contains runtime `last_fired_at`, `last_trigger_trace`, `created_at`, `updated_at`. For Flow-generated automations, `last_trigger_trace` is the snapshot of evaluated Flow blocks from the latest execution attempt (`node_id`, `kind`, `matched`, `actual`, `expected`, `config`, `inputs`).
|
||||
|
||||
Routes:
|
||||
|
||||
@@ -1056,7 +1056,7 @@ When InfluxDB is enabled, older history can be read from Influx and merged with
|
||||
|
||||
### `GET /api/control-plan`
|
||||
|
||||
Returns the latest materialized machine-readable thermostat plan. The response shape is unchanged; the bundled Web UI receives plan updates primarily through WebSocket and uses this endpoint for fallback/resynchronization.
|
||||
Returns the latest materialized machine-readable thermostat plan. The bundled Web UI receives plan updates primarily through WebSocket and uses this endpoint for fallback/resynchronization. Flow-generated entries in `rules[]` include `flow_id`, `flow_node_id` and the persisted `last_trigger_trace` snapshot used by Recently triggered automations.
|
||||
|
||||
|
||||
Top-level fields:
|
||||
@@ -1097,6 +1097,8 @@ current_schedule_id, current_schedule_name,
|
||||
next_events[]
|
||||
```
|
||||
|
||||
Each automation rule includes runtime readiness fields. Flow-generated rules also expose `flow_id`, `flow_node_id` and `last_trigger_trace[]`; the trace preserves the evaluated block configuration and observed values from the latest execution attempt.
|
||||
|
||||
This endpoint is the best way for another client to understand **desired vs actual state**, who owns control, and why a zone is blocked/paused.
|
||||
|
||||
---
|
||||
|
||||
+13
-4
@@ -2,7 +2,7 @@
|
||||
"openapi": "3.1.0",
|
||||
"info": {
|
||||
"title": "GREE Controller API",
|
||||
"version": "0.15.17",
|
||||
"version": "0.15.18",
|
||||
"summary": "Local HTTP/WebSocket API for GREE Controller",
|
||||
"description": "Local API used by the GREE Controller Web UI and Home Assistant integration.",
|
||||
"license": {
|
||||
@@ -3120,7 +3120,7 @@
|
||||
"History"
|
||||
],
|
||||
"summary": "Get resolved control plan",
|
||||
"description": "Machine-readable desired-vs-actual thermostat plan with ownership, blocking reasons, schedules, next events and per-zone control decisions. The response shape is unchanged; the bundled Web UI receives plan changes through WebSocket and uses this endpoint as a fallback/resynchronization surface.",
|
||||
"description": "Machine-readable desired-vs-actual thermostat plan with ownership, blocking reasons, schedules, next events and per-zone control decisions. Flow-generated rules include flow ownership and the persisted last_trigger_trace snapshot from the latest execution attempt. The bundled Web UI receives plan changes through WebSocket and uses this endpoint as a fallback/resynchronization surface.",
|
||||
"operationId": "controlPlan",
|
||||
"security": [
|
||||
{
|
||||
@@ -6079,7 +6079,7 @@
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"example": "0.15.17"
|
||||
"example": "0.15.18"
|
||||
},
|
||||
"uptime_seconds": {
|
||||
"type": "integer",
|
||||
@@ -7846,7 +7846,8 @@
|
||||
"enum": [
|
||||
"temperature_above",
|
||||
"temperature_below",
|
||||
"time"
|
||||
"time",
|
||||
"flow"
|
||||
],
|
||||
"example": "temperature_above"
|
||||
},
|
||||
@@ -7914,6 +7915,14 @@
|
||||
],
|
||||
"format": "date-time"
|
||||
},
|
||||
"last_trigger_trace": {
|
||||
"type": "array",
|
||||
"description": "For Flow-generated automations, snapshot of evaluated Flow blocks from the latest execution attempt.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"flow_id": {
|
||||
"type": [
|
||||
"string",
|
||||
|
||||
Reference in new issue
Block a user