forked from openhab/openhab-addons
-
Notifications
You must be signed in to change notification settings - Fork 0
/
thing-types.xml
327 lines (297 loc) · 10.6 KB
/
thing-types.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="alarmdecoder"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<!-- Alarm Decoder Bridge -->
<bridge-type id="ipbridge">
<label>Alarm Decoder IP Bridge</label>
<description>Nu Tech Alarm Decoder IP Bridge</description>
<properties>
<property name="vendor">Nu Tech Software Solutions</property>
</properties>
<config-description>
<parameter name="hostname" type="text" required="true">
<label>Host Name</label>
<context>network-address</context>
<description>The hostname or IP address of the Alarm Decoder device</description>
</parameter>
<parameter name="tcpPort" type="integer">
<label>TCP Port</label>
<description>TCP port number for the Alarm Decoder connection</description>
<default>10000</default>
</parameter>
<parameter name="discovery" type="boolean">
<label>Enable Discovery</label>
<description>Enable automatic discovery of zones and RF zones</description>
<default>false</default>
</parameter>
<parameter name="reconnect" type="integer" min="1" max="60" unit="min">
<label>Reconnect Interval</label>
<description>The period in minutes that the handler will wait between connection attempts and checks</description>
<unitLabel>minutes</unitLabel>
<default>2</default>
<advanced>true</advanced>
</parameter>
<parameter name="timeout" type="integer" min="0" max="60" unit="min">
<label>Message Receive Timeout</label>
<description>The period in minutes after which the connection will be reset if no valid messages have been received.
Set to 0 to disable.</description>
<unitLabel>minutes</unitLabel>
<default>5</default>
<advanced>true</advanced>
</parameter>
</config-description>
</bridge-type>
<bridge-type id="serialbridge">
<label>Alarm Decoder Serial Bridge</label>
<description>Nu Tech Alarm Decoder Serial Bridge</description>
<properties>
<property name="vendor">Nu Tech Software Solutions</property>
</properties>
<config-description>
<parameter name="serialPort" type="text" required="true">
<label>Serial Or USB Port</label>
<context>serial-port</context>
<limitToOptions>false</limitToOptions>
<description>The name of the serial port used to connect to the Alarm Decoder device</description>
</parameter>
<parameter name="bitrate" type="integer">
<label>Bitrate</label>
<default>115200</default>
<description>Speed of the serial connection</description>
</parameter>
<parameter name="discovery" type="boolean">
<label>Enable Discovery</label>
<description>Enable automatic discovery of zones and RF zones</description>
<default>false</default>
</parameter>
</config-description>
</bridge-type>
<!-- Zone Thing Type -->
<thing-type id="zone">
<supported-bridge-type-refs>
<bridge-type-ref id="ipbridge" />
<bridge-type-ref id="serialbridge" />
</supported-bridge-type-refs>
<label>Alarm Zone</label>
<description>Alarm Decoder REL or EXP zone</description>
<channels>
<channel id="contact" typeId="contact-channel" />
</channels>
<representation-property>id</representation-property>
<config-description>
<parameter name="address" type="integer" required="true">
<label>Zone Address</label>
</parameter>
<parameter name="channel" type="integer" required="true">
<label>Zone Channel</label>
</parameter>
</config-description>
</thing-type>
<!-- RF Zone Thing Type -->
<thing-type id="rfzone">
<supported-bridge-type-refs>
<bridge-type-ref id="ipbridge" />
<bridge-type-ref id="serialbridge" />
</supported-bridge-type-refs>
<label>Alarm RF Zone</label>
<description>Alarm Decoder RFX zone</description>
<channels>
<channel id="lowbat" typeId="system.low-battery">
<label>Low Battery</label>
</channel>
<channel id="supervision" typeId="indicator-channel">
<label>Supervision Indicator</label>
</channel>
<channel id="loop1" typeId="contact-channel">
<label>Loop 1</label>
</channel>
<channel id="loop2" typeId="contact-channel">
<label>Loop 2</label>
</channel>
<channel id="loop3" typeId="contact-channel">
<label>Loop 3</label>
</channel>
<channel id="loop4" typeId="contact-channel">
<label>Loop 4</label>
</channel>
</channels>
<representation-property>serial</representation-property>
<config-description>
<parameter name="serial" type="integer" required="true">
<label>Serial</label>
<description>Serial number of the RF zone</description>
</parameter>
</config-description>
</thing-type>
<!-- Keypad Thing Type -->
<thing-type id="keypad">
<supported-bridge-type-refs>
<bridge-type-ref id="ipbridge" />
<bridge-type-ref id="serialbridge" />
</supported-bridge-type-refs>
<label>Alarm Keypad</label>
<description>Alarm Decoder keypad thing</description>
<channels>
<channel id="zone" typeId="number-channel">
<label>Zone</label>
</channel>
<channel id="text" typeId="text-channel">
<label>Keypad Message</label>
</channel>
<channel id="ready" typeId="indicator-channel">
<label>Ready</label>
</channel>
<channel id="armedaway" typeId="indicator-channel">
<label>Armed Away</label>
</channel>
<channel id="armedhome" typeId="indicator-channel">
<label>Armed Stay</label>
</channel>
<channel id="backlight" typeId="indicator-channel">
<label>Keypad Backlight</label>
</channel>
<channel id="program" typeId="indicator-channel">
<label>Programming Mode</label>
</channel>
<channel id="beeps" typeId="number-channel">
<label>Beeps</label>
<description>Number of beeps for message</description>
</channel>
<channel id="bypassed" typeId="indicator-channel">
<label>Zone Bypassed</label>
</channel>
<channel id="acpower" typeId="indicator-channel">
<label>AC Power</label>
</channel>
<channel id="chime" typeId="indicator-channel">
<label>Chime Enabled</label>
</channel>
<channel id="alarmoccurred" typeId="indicator-channel">
<label>Alarm Occurred</label>
<description>Alarm has occurred in the past</description>
</channel>
<channel id="alarm" typeId="indicator-channel">
<label>Alarm</label>
<description>Alarm is currently sounding</description>
</channel>
<channel id="lowbat" typeId="system.low-battery">
<label>Low Battery</label>
</channel>
<channel id="delayoff" typeId="indicator-channel">
<label>Entry Delay Off</label>
</channel>
<channel id="fire" typeId="indicator-channel">
<label>Fire Detected</label>
</channel>
<channel id="sysfault" typeId="indicator-channel">
<label>System Fault</label>
</channel>
<channel id="perimeter" typeId="indicator-channel">
<label>Perimeter Only</label>
</channel>
<channel id="command" typeId="command-channel">
<label>Keypad Command</label>
</channel>
<channel id="intcommand" typeId="int-command-channel">
<label>Integer Mapped Keypad Command</label>
</channel>
</channels>
<config-description>
<parameter name="addressMask" type="text" required="true">
<label>Address Mask</label>
<description>Keypad address mask</description>
</parameter>
<parameter name="sendCommands" type="boolean">
<label>Send Commands</label>
<description>Allow keypad commands to be sent to the alarm system from openHAB. Enabling this means the alarm system
will be only as secure as your openHAB system.</description>
<default>false</default>
</parameter>
<parameter name="sendStar" type="boolean">
<label>Send * for Fault Info</label>
<description>When disarmed, automatically send * character to obtain zone fault information.</description>
<default>false</default>
</parameter>
<parameter name="commandMapping" type="text">
<label>Command Mapping for intcommand Channel</label>
<description>Comma separated list of key/value pairs mapping integers to command strings for intcommand channel.</description>
<default>0=0,1=1,2=2,3=3,4=4,5=5,6=6,7=7,8=8,9=9,10=*,11=#</default>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
<!-- LRR Thing Type -->
<thing-type id="lrr">
<supported-bridge-type-refs>
<bridge-type-ref id="ipbridge" />
<bridge-type-ref id="serialbridge" />
</supported-bridge-type-refs>
<label>Long Range Radio</label>
<description>Long range radio message handler</description>
<channels>
<channel id="partition" typeId="number-channel">
<label>Partition</label>
<description>Partition number (0 = System)</description>
</channel>
<channel id="eventdata" typeId="number-channel">
<label>Event Data</label>
<description>CID event data (user or zone)</description>
</channel>
<channel id="cidmessage" typeId="text-channel">
<label>CID Message</label>
<description>SIA Contact ID Protocol message</description>
</channel>
<channel id="reportcode" typeId="text-channel">
<label>Report Code</label>
<description>CID report code</description>
</channel>
</channels>
<config-description>
<parameter name="partition" type="integer">
<label>Partition</label>
<description>Partition for which to receive LRR events (0=All)</description>
<default>0</default>
</parameter>
</config-description>
</thing-type>
<!-- ===== Channel Type Definitions ===== -->
<!-- Contact Channel Type -->
<channel-type id="contact-channel">
<item-type>Contact</item-type>
<label>Contact State</label>
<category>Switch</category>
<state readOnly="true" />
</channel-type>
<!-- Indicator Channel Type -->
<channel-type id="indicator-channel">
<item-type>Switch</item-type>
<label>Indicator State</label>
<category>Switch</category>
<state readOnly="true" />
</channel-type>
<!-- Number Channel Type -->
<channel-type id="number-channel">
<item-type>Number</item-type>
<label>Number</label>
<category>Number</category>
<state readOnly="true" />
</channel-type>
<!-- Text channel type -->
<channel-type id="text-channel">
<item-type>String</item-type>
<label>Text Channel</label>
<state readOnly="true" />
</channel-type>
<!-- Command channel type -->
<channel-type id="command-channel" advanced="true">
<item-type>String</item-type>
<label>Command Channel</label>
</channel-type>
<!-- Integer Command channel type -->
<channel-type id="int-command-channel" advanced="true">
<item-type>Number</item-type>
<label>Integer Command Channel</label>
</channel-type>
</thing:thing-descriptions>