From d24ee9f204cc671ef5b4ca450e213bfd5cd0b566 Mon Sep 17 00:00:00 2001 From: Aircoookie Date: Wed, 27 Mar 2019 08:39:08 +0100 Subject: [PATCH] Updated JSON API (markdown) --- JSON-API.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/JSON-API.md b/JSON-API.md index 1cf1fe0..8e9bd5f 100644 --- a/JSON-API.md +++ b/JSON-API.md @@ -10,9 +10,13 @@ The response consists of four objects: - `info` contains general information about the device. No value can be modified using this API. - `effects` contains an array of the effect mode names - `palettes` contains an array of the palette names +You may also obtain those objects individually using the URLs `/json/state` `/json/info` `/json/eff`, and ``/json/pal` ### Setting new values -Sending a POST request to `/json/state` with (parts of) the state object will update the respective values. +Sending a POST request to `/json` or `/json/state` with (parts of) the state object will update the respective values. +Example: `{"on":true,"bri":255}` sets the brightness to maximum. `{"seg":[{"col":[[0,255,200]]}]}` sets the color of the first segment to teal. + +Note: In 0.8.4, segments are not supported and any but the first will be ignored. Sample JSON API response (v0.8.4):