Event

devices.properties.event

Display of readings of device properties (properties can have one of the specified states).

  1. Property description
  2. Current property state

Property description

The structure is used in the response to the Information about user devices operation.

  1. Property parameters
  2. Example of use

Property parameters

Parameter Type Description Required
type String Property type. Yes
retrievable Boolean
Whether it's possible to request the state of the device property. Acceptable values:
  • true: A state request is available for the property. Default value.
  • false: A state request is not available for the property. The value is available if reportable:true.
No
reportable Boolean Whether the property reports the state change to Yango Smart Home using the notification service. Acceptable values:
  • true: Notification is enabled. The manufacturer notifies Yango Smart Home of every property state change.
  • false: Notification is disabled. The manufacturer doesn't notify Yango Smart Home of the property state change. Default value.
No
parameters Object The parameters object. Yes
parameters object
instance String Function name for a property. You can find the acceptable values in the List of functions section. Yes
events Array of event objects

Array of event objects that describe events supported by the property. Minimum number of events in the array: 1.

Yes
The event object that is a part of the events array
value String The value of the function operating mode processed on the provider side. You can find the acceptable values in the List of functions section. Yes
Parameter Type Description Required
type String Property type. Yes
retrievable Boolean
Whether it's possible to request the state of the device property. Acceptable values:
  • true: A state request is available for the property. Default value.
  • false: A state request is not available for the property. The value is available if reportable:true.
No
reportable Boolean Whether the property reports the state change to Yango Smart Home using the notification service. Acceptable values:
  • true: Notification is enabled. The manufacturer notifies Yango Smart Home of every property state change.
  • false: Notification is disabled. The manufacturer doesn't notify Yango Smart Home of the property state change. Default value.
No
parameters Object The parameters object. Yes
parameters object
instance String Function name for a property. You can find the acceptable values in the List of functions section. Yes
events Array of event objects

Array of event objects that describe events supported by the property. Minimum number of events in the array: 1.

Yes
The event object that is a part of the events array
value String The value of the function operating mode processed on the provider side. You can find the acceptable values in the List of functions section. Yes

Example of use

Yango Smart Home requests the details of user devices from the provider. The provider responds that the user has a sensor that can display window/door opening events.

curl -i -X GET 'https://example.com/v1.0/user/devices' \
-H 'Authorization: Bearer 123qwe456a...' \
-H 'X-Request-Id: ff36a3cc-ec...'
Copied to clipboard

Current property state

The structure is used in the response to the Information about the states of user devices operation and in the request body of the Notification about device state change operation.

  1. Property parameters
  2. Example of use

Property parameters

Parameter Type Description Required
type String Property type. Yes
state Object Property state parameters. Yes
state object
instance String Function name for the property. You can find the acceptable values in the List of functions section. Yes
value String Property value for this capability. Yes
Parameter Type Description Required
type String Property type. Yes
state Object Property state parameters. Yes
state object
instance String Function name for the property. You can find the acceptable values in the List of functions section. Yes
value String Property value for this capability. Yes

Example of use

Yango Smart Home requests the provider to change the state of the user device. The provider responds that the property shows the opening of a window or a door.

curl -i -X POST 'https://example.com/v1.0/user/devices/query' \
-H 'Authorization: Bearer 123qwe456a...' \
-H 'X-Request-Id: ff36a3cc-ec...' \
-H 'Content-Type: application/json' \
-d '{
      "devices": 
      [
        {
            "id": "sensor-001-snsr",
            "custom_data": {
                "api_location": "rus"
            } 
        }
      ]
    }'
Copied to clipboard

Support