RGBControl

Enable / disable ModIT RGB LED control for ports. This does not require RemoteControl to be enabled.

Syntax: see Call Structure

{

"method": "cbrx_connection_set",

"params": [

connection-handle, "RGBControl",

{

"port": N,

"enable": value

}

]

}

Parameter Description
connection-handle The Connection Handles as an integer
N port number
value The value you wish to set for the key
Value Description
true Enable control of the RGB LED's
false Disbale control of the RGB LED's
Returns:

{

"result": true

}

  • Errors
  • If there is an error in the API method then a JSON-RPC Error Object will be returned.

    Example
    Copy
    {
        "id": 0,
        "jsonrpc": "2.0",
        "method": "cbrx_connection_set",
        "params": [
            7654,
            "RGBControl",
            {
                "port": 8,
                "enable": true
            }
        ]
    }
    Multiple ports

    If you wish to set control on a range of ports then the params would change. You would need to enter two values the 'start' value of the port to start with and the 'end' value of the port to finish with.

    Syntax: see Call Structure

    {

    "method": "cbrx_connection_set",

    "params": [

    connection-handle, "RGBControl",

    { "start": N, "end": N, "enable": value

    }

    ]

    }

    Parameter Description
    connection-handle The Connection Handles as an integer
    N port number
    value The value you wish to set for the key
    Value Description
    true Enable control of the RGB LED's
    false Disbale control of the RGB LED's
    Returns:

    {

    "result": true

    }

  • Errors
  • If there is an error in the API method then a JSON-RPC Error Object will be returned.

    Example
    Copy
    {
        "id": 0,
        "jsonrpc": "2.0",
        "method": "cbrx_connection_set",
        "params": [
            7654,
            "RGBControl",
            {
                "start": 1,
                "end": 8,
                "enable": true
            }
        ]
    }