forked from andreaseu/homebridge-garage-remote-http
-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathconfig.schema.json
More file actions
153 lines (153 loc) · 5.93 KB
/
Copy pathconfig.schema.json
File metadata and controls
153 lines (153 loc) · 5.93 KB
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
{
"pluginAlias": "GarageDoorOpener",
"pluginType": "accessory",
"singular": false,
"schema": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true,
"description": "Name to appear in the Home app"
},
"http_method": {
"title": "HTTP Method",
"type": "string",
"oneOf": [
{
"title": "GET",
"enum": [
"GET"
]
},
{
"title": "POST",
"enum": [
"POST"
]
}
],
"required": true,
"default": "GET",
"description": "The HTTP method to be used to communicate with the device API."
},
"openURL": {
"title": "Open URL",
"type": "string",
"required": true,
"description": "URL to trigger the opening of your garage"
},
"closeURL": {
"title": "Close URL",
"type": "string",
"required": true,
"description": "URL to trigger the closing of your garage"
},
"username": {
"title": "Username",
"type": "string",
"description": "Username if HTTP authentication is enabled"
},
"password": {
"title": "Password",
"type": "string",
"description": "Password if HTTP authentication is enabled"
},
"openTime": {
"title": "Time to open the door",
"type": "integer",
"required": true,
"default": 10,
"description": "Time (in seconds) to simulate your garage opening"
},
"closeTime": {
"title": "Time to close the door",
"type": "integer",
"default": 10,
"description": "Time (in seconds) to simulate your garage closing"
},
"autoLock": {
"title": "Auto lock",
"type": "boolean",
"default": false,
"description": "Whether your garage should auto-close after being opened"
},
"autoLockDelay": {
"title": "Auto lock delay",
"type": "integer",
"default": 20,
"description": "Time (in seconds) until your garage will automatically close (if enabled)"
},
"polling": {
"title": "Poll state",
"type": "boolean",
"default": false,
"description": "Whether the state should be polled at intervals (requires magnetic sensor)."
},
"pollInterval": {
"title": "Polling interval",
"type": "integer",
"default": 120,
"description": "Time (in seconds) between device polls (if `polling` is enabled) "
},
"movementPollInterval": {
"title": "Movement Polling interval",
"type": "integer",
"default": 2,
"description": "Time (in seconds) between device polls when moving (if `polling` is enabled) "
},
"statusURL": {
"title": "Status polling URL",
"type": "string",
"description": "URL to retrieve state on poll (if `statusField*` options are not set, expects HTTP response body to be `0` or `1`)"
},
"statusKey": {
"title": "Status Key",
"type": "string",
"default": "$.inputs[0].input",
"description": "JSONPath that identifies the property that contains the status of the door (e.g. `$.inputs[0].input` is the default for Shelly 1) | `$.inputs[0].input`"
},
"statusValueOpen": {
"title": "Open status value",
"type": "string",
"default": "0",
"description": "Regex that will match the `open` state of the relay status (e.g. `open`)"
},
"statusValueClosed": {
"title": "Closed status value",
"type": "string",
"default": "1",
"description": "Regex that will match the `closed` state of the relay status (e.g. `closed`)"
},
"statusValueOpening": {
"title": "Opening status value",
"type": "string",
"default": "2",
"description": "Regex that will match the `opening` state of the relay status (e.g. `opening`)"
},
"statusValueClosing": {
"title": "Closing status value",
"type": "string",
"default": "3",
"description": "Regex that will match the `closing` state of the relay status (e.g. `closing`)"
},
"manufacturer": {
"title": "Manufactor",
"type": "string",
"description": "Appears under the Manufacturer field for the accessory"
},
"model": {
"title": "Model",
"type": "string",
"description": "Appears under the Model field for the accessory"
},
"debug": {
"title": "Debug mode",
"type": "boolean",
"default": false,
"description": "Turn on debug mode, i.e. additional information will show up on the homebridge log."
}
}
}
}