-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.schema.json
135 lines (124 loc) · 3.85 KB
/
config.schema.json
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
{
"pluginAlias": "Hydrawise",
"pluginType": "platform",
"singular": true,
"customUi": true,
"headerDisplay": "[homebridge-hunter-hydrawise](https://github.com/hjdhjd/homebridge-hunter-hydrawise) provides HomeKit support for Hunter Hydrawise irrigation controllers.",
"footerDisplay": "See the [homebridge-hunter-hydrawise developer page](https://github.com/hjdhjd/homebridge-hunter-hydrawise) for detailed documentation, including [feature options](https://github.com/hjdhjd/homebridge-hunter-hydrawise#feature-options).",
"schema": {
"type": "object",
"properties": {
"apiKey": {
"title": "Hunter Hydrawise Account API Key",
"type": "string",
"placeholder": "e.g. ABCD-EFGH-0123-4567",
"maxLength": 19,
"minLength": 19,
"required": true,
"description": "The API key for your Hunter Hydrawise account. You can generate one by going to the Account Settings section of the Account Details page on your Hydrawise online account. Default: None."
},
"debug": {
"title": "Debug Logging",
"type": "boolean",
"required": false,
"description": "Logging verbosity for debugging. Default: false."
},
"mqttTopic": {
"type": "string",
"title": "MQTT Base Topic",
"required": false,
"placeholder": "e.g. hydrawise",
"description": "The base MQTT topic to publish to. Default: hydrawise."
},
"mqttUrl": {
"type": "string",
"title": "MQTT Broker URL",
"required": false,
"format": "uri",
"placeholder": "e.g. mqtt://1.2.3.4",
"description": "URL for the MQTT broker you'd like to publish event messages to. Default: None."
},
"name": {
"title": "Plugin Name",
"type": "string",
"required": true,
"default": "Hunter Hydrawise",
"description": "Name to use for Homebridge logging purposes. Default: Hunter Hydrawise."
},
"options": {
"title": "Feature Options",
"type": "array",
"items": {
"type": "string",
"title": "Feature Option",
"required": false,
"description": "Enter only one option per entry. Use the feature options webUI tab above unless you know what you're doing.",
"placeholder": "e.g. Disable.Device"
}
}
}
},
"layout": [
{
"type": "section",
"title": "Required Settings",
"items": [
{
"description": "These options are required in order to use this plugin.",
"items": [
"apiKey"
]
}
]
},
{
"type": "section",
"title": "Plugin Feature Options (Optional)",
"expandable": true,
"expanded": false,
"items": [
{
"key": "options",
"type": "array",
"orderable": true,
"title": " ",
"description": "Use the feature options webUI tab above instead of manually configuring feature options here.",
"buttonText": "Add Feature Option",
"items": [
"options[]"
]
}
]
},
{
"type": "section",
"title": "MQTT Settings (Optional)",
"expandable": true,
"expanded": false,
"items": [
{
"description": "MQTT support will only be enabled if an MQTT broker URL is specified below.",
"items": [
"mqttUrl",
"mqttTopic"
]
}
]
},
{
"type": "section",
"title": "Advanced Settings (Optional)",
"expandable": true,
"expanded": false,
"items": [
{
"description": "These settings should be rarely used or needed by most people. Use these with caution.",
"items": [
"name",
"debug"
]
}
]
}
]
}