CarControl¶

Outgoing Messages¶

AdjustControllerValue¶

Adjusts the range setting identified by endpointId and instanceId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "AdjustControllerValue"
        }
    },
    "payload": {
        "controllerType": "RANGE",
        "capabilityType": "RANGE",
        "endpointId": {{String}},
        "controllerId": {{String}},
        "instanceId": {{String}},
        "delta": {{double}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
controllerId	String	Yes	Controller Id. This attribute is deprecated in 4.0. Please use instanceId.
instanceId	String	Yes	The unique identifier of the setting.
delta	double	Yes	The delta by which to adjust the range setting.

AdjustControllerValue¶

Adjusts the mode of the setting identified by endpointId and instanceId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "AdjustControllerValue"
        }
    },
    "payload": {
        "controllerType": "MODE",
        "capabilityType": "MODE",
        "endpointId": {{String}},
        "controllerId": {{String}},
        "instanceId": {{String}},
        "delta": {{Int}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
controllerId	String	Yes	Controller Id. This attribute is deprecated in 4.0. Please use instanceId.
instanceId	String	Yes	The unique identifier of the setting.
delta	Int	Yes	The delta by which to adjust the mode.

AdjustControllerValue¶

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "AdjustControllerValue"
        }
    }
}

SetControllerValue¶

Sets the power state of the endpoint identified by endpointId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue"
        }
    },
    "payload": {
        "controllerType": "POWER",
        "capabilityType": "POWER",
        "endpointId": {{String}},
        "turnOn": {{Bool}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
turnOn	Bool	Yes	The power setting. True to turn on the endpoint or False to turn off.

SetControllerValue¶

Sets the range setting identified by endpointId and instanceId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue"
        }
    },
    "payload": {
        "controllerType": "RANGE",
        "capabilityType": "RANGE",
        "endpointId": {{String}},
        "controllerId": {{String}},
        "instanceId": {{String}},
        "value": {{double}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
controllerId	String	Yes	Controller Id. This attribute is deprecated in 4.0. Please use instanceId.
instanceId	String	Yes	The unique identifier of the setting.
value	double	Yes	The new range setting.

SetControllerValue¶

Sets the toggle state of the setting identified by endpointId and instanceId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue"
        }
    },
    "payload": {
        "controllerType": "TOGGLE",
        "capabilityType": "TOGGLE",
        "endpointId": {{String}},
        "controllerId": {{String}},
        "instanceId": {{String}},
        "turnOn": {{Bool}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
controllerId	String	Yes	Controller Id. This attribute is deprecated in 4.0. Please use instanceId.
instanceId	String	Yes	The unique identifier of the setting.
turnOn	Bool	Yes	The power state of the setting. True to turn on the setting or False to turn off.

SetControllerValue¶

Sets the mode of the setting identified by endpointId and instanceId.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue"
        }
    },
    "payload": {
        "controllerType": "MODE",
        "capabilityType": "MODE",
        "endpointId": {{String}},
        "controllerId": {{String}},
        "instanceId": {{String}},
        "value": {{String}}        
    }
}

Payload¶

Property	Type	Required	Description
controllerType	String	Yes	This attribute is deprecated in 4.0. Please use capabilityType.
capabilityType	String	Yes	Capability type.
endpointId	String	Yes	The unique identifier of the endpoint.
controllerId	String	Yes	Controller Id. This attribute is deprecated in 4.0. Please use instanceId.
instanceId	String	Yes	The unique identifier of the setting.
value	String	Yes	The new mode to set.

SetControllerValue¶

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue"
        }
    }
}

Incoming Messages¶

AdjustControllerValueReply¶

Reply for AdjustControllerValue message.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "AdjustControllerValue",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "success": {{Bool}}        
    }
}

Payload¶

Property	Type	Required	Description	Example
success	Bool	Yes	Whether the requested setting was successfully adjusted. Failure to send the asynchronous reply message within 5 seconds results in a timeout.

SetControllerValueReply¶

Reply for SetControllerValue message.

JSON Structure¶

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "CarControl",
            "action": "SetControllerValue",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "success": {{Bool}}        
    }
}

Payload¶

Property	Type	Required	Description	Example
success	Bool	Yes	Whether the requested setting was updated successfully. Failure to send the asynchronous reply message within 5 seconds results in a timeout.