dynamic-content-widget-60d820d-3

Example 1: Subscription to a cloud abstract with data type that is representable by one of the Item Value Types.

Edit

Request
Response

Edit

				
					{
    "id": "_request_id_",
    "method": "cloud.controller_subscribe_abstracts",
    "api": 1,
    "params": {
      "abstracts": [
         {
            "abstract_uuid": "1234-abcd-...",
            "device_id": "72613916",
            "mappings": [
              {
               "capability": "power",
               "variable": "status",
               "item_id": "32829327",
               "value": 1
              },
              {
               "capability": "indicator",
               "variable": "status",
               "item_id": "36281629",
               "value": "test-string"
              }
            ]
         },
         ...
      ]
   }
}

Edit

				
					{
    "error": null,
    "id": "_ID_",
    "method": "cloud.controller_subscribe_abstracts",
    "result": {},
}

The result of that call will be an abstract subscription that informs firmware about cloud Abstract object changes via hub.item.value.set command.

Example 2: Abstract subscription to geofence data for the ezlo_geofencing plugin with custom template for an API call to use as a callback to report geofence data changes.

Edit

				
					{
    "method": "cloud.controller_subscribe_abstracts",
    "id": "_ID_",
    "params": {
       "abstracts": {
            "abstract_uuid": "4567-zxcv-...",
            "mappings": [
                {
                    "capability": "geofences",
                    "variable": "geofences",
                    "value": 1,
                    "response_type": "geofence_standard_response",
                    "response_data": {
                        "receiving_item_id": "<receivingItemId>",
                        "gateway_name": "ezlo_geofencing"
                    }
                }       
            ]
        },
        "response_type": {
            "geofence_standard_response": {
                "template": "{\"method\": \"hub.cloud.subscription.dispatch\",\"params\": { \"gatewayName\": \"\", \"_id\" : \"\",\"value\" : true}}",
                "value_path": ".params.value",
                "value_info": ".params.cloud_value_type",
                "data_paths":{
                    "receiving_item_id": ".params._id",
                    "gateway_name": ".params.gatewayName"
                }
              }
        }
    }
}

Example 2: Available since Firmware Version 2.0.41.

The result of it will be an abstract subscription, that is reporting new data in the format of the hub.cloud.subscription.dispatch command.

				
					{
    "method": "hub.cloud.subscription.dispatch",
    "id": "_ID_",
    "params": {
        "gatewayName": "<gatewayNameValue>",
        "itemId": "<itemIdValue>",
        "value": any
    }
}