Skip to main content

DevicePut

Properties

NameTypeRequiredDescription
type_DevicePutType
metadataDevicePutMetadata
identifyIdentify
usertestDevicePutUsertest

DevicePutType

Properties

NameTypeRequiredDescription
devicestring"device"

DevicePutMetadata

Properties

NameTypeRequiredDescription
namestringHuman readable name of a resource
archetypeProductArchetypeThe default archetype given by manufacturer. Can be changed by user.

Identify

Properties

NameTypeRequiredDescription
actionIdentifyActionTriggers a visual identification sequence, current implemented as (which can change in the future): Bridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors perform LED identification cycles for 15 seconds

IdentifyAction

Triggers a visual identification sequence, current implemented as (which can change in the future): Bridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors perform LED identification cycles for 15 seconds

Properties

NameTypeRequiredDescription
identifystring"identify"

DevicePutUsertest

Properties

NameTypeRequiredDescription
usertestbooleanActivates or extends user usertest mode of device for 120 seconds. false deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →