February, 2014
ZigBee-13-0638-01
1
2
3
Project
ZigBee Alliance
Title
ZigBee SE v1.2 0.7 Additional Changes
Date
Submitted
February 7th , 2014
Source
Sean
Gulliford Voice: +44.7718.475.580
SSWG ZigBee Alliance Members
E-mail:sean.gulliford@edmimeters.com
Re:
Technical Requirements Document (TRD)
Abstract
This document describes solutions and errata for additional changes identified
through the UK gap analysis and developed as part of the Blackwall project applied
to the ZigBee PRO Energy incremental release #2 (ZSE 1.2)
Purpose
The technical requirements defined in this document will result in a revision of the
ZigBee PRO Energy Profile specification.
Notice
This document has been prepared to assist the ZigBee Alliance. It is offered as a
basis for discussion and is not binding on the contributing individual(s) or
organization(s). The material in this document is subject to change in form and
content after further study. The contributor(s) reserve(s) the right to add, amend or
withdraw material contained herein.
Release
The contributor acknowledges and accepts that this contribution will be posted in
the member area of the ZigBee web site.
4
5
ZPE Blackwall Additional Changes
Page 1
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
6
Legal
Notice
Copyright © 2014 ZigBee Alliance, Inc. All rights Reserved. This information within this document
is the property of the ZigBee Alliance and its use and disclosure are restricted.
Elements of ZigBee Alliance specifications may be subject to third party intellectual property rights,
including without limitation, patent, copyright or trademark rights (such a third party may or may
not be a member of ZigBee). ZigBee is not responsible and shall not be held responsible in any
manner for identifying or failing to identify any or all such third party intellectual property rights.
This document and the information contained herein are provided on an “AS IS” basis and ZigBee
DISCLAIMS ALL WARRANTIES EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO (A) ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING WITHOUT LIMITATION ANY
INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT OR
TRADEMARK RIGHTS) OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT. IN NO EVENT
WILL ZIGBEE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF
USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER DIRECT, INDIRECT,
SPECIAL OR EXEMPLARY, INCIDENTIAL, PUNITIVE OR CONSEQUENTIAL DAMAGES
OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH LOSS OR DAMAGE. All Company, brand and product names may be trademarks that
are the sole property of their respective owners.
The above notice and this paragraph must be included on all copies of this document that are made.
ZigBee
2400
Camino
San Ramon, CA 94583
Alliance,
Ramon,
Suite
Inc.
375
7
ZPE Blackwall Additional Changes
Page 2
ZigBee PRO Energy Working Group
February, 2014
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
ZigBee-13-0638-01
Table of Contents
Table of Contents ............................................................................................................................ 3
List of Tables ................................................................................................................................... 4
List of Figures ................................................................................................................................. 5
Document History ........................................................................................................................... 6
1
Introduction ............................................................................................................................. 7
1.1 Blackwall project .............................................................................................................. 7
1.2 Scope ................................................................................................................................ 7
2
References ............................................................................................................................... 8
2.1 References ........................................................................................................................ 8
2.1.1 ZigBee Alliance documents ...................................................................................... 8
2.1.2 GB SMIP documents ................................................................................................. 8
3
Definitions ............................................................................................................................... 9
3.1 Conformance levels .......................................................................................................... 9
3.2 ZigBee acronyms and abbreviations................................................................................. 9
3.3 ZigBee Definitions ......................................................................................................... 10
3.4 GB SMIP and other acronyms and abbreviations .......................................................... 10
3.5 GB SMIP definitions ...................................................................................................... 11
4
Required Changes ................................................................................................................. 13
4.1 Snapshots ........................................................................................................................ 13
4.1.1 Required Changes ................................................................................................... 13
4.2 PublishTopupLog ........................................................................................................... 15
4.2.1 Required Changes ................................................................................................... 15
4.3 Supplier Contact Telephone Number ............................................................................. 16
4.3.1 Required Changes ................................................................................................... 16
4.4 Customer Identification Number .................................................................................... 18
4.4.1 Required Changes ................................................................................................... 18
4.5 Maximum Credit per Vend Threshold............................................................................ 21
4.5.1 Required Changes ................................................................................................... 21
4.6 Axillary Switch Labels ................................................................................................... 24
4.6.1 Required Changes ................................................................................................... 24
AuxSwitchNLabel Attributes ................................................................................................ 25
4.7 Power Threshold Clarification........................................................................................ 25
4.7.1 Required Changes ................................................................................................... 25
ZPE Blackwall Additional Changes
Page 3
ZigBee PRO Energy Working Group
February, 2014
42
43
44
ZigBee-13-0638-01
List of Tables
Table 1-1 – Document Revision Change History............................................................................ 6
ZPE Blackwall Additional Changes
Page 4
ZigBee PRO Energy Working Group
February, 2014
45
46
ZigBee-13-0638-01
List of Figures
No table of figures entries found.
ZPE Blackwall Additional Changes
Page 5
ZigBee PRO Energy Working Group
February, 2014
47
48
49
50
51
ZigBee-13-0638-01
Document History
Table 1.1 shows the change history for this specification.
Table 1-1 – Document Revision Change History
Revision
00
00
Version
0.1
0.2
Description
Initial document for discussion
Remove changes suggested in section 4.7 as these have been addressed
through comments raised at the test events.
52
53
ZPE Blackwall Additional Changes
Page 6
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
54
1 Introduction
55
1.1 Blackwall project
56
57
The Blackwall project is the project to deliver errata text for the ZigBee PRO Energy Specification
(12-0517) that meets the requirements laid out in the related TRD [TRD].
58
1.2 Scope
59
60
61
This document is a working document of the ZigBee PRO Energy Blackwall project and delivers
errata text specifically regarding the additional changes identified through Gap analysis of the UK
requirements and 12-0517-09.
ZPE Blackwall Additional Changes
Page 7
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
62
2 References
63
2.1 References
64
65
66
67
68
69
The following standards and specifications contain provisions, which through reference in this
document constitute provisions of this specification. All the standards and specifications listed
are normative references. At the time of publication, the editions indicated were valid. All
standards and specifications are subject to revision, and parties to agreements based on this
specification are encouraged to investigate the possibility of applying the most recent editions of
the standards and specifications indicated below.
70
71
72
73
74
2.1.1 ZigBee Alliance documents
75
76
77
78
79
80
2.1.2 GB SMIP documents
[ZCL] ZigBee document 07-5123-04, ZigBee Cluster Library Specification
[ZSE1.2] 12-0517-09 ZigBee Smart Energy 1.2 0.7 Draft Specification
[SMETS] SMIP Smart Metering Equipment Technical Specification Version 21
[CHTS Ver 1.2 16th April 2013 (Draft)] 2
1
2
https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/68898/smart_meters_equipment_technical_spec_version_2.pdf
Not yet released
ZPE Blackwall Additional Changes
Page 8
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
81
3 Definitions
82
3.1 Conformance levels
83
84
85
86
87
88
89
90
91
92
93
94
95
96
Expected: A key word used to describe the behavior of the hardware or software in the design
models assumed by this Standard. Other hardware and software design models may also be
implemented.
97
3.2 ZigBee acronyms and abbreviations
May: A key word indicating a course of action permissible within the limits of the standard (“may”
equals “is permitted”).
Shall: A key word indicating mandatory requirements to be strictly followed in order to conform
to the standard; deviations from shall are prohibited (“shall” equals “is required to”).
Should: A key word indicating that, among several possibilities, one is recommended as
particularly suitable, without mentioning or excluding others; that a certain course of action is
preferred but not necessarily required; or, that (in the negative form) a certain course of action
is deprecated but not prohibited (“should” equals “is recommended that”).
98
AES
AMI
BOMD
CA
ECDSA
ECMQV
EPID
ESI
EUI64
HA
HAN
HHT
IHD
MAC
MAC
MRD
NAN
PAN
Advanced Encryption Standard
Advanced Metering Infrastructure or Advanced Metering
InitiativeOperated Mirrored Device
Battery
Certificate Authority
Elliptic Curve Digital Signature Algorithm
Elliptic Curve Menezes-Qu-Vanstone
Extended PAN Identifier
Energy Service Interface
Extended Universal Identifier-64
Home Automation
Home Area Network
Hand Held Terminal
In-Home Display
Medium Access Control (referring to protocol stack) sub
layer)
Message Authentication Code (referring to
cryptographic operation)
Market Requirements Document
Neighborhood Area Network
Personal Area Network
ZPE Blackwall Additional Changes
Page 9
ZigBee PRO Energy Working Group
February, 2014
SE
TC
ZCL
ZDO
ZDP
99
ZigBee-13-0638-01
Smart Energy
Trust Center
ZigBee Cluster Library
ZigBee Device Objects (refer to [B3])
ZigBee Device Profile
3.3 ZigBee Definitions
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
Attribute: A data entity which represents a physical quantity or state. This data is communicated
to other devices using commands.
133
3.4 GB SMIP and other acronyms and abbreviations
Cluster: A container for one or more attributes and/or messages in a command structure.
Cluster identifier: A reference to the unique enumeration of clusters within a specific
application profile. The cluster identifier is a 16-bit number unique within the scope of the
application profile and identifies a specific cluster. Cluster identifiers are designated as inputs
or outputs in the simple descriptor for use in creating a binding table.
Device: A description of a specific device within an application profile. For example, the light
sensor device description is a member of the home automation application profile. The device
description also has a unique identifier that is exchanged as part of the discovery process.
Node: Same as a unit.
Product: A product is a unit that is intended to be marketed. It implements application profiles
that may be a combination of private, published, and standard.
Service discovery: The ability of a device to locate services of interest.
Unit: A unit consists of one or more physical objects (e.g., switch, controller, etc.) and their
corresponding application profile(s) that share a single 802.15.4 radio. Each unit has a unique 64bit IEEE address.
ZigBee coordinator: An IEEE 802.15.4-2003 PAN coordinator.
ZigBee end device: an IEEE 802.15.4-2003 RFD or FFD participating in a ZigBee network,
which is neither the ZigBee coordinator nor a ZigBee router.
ZigBee router: an IEEE 802.15.4-2003 FFD participating in a ZigBee network, which is not the
ZigBee coordinator but may act as an IEEE 802.15.4-2003 coordinator within its personal
operating space, that is capable of routing messages between devices and supporting associations.
134
CH
CHTS
Communications Hub
Communications Hub Technical Specification
ZPE Blackwall Additional Changes
Page 10
ZigBee PRO Energy Working Group
February, 2014
E2E
ESME
GB
GSME
HCALCS
NIC
PPMID
SMETS
SMIP
WAN
ZigBee-13-0638-01
End-to-end
Electricity Smart Metering Equipment
Great Britain
Gas Smart Metering Equipment
HAN-Connected Auxiliary Load Control Switch
Network Interface Controller
Prepayment Interface Device
Smart Metering Equipment Technical Specification
Smart Metering Implementation Programme
Wide area network
135
3.5 GB SMIP definitions
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
Comms Hub (CH): The CH is a communications device that connects E2E HAN Devices with a
Remote Party over the WAN. In addition to its own function, the CH also contains a Gas Proxy,
a ZigBee Coordinator and a ZigBee Trust Center.
Electricity Smart Metering Equipment (ESME): An ESME is an electricity meter with a HAN
interface, which measures, stores and displays consumption (and production) of electrical energy
in premises. There may be more than one ESME in premises however there is one ESME in typical
domestic premises.
End-to-end (E2E) HAN Device: An E2E HAN Device is a device in communication with a
Remote Party. An E2E HAN Device can be an electricity meter, a gas meter, a CH, a load control
switch and a prepayment terminal device.
Gas Proxy: A Gas Proxy is a virtual device that resides on the CH. It acts as a proxy for the gas
meter by synchronizing data (through the mirror functionality) provided at relatively infrequent
intervals by the gas meter and making the data readily available (through the gas ESI functionality)
for other HAN devices requesting information, e.g. IHD or CAD.
Gas Smart Metering Equipment (GSME): A GSME is a gas meter with a HAN interface, which
measures, stores and displays consumption of gas volume in premises. There is one GSME in a
typical domestic premises. A GSME may be battery powered and therefore may only communicate
infrequently with the Gas Proxy for short periods of time
HAN-Connected Auxiliary Load Control Switch (HCALCS): An HCALCS is a HANconnected auxiliary load control switch, which can be used for controlling load on appliances. In
ZSE, it is known as a “load control device”.
ZPE Blackwall Additional Changes
Page 11
ZigBee PRO Energy Working Group
February, 2014
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
ZigBee-13-0638-01
Prepayment Interface Device (PPMID): A PPMID is a Type 1 Device which enables local entry
of top-up data and re-arming a supply. In ZSE, it is known as a “prepayment terminal device”.
Remote Party: Any party remote from the HAN communicating through the WAN that can
perform end-to-end communication with an E2E HAN Device.
Smart Metering Device: A Smart Metering Device is a device in the GB HAN and can be an
IHD, CH (including Gas Proxy), HCALCS, PPMID, ESME or GSME.
Type 1 Device: This is the GB-specific term used for a Smart Metering Device which can issue
commands to GSME or ESME, e.g. a top up command. A PPMID is an example of a Type 1
Device.
Type 2 Device: This is the GB-specific term used for a Smart Metering Device which can only
issue data read requests to Gas Proxy or ESME and is not able to issue any commands to Gas
Proxy, GSME or ESME. A Type 2 Device does not generate or receive Remote Party messages.
An IHD is an example of a Type 2 Device.
Wide Area Network (WAN): The WAN is the network which connects a CH and other Remote
Parties. In other jurisdictions, it is also known as the AMI network
Unit: A unit consists of one or more physical objects (e.g., switch, controller, etc.) and their
corresponding application profile(s) that share a single 802.15.4 radio. Each unit has a unique 64bit IEEE address.
ZPE Blackwall Additional Changes
Page 12
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
186
187
4 Required Changes
188
4.1 Snapshots
189
190
191
192
193
The commands GetSnapshot [ZSE1.2] D.3.3.3.1.7 and GetPrepaySnapshot [ZSE1.2] D.7.2.3.8
require that an “end time” field be added to the command to allow a range to be specified when
requesting snapshots. This change is required to satisfy the use case where a previous supplier
wishes to retrieve snapshots from the smart metering system relating to that suppliers contract
period.
194
195
196
197
198
199
200
4.1.1 Required Changes
201
202
This command is used to request snapshot data from the cluster server. See section Error!
Reference source not found. for further details.
203
4.1.1.1.1 Payload Format
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
--------------------------------------------------------------------------------------------------------------------4.1.1.1 GetSnapshot Command
Octets
Data Type
204
4
UTC Time
4
UTC Time
1
4
Unsigned 8-bit 32-bit BitMap
Integer
Field Name Start Time (M) End Time (M)
Snapshot Offset Snapshot
Cause
(M)
(M)
Figure Error! No text of specified style in document.-1– GetSnapshot Command Payload
205
4.1.1.2 Payload Details
206
207
208
Start Time (mandatory): A UTC Timestamp indicating the earliest start time of a snapshot to be
returned by a corresponding Publish Snapshot command. Snapshots with a time stamp equal to or
greater than the specified Start Time shall be returned.
209
210
211
End time (Mandatory): A UTC Timestamp indicating the latest end time of a snapshot to be
returned by a corresponding Publish Snapshot command. Snapshots with a time stamp equal to or
less than the specified End Time shall be returned.
212
213
214
215
Snapshot Offset (mandatory): Where multiple snapshots satisfy the selection criteria specified
by the other fields in this command, this field identifies the individual snapshot to be returned. An
offset of zero (0x00) indicates that the first snapshot satisfying the selection criteria should be
returned, 0x01 the second, and so on.
ZPE Blackwall Additional Changes
Page 13
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
216
217
218
Snapshot Cause (mandatory): This field is used to select only snapshots that were taken due to
a specific cause. The allowed values are listed in Error! Reference source not found.. Setting the
type to 0xFFFFFFFF indicates that all snapshots should be selected, irrespective of the cause.
219
4.1.1.3 Effect on Receipt
220
221
On receipt of this command the server will respond with the appropriate data as detailed in subclause Error! Reference source not found..
222
--------------------------------------------------------------------------------------------------------------------
223
4.1.1.4 Get Prepay Snapshot Command
224
This command is used to request the Prepayment cluster server for snapshot data.
225
4.1.1.4.1 Payload Format
226
4
Octets
4
1
4
UTC
UTC
Unsigned 8-bit
Data
32-bit BitMap
Time
Time
Integer
Type
Start
End
Snapshot
Field
Snapshot Cause (M)
Time (M) Time (M) Offset (M)
Name
Figure Error! No text of specified style in document.-2– Get Prepay Snapshot Command Payload
227
4.1.1.4.2 Payload Details
228
229
230
Start Time (mandatory): A UTC Timestamp indicating the earliest start time of a snapshot to be
returned by a corresponding PublishPrepaySnapshot command. Snapshots with a time stamp equal
to or greater than the specified Start Time shall be returned.
231
232
233
End time (Mandatory): A UTC Timestamp indicating the latest end time of a snapshot to be
returned by a corresponding PublishPrepaySnapshot command. Snapshots with a time stamp equal
to or less than the specified End Time shall be returned.
234
235
236
237
Snapshot Offset (mandatory): Where multiple snapshots satisfy the selection criteria specified
by the other fields in this command, this field identifies the individual snapshot to be returned. An
offset of zero (0x00) indicates that the first snapshot satisfying the selection criteria should be
returned, 0x01 the second, and so on.
238
239
240
Snapshot Cause (mandatory): This field is used to request only snapshots for a specific cause.
The allowable values are listed in Error! Reference source not found.. Setting the type to
0xFFFFFFFF indicates that all snapshots should be transmitted, irrespective of the cause.
241
242
243
4.1.1.4.3 Effect on Receipt
On receipt of this command, the server will respond with the appropriate data as detailed in subclause Error! Reference source not found..
244
-------------------------------------------------------------------------------------------------------------------ZPE Blackwall Additional Changes
Page 14
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
245
4.2 PublishTopupLog
246
247
248
249
The publishTopup log command [ZSE1.2] D.7.2.4.6 is to be updated to include a timestamp for
each top-up returned, this is a requirement specified in [SMETS].
250
251
252
253
254
4.2.1 Required Changes
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
--------------------------------------------------------------------------------------------------------------------
255
256
4.2.1.1 PublishTopUpLog Command
257
258
This command is used to send the Top Up Code Log entries to the client. They are sent most recent
entry first.
259
4.2.1.1.1 Payload Format
260
Octets
1
1
xx
Unsigned 8 –bit Integer
Unsigned 8 –bit Integer
Data Type
Total Number of Commands (M) Top Up Payload
Field Name Command Index (M)
Figure Error! No text of specified style in document.-3– Publish Top Up Log Command Payload
261
262
263
264
265
4.2.1.1.2 Payload Details
Command Index (mandatory): The Command Index is used to count the payload fragments in
the case where the entire payload does not fit into one message. The Command Index starts at 0
and is incremented for each fragment belonging to the same command. A value of 0xFE in the
Command Index states that this is the last expected command.
266
267
268
Total Number of Commands (mandatory): In the case that an entire payload does not fit into
one message, the Total Number of Commands field indicates the total number of sub-commands
in the message.
269
4.2.1.1.2.1 Top Up Payload Details
Octets
Data
Type
Field
Name
270
4
4
4
1..26
4
1..26
4
UTC
UTC
Signed
Signed
Octet
Octet
Octet
Signed 32Time
Time
32-bit
32-bit
String
String
String
bit Integer
Integer
Integer
TopUp TopUp TopUp
TopUp TopUp TopUp
TopUp
TopUp
Code
Amount Time
Code
Amount Time
Code
Amount +
(M)
(M)
+1 (M) + 1 (M)
+n (M) n (M)
Figure Error! No text of specified style in document.-4– Top Up Code Payload
1..26
ZPE Blackwall Additional Changes
Page 15
4
UTC Time
TopUp
Time
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
271
TopUp Code (mandatory): This is the value of the Top Up code stored in the log.
272
273
TopUp Amount (mandatory): This is the amount of credit that was added to the Metering Device
during this Top Up.
274
TopUp Time (mandatory): The time the topup was applied at the meter in UTC time format.
275
--------------------------------------------------------------------------------------------------------------------
276
4.3 Supplier Contact Telephone Number
277
278
279
280
281
Additional attributes are required in the Supplier Attribute Set (D.10.3.2.1) to hold the Suppliers contact
telephone number . These are defined as informational items in [SMETS] to be stored on the Meter and
displayed via its user interface.
282
283
284
285
286
287
288
289
290
291
292
4.3.1 Required Changes
293
294
4.3.1.1 Supplier Attribute Set
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
Note: the changes detailed below are based on the fact that this attribute set currently exists as
part of the Device Management client attribute set which shall reside on the meter, however recent
changes to the specification due to comments raised during the ballot indicate that this set is likely
to be moved to the Metering cluster and so will be moved to the server side of the cluster. This
document references [ZSE1.2] prior to these changes being made.
--------------------------------------------------------------------------------------------------------------------
Table Error! No text of specified style in document.-2– Supplier Attribute Sets
Attribute
Identifier
Name
Type
Range
Access
0x0000
ProviderID
Unsigned
32bit Integer
0x00000000 –
0xFFFFFFFF
0x0001
ProviderTelephone
Octet string
1 to 20 Octets
Read
only
Read
only
0x0002 –
0x000F
Reserved
0x0010
ReceivedProvider ID
Unsigned
32bit Integer
0x00000000 –
0xFFFFFFFF
0x0011
RecievedProviderTele
phone
Octet string
1 to 20 Octets
ZPE Blackwall Additional Changes
Page 16
Read
only
Read
only
Default
Mandator
y
/
Optional
-
O
-
O
-
O
-
O
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
0x0012 –
0x001F
Reserved
0x0020
SupplyTamperState
Boolean
0x0021
SupplyDepletionState
Boolean
0x0022
SupplyUncontrolled
FlowState
Boolean
0x0023 –
0x00FF
Reserved
Read
only
Read
only
Read
only
0x00
O
0x00
O
0x00
O
295
296
297
298
4.3.1.1.1 ProviderID Attribute
An unsigned 32 bit field containing a unique identifier for the commodity provider to whom this
attribute relates.
299
300
301
302
4.3.1.1.2 ProviderTelephone Attribute
The ProviderTelephone is a ZCL Octet string capable of storing a 19 character string (the first octet
indicates length) encoded in UTF-8 format. It holds the contact telephone number of the current
Provider delivering to the premises.
303
304
305
4.3.1.1.3 ReceivedProviderID Attribute
An unsigned 32 bit field containing a unique identifier for the commodity provider to whom this
attribute relates. This attribute is only for the Received supply.
306
307
308
309
4.3.1.1.4 ReceivedProviderTelephone Attribute
The RecievedProviderTelephone is a ZCL Octet string capable of storing a 19 character string (the
first octet indicates length) encoded in UTF-8 format. It holds the contact telephone number of the
current Provider receiving from the premises.
310
4.3.1.2 Publish Change of Supplier Command
311
312
313
314
315
This command is used to change the Supplier (commodity provider) that is supplying the property.
This command shall only be used if there is a requirement for the ProviderID to be a static value
within the Prepayment and Price clusters. Should there be a requirement for the ProviderID to be
dynamic, this command and the associated attributes should not be used. It is recommended that
this command is sent at least one week before the proposed date of change.
316
4.3.1.2.1 Payload Format
Octets
Data
Type
4
4
1
4
4
4
1 - 16
1-20
Unsigned
32
bit
Integer
Unsigned
32
bit
Integer
8 bit
Bitmap
Unsigned
32-bit
Integer
UTC Time
32-Bit
BitMap
Octet
String
Octet
String
ZPE Blackwall Additional Changes
Page 17
ZigBee PRO Energy Working Group
February, 2014
Current
Field
Provider
Name
ID (M)
ZigBee-13-0638-01
Issuer
Event ID
(M)
Tariff
Type
(M)
Proposed
Provider
ID (M)
Provider
Change
Implementation
Time (M)
Provider
Change
Control
(M)
Proposed
Provider
Name
(M)
Proposed
Provider
Telephone
(M)
317
Figure Error! No text of specified style in document.-5– Publish Change of Supplier Command Payload
318
319
320
321
4.3.1.2.2 Payload Details
ProposedProviderTelephone: a ZCL Octet string capable of storing a 19 character string (the first
octet indicates length) encoded in UTF-8 format. It holds the contact telephone number of the
proposed Provider delivering to the premises.
322
--------------------------------------------------------------------------------------------------------------------
323
4.4 Customer Identification Number
324
325
326
327
The Customer identification number is defined in [SMETS] as a “A number used to verify that an
individual requesting a service is present in the Consumer Premises” It may be issued to a Meter
for display on the Meter’s UI and/or via an IHD.
328
329
330
331
332
333
334
335
4.4.1 Required Changes
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
Table Error! No text of specified style in document.-3– Formatting Attribute Set
Man./
Range
Identifier Name
Type
Access
Default Opt.
0x0300
UnitofMeasure
8-bit
Enumeration
0x0301
Multiplier
0x0302
0x00
M
Unsigned 24- 0x00000 Read
bit Integer
0 to
Only
0xFFFFFF
-
O
Divisor
Unsigned 24- 0x00000 Read
bit Integer
0 to
Only
0xFFFFFF
-
O
0x0303
SummationFormatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
M
0x0304
DemandFormatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
O
0x0305
HistoricalConsumption
Formatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
O
ZPE Blackwall Additional Changes
0x00 to
0xFF
Page 18
Read
Only
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
0x0306
MeteringDeviceType
8-bit BitMap
0x00 to
0xFF
Read
Only
-
M
0x0307
SiteID
Octet String
1 to 33
Octets
Read
only
-
O
0x0308
MeterSerialNumber
Octet String
1 to 25
Octets
Read
only
-
O
0x0309
EnergyCarrierUnit
OfMeasure
8-bit
Enumeration
0x00 to
0xFF
Read
Only
-
M:Heat
M:Cooling
O:others
0x030A
EnergyCarrier
SummationFormatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
0x030B
EnergyCarrier
DemandFormatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
M:Heat
M:Cooling
O:others
O
0x030C
TemperatureUnit
OfMeasure
8-bit
Enumeration
0x00 to
0xFF
Read
Only
-
M:Heat
M:Cooling
O:others
0x030D
TemperatureFormatting
8-bit BitMap
0x00 to
0xFF
Read
Only
-
M:Heat
M:Cooling
O:others
0x030E
ModuleSerialNumber
Octet String
1 to 25
Octets
Read
only
-
O
0x030F
OperatingTariffLabel
Delivered
Octet String
1 to 25
Octets
Read
only
-
O
0x0310
OperatingTariffLabel
Received
Octet String
1 to 25
Octets
Read
only
-
O
0x0311
CustomerIDNumber
Octet String
1 to 7
Octets
Read
only
-
O
0x0312 to Reserved
0x03FF
336
337
4.4.1.1 CustomerIDNumber Attribute
338
339
340
The MeterSerialNumber is a ZCL Octet String field capable of storing a 6 character string
(the first Octet indicates length) encoded in UTF-8 format. It is used to provide a unique customer
identification which may be used to confirm the customer is at the premises.
341
A new command is required to allow the Customer Id number to be set.
342
4.4.1.2 UpdateCIN Command
343
This command is used to set the CustomerIDNumber attribute on a meter.
344
4.4.1.2.1 Payload Format
ZPE Blackwall Additional Changes
Page 19
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
Octets
4
4
1-7
Data
Type
Unsigned 32
bit Integer
Unsigned 32
bit Integer
Octet String
Field
Name
Issuer Event
ID (M)
Provider ID
(M)
CustomerIDNumber
(M)
345
Figure Error! No text of specified style in document.-6– Update SiteID Command Payload
346
347
348
349
350
351
352
4.4.1.2.2 Payload Details
Issuer Event ID (mandatory): Unique identifier generated by the commodity provider. When
new information is provided that replaces older information for the same time period, this field
allows devices to determine which information is newer. The value contained in this field is a
unique number managed by upstream servers or a UTC based time stamp (UTCTime data type)
identifying when the Publish command was issued. Thus, newer information will have a value in
the Issuer Event ID field that is larger than older information.
353
354
Provider ID: An unsigned 32-bit field containing a unique identifier for the commodity provider
to whom this command relates.
355
CustomerIDNumber (mandatory): An octet string that denotes the Site ID.
356
357
358
359
360
361
362
4.4.1.2.3 Effect on Receipt
Upon receipt of this command the meter shall update the CustomerIDNumber attribute and return
a ZCL response indicating SUCCESS.
363
364
365
366
367
368
369
4.4.1.2.4 Associated changes due to the addition of the UpdateCIN command
A ZCL response, indicating NOT_AUTHORIZED shall be returned if the providerId contained
within the command does not match the current provider ID. For all other failures a ZCL response
indicating FAILURE shall be returned.



Table D-61 to be update to include the new command and ID (0x0B)
Table Error! No text of specified style in document.-4– Metering Event Configuration Attribute
Set to be updated to include event configurations for this new command
Notification Flags update to include this command.
370
371
372
ZPE Blackwall Additional Changes
Page 20
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
373
4.5 Maximum Credit per Vend Threshold
374
375
376
377
378
Maximum credit threshold per Vend is not supported by the Prepayment Information Attribute Set
[ZSE1.2] D.7.2.2.1, this is defined in [SMETS] as, “The maximum credit which can be applied by
any Add Credit Command”
379
380
381
382
383
384
4.5.1 Required Changes
385
4.5.1.1 Prepayment Information Attribute Set
386
387
The following set of attributes provides access to the standard information relating to a Prepayment
meter.
388
Table Error! No text of specified style in document.-5– Prepayment Information Attribute Set
Mandatory
Identifier
Name
Type
Range
Access
Default / Optional
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
--------------------------------------------------------------------------------------------------------------------
0x0000
0x0001
0x0002
0x0003
0x0004
0x0005
0x0006
0x0007 –
0x000F
0x0010
Payment
Control
Configuration
Credit
Remaining
Emergency
Credit
Remaining
Credit
Status
16-bit 0x0000 to 0xFFFF Read only
Bitmap
M
Signed
32-bit
Integer
- 0x7FFFFFFF
To
+0x7FFFFFFF
Read only
-
O
Signed
32-bit
Integer
-0x7FFFFFFF
to
+0x7FFFFFFF
Read only
-
O
8-bit
Bitmap
0x00 to 0x40
Read only
0x00
O
Read only
-
O
-0x7FFFFFFF
To
+0x7FFFFFFF
-0x7FFFFFFF
To
+0x7FFFFFFF
Read only
-
O
Read only
-
O
0x00000000
to
0xFFFFFFFF
Read only
-
O
CreditRemaining UTCTime
TimeStamp
Accumulated
Signed
32-bit
Debt
Integer
OverallDebtCap Signed
32-bit
Integer
Reserved
EmergencyCredit Unsigned
32-bit
Limit/Allowance
Integer
ZPE Blackwall Additional Changes
0x0000
Page 21
ZigBee PRO Energy Working Group
February, 2014
0x0011
0x0012 –
0x001F
0x0020
0x0021
0x0022
0x0022 –
0x002F
0x0030
ZigBee-13-0638-01
Read only
-
O
TotalCreditAdded Unsigned 0x000000000000 Read only
48-bit
to
Integer 0xFFFFFFFFFFFF
Read only
MaxCreditLimit Unsigned
0x00000000
32-bit
to
Integer
0xFFFFFFFF
-
O
-
O
0x00000000
to
0xFFFFFFFF
Read only
-
O
EmergencyCredit Unsigned
32-bit
Threshold
Integer
Reserved
MaxCreditPerVend Unsigned
32-bit
Integer
0x00000000
to
0xFFFFFFFF
Reserved
FriendlyCredit
Warning
Unsigned
8-bit
Integer
0x00 to 0xFF
Read only
0x0A
O
0x0031
LowCredit
Warning
Unsigned
32-bit
Integer
0x00000000
to
0xFFFFFFFF
Read only
-
O
0x0032
IHDLow
CreditWarning
Unsigned
32-bit
Integer
0x00000000
to
0xFFFFFFFF
Read/
Write
-
O
InterruptSuspend Unsigned
Time
8-bit
Integer
0x00 to 0xFF
Read only
60
O
RemainingFriendly Unsigned 0x0000 to 0xFFFF Read only
CreditTime
16-bit
Integer
Read only
NextFriendly UTCTime
CreditPeriod
Reserved
-
O
-
O
0x0033
0x0034
0x0035
0x0036 –
0x003F
0x0040
0x0041 –
0x007F
0x0080
0x0081 –
0x00FF
CutOffValue
Signed
32-bit
Integer
-0x7FFFFFFF
to
+0x7FFFFFFF
Read only
-
O
Octet
String
1 to 21
Read/
Write
-
O
Reserved
TokenCarrierID
Reserved
ZPE Blackwall Additional Changes
Page 22
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
389
390
391
392
393
394
395
396
397
4.5.1.1.1 MaxCreditLimit Attribute
An unsigned 32-bit integer value indicating the maximum credit balance allowed on a meter. Any
further vend amount that will cause the meter to exceed this limit will be rejected. This can be
stated in currency (as per the Price cluster) or in units (unit of measure will be defined in the
Metering cluster) depending on the prepayment mode of operation defined in Table Error! No
text of specified style in document.-6– Payment Control Configuration Attribute
398
399
400
401
402
403
404
405
4.5.1.1.2 MaxCreditPerVend
An unsigned 32-bit integer value indicating the maximum credit per vend. Any single vend greater
than this threshold will cause the meter to reject the vend. This value can be stated in currency (as
per the Price cluster) or in units (unit of measure will be defined in the Metering cluster) depending
on the prepayment mode of operation defined in Table Error! No text of specified style in
document.-7– Payment Control Configuration Attribute
406
407
This command is sent from a client to the Prepayment server to set the maximum credit levels
allowed in the meter.
408
4.5.1.2.1 Payload Format
4.5.1.2 Set Maximum Credit Limit
Octets
4
4
4
4
Data
Type
Unsigned 32
bit Integer
Unsigned 32
bit Integer
UTC Time
Unsigned 32bit Integer
4
Unsigned 32bit Integer
409
Maximum
Credit
Per
Vend
Figure Error! No text of specified style in document.-7– Set Maximum Credit Level Command Payload
410
411
412
4.5.1.2.2 Payload Details
Provider ID (mandatory): An unsigned 32 bit field containing a unique identifier for the
commodity supplier to whom this command relates.
413
414
415
416
417
418
Issuer Event ID (mandatory): Unique identifier generated by the commodity provider. When
new information is provided that replaces older information for the same time period, this field
allows devices to determine which information is newer. The value contained in this field is a
unique number managed by upstream servers or a UTC based time stamp (UTCTime data type)
identifying when the command was issued. Thus, newer information will have a value in the Issuer
Event ID field that is larger than older information.
Field
Name
Provider ID
(M)
Issuer Event
ID (M)
ZPE Blackwall Additional Changes
Implementation
Date/Time (M)
Page 23
Maximum
Credit Level
ZigBee PRO Energy Working Group
February, 2014
ZigBee-13-0638-01
419
420
421
422
423
Implementation Date/Time (mandatory): A UTC Time field to indicate the date from which the
maximum credit level is to be applied. An Implementation Date/Time of 0x00000000 shall indicate
that the command should be executed immediately. An Implementation Date/Time of
0xFFFFFFFF shall cause an existing but pending Set Maximum Credit Limit command to be
cancelled.
424
425
426
427
428
429
430
Maximum Credit Level: An unsigned 32-bit integer value indicating the maximum credit balance
allowed on a meter. Any further vend amount that will cause the meter to exceed this limit will be
rejected. This can be stated in currency (as per the Price cluster) or in units (unit of measure will
be defined in the Metering cluster) depending on the prepayment mode of operation defined in
Table Error! No text of specified style in document.-8– Payment Control Configuration
Attribute
.
431
432
433
434
435
436
437
MaximumCreditPerVend: An unsigned 32-bit integer value indicating the maximum credit per
vend. Any single vend greater than this threshold will cause the meter to reject the vend. This value
can be stated in currency (as per the Price cluster) or in units (unit of measure will be defined in
the Metering cluster) depending on the prepayment mode of operation defined in Table Error! No
text of specified style in document.-9– Payment Control Configuration Attribute
438
4.6 Axillary Switch Labels
439
440
441
442
443
The Auxiliary switch labels [ZSE1.2] D.9.2.2.1 are required to be increased in size from 13 to 23
octets in order to hold the labels to be used in the UK market, two examples are “Economy 7
Heating”, and “Economy 7 Hot water” .
444
445
446
447
448
449
450
451
--------------------------------------------------------------------------------------------------------------------
4.6.1 Required Changes
This section details the changes required to the ZigBee specification based on the relevant
excerpt(s) from [ZSE1.2].
-------------------------------------------------------------------------------------------------------------------4.6.1.1 Auxiliary Switch Label Attribute Set
Table Error! No text of specified style in document.-10– Auxiliary Switch Label Attribute Set
Attribute
Identifier
Name
Type
Range
Access
Default
Mandatory /
Optional
0x0000
AuxSwitch1Labe
l
Octet
String
1 to 23
Octets
Read/ Write
“Auxiliary 1”
O
ZPE Blackwall Additional Changes
Page 24
ZigBee PRO Energy Working Group
February, 2014
AuxSwitch2Labe
l
AuxSwitch3Labe
l
AuxSwitch4Labe
l
AuxSwitch5Labe
l
AuxSwitch6Labe
l
AuxSwitch7Labe
l
AuxSwitch8Labe
l
0x0001
0x0002
0x0003
0x0004
0x0005
0x0006
0x0007
0x0008
0x00FF
–
ZigBee-13-0638-01
Octet
String
Octet
String
Octet
String
Octet
String
Octet
String
Octet
String
Octet
String
1 to 23
Octets
1 to 23
Octets
1 to 23
Octets
1 to 23
Octets
1 to 23
Octets
1 to 23
Octets
1 to 23
Octets
Read/ Write
“Auxiliary 2”
O
Read/ Write
“Auxiliary 3”
O
Read/ Write
“Auxiliary 4”
O
Read/ Write
“Auxiliary 5”
O
Read/ Write
“Auxiliary 6”
O
Read/ Write
“Auxiliary 7”
O
Read/ Write
“Auxiliary 8”
O
Reserved
452
453
AuxSwitchNLabel Attributes
454
455
456
457
The AuxSwitchNLabel attributes provide a method for assigning a label to an Auxiliary Switch.
The AuxSwitchNLabel attributes are ZCL Octet String fields capable of storing 22 character strings
(the first Octet indicates length) encoded in the UTF-8 format.
--------------------------------------------------------------------------------------------------------------------
458
459
460
461
462
463
464
465
466
468
4.7 Power Threshold Clarification
The attributes LowMediumThreshold [ZSE1.2] D.10.2.2.5.1 and MediumHighThreshold [ZSE1.2]
D.10.2.2.5.2 do not have explicit definitions of units in [ZSE1.2], This is a minor issue and is only
captured here for completeness.
This issue has been dealt with under comments #TE4-11 and #TE4-12 (See 13-0546 for details)
and will be added to the SE 1.2 Draft Specification 12-0517-11.
ZPE Blackwall Additional Changes
Page 25
ZigBee PRO Energy Working Group