forked from timroemisch/mqtt-s7-connector
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathconfig_schema.yaml
355 lines (350 loc) · 10.8 KB
/
config_schema.yaml
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
$schema: "http://json-schema.org/draft-07/schema"
type: object
properties:
update_time:
type: integer
default: 1000
temperature_interval:
type: integer
default: 300000
mqtt_base:
type: string
default: "s7"
"pattern": "^[a-zA-Z0-9_-]*$"
mqtt_device_name:
type: string
default: "plc"
"pattern": "^[a-zA-Z0-9_-]*$"
retain_messages:
type: boolean
default: false
discovery_prefix:
type: string
default: "homeassistant"
"pattern": "^[a-zA-Z0-9_-]*$"
discovery_retain:
type: boolean
default: false
plc:
type: object
properties:
port:
type: integer
host:
type: string
rack:
type: integer
slot:
type: integer
debug:
type: boolean
default: false
required:
- port
- host
- rack
- slot
mqtt:
type: object
properties:
host:
type: string
user:
type: string
password:
type: string
rejectUnauthorized:
type: boolean
required:
- host
- user
- password
- rejectUnauthorized
devices:
type: array
items:
type: object
properties:
type:
description: "Type of the entity"
type: string
enum:
- binarycover
- climate
- heater
- cover
- light
- number
- sensor
- switch
- button
required:
- type
allOf:
# Sensor specific schema
- if:
properties:
type:
const: sensor
then:
additionalProperties: false
properties:
type:
const: sensor
name: &name
description: "Name of the entity generated in Home Assistant"
type: string
device_name: &device_name
description: "The name of the device which will be generated in Home Assistant."
type: string
mqtt: &mqtt
description: "The MQTT path fragment for this device. Will be generated using the device_name and name by default."
device_class: &device_class
description: "A device class is a measurement categorization in Home Assistant. https://www.home-assistant.io/integrations/homeassistant/#device-class"
type: string
value_template: &value_template
description: "Defines a HA-template to convert the value from the PLC to the value used by Home Assistant. See https://www.home-assistant.io/docs/configuration/templating/#using-templates-with-the-mqtt-integration"
type: string
manufacturer: &manufacturer
description: "The manufacturer gets displayed in the Home Assistant device view."
type: string
state: &state
description: "PLC read/write configuration"
oneOf:
- type: string
pattern: "^[M|DB][A-Z0-9,.]*$"
- type: object
additionalProperties: false
properties:
plc:
type: string
pattern: "^[M|DB][A-Z0-9,.]*$"
rw:
type: string
update_interval:
type: number
set_plc:
type: string
write_back:
type: boolean
required: [ 'plc' ]
unit_of_measurement: &unit_of_measurement
type: string
required:
- type
- name
- state
# Number specific schema
- if:
properties:
type:
const: "number"
then:
additionalProperties: false
properties:
type:
const: "number"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
state: *state
command_template: &command_template
description: "Defines a HA-template to convert the value from the Home Assistant to the value used in the PLC. See https://www.home-assistant.io/docs/configuration/templating/#using-command-templates-with-mqtt"
type: string
unit_of_measurement: *unit_of_measurement
step:
description: "The step size of the number input generated by Home Assistant."
type: number
min:
description: "The minimum value of the number input generated by Home Assistant."
type: number
max:
description: "The maximum value of the number input generated by Home Assistant."
type: number
mode:
description: "The type of the input widget generated by Home Assistant."
type: string
enum:
- box
- slider
required:
- name
- type
- state
# Light specific schema
- if:
properties:
type:
const: "light"
then:
additionalProperties: false
properties:
type:
const: "light"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
state: *state
command_template: *command_template
brightness: *state
brightness_value_template: *value_template
brightness_command_template: *command_template
required:
- type
- name
- state
# Switch specific schema
- if:
properties:
type:
const: "switch"
then:
additionalProperties: false
properties:
type:
const: "switch"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
state: *state
command_template: *command_template
required:
- type
- name
- state
# Cover specific schema
- if:
properties:
type:
const: "cover"
then:
additionalProperties: false
properties:
type:
const: "cover"
name: *name
device_name: *device_name
device_class: *device_class
mqtt: *mqtt
manufacturer: *manufacturer
targetPosition: *state
currentPosition: *state
currentTiltAngle: *state
tiltAngle: *state
trigger: *state
required:
- type
- name
- targetPosition
# BinaryCover specific schema
- if:
properties:
type:
const: "binarycover"
then:
additionalProperties: false
properties:
type:
const: "binarycover"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
targetPosition: *state
currentPosition: *state
required:
- type
- name
# Climate specific schema
- if:
properties:
type:
const: "climate"
then:
additionalProperties: false
properties:
type:
const: "climate"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
current_temperature: *state
current_temperature_template: *value_template
target_temperature: *state
temperature_command_template: *command_template
required:
- type
- name
- current_temperature
- target_temperature
# Heater specific schema
- if:
properties:
type:
const: "heater"
then:
additionalProperties: false
properties:
type:
const: "heater"
name: *name
device_name: *device_name
device_class: *device_class
value_template: *value_template
mqtt: *mqtt
manufacturer: *manufacturer
current_temperature: *state
current_temperature_template: *value_template
target_temperature: *state
temperature_command_template: *command_template
heatMode_temperature_threshold:
description: "The temperature threshold on which the heater will be set in heat mode"
type: number
min_temp:
description: "The minimum value of the heater widget in Home Assistant"
type: number
max_temp:
description: "The maximum value of the heater widget in Home Assistant"
type: number
temp_step:
type: number
description: "Step size for temperature set point."
required:
- type
- name
- current_temperature
- target_temperature
# Button specific schema
- if:
properties:
type:
const: "button"
then:
additionalProperties: false
properties:
type:
const: "button"
name: *name
device_name: *device_name
state: *state
press_duration:
description: "The duration in milliseconds the state Bit gets set to 1"
type: integer
required:
- plc
- mqtt
- devices