This commit is contained in:
Mateusz Gruszczyński
2026-09-16 22:22:09 +02:00
parent c7d47db64e
commit bb39ab9dfa
27 changed files with 523 additions and 319 deletions
+4 -4
View File
@@ -1,6 +1,6 @@
# GREE Controller API reference
HTTP and WebSocket API for GREE Controller **0.14.15**.
HTTP and WebSocket API for GREE Controller **0.14.18**.
[← Main documentation](../README.md)
@@ -239,7 +239,7 @@ Response:
{
"status": "ok",
"name": "gree-controller",
"version": "0.14.15",
"version": "0.14.18",
"uptime_seconds": 1234,
"control_ready": true,
"time": "2026-08-30T06:54:00Z"
@@ -302,7 +302,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.14.15",
"version": "0.14.18",
"uptime_seconds": 1234,
"auth_required": false,
"control_ready": true,
@@ -326,7 +326,7 @@ Returns the initial Web UI snapshot:
`POST /api/charts/custom/share` is an administrator endpoint that persists a selected Custom Chart definition and returns a random path such as `/charts/custom/chart_<token>`. Only a hash of the share token is stored. The URL does not contain device names or metric selectors.
`GET /charts/custom/:token` renders only the shared chart, without the dashboard. `GET /api/public/charts/custom/:token` returns only the series configured for that share and is intentionally unauthenticated. Possession of the unguessable share URL is the authorization for this narrow read-only endpoint.
`GET /charts/custom/:token` renders only the shared chart, without the dashboard, and lets the viewer switch the history range. `GET /api/public/charts/custom/:token` returns only the series configured for that share and is intentionally unauthenticated; an optional `hours` query parameter changes only the time range, not the shared series definition. Possession of the unguessable share URL is the authorization for this narrow read-only endpoint.
In the Home Assistant add-on, TCP `8787` is the fixed internal application/ingress port. The startup script validates that Supervisor reports the same `ingress_port`; a manually modified mismatched package fails fast instead of starting partially. For generated links, the add-on discovers the primary Home Assistant host IPv4 through the Supervisor API and publishes `http://<HA-IP>:8787/charts/custom/...` by default. The optional `public_chart_base_url` add-on setting overrides that base for reverse proxies or unusual routing. Standalone installations use their current origin/configured base path and therefore follow any port configured in `GREE_CONTROLLER_BIND`.