homebridge-blinds-cmd/config.schema.json at master · hjdhjd/homebridge-blinds-cmd · 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
{
  "pluginAlias": "Blinds Command",
  "pluginType": "platform",
  "headerDisplay": "homebridge-blinds-cmd creates window covering (or blind) accessories in HomeKit, providing control and status functions through the command line scripts.",
  "footerDisplay": "For additional help and documentation please see the [developer page](https://github.com/hjdhjd/homebridge-blinds-cmd).",
  "singular": true,

  "schema": {
    "type": "object",
    "properties": {

      "blinds": {
        "type": "array",
        "title": "Blinds",

        "items": {
          "type": "object",
          "title": "Blind",
          "properties": {

            "name": {
              "type": "string",
              "title": "Blind Name",
              "required": true,
              "placeholder": "e.g. Blinds",
              "description": "Name you want to give this blind accessory in HomeKit. Each blind must have a unique name."
            },

            "up": {
              "type": "string",
              "title": "Up Command Script",
              "required": true,
              "placeholder": "e.g. /path/to/your/raise-blinds-script",
              "description": "Path to the command or script to raise the blind. Default: none."
            },

            "down": {
              "type": "string",
              "title": "Down Command Script",
              "required": true,
              "placeholder": "e.g. /path/to/your/lower-blinds-script",
              "description": "Path to the command or script to lower the blind. Default: none."
            },

            "stop": {
              "type": "string",
              "title": "Stop Command Script",
              "required": false,
              "placeholder": "e.g. /path/to/your/stop-blinds-script",
              "description": "Path to the command or script to stop the blind. Default: none."
            },

            "status": {
              "type": "string",
              "title": "Status Command Script",
              "required": false,
              "placeholder": "e.g. /path/to/your/blinds-status-script",
              "description": "Path to the command or script to show the current position of the blind. Default: none."
            },

            "transitionInterval": {
              "type": "number",
              "title": "Simulated Transition Duration",
              "required": false,
              "minimum": 0,
              "maximum": 120,
              "placeholder": "e.g. 12.5",
              "description": "Duration, in seconds, of an open or close event used to simulate action progress in HomeKit. Default: 10.0."
            },

            "refreshRate": {
              "type": "number",
              "title": "Status Refresh Interval",
              "required": false,
              "minimum": 0,
              "maximum": 120,
              "placeholder": "e.g. 10",
              "description": "Interval, in seconds, to execute the status command or script in order to keep HomeKit up to date on blinds status. Default: 0 (disabled)."
            },

            "manufacturer": {
              "type": "string",
              "title": "Blind Manufacturer",
              "required": false,
              "placeholder": "e.g. SomeManufacturer",
              "description": "Manufacturer name to assign to this blind."
            },

            "model": {
              "type": "string",
              "title": "Blind Model",
              "required": false,
              "placeholder": "e.g. SomeModel",
              "description": "Model name to assign to this blind."
            },

            "serial": {
            "type": "string",
            "title": "Blind Serial",
            "required": false,
            "placeholder": "e.g. SomeSerial",
            "description": "Serial number of this blind."
            }
          }
        }
      }
    }
  },

  "layout": [
    {
      "key": "blinds",
      "type": "array",
      "name": " ",
      "description": "Provide the details of your blinds.",
      "orderable": true,
      "buttonText": "Add Blind",
      "items": [
        "blinds[].name",

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Blind Commands",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "Commands to control your blinds.",
              "items": [
                "blinds[].up",
                "blinds[].down",
                "blinds[].stop",
                "blinds[].status"
              ]
            }
          ]
        },

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Optional Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "These settings are optional and provide additional customization settings.",
              "items": [
                "blinds[].transitionInterval",
                "blinds[].refreshRate"
              ]
            }
          ]
        },

        {
          "key": "blinds[]",
          "type": "section",
          "title": "Blind Information",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "description": "These settings are optional and allow you to set additional information about your blinds.",
              "items": [
                "blinds[].manufacturer",
                "blinds[].model",
                "blinds[].serial"
              ]
            }
          ]
        }
      ]
    }
  ]
}