Get Info

hide footbox
title Payload direction
clients -> devices: get_info payload

The following payload is sent to request the targeted device to send its current capabilities values

Payload

{
   "action":"get_info",
   "timestamp":"[TIMESTAMP]",
   "uid":"[PAYLOAD_UID]",
   "modules": [
       {
           "id":"[MODULE_UID]",
           "device"|"scenario"|"service":{

           }
       }
   ]
}

See [TIMESTAMP], [PAYLOAD_UID], [MODULE_UID|NAME|TYPE]

Then the device should respond with the Infos payload

Infos

The following payload is indicating new capability values for the specified device or scenario. You might use the “device” key most of the time. Use the “infos” value for the “event” key by default. If you the information is important to be notified to the end user (such as a device call, for example), replace the value by “alert”

hide footbox
title Payload direction
devices -> clients: infos payload

Payload

{
 "event": "infos"|"alert"|"silent",
 "timestamp":"[TIMESTAMP]",
 "uid":"[PAYLOAD_UID]",
 "modules": [
     {
         "id":"[MODULE_UID]",
         "device"|"scenario"|"service":{
             "bearerId":"[BEARER_DEVICE_UID]",
             "associateStatus":"ASSOCIATED"|"PENDING",
             "status":[
                 {
                     "capability":"[CAPABILITY_NAME]",
                     "value":"[VALUE]"
                 },
                 ...
             ]
         }
     }
     ]
}

See [TIMESTAMP], [PAYLOAD_UID], [MODULE_UID|NAME|TYPE], [BEARER_DEVICE_UID], [ASSOCIATE_STATUS], [CAPABILITY_NAME], [VALUE]