From 8051b23c3fc5cc5ad44102b1198f3da807685eb6 Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 27 Sep 2023 14:58:42 +0200 Subject: [PATCH] added API documentation --- api-doc.txt | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 api-doc.txt diff --git a/api-doc.txt b/api-doc.txt new file mode 100644 index 0000000..5da3ca9 --- /dev/null +++ b/api-doc.txt @@ -0,0 +1,8 @@ +The server listens on '/' for GET queries with a url query format like +?l=*&r0=*&g0=*&b0=*&a0=*&t0=* ... &rl=*&gl=*&bl=*&al=*&tl=* +Where l is the number of points on a gradient. And each point of the gradient has a r* g* b* a* and t* where * is the index. +r g and b are the red green and blue 8-bit colour components of a point on the gradient. A is the 5-bit global component of the led at that point. +t is the offset from the start measured in leds. +Each point also has an optional &m 'movement' argument. &m should be either -1, +1 or 0 and represents the movement per frame or the point. +A point on the gradient can have an &m parameter, and has to have a &r, &g, &b, &a, and &t. +The whole gradient can have a duration &d parameter and must have a length &l