-
Notifications
You must be signed in to change notification settings - Fork 1
/
HF-Interfaces.xml
757 lines (677 loc) · 34.6 KB
/
HF-Interfaces.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
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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- This is a draft of a mapping of some HAN-FUN interfaces into an HGI SDT representation -->
<!--
Copyright [2016] ULE Alliance
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<Domain xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://homegatewayinitiative.org/xml/dal/3.0"
id="ule.hanfun.interfaces">
<Modules>
<!-- Alert Interface: SERVER -->
<!-- We will really need some other way of indicating an interface's role -->
<ModuleClass name="0x100 - Alert Server Interface">
<Doc>
The <em>Alert Server</em> interface can be used by any device that requires sending an
alert. The alert type will be specified by the unit type where the interface is
implemented, for example for a smoke detector the alert will indicate the presence of
smoke, but for a motion detector the same alert will indicate that movement exists on
the area covered by it.
This interface can support multiple alerts, from 1 up to 32.
</Doc>
<Actions>
<Action name="Status">
<Doc>
This command, sent to a client implementation of the Alert interface, indicates
the current state of all alerts.
</Doc>
<Args>
<Arg name="Unit Type">
<Doc>
The unique identifier of the unit type implementing this server interface.
</Doc>
<DataType>
<SimpleType type="integer"/>
</DataType>
</Arg>
<Arg name="State Attribute">
<Doc>
The value of <em>State</em>.
</Doc>
<DataType>
<Array>
<DataType>
<SimpleType type="boolean"/>
<Constraints>
<Constraint name="maxStates" type="integer" value="32">
<Doc>The maximum number of independent states is fixed at 32.</Doc>
</Constraint>
</Constraints>
</DataType>
</Array>
</DataType>
</Arg>
</Args>
</Action>
</Actions>
<Data>
<DataPoint name="State"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>State</em> indicates the state of an alert. A bit set to "true"
indicates an active alert, a bit set to "false" indicates idle.
</Doc>
<DataType>
<Array>
<DataType>
<SimpleType type="boolean"/>
<Constraints>
<Constraint name="maxStates" type="integer" value="32">
<Doc>The maximum number of independent states is fixed at 32.</Doc>
</Constraint>
</Constraints>
</DataType>
</Array>
</DataType>
</DataPoint>
<DataPoint name="Enable"
optional="false"
writable="true"
readable="true"
eventable="true">
<Doc>
<em>Enable</em> indicates if an alert is enabled or disabled. A disabled alert
will never trigger. A bit set to "true" indicates alert is enabled, a bit set to
"false" indicates alert is disabled.
</Doc>
<DataType>
<Array>
<DataType>
<SimpleType type="boolean"/>
<Constraints>
<Constraint name="maxEnables" type="integer" value="32">
<Doc>The maximum number of independent enables is fixed at 32.</Doc>
</Constraint>
</Constraints>
</DataType>
</Array>
</DataType>
</DataPoint>
</Data>
</ModuleClass>
<!-- Alert Interface: CLIENT -->
<ModuleClass name="0x100 - Alert Client Interface">
<Doc>
The <em>Alert Client</em> interface can be used by any device that requires receiving an
alert.
</Doc>
</ModuleClass>
<!-- On/Off Interface: SERVER-->
<ModuleClass name="0x200 - On/Off Server Interface">
<Doc>
The <em>On/Off Server</em> interface enables a device to have some feature
(light, relay, LED, etc) locally turned on/off.
</Doc>
<Data>
<DataPoint name="State"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>State</em> indicates the current On (when true)/Off (when false) state.
</Doc>
<DataType>
<SimpleType type="boolean"/>
</DataType>
</DataPoint>
</Data>
</ModuleClass>
<!-- On/Off Interface CLIENT-->
<ModuleClass name="0x200 - On/Off Client Interface">
<Doc>
The <em>On/Off Client</em> interface enables a device to remotely turn on/off have
some feature. It allows, for example, turning on or off a siren, an LED or a relay.
</Doc>
<Actions>
<Action name="On">
<Doc>
This command, sent to a server implementation of the On-Off interface,
turns some device feature on.
</Doc>
</Action>
<Action name="Off">
<Doc>
This command, sent to a server implementation of the On-Off interface,
turns some device feature off.
</Doc>
</Action>
<Action name="Toggle">
<Doc>
This command, sent to a server implementation of the On-Off interface, toggles
the state of some device feature. If the feature was set to On, it will be
turned Off and vice-versa.
</Doc>
</Action>
</Actions>
</ModuleClass>
<!-- Simple Power Metering Interface: SERVER -->
<ModuleClass name="0x300 - Simple Power Metering Server Interface">
<Doc>
The <em>Simple Power Metering Server</em> interface enables a device to realize
measurements of electric quantities that are made available for other devices to read.
All attributes are optional so is up to the device definition to define which ones are
implemneted.
</Doc>
<Actions>
<Action name="Report" optional="true">
<Doc>
This optional command, sent to a client implementation of the Simple Power
Metering interface, will send the value of all implemented attributes with the
periodicity defined by <em>Report Interval</em> attribute.
</Doc>
<Args>
<Arg name="Number of Attributes">
<Doc>
Number of attributes, present in the command, for which values are sent.
</Doc>
<DataType>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00"/>
<Constraint name="maxValue" type="integer" value="0xFF"/>
</Constraints>
</DataType>
</Arg>
<Arg name="Pair ID-Value">
<Doc>
Pair of values in the form Attribute ID - Attribute Value.
</Doc>
<DataType>
<Struct>
<DataType name="Attribute ID">
<Doc>
Identifier of an attribute whose value is sent.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00"/>
<Constraint name="maxValue" type="integer" value="0xFF"/>
</Constraints>
</DataType>
<DataType name="Attribute Value">
<Doc>
Value currently store in the specified attribute.
</Doc>
<SimpleType type="integer"/>
</DataType>
</Struct>
</DataType>
</Arg>
</Args>
</Action>
</Actions>
<Data>
<DataPoint name="Energy"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Energy</em> attribute stores energy consumption from device power up
or from a measurement reset
</Doc>
<DataType unitOfMeasure="Watts/Hour">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Energy Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Energy at Last Reset"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Energy at Last Reset</em> stores the <em>Energy</em> value at the
instant a measurement reset occurred (see <em>Measurement Reset</em>
action). It is mandatory if the referred action is implemented.
</Doc>
<DataType unitOfMeasure="Watts/Hour">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Energy Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Time at Last Reset"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Time at Last Reset</em> stores the time value (from device uptime
or UTC) at the instant a measurement reset occurred (see
<em>Measurement Reset</em> action). It is mandatory if the referred
action is implemented.
</Doc>
<DataType unitOfMeasure="Seconds">
<Struct>
<DataType name="Time Reference">
<Doc>
<em>Time Reference</em> indicates the original source from
which time is measured/referenced.
</Doc>
<SimpleType type="boolean"/>
</DataType>
<DataType name="Energy Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Instantaneous Power"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Instantaneous Power</em> stores the presently instantaneous power
value.
</Doc>
<DataType unitOfMeasure="Watts">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Power Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Average Power"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Average Power</em> stores the power measured over a period of time
specified by <em>Average Power Interval</em>.
</Doc>
<DataType unitOfMeasure="Watts">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Power Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Average Power Interval"
optional="true"
writable="true"
readable="true"
eventable="true">
<Doc>
<em>Average Power Interval</em> specifies the time period over which
power should be averaged and stored into <em>Average Power</em>.
</Doc>
<DataType unitOfMeasure="Seconds">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x0000"/>
<Constraint name="maxValue" type="integer" value="0xFFFF"/>
</Constraints>
</DataType>
</DataPoint>
<DataPoint name="Voltage"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Voltage</em> stores the presently instantaneous voltage value.
</Doc>
<DataType unitOfMeasure="Volts">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Voltage Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Current"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Current</em> stores the presently instantaneous current value.
</Doc>
<DataType unitOfMeasure="Amperes">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Current Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Frequency"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Frequency</em> stores the presently instantaneous frequency value.
</Doc>
<DataType unitOfMeasure="Hertz">
<Struct>
<DataType name="Precision Code">
<Doc>
<em>Precision Code</em> indicates a metric prefix that affects
the basic unit of measurement.
</Doc>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="Possible Values">
<Doc>
<em>Precision Code</em> can only take a value from the
following: 0x00, 0x10, 0x11, 0x12, 0x13, 0x20, 0x21, 0x22
and 0x23.
</Doc>
</Constraint>
</Constraints>
</DataType>
<DataType name="Frequency Value">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00000000"/>
<Constraint name="maxValue" type="integer" value="0xFFFFFFFF"/>
</Constraints>
</DataType>
</Struct>
</DataType>
</DataPoint>
<DataPoint name="Power Factor"
optional="true"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Power Factor</em> stores the ratio between real and apparent power.
</Doc>
<DataType>
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x00"/>
<Constraint name="maxValue" type="integer" value="0xFF"/>
</Constraints>
</DataType>
</DataPoint>
<DataPoint name="Report Interval"
optional="true"
writable="true"
readable="true"
eventable="true">
<Doc>
<em>Report Interval</em> stores the periodic time interval, in seconds,
at which the <em>Report</em> action should be sent. If set to 0 (zero)
the action will never be. It is mandatory if the referred action is
implemented.
</Doc>
<DataType unitOfMeasure="Seconds">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x0000"/>
<Constraint name="maxValue" type="integer" value="0xFFFF"/>
</Constraints>
</DataType>
</DataPoint>
</Data>
</ModuleClass>
<!-- Simple Power Metering Interface: CLIENT -->
<ModuleClass name="0x300 - Simple Power Metering Client Interface">
<Doc>
The <em>Simple Power Metering Client</em> interface enables a device to receive
measurements of electric quantities.
</Doc>
<Actions>
<Action name="Measurement Reset" optional="true">
<Doc>
This optional command sent to a server implementation of the Simple Power
Metering interface, performs the following operations:
* Copy Energy attribute present value into Energy at Last Reset attribute;
* Set Energy attribute to 0 (zero);
* Store device time into Time at Last Reset attribute.
Due to the nature of these operations, if this action is implemented then
<em>Energy at Last Reset</em> and <em>Time at Last Reset</em> must also be.
</Doc>
</Action>
</Actions>
</ModuleClass>
<!-- Simple Temperature Interface: SERVER -->
<ModuleClass name=" 0x301 - Simple Temperature Server Interface">
<Doc>
The <em>Simple Temperature Server</em> interface enables a device to be able to
provide temperature readings.
</Doc>
<Data>
<DataPoint name="Measured Temperature"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Measured Temperature</em> holds the current measured temperature,
in one hundredth (1/100) of Celsius degrees.
</Doc>
<DataType unitOfMeasure="One hundredth Celsius">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="-32768"/>
<Constraint name="maxValue" type="integer" value="+32767"/>
</Constraints>
</DataType>
</DataPoint>
<DataPoint name="Minimum Measureable Temperature"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Minimum Measureable Temperature</em> holds the minimum temperature,
in one hundredth (1/100) of Celsius degrees, that can be measured by the
device.
</Doc>
<DataType unitOfMeasure="One hundredth Celsius">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="-32768"/>
<Constraint name="maxValue" type="integer" value="+32767"/>
</Constraints>
</DataType>
</DataPoint>
<DataPoint name="Maximum Measureable Temperature"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Maximum Measureable Temperature</em> holds the maximum temperature,
in one hundredth (1/100) of Celsius degrees, that can be measured by the
device.
</Doc>
<DataType unitOfMeasure="One hundredth Celsius">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="-32768"/>
<Constraint name="maxValue" type="integer" value="+32767"/>
</Constraints>
</DataType>
</DataPoint>
<DataPoint name="Tolerance"
optional="false"
writable="false"
readable="true"
eventable="true">
<Doc>
<em>Tolerance</em> holds the magnitude, in one hundredth (1/100) of
Celsius degrees of the error associated with <em>Measured Temperature</em>,
which means the actual value is between
(<em>Measured Temperature</em> - <em>Tolerance</em>) and
(<em>Measured Temperature</em> + <em>Tolerance</em>).
</Doc>
<DataType unitOfMeasure="One hundredth Celsius">
<SimpleType type="integer"/>
<Constraints>
<Constraint name="minValue" type="integer" value="0x0000"/>
<Constraint name="maxValue" type="integer" value="0xFFFF"/>
</Constraints>
</DataType>
</DataPoint>
</Data>
</ModuleClass>
<!-- Simple Temperature Interface: CLIENT -->
<ModuleClass name="0x301 - Simple Temperature Client Interface">
<Doc>
The <em>Simple Temperature Client</em> interface enables a device to be able to
receive temperature readings.
</Doc>
</ModuleClass>
</Modules>
</Domain>