# DevicePut

**Properties**

| Name     | Type              | Required | Description |
| :------- | :---------------- | :------- | :---------- |
| type\_   | DevicePutType     | ❌       |             |
| metadata | DevicePutMetadata | ❌       |             |
| identify | Identify          | ❌       |             |
| usertest | DevicePutUsertest | ❌       |             |

# DevicePutType

**Properties**

| Name   | Type   | Required | Description |
| :----- | :----- | :------- | :---------- |
| device | string | ✅       | "device"    |

# DevicePutMetadata

**Properties**

| Name      | Type             | Required | Description                                                          |
| :-------- | :--------------- | :------- | :------------------------------------------------------------------- |
| name      | string           | ❌       | Human readable name of a resource                                    |
| archetype | ProductArchetype | ❌       | The default archetype given by manufacturer. Can be changed by user. |

# Identify

**Properties**

| Name   | Type           | Required | Description                                                                                                                                                                                                                                                  |
| :----- | :------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action | 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 |

# 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**

| Name     | Type   | Required | Description |
| :------- | :----- | :------- | :---------- |
| identify | string | ✅       | "identify"  |

# DevicePutUsertest

**Properties**

| Name     | Type    | Required | Description                                                                                                                                                                                                             |
| :------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| usertest | boolean | ❌       | Activates 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) |

<!-- This file was generated by liblab | https://liblab.com/ -->