openhue-api/src/device/schemas/DeviceGet.yaml at 74aff67dd761f1b4e19a74c494a01d665cc3c855 · openhue/openhue-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
type: object
description: Definition of a device resource
allOf:
  - $ref: '../../common/ResourceOwned.yaml'
  - type: object
    required:
      - product_data
      - metadata
      - identify
      - services
    properties:
      type:
        type: string
        enum:
          - device
      product_data:
        $ref: './ProductData.yaml'
      metadata:
        type: object
        required:
          - name
          - archetype
        properties:
          name:
            type: string
            minLength: 1
            maxLength: 32
            description: Human readable name of a resource
          archetype:
            $ref: './ProductArchetype.yaml'
      identify:
        type: object
        description: Triggers a visual identification sequence on the device
      usertest:
        type: object
        properties:
          status:
            type: string
            enum:
              - set
              - changing
          usertest:
            type: boolean
            description: |
              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)
      services:
        type: array
        description: References all services providing control and state of the device.
        items:
          $ref: '../../common/ResourceIdentifier.yaml'