Roller Shade

May 16, 2026 ยท View on GitHub


Device List Information

KeyValue TypeDescription
deviceIdStringdevice ID
deviceNameStringdevice name
deviceTypeStringdevice type. Roller Shade
bleVersionIntegerfirmware version
enableCloudServiceBooleandetermines if Cloud Service is enabled or not for the current device
hubDeviceIdStringdevice's parent Hub ID
groupingDevicesIdsArraya list of device IDs such that the Roller Shade devices are being paired or grouped
groupBooleandetermines if a device is paired with or grouped with one or more devices of the same type or not
masterBooleandetermines if a device is the master device or not when paired with or grouped with one or more devices of the same type
groupNameStringthe name of the device group

Device Status

KeyValue TypeDescription
deviceIdStringdevice ID
deviceTypeStringdevice type. Roller Shade
hubDeviceIdStringdevice's parent Hub ID
versionStringthe current firmware version, e.g. V4.2
calibrateBooleandetermines if the open and the closed positions have been properly calibrated or not
batteryIntegerthe current battery level 0-100
movingBooleandetermines if the device is moving or not
slidePositionIntegerthe current position, 0-100

Control Commands

deviceTypecommandTypeCommandcommand parameterDescription
Roller ShadecommandsetPosition0~1000, open; 100, closed

Webhook Events

Key NameValue TypeDescription
eventTypeStringthe type of events
eventVersionStringthe current event version
contextObjectthe detail info of the event
deviceTypeStringthe type of the device
deviceMacStringthe MAC address of the device
calibrateBooleandetermines if the open position and the close position of a device have been properly calibrated or not
slidePositionIntegerthe percentage of the distance between the calibrated open position and closed position that the device has traversed
batteryIntegerthe battery level
timeOfSampleLongthe time stamp when the event is sent
{
    "eventType": "changeReport",
    "eventVersion": "1",
    "context": {
        "deviceType": "WoRollerShade",
        "deviceMac": DEVICE_MAC_ADDR,
        "calibrate":false,
        "slidePosition":50, //0~100
        "battery":100,
        "timeOfSample": 123456789
    }
}