JointSpace API Documentation

REST API Method: POST ambilight/cached

Changes the ambilight colours in the cache. When changing part of the pixels, the other pixels keep their value.

URL

Format

HTTP Method

Requires Authentication

Parameters

none

Upload data

This resource accepts a JSON object with key/value pairs. It is allowed to send an object containing only the key/value pairs that need to be changed. See the JSON example for how these key/value pairs are passed.

Keys

• layerx (object): An object containing all pixels in layer i.
• left (object): An object containing all pixels on the left side in the containing layer.
• top (object): An object containing all pixels on the top side in the containing layer.
• right (object): An object containing all pixels on the right side in the containing layer.
• bottom (object): An object containing all pixels on the bottom side in the containing layer.
• pixelnr (object): An object containing RGB value for one pixel. The pixel nr is relative within the side containing the pixel. Pixels within a side are numbered clockwise (from the viewer perspective) starting from "0".
• r (integer): The red value for a pixel, between 0 and 255.
• g (integer): The green value for a pixel, between 0 and 255.
• b (integer): The blue value for a pixel, between 0 and 255.

JSON example

Setting all pixels on all layers to the same colour:
{
    "r": 100,
    "g": 210,
    "b": 30
}

Setting all pixels on layer 2 to the same colour. Other pixels keep their colour:
{
    "layer 2:"
    {
        "r": 100,
        "g": 210,
        "b": 30
    }
}

Setting all pixels on the left and right side on layer 1 to the same colour.  Other pixels keep their colour:
{
    "layer1":
    {
        "left":
        {
            "r": 100,
            "g": 210,
            "b": 30
        },
        "right":
        {
            "r": 100,
            "g": 210,
            "b": 30
        }
    }
}

Setting a specific pixel (e.g. pixel 5 at the top side) on layer 1 to a colour.  Other pixels keep their colour:
{
    "layer1":
    {
        "top":
        {
            "5":
            {
                "r": 100,
                "g": 210,
                "b": 30
            }
        }
    }
}


Setting all pixels individually:
{
    "layer1":
    {
        "left":
        {
            "0":
            {
                "r": 100,
                "g": 210,
                "b": 30
            },
            "1":
            {
                "r": 110,
                "g": 220,
                "b": 25
            },
            "2":
            {
                "r": 115,
                "g": 230,
                "b": 20
            },
            "3":
            {
                "r": 125,
                "g": 235,
                "b": 15
            }
        },
        "top":
        {
            "0":
            {
                "r": 140,
                "g": 250,
                "b": 10
            },
            "1":
            {
                "r": 140,
                "g": 250,
                "b": 10
            },
            "2":
            {
                "r": 140,
                "g": 250,
                "b": 10
            },
            "3":
            {
                "r": 140,
                "g": 250,
                "b": 10
            },
            "4":
            {
                "r": 140,
                "g": 250,
                "b": 10
            },
            "5":
            {
                "r": 140,
                "g": 250,
                "b": 10
            }
        },
        "right":
        {
            "0":
            {
                "r": 125,
                "g": 235,
                "b": 15
            },
            "1":
            {
                "r": 115,
                "g": 230,
                "b": 20
            },
            "2":
            {
                "r": 110,
                "g": 220,
                "b": 25
            },
            "3":
            {
                "r": 100,
                "g": 210,
                "b": 30
            }
        },
        "bottom":
        {
        }
    }
    "layer2":
    {
        etc.
    }
}