Ubisys S1 User manual

u
ZIGBEE POWER SWITCH S1(-R)
REFERENCE MANUAL


2 www.ubisys.de
u
1. OVERVIEW
Thank you for purchasing he ubisys power swi ch S1, a ZigBee load swi ch wi h in egra ed smar
me er, also known as Smar Power Ou le .
You have decided for a high-quali y produc wi h firs -ra e suppor !
This reference manual provides opera ing and main enance ins ruc ions, in erface specifica ions,
command references and more. I is primarily in ended for sys em in egra ors, no end-users.
An ins alla ion guide specific o your region is available as a separa e documen and is included in
prin ed form in he produc package.
If you have any ques ions or need addi ional suppor , please visi he suppor pages ha bes fi your
background:
If you are a consumer (priva e household) or ins aller, please visi he Smar Home suppor pages a
h p://www.ubisys.de/en/smar home/suppor .h ml for con ac de ails.
As a commercial cus omer, please visi he Engineering suppor pages a
h p://www.ubisys.de/en/engineering/suppor .h ml for con ac de ails.
Copyrigh © 2014-2021 ubisys echnologies GmbH, Düsseldorf, Germany.
All righ s reserved.

3 www.ubisys.de
u
2. CONTENTS
1. Overview 2
2. Con en s 3
3. Fea ures 5
4. InsIns alla ion 6
4.1. Mains Powered Opera ion 6
4.2. Low-Vol age Opera ion (Main enance and Early Sys em In egra ion S ages only) 6
5. Ini ial Device S ar -up 7
6. Man-Machine In erface (MMI) 8
6.1. Power-Cycle Sequencing Fac ory Rese 9
7. ZigBee In erface 10
7.1. Applica ion Endpoin #0 (S1/S1-R) – ZigBee Device Objec 13
7.2. Applica ion Endpoin #1 (S1/S1-R) – Mains Power Ou le 14
7.2.1. Basic Clus er (Server) 14
7.2.2. Iden ify Clus er (Server) 14
7.2.3. Groups Clus er (Server) 15
7.2.4. Scenes Clus er (Server) 15
7.2.5. On/off Clus er (Server) 16
7.3. Applica ion Endpoin #2 (S1/S1-R) – Primary Level Con rol Swi ch 18
7.3.1. Basic Clus er (Server) 18
7.3.2. Iden ify Clus er (Server) 18
7.3.3. Scenes Clus er (Clien ) 18
7.3.4. On/off Clus er (Clien ) 19
7.3.5. Level Con rol Clus er (Clien ) 19
7.4. Applica ion Endpoin #3 (S1-R) – Secondary Level Con rol Swi ch 20
7.4.1. Basic Clus er (Server) 20
7.4.2. Iden ify Clus er (Server) 20
7.4.3. Scenes Clus er (Clien ) 20
7.4.4. On/off Clus er (Clien ) 21
7.4.5. Level Con rol Clus er (Clien ) 21
7.5. Applica ion Endpoin #3 (S1) – Me ering 22
7.6. Applica ion Endpoin #4 (S1-R) – Me ering 22
7.6.1. Basic Clus er (Server) 22

4 www.ubisys.de
u
7.6.2. Me ering Clus er (Server) 22
7.6.3. Elec rical Measuremen Clus er (Server) 23
7.7. Applica ion Endpoin #232 (S1/S1-R) – Device Managemen 24
7.7.1. Basic Clus er (Server) 24
7.7.2. Iden ify Clus er (Clien ) 25
7.7.3. Commissioning Clus er (Server) 25
7.7.4. Over- he-Air Upgrade Clus er (Clien ) 25
7.7.5. Device Se up Clus er (Server) 25
7.8. Applica ion Endpoin #242 – ZigBee Green Power 30
7.8.1. Green Power Clus er (Server) 30
7.8.2. Green Power Clus er (Clien ) 31
8. Physical Dimensions 35
9. Ordering Informa ion 36
10. General Terms & Condi ions of Business 37
11. Declara ion of Conformi y 38
12. Revision His ory 39
13. Con ac 40

5 www.ubisys.de
u
3. FEATURES
- ZigBee 3.0 Cer ified Load Swi ch wi h In egra ed Smar Me er and ZigBee Rou er func ionali y
- Smar Mains Power Ou le for 230V~, 16A, 3.680VA
- S1: One configurable 230V~ inpu , pre-configured for opera ing he ou pu locally
S1-R: Two configurable 230V~ inpu s, one pre-configured for opera ing he ou pu locally
Individually reconfigurable as on/off, level con rol, and scene selec or swi ches for use wi h momen ary or
s a ionary swi ches
- Local con rol even works when he device is no joined o a ne work (no commissioned ye )
- Suppor s groups, scenes, bindings, and repor ing
- Reliable, una ended, main enance-free opera ion;
S1 designed for in-wall flush-moun ing,
S1-R designed for DIN rail moun ing (fuse cabine )
- Employs a la ching relay wi h mains synchronized swi ching for highes efficiency and durabili y
- Main ains he ou pu swi ching s a e even during a reboo (for example af er a firmware upda e). Hence,
can be used for cri ical loads, such as servers, e c.
- Made in Germany using high-quali y, enduring par s for many years of life expec ancy
- Low power dissipa ion: 0.3W
- On-board MCU: Advanced 32-bi ARM micro-con roller running a 48MHz wi h 64KB SRAM
- On-board PHY: Texas Ins rumen s CC2520, 5dBm ransmi power, -98dBm receiver sensi ivi y
- On-board inver ed-F an enna
- Leverages ubisys IEEE 802.15.4 MAC and ZigBee s ack for bes -in-class reliabili y and performance
- Suppor s all channels in he 2.4 GHz band, i.e. channels 11-26 as per IEEE 802.15.4:
Primary = { 11, 15, 20, 25 }; Secondary = { 12, 13, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26 }
- Suppor s joining cen ralized and dis ribu ed securi y ne works as rou er
- Suppor s forming simple cen ralized securi y ne works as Coordina or and Trus Cen er
- Suppor s forming dis ribu ed securi y ne works as rou er
- Three pre-configured Trus Cen er Link-Keys for joining:
o Global Defaul Trus Cen er Link-Key (“ZigBeeAlliance09”)
o ZigBee 3.0 Global Dis ribu ed Securi y Link-Key
1
o Device-individual link-key derived from ins alla ion code – also prin ed as ex and QR barcode
- Ex ended neighbour able wi h up o 78 en ries for rou ers and end-devices -
more han hree imes he capaci y required by he s andard (25)
- Ex ended rou ing able wi h up o 96 en ries for ad hoc and many- o-one rou es -
nearly en imes he capaci y required by he s andard (10)
- Ex ended buffering for sleeping end-devices wi h up o 24 buffers -
24 imes he capaci y required by he s andard (1)
- Ex ended APS duplica e rejec ion able wi h up o 64 slo s -
64 imes he capaci y required by he s andard (1)
- Ex ensive ransmi and receive queues for op imum hrough-pu and minimum packe drop ra e
- Reliable and scalable ne work-wide broadcas s fea uring passive acknowledgmen s
- Reliable packe forwarding wi h au oma ic ne work-level re ries
- Very sophis ica ed rou ing algori hm for reliable ad hoc rou ing – avoids rou ing loops even in case of
concurren rou e reques s wi h overlapping source/des ina ion
- Firmware upgradable over- he-air during normal opera ion using ZigBee OTA Upgrade Clus er
- Man-Machine-In erface: A push-bu on and a LED for ne work s eering, fac ory rese e c.
- Flame re ardan housing (V-0); black, RAL 9005
1
Since applica ion firmware 1.08. Prior, pre-cer ifica ion key (D0:..:DF)

6 www.ubisys.de
u
4. INSINSTALLATION
4.1. Mai s Powered Operatio
Please refer o he hardware ins alla ion guide, which was included in he produc package. I provides
de ailed ins alla ion ins ruc ions.
4.2. Low-Voltage Operatio (Mai te a ce a d Early System I tegratio Stages o ly)
Ins ead of applying dangerous mains vol age o he load swi ch S1, you may connec a low-vol age DC
source (e.g. 12V=, 24V=, 48V=) o he supply lines of S1. I s buil -in universal power supply is able o
opera e from bo h kinds of supplies, direc and al erna ing curren . This can be useful during
main enance or early s ages of sys em in egra ion. In his mode, he ZigBee in erface is opera ional and
you can run OTA firmware upgrades, for example. However, he inpu s and ou pu s are non-opera ional
and a emp ing o swi ch he ou pu can resul in a reboo , because he device de ec s a malfunc ion.
For DC opera ion (labora ory use), connec he DC ground (0V, “minus”, nega ive) of your power
supply o he phase inpu of S1 (marked “L”, brown) and he DC supply vol age (12…48VDC, “plus”,
posi ive) o he neu ral inpu of S1 (marked “N”, blue). Once powered, you should observe he normal
device s ar -up behaviour ( he green LED will flash a few imes).
If you are no using a safe low-vol age power-supply, u ilizing he services of a professional
ins aller/elec rician is impera ive.

7 www.ubisys.de
u
5. INITIAL DEVICE START-UP
The device will search for an open ZigBee ne work o join when you firs apply power o i .
Open he ZigBee ne work for joining and hen power-up he device.
S1 will blink quickly o indica e a search in progress. Once a search cycle is comple e i will ei her blink
five imes slowly o indica e i has joined a ne work, or blink hree imes quickly o indica e a joining
failure – for example no ne work found, no permi ed on o he ne work, e c. I will con inue o search
for a ne work in case of failure.
Subsequen ly, when he device is power-cycled, i will blink five imes slowly o indica e i is opera ing
as a rou er on he ne work, en imes slowly o indica e ha i is opera ing as a coordina or and rus
cen er or blink quickly o indica e i is searching for a ne work o join. When commissioned, he rou er’s
LED will remain off af er he five/ en blink cycles during normal opera ion. Af erwards, i will urn on only
for as long as i is permi ing o her devices o join he ne work.
Af er reboo , if he device is properly commissioned, i resumes opera ion doing a “silen rejoin”, i.e. i
does no broadcas a device announcemen in his case. Af er joining a ne work, he device will prolong
he joining window by hree minu es via a fresh ZDO permi joining reques
2
.
2
S re ching he joining dura ion is done in produc s wi h ubisys ZigBee S ack version 1.48 or above.

8 www.ubisys.de
u
6. MAN-MACHINE INTERFACE (MMI)
S1 offers a push-bu on behind a iny hole in he fron -face of he device, as well as a LED righ nex o
i
3
. This man-machine in erface provides access o a menu. In addi ion, i provides a handy shor cu o
fac ory rese he device
4
.
To fac ory rese he device, keep he bu on pressed for approxima ely 10 seconds un il he LED
s ar s o flash. This is equivalen o selec ing menu i em #5.
No ice ha he device also suppor s a power-cycle sequencing fac ory rese as de ailed in sec ion 6.1.
To en er he menu, press and hold he push-bu on for more han a second un il you see hree shor
flashes followed by a sequence of one blink, pause, one blink, pause, e c. This indica es ha you have
successfully en ered he menu. Wi h each shor bu on press (less han a second), you advance
hrough he menu. For example, pressing he bu on once brings you o he second menu i em, which
S1 indica es by wo blinks, pause, wo blinks pause, e c. Once you have reached he menu i em ha
you wan o run, press and hold he bu on for more han a second o execu e he selec ed i em. The
exac meaning of each menu i em depends on he par icular device and may vary from firmware version
o firmware version.
This is he menu for Power Swi ch S1 running firmware version 1.04 and above
5
:
Menu I em # Opera ion
1 ZigBee Commissioning: Ne work S eering
While in his mode a single press on he bu on ins iga es ZigBee Ne work S eering (“EZ-mode”). If he
device is on a ne work i will open he ne work for new devices for hree minu es, o herwise i will a emp o
join an open ne work. If he ne work is already open, he device will close he ne work ins ead such ha
repe i ive presses oggle he ne work permi joining s a e. The LED is on, when he ne work is open for new
devices, and off o herwise.
2 ZigBee Commissioning: Finding & Binding
Ins iga es he ZigBee Finding & Binding procedure (“EZ-mode”) on an ini ia or or arge endpoin . Targe
endpoin s will en er iden ify mode for hree minu es. Ini ia or endpoin s will query arge s and crea e sui able
bindings o hese arge s. Af er leaving he menu in his mode, he firs bu on press s ar s he selec ion of
he endpoin and each subsequen press (wi hin half a second) incremen s he endpoin number. Once he
desired endpoin is reached, wai for he LED o blink he selec ed number of imes. Then, press a single
ime o accep he selec ion or wai for hree seconds o cancel he command. The LED will blink one ime
o confirm an affirma ive choice, or wo imes o indica e he reques has been cancelled.
3
ZigBee Commissioning:
Clear
Binding
s
Clears bindings on an ini ia or endpoin . Selec his menu i em and leave menu mode. Af erwards he device
expec s he selec ion of an ini ia or endpoin . The firs bu on press s ar s he selec ion of he endpoin and
each subsequen press (wi hin half a second) incremen s he endpoin number. Once he desired endpoin
is reached, wai for he LED o blink he selec ed number of imes. Then, press a single ime o accep he
selec ion or wai for hree seconds o cancel he command. The LED will blink one ime o confirm an
affirma ive choice, or wo imes o indica e he reques has been cancelled. This mode is ac ive for one
round only. Af erwards he device rever s o mode #1.
4
ZigBee Commissioning:
Se Device Role and Fac ory Rese
Selec s he ZigBee device role for his device on he ne work, rese s he remaining se ings o fac ory
defaul s and res ar s he device. Selec his menu i em and leave menu mode. Af erwards he device
expec s he selec ion of an op ion. The firs bu on press s ar s he selec ion of he op ion and each
3
The high-vol age inpu s of S1/S1-R do no coun as an MMI fea ure.
4
The 10-second-press fac ory rese (equivalen o menu i em #5) is available since firmware version 1.05.
5
No ice: Prior versions have differen menu i ems. Only he fac ory rese command (menu i em #5) is iden ical
across all released versions of he firmware.

9 www.ubisys.de
u
subsequen press (wi hin half a second) incremen s he
op ion
number. Once he desired
op ion
is
reached,
wai for he LED o blink he selec ed number of imes. Then, press a single ime o accep he selec ion or
wai for hree seconds o cancel he command. The LED will blink one ime o confirm an affirma ive choice,
or wo imes o indica e he reques has been cancelled. The following op ions are available:
Op ion #1: Join an exis ing ZigBee ne work as rou er
Op ion #2: Form a new dis ribu ed securi y ne work as he firs rou er
Op ion #3: Form a new cen ralized securi y ne work as he coordina or and rus cen er
5 Fac ory Rese
Pu he device in o he same s a e as i was when i lef he fac ory, hen reboo . The only excep ion is he
ou going ne work securi y frame coun er, which is preserved across fac ory rese s. The device will
broadcas a ne work leave indica ion.
6
6 ZigBee Commissioning: Advanced Commands
Provides a number of advanced ZigBee commissioning command op ions. Selec his menu i em and leave
menu mode. Af erwards he device expec s he selec ion of an op ion. The firs bu on press s ar s he
selec ion of he op ion and each subsequen press (wi hin half a second) incremen s he op ion number.
Once he desired op ion is reached, wai for he LED o blink he selec ed number of imes. Then, press a
single ime o accep he selec ion or wai for hree seconds o cancel he command. The LED will blink one
ime o confirm an affirma ive choice, or wo imes o indica e he reques has been cancelled. The following
op ions are available:
Op ion #1: Perform a simple rese (reboo ), hen con inue opera ing seamlessly (silen re-join)
Op ion #2: Perform a simple rese (reboo ), hen re-join he ne work
Op ion #3: Perform a full fac ory rese , including securi y frame coun ers and preserved se ings
7 Reserved for in ernal use. Do no leave he menu in his mode.
6.1. Power-Cycle Seque ci g Factory Reset
I is possible o ins iga e a fac ory rese using a special power-cycle sequence
7
. This is equivalen o
selec ing menu i em #5, wi h he advan age ha you need no access o he device i self (only o i s
power supply).
1. Power he device for a leas four seconds.
2. In errup he power supply for a leas a second.
3. Reapply power for less han wo seconds bu more han half a second.
No ice ha a he end of his cycle, he device is off and should remain off for a leas a second.
4. Repea he previous s ep wo more imes, for a o al of hree shor power cycles.
5. Apply power o he device and leave i powered on.
The device will now fac ory rese and reboo .
6
Since applica ion firmware 1.06. Previously, he fac ory rese would resul in a silen leave.
7
Since applica ion firmware 1.09

10 www.ubisys.de
u
7. ZIGBEE INTERFACE
Please refer o he following IEEE and ZigBee Alliance documen s, which apply o his produc :
[R1] IEEE S andard 802 – Par 15.4: Low-Ra e Wireless Personal Area Ne works (LR-WPANs)
[R2] ZigBee Specifica ion, Revision 21, Documen No. 05-3474-21
[R3] ZigBee 2015 Layer PICS and S ack Profiles, Revision 6, Documen No. 08-0006-06
[R4] ZigBee Clus er Library Specifica ion, Revision 5, Documen No. 07-5123-05
[R5] ZigBee Base Device Behavior Specifica ion, Revision 13, Documen No. 13-0402-13
[R6] ZigBee PRO Green Power Fea ure Specifica ion, Revision 26, Documen No. 09-5499-26
[R7] ZigBee Home Au oma ion Public Applica ion Profile 1.2, Revision 29, Documen No. 05-3520-29
[R8] ZigBee Smar Energy S andard 1.1b, Revision 18, Documen No. 07-5356-18
Device Anatomy
The power swi ch S1 provides an on/off load con rol ou pu for a ra ed vol age of 230V~/50Hz and a
curren of 16A for a o al swi ching capabili y of 3.680VA, which ma ches ins alla ion requiremen s in
mos EMEA coun ries. Swi ching he la ching (bi-s able) relay occurs synchronized o he mains zero-
crossing o avoid sparks and huge swi ching curren s. I also provides an in egra ed smar me er, which
is capable of measuring ac ive power, reac ive power, apparen power, vol age, curren and frequency
8
.
In addi ion one (S1) or wo (S1-R) high-vol age inpu s are available for local con rol or remo e con rol
of o her on/off arge devices or groups. Being a mains-powered device, S1(-R) also ac s as a ZigBee
rou er improving ne work connec ivi y and meshing capabili ies as well as serving as a connec ion poin
(“paren ”) for sleeping end-devices.
Due o he addi ional inpu on S1-R, he ana omy of S1 and S1-R is sligh ly differen .
S1 provides seven ZigBee applica ion endpoin s:
Endpoin #
Profile
Applica ion
0 (0x00) 0x0000: ZigBee Device Profile ZigBee Device Objec (ZDO) – s andard managemen fea ures
1 (0x01) 0x0104: Common Profile (HA) On/off plug-in Uni (0x010A)
9
. This endpoin provides con rol of he
ou pu via he on/off clus er. I suppor s groups and scenes, as well as
repor ing for on/off s a e feedback. The iden ify clus er allows for push-
bu on commissioning as a arge .
2 (0x02) 0x0104: Common Profile (HA) Level Con rol Swi ch (0x0001)
10
. This endpoin is used o ransmi
on/off, level con rol or scene commands riggered by he local high-
vol age inpu .
3 (0x03) 0x0104: Common Profile (HA)
11
Me ering (0x0702). This endpoin provides me ering and elec rical
measuremen clus ers o measure power, energy, vol age, curren , and
o her figures.
200
(0xC8)
Priva e
Priva e. This endpoin con ains a legacy priva e applica ion and
is
provided for backwards-compa ibili y, only. This fea ure is depreca ed
8
More advanced fea ures like waveform sampling, o al harmonic dis or ion and o her quali y figures available
upon reques
9
Since applica ion version 1.14 (S1). Prior, Mains Power Ou le (0x0009) was used, which more accura ely
reflec s he na ure of he device, bu is ignored by a major connec ed ligh ing eco-sys em, which refuses o
con rol generic devices.
10
Since applica ion version 1.04 (S1). Prior, Generic On/Off Swi ch (0x0000) was used and nei her level con rol nor
scene commands were suppor ed.
11
Since applica ion version 1.02 (S1). Prior, profile ID 0x0109 (Smar Energy) was used.

11 www.ubisys.de
u
and
will be removed in a fu ure firmware release
af er a grace period
.
232 (0xE8) 0x0104: Common Profile (HA) Device Managemen (0x0507)
12
242 (0xF2) 0xA1E0: Green Power Profile ZigBee Green Power Combined Proxy and Sink
13
S1-R provides seven ZigBee applica ion endpoin s:
Endpoin # Profile Applica ion
0 (0x00) 0x0000: ZigBee Device Profile ZigBee Device Objec (ZDO) – s andard managemen fea ures
1 (0x01)
0x0104: Common Profile (HA)
Mains Power Ou le (0x0009). This endpoin provides con rol of he
ou pu via he on/off clus er. I suppor s groups and scenes, as well as
repor ing for on/off s a e feedback. The iden ify clus er allows for push-
bu on commissioning as a arge .
2 (0x02)
0x0104: Common Profile (HA)
Level Con rol Swi ch (0x0001)
14
. This endpoin is used o
ransmi on/off,
level con rol or scene commands riggered by he local high-vol age inpu .
3 (0x03) 0x0104: Common Profile (HA) Level Con rol Swi ch (0x0001)
15
. This endpoin is used o ransmi on/off,
level con rol or scene commands riggered by he local high-vol age inpu .
4 (0x04) 0x0104: Common Profile
(HA)
16
Me ering (0x0702). This endpoin provides me ering and elec rical
measuremen clus ers o measure power, energy, vol age, curren , and
o her figures.
200 (0xC8) Priva e Priva e. This endpoin con ains a legacy priva e applica ion and provided
for backwards-compa ibili y, only. This fea ure is depreca ed and will be
removed in a fu ure firmware release af er a grace period.
232 (0xE8)
0x0104: Common Profile (HA)
Device Managemen
(0x05
02)
17
The ubisys ZigBee manufac urer ID is 0x10F2. This manufac urer code is used o iden ify OTA upgrade
images, for accessing manufac urer-specific ZCL a ribu es and commands e c.
Ins alla ion Code
This power swi ch has a pre-configured link key, which is derived from he ins alla ion code prin ed on
he back of he uni s’s housing in ex forma and as a wo-dimensional barcode (QR code). The forma
specified in [R6], sec ion 5.4.8.1.1 is used wi h a full 128-bi ins alla ion code + 16-bi CRC. The QR
code con ains addi ional informa ion as illus ra ed in he following example:
ubisys2/R0/001FEE00000000FF/0F7C1CD805F91649EBA84580AA1CB432F51A/21
Here, “ubisys2” is he da a forma iden ifier, R0 is he model s ring ( his is jus an example, i would be
“S1” or “S1-R” for his produc ), followed by he EUI-64, he ins alla ion code, and a checksum ha
covers he en ire informa ion (including model, EUI-64 and ins alla ion code), all separa ed by a single
dash charac er (‘/’). The check sum is an unsigned 8-bi in eger, which is calcula ed by performing a
by e-wise exclusive-or (XOR, “”) of he ASCII charac ers of he model s ring, he binary
represen a ion of he EUI-64 (in big endian forma ), and he binary represen a ion of he ins all code.
12
Since applica ion version 1.02 (S1). Prior, device ID 0x0008 (Range Ex ender) was used.
13
Since applica ion version 1.07.
14
Since applica ion version 1.04 (S1-R). Prior, Generic On/Off Swi ch (0x0000) was used and nei her level con rol nor
scene commands were suppor ed.
15
Since applica ion version 1.04 (S1-R). Prior, Generic On/Off Swi ch (0x0000) was used and nei her level con rol nor
scene commands were suppor ed.
16
Since applica ion version 1.01 (S1-R). Prior, profile ID 0x0109 (Smar Energy) was used.
17
Since applica ion version 1.01 (S1-R). Prior, device ID 0x0008 (Range Ex ender) was used.

12 www.ubisys.de
u
For he example above, his calcula ion yields:
52 (‘R’)  30 (‘0’) 
00  1F  EE  00  00  00  00  FF 
0F  7C  1C  D8  05  F9  16  49  EB  A8  45  80  AA  1C  B4  32  F5  1A = 21
No ice: The da a forma “ubisys1” is iden ical o “ubisys2” excep for he check sum, which is presen ,
bu invalid. If you encoun er “ubisys1” labels, hen do no verify he railing check sum field.

13 www.ubisys.de
u
7.1. Applicatio E dpoi t #0 (S1/S1-R) – ZigBee Device Object
Please refer o he ZigBee Specifica ion [R2] for de ails on he ZigBee Device Objec (ZDO) and he
pro ocol used for over- he-air communica ion, called he ZigBee Device Profile (ZDP). No ice ha he
ZDP is fundamen ally differen from ypical applica ion endpoin s, which build on he ZigBee founda ion
framework and he ZigBee Clus er Library (ZCL).
The ubisys ZigBee Power Swi ch S1/S1-R suppor s he following ZDO services:
Primi ive Descrip ion
nwk_addr_req/
nwk_addr_rsp
Ne work address reques /response
Transla es a 64-bi IEEE address in o a 16-bi ne work shor address. Use only when really
required, because his message employs a ne work-wide broadcas (flooding)
ieee_addr_req/
ieee_addr_rsp
IEEE address reques /response
Transla es a 16-bi ne work shor address in o a 64-bi IEEE address.
node_desc_req/
node_desc_rsp
Node descrip or reques /response
Re urns informa ion such as he manufac urer ID, power supply, e c.
power_desc_req/
power_desc_rsp
18
Power descrip or reques /response
Re urns informa ion such as he power source and mode.
ac ive_ep_req/
ac ive_ep_rsp
Ac ive endpoin s reques /response
Re urns a se of available applica ion endpoin s on he device.
simple_desc_req/
simple_desc_rsp
Simple descrip or reques /response
Re urns a descrip or for a cer ain applica ion endpoin wi h a lis of available services
(clus ers).
ma ch_desc_req/
ma ch_desc_rsp
Ma ch descrip or reques
/response
Searches for a cer ain clus er or se of clus ers and re urns he ma ching endpoin s, if any.
device_annce Device announcemen
Adver ises he presence of a new device in he ne work.
paren _annce/
paren _annce_rsp
19
Paren announcemen /response
This is par of he ZigBee 2015 end-device child managemen fea ure.
sys em_server_discovery_req/
sys em_server_discovery_rsp
20
Sys em server discovery reques /response
Provides he abili y o discover sys em servers, in par icular he ne work manager.
bind_req/
bind_rsp
Bind reques /response
Crea es an applica ion binding
unbind_req/
unbind_rsp
Unbind reques /response
Removes an applica ion binding
mgm _nwk_disc_req/
mgm _nwk_disc_rsp
21
Managemen : Ne work discovery reques /response
Ins ruc s he device o perform a ne work discovery and repor he resul s back.
mgm _lqi_req/
mgm _lqi_rsp
Managemen : Neighbor able reques /response
Re urns informa ion abou neighboring devices, including he link quali y, device ype e c.
mgm _r g_req/
mgm _r g_rsp
Managemen : Rou ing able reques /response
Re urns informa ion abou rou es es ablished on he device.
mgm _bind_req/
mgm _bind_rsp
Managemen : Binding able reques /response
Re urns informa ion abou applica ion bindings on he device.
m
gm _leave_req/
mgm _leave_rsp
Managemen : Leave reques /response
Makes he device leave he ne work or removes one of i s end-device children.
mgm _permi _joining_req/
mgm _permi _joining_rsp
Managemen : Permi joining reques /response
Opens he ne work for new devices o join.
mgm _nwk_upda e_req/
mgm _nwk_upda e_no ify
22
Managemen : Ne work upda e reques /response/no ifica ion
Performs energy scans, ins iga es a channel change or assigns he ne work manager.
18
Available in ZigBee s ack version 1.60 and above. Legacy ZCP requiremen – do no use in applica ions
19
Available in ZigBee s ack version 1.56 and above.
20
Available in ZigBee s ack version 1.50 and above.
21
Available in ZigBee s ack version 1.61 and above.
22
Available in ZigBee s ack version 1.61 and above.

14 www.ubisys.de
u
7.2. Applicatio E dpoi t #1 (S1/S1-R) – Mai s Power Outlet
Use his applica ion endpoin o con rol he load ou pu , which is marked wi h a wave crossed by an
arrow. In case of S1, his is he red wire.
This is a Finding & Binding arge endpoin .
The applica ion endpoin exposes he following clus ers:
Clus er Direc ion Descrip ion
0x0000 Inbound
(Server)
Basic
Provides basic informa ion abou he device, such as he manufac urer ID, vendor and model
name, s ack profile, ZCL version, produc ion da e, hardware revision e c. Allows a fac ory rese
of a ribu es, wi hou he device leaving he ne work.
0x0003 Inbound
(Server)
Iden ify
Allows o pu he endpoin in o iden ify mode. Useful for iden ifying/loca ing devices and
required for Finding & Binding.
0x0004 Inbound
(Server)
Groups
Allows adding his endpoin o one or more groups. Af erwards he endpoin can be addressed
using he group address. This is also a prerequisi e for scenes. You may also query group
membership and dele e group associa ions.
0x000
5
Inbound
(Server)
Scenes
Allows s oring one or more scenes per group, where each scene consis s of a pre-se on/off
s a e value. You may ei her s ore he curren values as a scene, or provide scene se ings when
adding a scene, or dele e scenes.
0x0
006
Inbound
(Server)
On/off
Provides con rol of he relay ou pu
7.2.1. Basic Cluster (Server)
Please refer o sec ion 7.7.1 for de ails.
7.2.2. Ide tify Cluster (Server)
In iden ify mode, he ou pu relay will be oggled once every second.
Cau ion: Make sure he a ached load can handle his swi ching ra e or physically disconnec he load!
A ribu es suppor ed:
A ribu e
Type
Descrip ion
0x0000
unsigned
16
Iden ifyTime
The remaining ime, in seconds, he device will be iden ifying i self.
No ice ha S1 curren ly does no provide any visual feedback in iden ify mode.
Clus er commands suppor ed:
Command Descrip ion
0x00 Iden ify
Pu s he device in o iden ify mode, or ermina es iden ify mode.

15 www.ubisys.de
u
0x01
Query Iden ify
De ermines whe her he device is curren ly iden ifying, and re urns he remaining ime if so.
0x40 Trigger Effec
23
Ins iga es a visual effec .
7.2.3. Groups Cluster (Server)
A ribu es suppor ed:
A ribu e Type Descrip ion
0x0000 bi map8,
read-only
NameSuppor
Always se o 0: This implemen a ion does no suppor s oring names for groups.
Clus er commands suppor ed:
Command Descrip ion
0x00 Add Group
Adds he endpoin o a group.
0x01
View Group
De ermines whe her he device belongs o a group and re urns he group name, if suppor ed.
0x02 Ge Group Membership
Re urns he se of groups his endpoin belongs o.
0x03 Remove Group
Removes his endpoin from he specified group. Also removes all scenes ha refer o his group.
0x04 Remove All Groups
Removes his endpoin from all groups. Also removes all scenes ha refer o any of he exis ing groups.
0x05 Add Group if Iden ifying
Adds his endpoin o he group, if he endpoin is iden ifying.
7.2.4. Sce es Cluster (Server)
A ribu es suppor ed:
A ribu e Type Descrip ion
0x0000 unsigned8,
read-only
SceneCoun
Holds he o al number of scenes (across all groups) curren ly s ored on he device.
0x0001
unsigned
8,
read-only
Curren Scene
If he SceneValid a ribu e is rue, his a ribu e, oge her wi h he Curren Group a ribu e,
indica es he curren ly ac ive scene.
0x0002 unsigned8,
read-only
Curren Group
If he SceneValid a ribu e is rue, his a ribu e, oge her wi h he Curren Scene a ribu e,
indica es he curren ly ac ive scene.
0x0003 bool,
read-only
SceneValid
If rue, he scene iden ified by Curren Group and Curren Scene is curren ly ac ive, i.e. all device
a ribu e values ma ch he values in he scene field se .
0x0004 bi map8,
read-only
NameSuppor
Always se o 1: This implemen a ion does suppor s oring names for scenes.
Clus er commands suppor ed:
23
Since applica ion version 1.14

16 www.ubisys.de
u
Command Descrip ion
0x00 Add Scene
Adds a scene wi h or wi hou a scene field se
0x01 View Scene
Re urns he scene field se , name and ransi ion imes for a scene.
0x02 Remove Scene
Removes a scene from he scene able.
0x03
Remove All Scenes
Removes all scenes ha belong o a par icular group.
0x04 S ore Scene
S ores he device’s curren s a e as a scene or upda es a previously s ored scene accordingly.
0x05
Recall Scene
Rever s he device’s curren s a e using he values from he previously s ored field se .
0x06 Ge Scene Membership
Re urns he se of scenes (wi hin he scope of he specified group) curren ly s ored on he device.
0x40 Enhanced Add Scene
Similar o Add Scene wi h higher ransi ion ime resolu ion (10 hs of a second ins ead of once second)
0x41 Enhanced View Scene
Similar o View Scene wi h higher ransi ion ime resolu ion (10 hs of a second ins ead of once second)
0x42 Copy Scene
Copies a scene in a single opera ion as an al erna ive o (Enhanced) View Scene, (Enhanced) Add Scene
7.2.5. O /off Cluster (Server)
No ice: This clus er uses he binding able for managing repor ing arge s. Curren ly, here is no defaul
repor ing configura ion in place, so you need o configure repor ing, if you wan o receive feedback on
s a e changes.
A ribu es suppor ed:
A ribu e Type Descrip ion
0x0000 bool, read-only,
repor able
OnOff
Indica es he curren s a e of he ou pu relay, ei her on = ‘ rue’ or off = ‘false’.
0x4000 bool, read-only GlobalSceneCon rol
24
De ermines whe her he nex “Off wi h Effec ” command will s ore he global scene.
0x4001
unsigned16,
read-only OnTime
24
Time, in en hs of a second, he device remains on, before i au oma ically urns off. This
value is se by he “On wi h imed off” command. This is a ‘live’ down coun er.
0x4002
unsigned16,
read-only OffWai Time
24
Time, in en hs of a second, he device ignores “On wi h imed off” commands. This is a
‘live’ down coun er.
0x4003 enum8,
persis en S ar upOnOff
24
De ermines he s ar -up behavior of he device af er reboo . Ei her always urn off (0x00) or
urn on (0x01) he device; or res ore he previous se ing (0xFF) or inver he previous
se ing (0x02)
Clus er commands suppor ed:
Command
Descrip ion
0x00 Turn off
Turns he ou pu off. The a ached load will be disconnec ed from he mains.
24
Since applica ion version 1.14

17 www.ubisys.de
u
0x01
Turn on
Turns he ou pu on. The a ached load will be connec ed o he mains.
0x02 Toggle
Turns he ou pu off, i was urned on or urns he ou pu on, if i was urned off.
0x40
Off wi h effec
24
Turns he ou pu off af er having s ored he curren se ing as he global scene and rejec s fur her global
scene s orage reques s by he “On wi h recall global scene” command, un il he device is urned on again or
he global scene has been res ored.
0x41 On wi h recall global scene
24
Res ores he global scene. Despi e he name of his command, i does no always urn he device “on”;
ra her, i jus recalls he previously s ored se ing.
0x42 On wi h imed off
24
Turns he ou pu on and hen au oma ically urns i off af er he specified ime has elapsed.

18 www.ubisys.de
u
7.3. Applicatio E dpoi t #2 (S1/S1-R) – Primary Level Co trol Switch
This is a Finding & Binding ini ia or endpoin .
7.3.1. Basic Cluster (Server)
Please refer o sec ion 7.7.1 for de ails.
7.3.2. Ide tify Cluster (Server)
No ice: The iden ify clus er ins ance on his endpoin does no provide any visual or audible feedback. I
is mainly presen o comply wi h s andards requiremen s.
A ribu es suppor ed:
A ribu e Type Descrip ion
0x0000 unsigned16 Iden ifyTime
The remaining ime, in seconds, he device will be iden ifying i self.
No ice ha S1 curren ly does no provide any visual feedback in iden ify mode.
Clus er commands suppor ed:
Command Descrip ion
0x00 Iden ify
Pu s he device in o iden ify mode, or ermina es iden ify mode.
0x01
Query Iden ify
De ermines whe her he device is curren ly iden ifying, and re urns he remaining ime if so.
7.3.3. Sce es Cluster (Clie t)
This clus er is available on devices running firmware version 1.04 and above.
No ice: This clus er does no use he binding able for managing command arge s. Ins ead, recall
scene command empla es include he group address and scene number o recall. The device se up
clus er on he Device Managemen endpoin can be used o configure he behavior of he clus er, i.e.
which iden ifiers will be sen in he message body, when he inpu s a e changes. Using he device
se up clus er, you can configure his endpoin ei her o be used wi h a push-bu on or a swi ch.
This clus er ins ance is in ended for recalling scenes on he local and/or remo e devices using he local
inpu s and is no bound when fac ory fresh.
Clus er commands ransmi ed:
Command
Descrip ion
0x05 Recall Scene
Recalls a scene. The group address in he recall scene command payload is also used as he arge for he
command.

19 www.ubisys.de
u
7.3.4. O /off Cluster (Clie t)
No ice: This clus er uses he binding able for managing command arge s. When fac ory fresh, his
clus er is bound o endpoin #1 o enable local con rol. This works even when he device is no
commissioned ye . In addi ion, he device se up clus er on he Device Managemen endpoin can be
used o configure he behavior of he clus er, i.e. which of he commands men ioned below will ac ually
be sen , when he inpu s a e changes. Using he device se up clus er, you can configure his endpoin
ei her o be used wi h a push-bu on (momen ary swi ch, one s able posi ion) or a rocker swi ch ( wo
s able posi ions).
Clus er commands ransmi ed:
Command Descrip ion
0x00
Turn off
Turns he arge device or group of devices off.
0x01 Turn on
Turns he arge device or group of devices on.
0x02 Toggle
Toggles he arge device s a e. Should no be used o con rol groups.
7.3.5. Level Co trol Cluster (Clie t)
This clus er is available on devices running firmware version 1.04 and above.
No ice: This clus er uses he binding able for managing command arge s. In addi ion, he device se up
clus er on he Device Managemen endpoin can be used o configure he behavior of he clus er, i.e.
which of he commands men ioned below will ac ually be sen , when he inpu s a e changes. Using he
device se up clus er, you can configure his endpoin ei her o be used wi h one or wo push-bu ons.
This clus er ins ance is in ended for con rolling remo e dimmers using he local inpu s and is no bound
when fac ory fresh.
Clus er commands ransmi ed:
Command Descrip ion
0x05
Move wi h on/off
Moves he level ei her up or down a a specified ra e.
Main ains he companion on/off clus er’s OnOff a ribu e.
0x07 S op wi h on/off
S ops any level change in progress due o a move, move o level, s ep or recall scene command.
Main ains he companion on/off clus er’s OnOff a ribu e.

20 www.ubisys.de
u
7.4. Applicatio E dpoi t #3 (S1-R) – Seco dary Level Co trol Switch
This is a Finding & Binding ini ia or endpoin .
7.4.1. Basic Cluster (Server)
Please refer o sec ion 7.7.1 for de ails.
7.4.2. Ide tify Cluster (Server)
No ice: The iden ify clus er ins ance on his endpoin does no provide any visual or audible feedback. I
is mainly presen o comply wi h s andards requiremen s.
A ribu es suppor ed:
A ribu e Type Descrip ion
0x0000 unsigned16 Iden ifyTime
The remaining ime, in seconds, he device will be iden ifying i self.
No ice ha S1 curren ly does no provide any visual feedback in iden ify mode.
Clus er commands suppor ed:
Command Descrip ion
0x00 Iden ify
Pu s he device in o iden ify mode, or ermina es iden ify mode.
0x01
Query Iden ify
De ermines whe her he device is curren ly iden ifying, and re urns he remaining ime if so.
7.4.3. Sce es Cluster (Clie t)
No ice: This clus er does no use he binding able for managing command arge s. Ins ead, recall
scene command empla es include he group address and scene number o recall. The device se up
clus er on he Device Managemen endpoin can be used o configure he behavior of he clus er, i.e.
which iden ifiers will be sen in he message body, when he inpu s a e changes. Using he device
se up clus er, you can configure his endpoin ei her o be used wi h a push-bu on or a swi ch.
This clus er ins ance is in ended for recalling scenes on he local and/or remo e devices using he local
inpu s and is no bound when fac ory fresh.
Clus er commands ransmi ed:
Command Descrip ion
0x05 Recall Scene
Recalls a scene. The group address in he recall scene command payload is also used as he arge for he
command.