cbrx_connection_set
On the hub specified by the connection handle, set the key value. Calls to a dock will result in the relevant key being set on both the chargers except for the port specific keys which will be directed to the appropriate charger only.
Syntax: see API Call Structure
|
{ "method": "cbrx_connection_set", "params": [ connection-handle, "dictionary-key", Value ] } |
| Parameter | Description |
|---|---|
| connection-handle | The Connection Handles as an integer |
| dictionary-key |
as returned by a call to cbrx_connection_setdictionary see Set Dictionary for more information |
| Value | The value you wish to set the key too |
Returns:
|
{ "result": true } |
Errors
If there is an error in the API method then a JSON-RPC Error Object will be returned.
Examples
Example JSON-RPC request:
Copy
{
"jsonrpc": "2.0",
"id": 0,
"method": "cbrx_connection_set",
"params": [
5313,
"TwelveVoltRail.OverVoltage",
true
]
}Example successful response:
Copy
{
"jsonrpc": "2.0",
"id": 0,
"result": true
}