Harmony Hub

EIO0000001177 01/2020

Harmony Hub
ZBRN1/ZBRN2
User Manual
(Original Document)

01/2020
EIO0000001177.05

www.schneider-electric.com
 The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of
this document on any medium whatsoever without permission of Schneider Electric, given in
writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of
the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at
your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2020 Schneider Electric. All rights reserved.

2 EIO0000001177 01/2020
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Offer Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Call To Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Product References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 2 Physical Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2.1 Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Hardware Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Mechanical Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Environmental Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Housing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.3 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Electrical Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.4 Data Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Compatibility Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Transmitter Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Monostable Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Set/Reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Receiver Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 3 First Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
First Start Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Pairing Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Chapter 4 ZBRN1 Ethernet Communication . . . . . . . . . . . . . . . . . . 61
Communication on The Ethernet Network. . . . . . . . . . . . . . . . . . . . . . 62
Addressing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Communication and Status Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . 68
Modbus TCP Settings and Supported Functions . . . . . . . . . . . . . . . . 70
Ethernet Cable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

EIO0000001177 01/2020 3
 Chapter 5 ZBRN2 Modbus Serial Line Communication . . . . . . . . . . 73
Communication on The Modbus Network . . . . . . . . . . . . . . . . . . . . . . 74
Communication and Status Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Modbus Serial Line Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Modbus Settings and Supported Functions . . . . . . . . . . . . . . . . . . . . . 80
Modbus Serial Line Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 6 ZBRRH Receiver for Harmony Hub . . . . . . . . . . . . . . . . . 85
Presentation of ZBRRH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
General Installation Instruction for ZBRRH . . . . . . . . . . . . . . . . . . . . . 87
Receiver Wiring Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
LED Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
How to Teach/Unteach ZBRRH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Lock/Unlock for ZBRRH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Total Reset Function Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Chapter 7 Modbus Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.1 Memory Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Memory Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
7.2 Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Type 1 Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Type 4 Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Type 5 Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Type 6 Input Channels Registers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
7.3 Output Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Output Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.4 Action Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Action Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Action Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
7.5 Diagnostic Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Device Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Communication Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
7.6 Configuration Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Device Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Communication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Chapter 8 Radio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Radio Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

4 EIO0000001177 01/2020
 Chapter 9 User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Principle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Menu Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
9.2 Configuration Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Configuration Menu Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Input Configuration Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Output Configuration Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Communication Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Radio Frequency Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Factory Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
9.3 Diagnostic Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Diagnostic Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
9.4 SD Card Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
SD Card Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Chapter 10 SD Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
File Management and Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

EIO0000001177 01/2020 5
6 EIO0000001177 01/2020
 Safety Information

Important Information

NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, service, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.

EIO0000001177 01/2020 7
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.

8 EIO0000001177 01/2020
 About the Book

At a Glance

Document Scope
This documentation is a reference for the wireless transmitters and receivers used with the
ZBRN1/ZBRN2 Harmony Hub.
The purpose of this document is to:
 Show how to install and operate your Harmony Hub.
 Show how to connect Harmony Hub with wireless transmitters, programmable logic controllers
(PLCs), and other devices.
 Help become familiar with Harmony Hub features.

NOTE: Read and understand this document and all related documents (see page 10) before
installing, operating, or maintaining your Harmony Hub.
The users must read through the entire document to understand all its features.

Validity Note
This documentation is valid for the ZBRN1/ZBRN2 Harmony Hub, firmware version ≥V3.31.
The technical characteristics of the devices described in the present document also appear online.
To access the information online:

Step Action
1 Go to the Schneider Electric home page www.schneider-electric.com.
2 In the Search box type the reference of a product or the name of a product range.
 Do not include blank spaces in the reference or product range.
 To get information on grouping similar modules, use asterisks (*).

3 If you entered a reference, go to the Product Datasheets search results and click on the
reference that interests you.
If you entered the name of a product range, go to the Product Ranges search results and click
on the product range that interests you.
4 If more than one reference appears in the Products search results, click on the reference that
interests you.
5 Depending on the size of your screen, you may need to scroll down to see the datasheet.
6 To save or print a datasheet as a .pdf file, click Download XXX product datasheet.

The characteristics that are presented in the present document should be the same as those
characteristics that appear online. In line with our policy of constant improvement, we may revise
content over time to improve clarity and accuracy. If you see a difference between the document
and online information, use the online information as your reference.

EIO0000001177 01/2020 9
Related Documents

Title of Documentation Reference Number

Harmony XB5R Wireless and Battery-Less Push-Button Catalog DIA5ED2121214EN (Eng),
DIA5ED2121214FR (Fre)
Harmony XB5R Expert Instruction Sheet EIO0000000812 (Eng),
EIO0000000813 (Fre),
EIO0000000814 (Ger),
EIO0000000815 (Spa),
EIO0000000816 (Ita),
EIO0000000817 (Chs),
EIO0000000818 (Por)
Magelis Box iPC Modular and Display Optimized, Universal and EIO0000003374 (Eng),
Performance (HMIBMI, HMIBMO, HMIBMP, HMIBMU, HMIDM) - EIO0000003375 (Fre),
User Manual EIO0000003376 (Ger),
EIO0000003377 (Spa),
EIO0000003378 (Ita),
EIO0000003379 (Chs),
ZBRN1 Harmony Hub Instruction Sheet S1B87888
ZBRN2 Harmony Hub Instruction Sheet S1B87941
ZBRCETH Instruction Sheet S1B88209
ZBRRH Receiver Instruction Sheet GDE20645
ZBRRA/ZBRRC/ZBRRD Receivers Instruction Sheet S1A57202
Packages Instruction Sheet S1A57199
Transmitter with Metal or Plastic Head and Cap Instruction Sheet S1A57198
Relay Antenna Instruction Sheet S1A57194
Handy Box Instruction Sheet S1A57210
Modbus Serial Modbus Serial Link for Machines DIA3ED2160106EN (Eng)
DIA3ED2160106FR (Fre)

You can download these technical publications and other technical information from our website
at https://www.se.com/ww/en/download/ .

10 EIO0000001177 01/2020
Product Related Information

DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION OR ARC FLASH
 Disconnect all power from all equipment including connected devices prior to removing any
covers or doors, or installing or removing any accessories, hardware, cables, or wires except
under the specific conditions specified in the appropriate hardware guide for this equipment.
 Always use a properly rated voltage sensing device to confirm the power off where and when
indicated.
 Replace and secure all covers, accessories, hardware, cables, and wires and confirm that a
proper ground connection exists before applying power to the equipment.
 Use only the specified voltage when operating this equipment and any associated products.
Failure to follow these instructions will result in death or serious injury.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Only persons with expertise in the design and programming of control systems are allowed to
program, install, alter, and apply this product.
 Follow all local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001177 01/2020 11
12 EIO0000001177 01/2020
 Harmony Hub
Introduction
EIO0000001177 01/2020

Chapter 1
Introduction

Introduction

Purpose
This chapter provides an overview of the Harmony Hub and its wireless receiver.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Offer Description 14
Call To Action 18
Product References 20

EIO0000001177 01/2020 13
Introduction

Offer Description

Overview
The Harmony XB5R offer using Harmony Hub allows more flexibility and simplicity in the
installation. Wireless transmitters technology reduces the wiring and the cost of installation.
Harmony Hub converts radio frequency inputs into various communication protocols and operates
as intermediate equipment between a transmitter and a PLC or industrial PCs (IT/OT box) that
support Modbus TCP protocols.
Harmony Hub can be used with transmitters such as XB4R and XB5R wireless and batteryless
push-buttons, rope pull switch, mushroom head push-buttons, emergency stop monitoring, XCKW
and XCMW wireless and batteryless limit switches, temperature sensors, and energy sensors.
It has a wide range of industrial and building applications. For example, in packing lines, automatic
doors in logistic centers, manufacturing of vehicles in automotive industries, for bag filling in
cement industries, and for efficient use of power in office lighting.
Harmony Hub can also control output especially receivers and communicate with a tower light for
example to make call for action. This use case will help the operator visually for the status of his
requested action.

14 EIO0000001177 01/2020
 Introduction

Basic Architecture with PLC

The following figure shows the transmission between transmitters and a ZBRN1 Harmony Hub:

1 Harmony Hub
2 PLC
3 Pushbutton
4 Limit switch
5 Energy sensor
6 Humidity and thermal sensor
7 Thermal sensor

NOTE: You can associate 1 Harmony Hub with up to 60 transmitters. Each transmitter has a
unique ID (for example, 030079B1).
PowerTag energy monitoring sensor must be placed in a metal cabinet at a maximum distance of
3 meters to Harmony Hub.

IT/OT Architecture
Harmony Hub provides network connectivity openness by operating as intermediate equipment
between the wireless devices and PLCs (Programmable Logic Controller) or all industrial PCs
(IT/OT box) that support Modbus TCP protocols.
Harmony Hub is providing an easy way to digitalize your production line to improve operation
efficiency by using a non-intrusive wireless system easy to connect to your IT system.
Harmony Hub collect physical signals from an operator interface or secondary sensing to generate
computed data information for computerized maintenance management system (CMMS) tools and
operation management tools.

EIO0000001177 01/2020 15
Introduction

Data can be analyzed through our dedicated EcoStruxure platform through AVEVA™ Software,
Maintenace Advisor software, and Augmented Operator Advisor application.

1 ZBRN1 Harmony Hub associated with ZBRCETH communication module

2 iPC
3 Pushbutton
4 Limit switch
5 Energy sensor
6 Humidity and thermal sensor
7 Thermal sensor

Compatible Transmitters
Harmony Hub is compatible with:
 The Harmony batteryless and wireless push-buttons offer based on radio technology (ZBRT1,
ZBRT2)
 The Harmony wireless and batteryless rope pull switch (ZBRP1)
 The OsiSense wireless and batteryless radio limit switches (XCKW, XCMX)
 Temperature sensors with battery (A9XST114, …)
 Energy sensors (A9MEM1560, LV434020, …)

The following figures show some examples of transmitters:

16 EIO0000001177 01/2020
 Introduction

Example 1: Push-button with a plastic head

Example 2: Push-button with a metal head

Example 3: Push-button with a plastic head enclosed in a handy box

EIO0000001177 01/2020 17
Introduction

Call To Action

Overview
Harmony Hub can communicate with up to 60 ZBRRH receivers.
If you connect a tower light to the ZBRRH receiver, you can make a call to action function.
Call to action:
When a problem occurs on the machine, the operator just pushes its wireless pushbutton.
The Harmony Hub can then control a device to solve the problem or at least to display it with a
tower light.
The following figure shows the transmission between a ZBRN• Harmony Hub and ZBRRH receiver
to command, for example, a tower light:

1 Harmony Hub
2 ZBRRH receiver
3 Pushbutton
4 Limit switch
5 Energy sensor
6 Humidity and thermal sensor

18 EIO0000001177 01/2020
 Introduction

7 Thermal sensor
8 XVU tower light

Call to action process:

Step Action
A If a problem occurs on the machine, the operator pushes its wireless pushbutton.
A message is sent to the Harmony Hub.
B The Harmony Hub send a message to the Maintenance Advisor.
C The Maintenance Advisor send a message to the Harmony Hub.
D The Harmony Hub send a message to a ZBRRH receiver.
E The ZBRRH receiver commands one lamp of the XVU tower light.

Compatible Receiver
Harmony Hub is compatible with the Harmony ZBRRH receiver:

EIO0000001177 01/2020 19
Introduction

Product References

ZBRN1: Standard Harmony Hub with Communication Module

1 Harmony Hub
2 Instruction Sheet (ZBRN1)
3 Modbus TCP Communication module
4 Instruction Sheet (ZBRCETH)

NOTE: ZBRN1 must be associated with a communication module, reference ZBRCETH (Ethernet
protocol).

20 EIO0000001177 01/2020
 Introduction

ZBRN2: Harmony Hub for Modbus Serial Line Communication

1 Harmony Hub
2 Instruction Sheet

Difference Between ZBRN1 and ZBRN2

ZBRN2 has an embedded communication port for a Modbus serial line, whereas ZBRN1 can
support Modbus TCP communication using ZBRCETH module.

EIO0000001177 01/2020 21
Introduction

22 EIO0000001177 01/2020
 Harmony Hub
Physical Description
EIO0000001177 01/2020

Chapter 2
Physical Description

Physical Description

Purpose
This chapter provides an overview of Harmony Hub ZBRN1 and ZBRN2 hardware: description,
output connectors, installation, and power supply connections.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
2.1 Product Overview 24
2.2 Installation 26
2.3 Specifications 38
2.4 Data Management 41

EIO0000001177 01/2020 23
Physical Description

Section 2.1
Product Overview

Product Overview

Hardware Description

ZBRN1

1 Four 7-segments displays with 5 LEDs

2 Power LED
3 Communication LED
4 Radio signal strength LED
5 Power input terminal block
6 Connector for the optional external antenna
7 Protective plug for the connector for the optional external antenna
8 ZBRCETH Communication module inserted with 2 RJ45 Ethernet connectors
9 Jog dial
10 SD memory card slot

24 EIO0000001177 01/2020
 Physical Description

ZBRN2

1 Four 7-segments displays with 5 LEDs

2 Power LED
3 Communication LED
4 Radio signal strength LED
5 Power input terminal block
6 Connector for the optional external antenna
7 Protective plug for the connector for the optional external antenna
8 2 RS-485 Modbus serial line connectors
9 Jog dial
10 SD memory card slot

EIO0000001177 01/2020 25
Physical Description

Section 2.2
Installation

Installation

What Is in This Section?

This section contains the following topics:
Topic Page
Installation Requirements 27
Mechanical Installation 33
Environmental Features 35
Housing 37

26 EIO0000001177 01/2020
 Physical Description

Installation Requirements

Before Starting
Read and understand this chapter before beginning the installation of your Harmony Hub.

DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION OR ARC FLASH
 Disconnect all power from all equipment including connected devices prior to removing any
covers or doors, or installing or removing any accessories, hardware, cables, or wires except
under the specific conditions specified in the appropriate hardware guide for this equipment.
 Always use a properly rated voltage sensing device to confirm the power off where and when
indicated.
 Replace and secure all covers, accessories, hardware, cables, and wires and confirm that a
proper ground connection exists before applying power to the equipment.
 Use only the specified voltage when operating this equipment and any associated products.
Failure to follow these instructions will result in death or serious injury.

Operating Environment

WARNING
UNINTENDED EQUIPMENT OPERATION
Install and operate this equipment according to the environmental conditions described in the
operating limits.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001177 01/2020 27
Physical Description

Installation Considerations

WARNING
UNINTENDED EQUIPMENT OPERATION
 Use appropriate safety interlocks where personnel and/or equipment hazards exist.
 Install and operate this equipment in an enclosure appropriately rated for its intended
environment.
 Do not use this equipment in safety critical and hoisting machine functions due to:
 No permanent communication
 No acknowledge of the message from the receiver to the transmitters.

 Do not disassemble, repair, or modify this equipment.

 Do not connect any wiring to reserved, unused connections, or to connections designated as
not connected (N.C.).
Failure to follow these instructions can result in death, serious injury, or equipment damage.

28 EIO0000001177 01/2020
 Physical Description

Architecture
The following figures shows the general principle of Harmony Hub architecture:

EIO0000001177 01/2020 29
Physical Description

NOTE:
 The previous figure is not exhaustive. It shows only the general principle of the architecture.
 Refer to the specifications section (see page 38) for detailed wiring diagram and instructions for
Harmony Hubs.
 Refer to the user manual of your associated products for detailed wiring diagrams and
instructions.
 Harmony Hub can be connected to any PLC supporting the network buses listed in this
document.

Connection Requirements
Power Supply Connection
24...240 Vac/Vdc
Network connection
 RS-485 Modbus serial line network
 Ethernet Modbus TCP network

30 EIO0000001177 01/2020
 Physical Description

Maximum Distances
The following figure shows the maximum distance between the transmitters and the
ZBRN1/ZBRN2 Harmony Hubs:

(*) The application environment can modify the typical values.

(**) Free field (unobstructed and without electromagnetic perturbations).

The level of signal attenuation depends on the material through which the signal passes:

Material Attenuation
Glass window 10...20 %(*)
Plaster wall 30...45 %(*)
Brick wall 60 %(*)
Concrete wall 70...80 %(*)
(*) Values for indication purpose only. Actual values depend on the thickness and nature of the material.

EIO0000001177 01/2020 31
Physical Description

Material Attenuation
Metal structure 60...100 %(*)
(*) Values for indication purpose only. Actual values depend on the thickness and nature of the material.

NOTE: You can add ZBRA1 or ZBRA2 antenna or both to increase the range.
The reception is reduced if Harmony Hub is placed in a metal cabinet.
For further information on the use of ZBRA1 and ZBRA2 antennas, refer to the Radio chapter
(see page 149).

Impact of the radio performances in the environment:

 For any environment, the radio performances are subjected to be instable due to perturbations
made by any kind of industrial machines, processes, or electronic devices.
 As a consequence at any time, it is possible that the radio frames sent by a transmitter will not
be caught by the receiver during the perturbation.
 With Harmony XB5R offer, only one radio frame is sent to the receiver, there is no permanent
radio communication. This reason prevents the use of Harmony XB5R offer for applications
where permanent reliability and/or permanent precisions are needed.

32 EIO0000001177 01/2020
 Physical Description

Mechanical Installation

Mounted on DIN Rail

Harmony Hub must be installed on DIN rails complying with EN/IEC 60715.
To install Harmony Hub, use a tool to press down the D lock for inserting the DIN rail.
The following figure shows the position of Harmony Hub on the DIN rail:

Mounted on a Grid or Plate

Harmony Hub can be installed on a grid or a plate.
The following steps explain how to install the module:

Step Action
1 Pull out the panel mounting hooks.
2 Mount Harmony Hub on the grid or plate using the screws as shown in the
following figure.

EIO0000001177 01/2020 33
Physical Description

34 EIO0000001177 01/2020
 Physical Description

Environmental Features

Specifications
The following table shows the general environmental specifications:

Characteristics Specifications
Standards Conformity to R&TTE 1999/5/EC, LVD 2006/95/EC, EMC2004/108/EC
standards
Conformity to EN/IEC 60947-1, EN/IEC 60947-5-1, EN/IEC60950-1, IEC61131-2, EN
standards 300440-2, EN300489-3, EN300328, EN62311
Conformity to UL 508 (USA), CSA C22-2 n° 14 (Canada), CCC (China), Gost (Russia)
standards
Radio FCC (USA), CSA, RSS (Canada), C-Tick (Australia), ANATEL (Brazil),
certifications SRRC (China), MIC (Japan)
Agencies
UL USA UL508, 17th edition
CSA Canada CSA C22.2, No. 142-M2000
C-Tick Australia –
GOST Russia –
ANATEL Brazil –
FCC USA –
SRRC China –
CCC China –
MIC Japan –
RSS Canada –
Ambient operating –25...+55 °C (–13...+131 °F)
temperature
Storage temperature –40...+70 °C (–40...+158 °F)
Relative humidity 95% RH at 55 °C (131 °F)
Degree of pollution 2 (IEC60664-1)
Degree of protection IP20
Shock resistance Half sine wave acceleration: 11 ms 30 gn (IEC 60068-2 27)
Resistance to vibration ±3.5 mm (±0.13 in.): 5...8.14 Hz
1 gn: 8.14...150 Hz when mounted on a panel
2 gn: 8.45...150 Hz when mounted on a DIN rail (IEC 60068-2-6)

EIO0000001177 01/2020 35
Physical Description

Characteristics Specifications
Altitude requirement Operation: 0...2000 m (6561.66 ft)
Storage: 0...3000 m (9842.49 ft)
Only used at altitude not exceeding 2000 m (6561.66 ft).

Only used in non-tropical climate regions.

36 EIO0000001177 01/2020
 Physical Description

Housing

Clearances and Mounting Position

(1) To enhance the signal reception, observe the above positioning.

(2) In a metal cabinet, the optimum place for Harmony Hub is on the top. This position avoids obstacles and
enhances the signal reception.

EIO0000001177 01/2020 37
Physical Description

Section 2.3
Specifications

Specifications

Electrical Specifications

Power Supply Specifications

Harmony Hub complies with the following power requirements:

Electrical Features Description

AC Power Supply DC Power Supply
Rated voltage 24...240 Vac 24...240 Vdc
Voltage range 21...264 Vac 21...264 Vdc
Rated frequency 50/60 Hz –
Frequency range 47...63 Hz –
Under voltage protection No
Terminal blocks 3-pin terminal with a pitch of 7.62 mm (0.3 in.) on the output terminal block
Immunity to short interruptions 10 ms
(Conforming to IEC 61000-4-
11)
Dielectric strength with others 3000 Vac / 4250 Vdc (input-output)
1500 Vac / 2150 Vdc (input-PE*)
Short-circuit protection Yes (internal fuse 2 A, 250 V)
* PE = protective earth ground

Power Supply Connections

You can connect the power supply to any common supply from 24...240 Vac/Vdc.

DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION OR ARC FLASH
Comply with the wiring diagram shown immediately after this message.
Failure to follow these instructions will result in death or serious injury.

38 EIO0000001177 01/2020
 Physical Description

The following table shows the recommended wire sizes for the L/+ and N/- terminals:

The following table shows the recommended wire sizes for the PE terminal (protective earth
ground):

The following table shows the recommend torque for the 3 terminals:

EIO0000001177 01/2020 39
Physical Description

WARNING
UNINTENDED EQUIPMENT OPERATION
For the protective earth ground (PE) wiring, use a cable not longer than 300 mm (11.8 in.).
Failure to follow these instructions can result in death, serious injury, or equipment damage.

The following table shows the input power consumption:

Reference Input Power

ZBRN1 9W
ZBRN2 3.3 W

WARNING
UNINTENDED EQUIPMENT OPERATION
 Supply this product with a power line protected by a circuit breaker rated 16 A maximum and
a ground fault circuit breaker.
 A readily accessible disconnect device shall be incorporated external to the equipment.
 Install this product in an electrical cabinet and lock the cabinet using a key.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

40 EIO0000001177 01/2020
 Physical Description

Section 2.4
Data Management

Data Management

What Is in This Section?

This section contains the following topics:
Topic Page
Compatibility Rules 42
Transmitter Types 43
Monostable Input 45
Set/Reset 46
Receiver Types 47

EIO0000001177 01/2020 41
Physical Description

Compatibility Rules

Transmitter Compatibility
ZBRT2 transmitter is compatible with the following only:
 ZBRRA, ZBRRC, and ZBRRD receivers with firmware version 2.0 and higher
 ZBRA1 relay antenna with firmware version 2.0 and higher
 ZBRN1 /ZBRN2 Harmony Hubs with firmware version higher than 1.2

ZBRN• Harmony Hubs Compatibility

ZBRN• Harmony Hub transmitters are compatible with the following only:
 ZBRRH receiver with firmware version 1.03 and higher

42 EIO0000001177 01/2020
 Physical Description

Transmitter Types

ZBRT1 and ZBRTP Transmitters

The radio message is sent when the button is pressed, signaled by a click. If the button is held
down, the message is not transmitted continuously. The message is not sent when the button is
released.
To avoid any conflict of multiple transmission from different transmitters, a minimum of 10 ms is
required between each radio transmission.

ZBRT1 is used for applications where single pulse is required (for example, remote start of
machine and reset after machine fault detection).

EIO0000001177 01/2020 43
Physical Description

ZBRT2 Transmitter

The radio message is sent when the button is pressed, signaled by a click.
If the button is held down, the message is not transmitted continuously.
A second radio message is sent when the button is released. This message is not transmitted
continuously. It is transmitted once, at the release of the push-button.
This transmitter is used only for the set/reset output mode.

44 EIO0000001177 01/2020
 Physical Description

Monostable Input

Principle
The battery-less transmitter is equipped with a dynamo generator that converts mechanical energy
(produced by pressing the push-button) into electrical energy. A radio-coded message with a
unique ID code is sent in single pulse form.
The radio signal is transmitted when the push-button is pressed. This action is indicated by a click
in the example shown below. If the button is held, the signal is not transmitted continuously. No
signal is sent when the button is released.
The corresponding input channel of Harmony Hub stays active, depending on the input holding
time range, from 100 ms...1 s.
The input holding time is set for all the input channels.

Example
The following figure shows an example of a monostable channel with the input holding time of
500 ms:

EIO0000001177 01/2020 45
Physical Description

Set/Reset

Push-button Set/Reset

NOTE:
1. Release and push again to resynchronize
2. Push and release again to resynchronize

46 EIO0000001177 01/2020
 Physical Description

Receiver Types

ZBRN Transmitter / ZBRRH Receiver

Harmony Hub can communicate with up to 60 ZBRRH receivers

EIO0000001177 01/2020 47
Physical Description

48 EIO0000001177 01/2020
 Harmony Hub
First Installation
EIO0000001177 01/2020

Chapter 3
First Installation

First Installation

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
First Start Up 50
Configuration 52
Pairing Procedures 54

EIO0000001177 01/2020 49
First Installation

First Start Up

Overview
Follow this procedure when installing and starting up Harmony Hub.

ZBRN1 Startup Procedure

The following table shows the startup procedure for ZBRN1 Harmony Hub:

Step Action Comments

1 Unpack your Harmony Hub (ZBRN1), the Refer to package content (see page 20).
Ethernet communication Module (ZBRCETH),
and check the contents of the packages.
2 Insert the communication module in Refer to ZBRCETH Communication Module
Harmony Hub. (see page 62).
3 Choose an appropriate cabinet. Refer to Mechanical Installation
4 Install Harmony Hub on a DIN rail, a grid, or a
(see page 33).
plate.
5 If needed, connect the external antenna to Refer to Mounting Tips for ZBRA2 External
Harmony Hub. Antenna (see page 151).
6 Ensure that upstream power is off. Connect the Refer to Power Supply Connections
external 24...240 Vac/Vdc power supply. (see page 38).
7 Turn on the power. –
8 Configure Harmony Hub through the user Refer to User Interface (see page 167).
interface.
9 Connect Ethernet communication buses and Refer to the Ethernet Cable (see page 71).
network.
10 Verify all the connections. –
11 Run the application. –

NOTE: If you want to access to call to action features (see page 18), you have to proceed to the
firmware update (3.29 and higher) (see page 192).

ZBRN2 Startup Procedure

The following table shows the startup procedure for the ZBRN2 Harmony Hub:

Step Action Comments

1 Unpack your Harmony Hub (ZBRN2) and check Refer to package content (see page 21).
the contents of the package.

50 EIO0000001177 01/2020
 First Installation

Step Action Comments

2 Choose an appropriate cabinet. Refer to Mechanical Installation
3 Install Harmony Hub on a DIN rail, a grid, or a
(see page 33).
plate.
4 If needed, connect the external antenna to Refer to Mounting Tips for the ZBRA2
Harmony Hub. External Antenna (see page 151).
5 Ensure that upstream power is off. Connect the Refer to Power Supply Connections
external 24...240 Vac/Vdc power supply. (see page 38).
6 Turn on the power. –
7 Configure Harmony Hub through the user Refer to User Interface (see page 167).
interface.
8 Connect the serial line communication buses and Refer to Modbus Serial Line Cables
network. (see page 82).
9 Connect line termination devices to Harmony Hub Refer to Modbus Serial Line Cabling
(optional). (see page 78).
10 Verify all the connections. –
11 Run the application. –

NOTE: If you want to access to call to action features (see page 18), you have to proceed to the
firmware update (3.29 and higher) (see page 192).

EIO0000001177 01/2020 51
First Installation

Configuration

Mandatory Settings
Configure the following 2 types of parameters:
 Communication protocol
 Wireless devices association

Configure Harmony Hubs through the user interface. Refer to Configuration Menu (see page 167).

Transmitters Association Definition

For each input channel of Harmony Hub, the following states are possible:
 Empty: No transmitter associated with the input.
 Associated off-line: The input parameters are configured but no radio exchanges have been
performed.
 Associated on-line: The input parameters are configured and radio exchanges have been
performed.
HMI display for the input states:
 I 02 means that the input 2 is free
 I-02 means that the input 2 is associated off-line
 I_02 means that the input 2 is associated on-line

ZigBee Over the Air

The transmitter may be:
 Static: Data are only sent by the transmitter to Harmony Hub during pairing.
There is no encryption key or the encryption key is hard-coded in the transmitter and sent to
Harmony Hub.
 OTA (Over the Air): The transmitter and Harmony Hub exchange data while pairing.
The encryption key is generated by Harmony Hub and sent to the transmitter.

Supported Transmitter Types

The following transmitter types are supported:

Type HMI label Related transmitters

number
1 So Push buttons, limit switches, …

52 EIO0000001177 01/2020
 First Installation

Type HMI label Related transmitters

number
2 E3 Reserved
3 th Reserved
4 CL Humidity and thermal monitoring sensors

5 Et Thermal monitoring sensors

6 S1 Generic ZigBee, PowerTag sensors

Pairing Modes
Depending on the type of transmitter associated, three pairing modes are available:

Menu Description Compatible Transmitter Types

transmitters
Id Manual pairing. The ID of the transmitter is Static transmitters Transmitters type
set manually.  So  1
 S1  6
t Teach pairing(1) OTA transmitters Transmitters type
The first transmitter emitting a pairing  So  1
request is paired to this input.  CL  4
 Et  5
 S1  6
t Id Teach pairing with ID(1) OTA transmitters Transmitters type
Only the transmitter emitting a pairing  So  1
request with the correct ID is paired to this  CL  4
input.  Et  5
 S1  6

(1) The pairing request must be received by Harmony Hub within 2 minutes after the pairing mode has
been selected.

EIO0000001177 01/2020 53
First Installation

Pairing Procedures

Overview
The steps to follow to add and pair a transmitter to an input of Harmony Hub depends on the type
of transmitter to add.
In the following examples, consider that four inputs are already configured and that the new
transmitter is paired to the free input 2.
Procedure examples:
 Adding a Type 1 Transmitter Through the User Interface (see page 54)
 Adding a Type 4 Transmitter Through the User Interface (see page 55)
 Adding a Type 5 Transmitter Through the User Interface (see page 56)
 Adding a Type 6 Transmitter Through the User Interface (see page 57)
 Teach an Associated Off-line Transmitter Through the User Interface (see page 58)
 Adding a ZBRRH Receiver Through the User Interface (see page 59)

Refer to Supported Transmitter Types (see page 52).

Adding a Type 1 Transmitter Through the User Interface

NOTE: Type 1 transmitters can be paired with several Harmony Hubs.
Steps to follow to add a type 1 transmitter using the Id pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 > I 02
in this example).
2 Select the type of transmitter. tY.So: push-buttons or limit switches
3 Select the pairing mode. Id: Manual pairing
4 Enter the first two digits of the transmitter ID. -
5 Enter the last two digits of the transmitter ID. I_02 is displayed (associated on-line)

Steps to follow to add a type 1 transmitter using the t pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 > I 02
in this example).
2 Select the type of transmitter. tY.So: push-buttons or limit switches
3 Select the pairing mode. t: Teach pairing
4 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes I 02 is displayed, the input is free.

54 EIO0000001177 01/2020
 First Installation

Step Action Comment

5 Press the transmitter button 3 times. t1 is displayed at first press
t2 is displayed at second press
t3 is displayed quickly at third press
I_02 is displayed (associated on-line)

Steps to follow to add a type 1 transmitter using the t Id pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 > I 02
in this example).
2 Select the type of transmitter. tY.So: push-buttons or limit switches
3 Select the pairing mode. t Id: Teach pairing with ID
4 Enter the first two digits of the transmitter ID. -
5 Enter the last two digits of the transmitter ID. -
6 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes, I-02 is displayed (associated off-
line), refer to Teach an Associated Off-line
Transmitter (see page 58).
7 Press the transmitter button once. I_02 is displayed (associated on-line)

Adding a Type 4 Transmitter Through the User Interface

NOTE: Type 4 transmitters can be paired with only one Harmony Hub.
The transmitter must be unpaired before to pair it to Harmony Hub.
To unpair the humidity and thermal monitoring sensor, press and maintain the transmitter button
until its embedded led flashes three times, and wait 15 s before to start the new pairing.
Steps to follow to add a type 4 transmitter using the t Id pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 > I 02
in this example).
2 Select the type of transmitter. tY.CL: Humidity and thermal monitoring
sensors
3 Select the pairing mode. t Id: Teach pairing with ID
4 Enter the first two digits of the transmitter ID. -
5 Enter the last two digits of the transmitter ID. -

EIO0000001177 01/2020 55
First Installation

Step Action Comment

6 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes, I-02 is displayed (associated off-
line), refer to Teach an Associated Off-line
Transmitter (see page 58).
7 Press and maintain the transmitter button t1 is displayed at first frame received
until its embedded led flashes two times to t2 is displayed at second frame received
set it on commissioning mode t3 is displayed quickly at third frame received
I_02 is displayed (associated on-line)

Adding a Type 5 Transmitter Through the User Interface

NOTE: Type 5 transmitters can be paired with only one Harmony Hub. The transmitter must be
unpaired before to pair it to Harmony Hub.
To unpair the thermal monitoring sensor, press and maintain the transmitter button until its
embedded led flashes three times, and wait 15 s before to start the new pairing.
Steps to follow to add a type 5 transmitter using the t Id pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 > I 02
in this example).
2 Select the type of transmitter. tY.Et: Thermal monitoring sensors
3 Select the pairing mode. t Id: Teach pairing with ID
4 Enter the first two digits of the transmitter ID. -
5 Enter the last two digits of the transmitter ID. -
6 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes, I-02 is displayed (associated off-
line), refer to Teach an Associated Off-line
Transmitter (see page 58).
7 Press and maintain the transmitter button t1 is displayed at first frame received
until its embedded led flashes two times to t2 is displayed at second frame received
set it on commissioning mode t3 is displayed quickly at third frame received
I_02 is displayed (associated on-line)

56 EIO0000001177 01/2020
 First Installation

Adding a Type 6 Transmitter Through the User Interface

NOTE: Type 6 transmitters can be paired with only one Harmony Hub. A type 6 transmitter must
be unpaired before to pair it to Harmony Hub. For more detailsabout type 6 transmitter unpairing
procedure, refer to the transmitter documentation.
Steps to follow to add a type 6 transmitter using the t Id pairing mode:

Step Action Comment

1 Go on a free input of Harmony Hub (input 2 rdY > ConF > In.04 >I 02
in this example).
2 Select the type of transmitter. tY.S1: Generic transmitter, PowerTag
3 Select the pairing mode. t Id: Teach pairing with ID
4 Enter the first two digits of the transmitter ID. -
5 Enter the last two digits of the transmitter ID. -
6 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes, I-02 is displayed (associated off-
line), refer to Teach an Associated Off-line
Transmitter (see page 58).
7 The self-powered PowerTag transmitter t1 is displayed at first frame received
sends frame periodically. t2 is displayed at second frame received
t3 is displayed quickly at third frame received
I_02 is displayed (associated on-line)

EIO0000001177 01/2020 57
First Installation

Teach an Associated Off-line Transmitter Through the User Interface

A transmitter is associated off-line if the transmitter ID is already configured but no radio exchanges
have been performed.
Steps to follow to teach a transmitter that is associated off-line:

Step Action Comment

1 Go on an associated off-line input of rdY > ConF > In.04 > I-02
Harmony Hub (input 2 in this example).
2 Select the pairing mode. t: Teach pairing
3 Harmony Hub is waiting for a paring request. t is blinking
If the commissioning request is not received within
2 minutes, I-02 is displayed (associated off-
line).
4 According to the transmitter type: t1 is displayed at first frame received
 Type 1: Press the transmitter button 3 t2 is displayed at second frame received
times. t3 is displayed quickly at third frame received
 Type4: Press and maintain the I_02 is displayed (associated on-line)
transmitter button until its embedded led
flashes two times to set it on
commissioning mode.
 Type5: Press and maintain the
transmitter button until its embedded led
flashes two times to set it on
commissioning mode.
 Type 6: The self-powered PowerTag
transmitter sends frame periodically.

58 EIO0000001177 01/2020
 First Installation

Adding a ZBRRH Receiver Through the User Interface

As a prerequisite, the Harmony Hub must have a MAC/ID. For more details, refer to Factory Mode
(see page 182).
Steps to follow to teach an Output (ZBRRH receiver) through the user interface:

Step Action Comment

1 On the ZBRRH: Select button Choice during 3 s.
Start Teach mode Then led 1 to 4 blink.
Press button Ok once
2 On the Harmony Hub: rdY > ConF > OU.04 > OU 02
Go on Output configuration menu (input 2 in
this example)
3 Select the pairing mode. t > YES
t: Teach pairing
4 Harmony Hub sends Pairing request -
5 On the ZBRRH: The Q1…Q4 outputs are active during 1 s after the
ZBRRH is commissioned teaching procedure.

ZBRRH Receiver turns-on one time (around 1 second) when commissioning and decommis-
sioning with the Harmony Hub.

WARNING
UNINTENDED EQUIPMENT OPERATION
Before performing the ZBRRH commissioning or decommissioning with the Harmony Hub,
consider the effect on all equipment connected to the ZBRRH.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

For a graphical explanation, refer to the teach ZBRRH procedure (see page 93).

EIO0000001177 01/2020 59
First Installation

60 EIO0000001177 01/2020
 Harmony Hub
Ethernet Communication
EIO0000001177 01/2020

Chapter 4
ZBRN1 Ethernet Communication

ZBRN1 Ethernet Communication

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Communication on The Ethernet Network 62
Addressing Modes 66
Communication and Status Indicator 68
Modbus TCP Settings and Supported Functions 70
Ethernet Cable 71

EIO0000001177 01/2020 61
Ethernet Communication

Communication on The Ethernet Network

Introduction
Ethernet is a widely used, low-cost technology for local area networks. This technology is used to
exchange data between several devices connected together on a network.

Network Connection

1 ZBRN1 Harmony Hub associated with ZBRCETH communication module

2 iPC
3 Pushbutton
4 Limit switch
5 Energy sensor
6 Humidity and thermal sensor
7 Thermal sensor

ZBRCETH Communication Module

ZBRCETH is a communication module that supports Ethernet Modbus TCP protocol.
The following procedure describes the insertion of the communication module:

Step Action
1 Disconnect all power from the ZBRN1 Harmony Hub.

62 EIO0000001177 01/2020
 Ethernet Communication

Step Action
2 Place the module in ZBRN1 Harmony Hub.

1 ZBRN1 Harmony Hub

2 ZBRCETH communication module
3 Press firmly into place.

EIO0000001177 01/2020 63
Ethernet Communication

The following procedure describes the removal of the communication module:

Step Action
1 Disconnect all power from the ZBRN1 Harmony Hub.
2 Push down the release tab.

3 Pull out the module.

ZBRCETH offers one Ethernet communication port equipped with two RJ45 plugs. It enables daisy
chain wiring between devices without using a switch.

64 EIO0000001177 01/2020
 Ethernet Communication

The following table shows the specifications of the communication module:

Feature Specifications
Plug Two RJ45 connectors
Driver  10/100 MB/s
 Auto negotiation
 Half/Full duplex

Type of cable Shielded

Topology Daisy chain
Automatic polarity correction Yes

RJ45 Layout Description

ZBRCETH communication module has two RJ45 connectors for Ethernet connectivity as shown in
the following figure:

The following table shows the pin details of the RJ45 connector:

RJ45 pins Signal Description

1 TX+ Transmission signal
2 TX- Transmission signal
3 RX+ Reception signal
4 Unused –
5 Unused –
6 RX- Reception signal
7 Unused –
8 Unused –

EIO0000001177 01/2020 65
Ethernet Communication

Addressing Modes

Address Assignment
Assign the IP address to Harmony Hub using one of the following methods:
 By a DHCP (dynamic host control protocol) server.
 By a BOOTP (bootstrap protocol) server (BOOTP zone).
 Using the IP address stored in the flash memory.

NOTE: If Harmony Hub detects a duplicate address, it does not start until a unique address is
assigned to the transmitter.

Address Assignment by a DHCP Server

The IP address assigned by a DHCP server is stored in a table of DHCP server.

Step Action Comments

1 Select DHCP mode from the Ethernet menu For further information, refer to the IP setting
using the jog dial on Harmony Hub. menu (see page 179).
2 Select the DHCP value between 0–159 using This action defines the device name.
the jog dial.
3 Wait 10 s. When the display stops flashing after 10 s,
Harmony Hub triggers a request for an IP
address.

Address Assignment by BOOTP Server

The BOOTP server contains a MAC address table for the device connected to network with its IP
address. The following steps explain how to assign the address to Harmony Hub from the BOOTP
server:

Step Action Comments

1 Select the BOOTP mode from the Ethernet For further information, refer to the IP setting
menu using the jog dial on Harmony Hub. menu (see page 179).
2 Wait 10 s. When the display stops flashing after 10 s,
Harmony Hub triggers a request for an IP
address.

66 EIO0000001177 01/2020
 Ethernet Communication

Assignment of Stored IP Addresses

Harmony Hub uses the IP address stored in its flash memory. The following steps explain how to
assign the address to Harmony Hub from the flash memory:

Step Action Comments

1 Select the Static IP mode from the Ethernet Harmony Hub uses the IP address stored in
menu using the jog dial on Harmony Hub. the flash memory. For further information, refer
to the IP setting menu (see page 179).
2 Wait 10 s. When the display stops flashing after 10 s,
Harmony Hub triggers a request for an IP
address.

Modbus Unit ID Parameter

Use the PLC with the following UIDs to access the device communication details:
 Use UID 247 to access the Ethernet diagnostics information (ZBRCETH communication
module server).
 Use UID to access the Modbus TCP registers, such as input registers and holding time (ZBRN1
Harmony Hub server):
 For firmware version ≤ V1.5, use UID 248 or 255 to access the Modbus TCP registers
 For firmware version = V3.26, use UID 248 to access the Modbus TCP registers
 For firmware version ≥ V3.31, use UID 248 or 255 to access the Modbus TCP registers

EIO0000001177 01/2020 67
Ethernet Communication

Communication and Status Indicator

Status LED on The ZBRN1 Harmony Hub

1 Power LED
2 Communication LED
3 Radio signal strength LED

The yellow Ethernet communication LED shows the following status:

 On/flashing: Data is being exchanged (depends on the quantity of information).
 Off: No data is being exchanged.

Status LED on The ZBRCETH Communication Module

The following table shows the Ethernet Modbus TCP LED status:

Item Name LED State Description Module State

1 Link/Activity port 1 Solid green Ethernet link is present at The module is detecting an
100 Mbit/s. Ethernet link.
Flashing green Ethernet link is present with The module is detecting Ethernet
Ethernet traffic at traffic.
100 Mbit/s.
Solid yellow Ethernet link is present at The module is detecting an
10 Mbit/s. Ethernet link.
Flashing yellow Ethernet link is present with The module is detecting Ethernet
Ethernet traffic at 10 Mbit/s. traffic.

68 EIO0000001177 01/2020
 Ethernet Communication

Item Name LED State Description Module State

2 Module status Green On. The module is turned on.
Off. The module is off.
3 Network status Red Harmony Hub is being The module is being turned on.
turned on.
Solid green The network is operating The module is operating normally.
normally.
4 flashes A duplicate IP condition The module is offline.
exists.
5 flashes The module is attempting to The module is sending
get an IP configuration from BOOTP/DHCP requests to a
BootP server. BootP server and awaiting a reply.
6 flashes The operation is normal with The BootP request timed out. The
default IP addressing module applies the default IP
settings. address (85.16.x.y).
4 Link/Activity port 2 Solid green Ethernet link is present at The module is detecting an
100 Mbit/s. Ethernet link.
Flashing green Ethernet link is present with The module is detecting Ethernet
Ethernet traffic at traffic.
100 Mbit/s.
Solid yellow Ethernet link is present at The module is detecting an
10 Mbit/s. Ethernet link.
Flashing yellow Ethernet link is present with The module is detecting Ethernet
Ethernet traffic at 10 Mbit/s. traffic.

EIO0000001177 01/2020 69
Ethernet Communication

Modbus TCP Settings and Supported Functions

For further information on Modbus TCP settings, refer to the Modbus Settings and Supported
Functions (see page 80).

70 EIO0000001177 01/2020
 Ethernet Communication

Ethernet Cable

Ethernet Cable for ZBRN1 Harmony Hub

The following figure shows the Ethernet cable used to connect to the terminal equipment:

Item Description Reference Length

1 Ethernet cable (2 x RJ45 490NTW00002U 2 m (6.6 ft)
connectors, one at each
490NTW00005U 5 m (16.4 ft)
end)
490NTW00012U 12 m (39.4 ft)

EIO0000001177 01/2020 71
Ethernet Communication

72 EIO0000001177 01/2020
 Harmony Hub
Modbus Serial Line Communication
EIO0000001177 01/2020

Chapter 5
ZBRN2 Modbus Serial Line Communication

ZBRN2 Modbus Serial Line Communication

Purpose
This chapter provides an overview of the Modbus layout description, communication and status
indicator, line termination mode, settings, and the supported functions.
For more details, refer to Modbus Serial Modbus Serial Link for Machines documentation
(see page 10).

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Communication on The Modbus Network 74
Communication and Status Indicator 77
Modbus Serial Line Wiring 78
Modbus Settings and Supported Functions 80
Modbus Serial Line Cables 82

EIO0000001177 01/2020 73
Modbus Serial Line Communication

Communication on The Modbus Network

Introduction
The Modbus protocol is a master/slave protocol. It allows a single master to request responses
from the slaves, or to act based on the request. The master can address individual slaves, or can
send a broadcast message to all slaves. The slaves return a message (response) to requests
addressed to them individually. The slaves do not return responses to broadcast requests from the
master.

WARNING
UNINTENDED EQUIPMENT OPERATION
Do not use more than one master on the Modbus network. Unintended I/O behavior can result if
more than one master is able to communicate on the network at the same time.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Network Connection

1 PLC as master
2 Modbus Advantys OTB network interface module
3 ZBRN2 Harmony Hub
4 ATV12 drive
5 Modbus serial line

74 EIO0000001177 01/2020
 Modbus Serial Line Communication

Modbus Serial Ports

The following figure shows the serial line connectors in ZBRN2 :

1 Serial line connectors

ZBRN2 offers 1 Modbus serial line communication port equipped with 2 RJ45 plugs. It enables
wiring between the devices without using a hub.
The following table shows the specifications of ZBRN2 :

Features Specification
Function Modbus slave and Modbus RTU
Plug 2 RJ45 connectors
Isolated Yes
Maximum cable length 1000 m (3280.83 ft)
Polarization No
Supported baud rates Auto/1200/2400/4800/19200/38400/115200
Parity Even/Odd/No/Auto
Stop bit 1 bit (even and odd)
2 bits (no parity)

EIO0000001177 01/2020 75
Modbus Serial Line Communication

RJ45 Layout Description

Modbus serial port is an RS-485, 2-wire and common Modbus serial line using a RJ45 connector.
The following figure shows the layout of RJ45 connector:

RJ45 pin Signal Description

1 Unused –
2 Unused –
3 Unused –
4 D1 Transmission signal.
5 D0 Reception signal.
6 Unused Reserved.
7 Unused Reserved (5...24 Vdc).
8 Common Common of signal and supply.

76 EIO0000001177 01/2020
 Modbus Serial Line Communication

Communication and Status Indicator

Modbus Communication and Status LED

1 Power LED
2 Communication LED
3 Radio signal strength LED

The yellow Modbus communication LED shows the following status:

 On/flashing: Data is being exchanged (depends on the quantity of information).
 Off: No data is being exchanged.

EIO0000001177 01/2020 77
Modbus Serial Line Communication

Modbus Serial Line Wiring

Network Connection
You can directly connect Harmony Hub to a PLC for a distance up to 20 m (65.62 ft) as shown in
the following figure:

WARNING
UNINTENDED EQUIPMENT OPERATION
 Use a Modbus serial line cable not longer than 20 m (65.62 ft).
 Add a 120 ohm termination line when Harmony Hub is located at the end of the Modbus serial
line (reference VW3A8306RC).
Failure to follow these instructions can result in death, serious injury, or equipment damage.

78 EIO0000001177 01/2020
 Modbus Serial Line Communication

Using TWDXCAT3RJ
TWDXCAT3RJ is used for three connections, polarization, and line termination.
The following figure shows the connection of the device on the bus using TWDXCAT3RJ:

Using TWDXCAISO
TWDXCAISO is used for isolation and line termination.
The following figure shows the connection of the device on the bus using TWDXCAISO
(even if Harmony Hub is already isolated):

For distances longer than 20 m (65.62 ft), verify that the other devices connected to the bus are
isolated. If other devices are not isolated, use the TWDXCAISO module.

EIO0000001177 01/2020 79
Modbus Serial Line Communication

Modbus Settings and Supported Functions

Modbus Message Structure

The Modbus protocol uses 16-bit words (registers) divided into 2 bytes of 8 bits each.
A Modbus message starts with a header followed by a 1-byte address. A Modbus message uses
a Modbus function as its first byte.
The following table shows the full structure of a Modbus RTU message:

Address Modbus Messages CRC

Function Code Data
1 byte 1 byte n-byte field 2 bytes

List of Supported Commands

The following table shows the list of Modbus commands:

Modbus Function Sub-Function: Command Description

Code: Modbus
Dec Index (Hex) Encapsulated
Interface
01 (0001 H) – Read coils. This function code is used to read the
content of one or more contiguous coil
statuses in a slave.
03 (0003 H) – Read holding registers. This function code is used to read the
content of one or more adjacent
registers in a slave.
06 (0006 H) – Write single register. This function code is used to write the
content of a register in a slave.
16 (0010 H) – Write n registers. This function code is used to write the
content of one or more contiguous
registers in the slave.
43 (002B H) 14 (000E H) Read device identification. This function code is used to read the
identification and other information
relating to the physical description of a
slave.

NOTE: Registers can be read or written only if the registers are adjacent.

80 EIO0000001177 01/2020
 Modbus Serial Line Communication

List of Identification Registers

The following table lists the Modbus identification registers:

Identifier Register Name Value Data Type

0 (0000 H) VendorName Schneider Electric ASCII string
1 (0001 H) ProductCode ZBRN1: 052848
ZBRN2: 052849
2 (0002 H) MajorMinorRevision 1.0 for the first official version
3 (0003 H) VendorUrl https://www.schneider-electric.com
4 (0004 H) ProductName Harmony
5 (0005 H) ModelName ZBRN1
ZBRN2

Abort Code

Function Code Abort Code Description

03 H 02 H One of the registers does not exist.
03 H Incorrect register number.
04 H Unavailable value.
06 H 02 H The register does not exist.
04 H Invalid value or register in read only.
10 H 02 H The register does not exist.
03 H Incorrect register number.
04 H Invalid value or register in read only.
2B H 01 H Modbus encapsulated interface different from 14.
02 H Identifier does not exist.
03 H Identifier > 4 or = 0

EIO0000001177 01/2020 81
Modbus Serial Line Communication

Modbus Serial Line Cables

Modbus Serial Line Cables for ZBRN2 Harmony Hub

The following figure shows the Modbus serial line cable with 2 RJ45 connectors to connect to any
device supporting the protocol:

Item Description Reference Length

1 Modbus serial line cable VW3A8306R03 0.3 m (0.9 ft)
VW3A8306R10 1 m (3.2 ft)
VW3A8306R30 3 m (9.8 ft)

The following figure shows the Modbus serial line cable with 1 RJ45 connector and 1 mini DIN
connector to connect to a Twido PLC:

82 EIO0000001177 01/2020
 Modbus Serial Line Communication

Item Description Reference Length

2 Modbus serial line cable for Twido PLC TWDXCARJ003 0.3 m (0.9 ft)
TWDXCARJ010 1 m (3.2 ft)
TWDXCARJ030 3 m (9.8 ft)

The following figure shows the Modbus serial line cable with 1 RJ45 connector and one USB
connector to connect to a PC:

Item Description Reference Length

3 Modbus serial line cable TCSMCNAM3M002P 2.5 m (8.2 ft)

The following figures show USB to RS-485 converter and Modbus serial line cable to connect to a
PC:

EIO0000001177 01/2020 83
Modbus Serial Line Communication

Item Description Reference Length

4a USB to RS-485 converter TSXCUSB485 –
4b Modbus serial line cable VW3A8306R03 –

The following figures show USB to RS-485 converter and Modbus serial line cable to connect to a
Twido PLC.

Item Description Reference Length

5a USB to RS-485 converter TSXCUSB485 –
5b Modbus serial line cable for Twido PLC TWDXCARJP03P –

84 EIO0000001177 01/2020
 Harmony Hub
ZBRRH Receiver for Harmony Hub
EIO0000001177 01/2020

Chapter 6
ZBRRH Receiver for Harmony Hub

ZBRRH Receiver for Harmony Hub

Purpose
This chapter provides an overview of the Harmony ZBRRH receiver, hardware description, output
connectors, installation, power supply connections, and main procedures.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Presentation of ZBRRH 86
General Installation Instruction for ZBRRH 87
Receiver Wiring Diagram 91
LED Status 92
How to Teach/Unteach ZBRRH 93
Lock/Unlock for ZBRRH 96
Total Reset Function Description 99

EIO0000001177 01/2020 85
ZBRRH Receiver for Harmony Hub

Presentation of ZBRRH

Programmable Receiver
The following figure shows the Harmony ZBRRH receiver:

(1): Selection button

(2): Validation button
The following table describes the characteristics of the receiver:

Designation Ouputs Receiver Voltage Reference Mass

Receiver with indicator light 4 PNP 24 Vdc ZBRRH 0.130 kg
LED and teach button 200 mA (0.287 lb)

86 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

General Installation Instruction for ZBRRH

Overview
The general installation instructions for ZBRRH are the same as the ZBRN ones:
 Maximum distances transmitter/receiver,
 The installation conditions,
 The mounting tips,
 The mounting tips for antenna,
 …

For more details, refer to the ZBRRH Instruction Sheet.

Maximum Distances

(*) Typical values that may be modified by the application environment.

(**) Free field (unobstructed).
NOTE:
 The range may be increased by adding antenna ZBRA1.
 The range is reduced if the transmitter is placed in a metal box (reduction factor: approx. 10%).
 Once wiring is complete, test the product in all possible active areas (while remaining within
range).
NOTE: The relay antenna must have a firmware version ≥V3.2.

EIO0000001177 01/2020 87
ZBRRH Receiver for Harmony Hub

The level of signal attenuation depends on the materials through which the signal will pass:

Material Attenuation
Glass window 10...20 % (*)
Plaster wall 30...45 % (*)
Brick wall 60 % (*)
Concrete wall 70...80 % (*)
Metal structure 60...100 % (*)
(*) Values for indication purposes only. Actual values depend on the thickness and nature of the material.

Installation Conditions

Receiver operating temperature -25...+55°C (-13...+131°F)

Receiver protection level IP20

88 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

Mounting Tips for Antenna

The ZBRA1 relay antenna is installed with regard to its vertical axis as shown in the following figure

The antenna and the receiver are installed following their vertical axis.
The relay antenna is used to bypass the obstacle as shown in the following figure:

EIO0000001177 01/2020 89
ZBRRH Receiver for Harmony Hub

NOTE: The antenna should be placed before the obstacle. The signal will be amplified before the
obstacle to enable to go through it.
Impact of the radio performances in the environment:
 For any environment, the radio performances are subjected to be instable due to perturbations
made by any kind of industrial machines, processes, or electronic devices.
 As a result at any time, it is possible that radio frames sent by a transmitter will not be caught
by the receiver during the perturbation.
 With XB5R offer, only one radio frame is sent to the receiver and there is no permanent radio
communication. This reason makes to avoid the use of XB5R offer for applications where
permanent reliability and/or permanent precisions are needed.

90 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

Receiver Wiring Diagram

Wiring Diagram
The following figure shows the wiring diagram for the Harmony ZBRRH receiver:

(2): 500 mA fuse from supplier Bussman® reference GMA-500 mA, 250 V 0.5 A fast-blow.

EIO0000001177 01/2020 91
ZBRRH Receiver for Harmony Hub

LED Status

ZBRRH

92 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

How to Teach/Unteach ZBRRH

Legend
The icons shown have the following meanings:

LEDs Meaning
Green

Yellow

Flashing

Teach ZBRRH Procedure

As a prerequisite, the Harmony Hub must have a MAC/ID. For more details, refer to Factory Mode
(see page 182).

EIO0000001177 01/2020 93
ZBRRH Receiver for Harmony Hub

This procedure shows how to Teach Q1…Q4 outputs (ZBRRH):

NOTE:
 If the ZBRRH receive any request from other ZBRN, the teaching procedure can not be
performed.
 The Q1…Q4 outputs are active during 1 s after the teaching procedure.
 The teaching procedure must be performed within 1 min 30 s.

94 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

Unteach ZBRRH Procedure

This procedure shows how to Unteach Q1…Q4 outputs (ZBRRH):

NOTE: The Q1…Q4 outputs are active during 1 s after the teaching procedure.

EIO0000001177 01/2020 95
ZBRRH Receiver for Harmony Hub

Lock/Unlock for ZBRRH

Introduction
Lock enables to block the menus access by non authorized persons. The functioning of the
receiver is not affected.

96 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

Electronic Lock/Unlock
This procedure shows how to electronically lock/unlock the receiver:

EIO0000001177 01/2020 97
ZBRRH Receiver for Harmony Hub

Mechanical Lock/Unlock
The following diagram shows how to perform buttons mechanical lock.

98 EIO0000001177 01/2020
 ZBRRH Receiver for Harmony Hub

Total Reset Function Description

Total Reset procedure for ZBRRH

Total Reset: After a Total Reset, the receiver is on factory setting. The registered ID is canceled.

EIO0000001177 01/2020 99
ZBRRH Receiver for Harmony Hub

100 EIO0000001177 01/2020

 Harmony Hub
Modbus Registers
EIO0000001177 01/2020

Chapter 7
Modbus Registers

Modbus Registers

Introduction
All the following addresses are indicated according to the IEC %MW standard format.
For access to Modbus registers, add 1 to each address.

WARNING
UNINTENDED EQUIPMENT OPERATION
Do not write or read the register addresses which are not mentioned in this document.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

All the registers used are 16 bits.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
7.1 Memory Table 102
7.2 Input Channels Registers 103
7.3 Output Registers 112
7.4 Action Registers 114
7.5 Diagnostic Registers 126
7.6 Configuration Registers 140

EIO0000001177 01/2020 101

Modbus Registers

Section 7.1
Memory Table

Memory Table

Memory Table

Memory Table
The memory table of the Harmony Hub ZBRN is composed by:

Register Name Mainly used

Address
0000…1999 Input registers (see page 103) Yes
Permits you to read inputs data.
2000…2099 Command Action registers (see page 114) Advanced
2100…2339 Output registers (see page 112) Yes
Permits you to command the activation of each output (Q1…Q4) of each
associated ZBRRH receiver.
2340…3999 Reserved -
4000…4999 Device Diagnostic (see page 127) No
5000…5999 Communication Diagnostics (see page 133) No
6000…6999 Device Configuration (see page 141) No
7000…7999 Communication Configuration (see page 146) No

102 EIO0000001177 01/2020

 Modbus Registers

Section 7.2
Input Channels Registers

Input Channels Registers

What Is in This Section?

This section contains the following topics:
Topic Page
Input Channels Registers 104
Type 1 Input Channels Registers 106
Type 4 Input Channels Registers 107
Type 5 Input Channels Registers 108
Type 6 Input Channels Registers 109

EIO0000001177 01/2020 103

Modbus Registers

Input Channels Registers

Input Channels
The following table presents the input channel registers:

Register Name Name Access Input Description

Address type(1) Channel
0000 Input registers Input register 1 R 0...15 Stores the status (0 or 1) of input
(see page 105) channels from 0 to 15 (2).
0001 Input register 2 R 16...31 Stores the status (0 or 1) of input
channels from 16 to 31 (2).
0002 Input register 3 R 32...47 Stores the status (0 or 1) of input
channels from 32 to 47 (2).
0003 Input register 4 R 48...59 Stores the status (0 or 1) of input
channels from 48 to 59 (2).
0004 Reserved Reserved - - -
…
0009
0010 Input Channel Data Input Channel 0 data R 0 Stores the data of input channel
… Registers 0.
0042 (see page 105)
0043 Input Channel 1 data R 1...58 Stores the data of input channels
… … from 1 to 58.
1956 Input Channel 58 data
1957 Input Channel 59 data R 59 Stores the data of input channel
… 59.
1989
1990 Reserved Reserved - - -
…
1999
1 R: Read only.
2 Only for push-buttons and limit switches.

104 EIO0000001177 01/2020

 Modbus Registers

Input Registers
Input registers 1…4 are reserved for push-button and limit switch transmitters (type 1 and some
type 6).
Each bit represents an input of Harmony Hub. When a valid message is received, the status bit is
updated to 1 for the duration of the holding time.
The following table presents the input channel registers:

Register Name Description Channel Status

Address
0000 Input register 1 Bit 0 = Input channel 0 status  0: Input channel OFF
…  1: Input channel ON
Bit 15 = Input channel 15 status
0001 Input register 2 Bit 0 = Input channel 16 status  0: Input channel OFF
…  1: Input channel ON
Bit 15 = Input channel 31 status
0002 Input register 3 Bit 0 = Input channel 32 status  0: Input channel OFF
…  1: Input channel ON
Bit 15 = Input channel 47 status
0003 Input register 4 Bit 0 = Input channel 33 status  0: Input channel OFF
…  1: Input channel ON
Bit 11 = Input channel 59 status
Bit 12…15 = Reserved

Input Channel Data Registers

The input channel data table (0010…1989) is composed with 60 sub-sections for the 60 inputs.
Each sub-section is 33 registers long.
For the input channel N (0…59): the first input data register address = 10 + 33 * N
The content of each input channel data registers depends on the transmitter type:
 Type 1 input channel registers for push buttons and limit switches. (see page 106)
 Type 4 input channel registers for thermal, humidity monitoring sensors. (see page 107)
 Type 5 input channel registers for thermal monitoring sensors. (see page 108)
 Type 6 input channel registers for generic ZigBee and power tag sensors. (see page 109)

EIO0000001177 01/2020 105

Modbus Registers

Type 1 Input Channels Registers

Overview
Type 1 is reserved for push buttons and limit switches.
For an input channel N (0…59), the input data register address = 10 + 33 * N + offset

Type 1 Input Channels Data

The following table presents the type 1 transmitter data mapping:

Offset Name Access Channel Status Description Unit

Register type
+0 Device type R Bit 0…Bit 7: Type of transmitter Stores the type of transmitter
 0: none associated to the input channel.
 1…6: type number

Bit 8…Bit 15: Reserved

+1 Time out R Bit 0…Bit 7: Timeout flag: Stores the time-out flag and the
RSSI  True: FF H (time out expired) radio reception power value.
 False: 00 H

Bit 8…Bit 15: RSSI:

 (-127…127 dBm)
 -128: Invalid value

+2 Time stamp R Two registers to store the double word Stores the details of the μs/320
value. time stamp
+3
+2: Stores the most significant word.
+3: Stores the least significant word.
 FFFF FFFF H: Invalid value
 00FF 0000 H: Rollback value

+4…6 Reserved - - -
+7, +8 Counters - Application CMD = 0x20 Number of ON command received
+9, +10 - Application CMD = 0x21 Number of OFF commands
received.
+11, +12 - Application CMD = 0x22 Number of Toggle commands
received. Example: ZBRT1.
+13, +14 - Application CMD = 0x60 Number of Press commands
received. Example: ZBRT2.
+15, +16 - Application CMD = 0x61 Number of Release commands
received. Example: ZBRT2.
+17…32 Reserved - - -
R: Read only.

106 EIO0000001177 01/2020

 Modbus Registers

Type 4 Input Channels Registers

Overview
Type 4 is reserved for thermal, humidity monitoring sensors.
For an input channel N (0…59), the input data register address = 10 + 33 * N + offset

Type 4 Input Channels Data

The following table presents the type 4 transmitter data:

Offset Name Access Channel Status Description Unit

Register type
+0 Device type R Bit 0…Bit 7: Type of transmitter Stores the type of transmitter
 0: none associated to the input channel.
 1…6: type number

Bit 8…Bit 15: Reserved

+1 Time out R Bit 0…Bit 7: Timeout flag: Stores the time-out flag and the
RSSI  True: FF H (time out expired) radio reception power value.
 False: 00 H

Bit 8…Bit 15: RSSI:

 (-127…127 dBm)
 -128: Invalid value

+2 Time stamp R Two registers to store the double word Stores the details of the μs/320
value. time stamp.
+3
+2: Stores the most significant word.
+3: Stores the least significant word.
 FFFF FFFF H: Invalid value
 00FF 0000 H: Rollback value

+4 Battery R Bit 0…Bit 7: Battery voltage Stores the internal 0.01 mV

voltage  FF H: Invalid value battery voltage.
Bit 8…Bit 15: Reserved
+5 Reserved - - -
+6 Temperature R  8000 H: Invalid value Stores the measured 0.01 °C
temperature.
+7 Humidity R  0…10,000 Stores the measured 100*%
 FFFF H: Invalid value humidity.
+8…32 Reserved - - -
R: Read only.

EIO0000001177 01/2020 107

Modbus Registers

Type 5 Input Channels Registers

Overview
Type 5 is reserved for thermal monitoring sensors.
For an input channel N (0…59), the input data register address = 10 + 33 * N + offset

Type 5 Input Channels Data

The following table presents the type 5 transmitter data:

Offset Name Access Channel Status Description

Register type
+0 Device type R Bit 0…Bit 7: Type of transmitter Stores the type of transmitter
 0: none associated to the input channel.
 1…6: type number

Bit 8…Bit 15: Reserved

+1 Time out R Bit 0…Bit 7: Timeout flag: Stores the time-out flag and the radio
RSSI  True: FF H (time out expired) reception power value.
 False: 00 H

Bit 8…Bit 15: RSSI:

 (-127…127 dBm)
 -128: Invalid value

+2 Time stamp R Two registers to store the double word Stores the details of the μs/320
value. time stamp.
+3
+2: Stores the most significant word.
+3: Stores the least significant word.
 FFFF FFFF H: Invalid value
 00FF 0000 H: Rollback value

+4 Battery R Bit 0…Bit 7: Battery voltage Stores the internal 0.01 mV

voltage  FF H: Invalid value battery voltage.
Bit 8…Bit 15: Reserved
+5 Reserved - - -
+6 Temperature R  8000 H: Invalid value Stores the measured 0.01 °C
temperature.
+7…32 Reserved - - -
R: Read only.

108 EIO0000001177 01/2020

 Modbus Registers

Type 6 Input Channels Registers

Overview
Type 6 is reserved for generic ZigBee and power tag sensors.
The data updated in the registers depend on the sensor. For more details, refer to the sensor
documentation.
For an input channel N (0…59), the input data register address = 10 + 33 * N + offset

Type 6 Input Channels Data

The following table presents the type 6 generic I/O transmitter data:

Offset Name Access Channel Status Description

Register type
+0 Device type R Bit 0…Bit 7: Type of transmitter Stores the type of transmitter
 0: none associated to the input channel.
 1…6: type number

Bit 8…Bit 15: Reserved

+1 Time out R Bit 0…Bit 7: Timeout flag: Stores the time-out flag and the radio
RSSI  True: FF H (time out expired) reception power value.
 False: 00 H

Bit 8…Bit 15: RSSI:

 (-127…127 dBm)
 -128: Invalid value

+2 Time stamp R Two registers to store the double word Stores the details of the μs/320
value. time stamp.
+3
+2: Stores the most significant word.
+3: Stores the least significant word.
 FFFF FFFF H: Invalid value
 00FF 0000 H: Rollback value

+4 Battery R Bit 0…Bit 7: Battery voltage Stores the internal battery 0.01 mV
voltage  FF H: Invalid value voltage.
Bit 8…Bit 15: Reserved
+5 Internal R  -200…200 °C Stores the internal °C
Temperature  8000 H: Invalid value temperature.
+6 Temperature R  8000 H: Invalid value Stores the measured 0.01 °C
temperature.
R: Read only.

EIO0000001177 01/2020 109

Modbus Registers

Offset Name Access Channel Status Description

Register type
+7 Energy R Four registers to store the energy value. Stores the energy -
+8 +7: Stores the most significant word.
+10: Stores the least significant word.
+9  FFFF FFFF FFFF FFFF H: Invalid
+10 value
+11 Unit R - Stores the unit of measure.
+12 Power A R  8000 H: Invalid value Stores the measured W
power phase A.
+13 Power B R  8000 H: Invalid value Stores the measured W
power phase B.
+14 Power C R  8000 H: Invalid value Stores the measured W
power phase C.
+15 Current A R  FFFF H: Invalid value Stores the measured A *100
current phase A.
+16 Current B R  FFFF H: Invalid value Stores the measured A *100
current phase B.
+17 Current C R  FFFF H: Invalid value Stores the measured A *100
current phase C.
+18 Voltage A R  FFFF H: Invalid value Stores the measured V *100
voltage phase A.
+19 Voltage B R  FFFF H: Invalid value Stores the measured V *100
voltage phase B.
+20 Voltage C R  FFFF H: Invalid value Stores the measured V *100
voltage phase C.
+21 CO2 R Two registers to store the double word Stores the measured CO2 0.01 %
+22 value. level.
+21: Stores the most significant word.
+22: Stores the least significant word.
 7FC0 0000 H: Invalid value

+23 CO R Two registers to store the double word Stores the measured CO 0.01 %
+24 value. level.
+23: Stores the most significant word.
+24: Stores the least significant word.
 7FC0 0000 H: Invalid value

+25 Illuminance R  FFFF H: Invalid value Stores the measured 10,000

illuminance. *Log(Lux)
+1
+26 Pressure R  FFFF H: Invalid value Stores the measured 10*kPa
pressure.
R: Read only.

110 EIO0000001177 01/2020

 Modbus Registers

Offset Name Access Channel Status Description

Register type
+27 Flow R  FFFF H: Invalid value Stores the measured flow. 100*m3/h
+28 Humidity R  0…10,000 Stores the measured 100*%
 FFFF H: Invalid value humidity.
+29 Occupancy R Bit 0…Bit 7: Occupancy Stores the status -
 FF H: Invalid value occupancy.
Bit 8…Bit 15: Reserved
+30 State On/Off R Bit 0…Bit 7: State On/Off Stores the state On/Off. -
 FF H: Invalid value

Bit 8…Bit 15: Reserved

+31 Level state R Bit 0…Bit 7: Level state Stores the level state. -
 FF H: Invalid value

Bit 8…Bit 15: Reserved

+32 Door lock R Bit 0…Bit 7: Door lock state Stores the door lock state. -
state  FF H: Invalid value

Bit 8…Bit 15: Reserved

R: Read only.

EIO0000001177 01/2020 111

Modbus Registers

Section 7.3
Output Registers

Output Registers

Output Registers

Overview
The Harmony Hub can be associated with up to 60 ZBRRH receivers. Each ZBRRH receiver has
an output channel stored in the Harmony Hub.
The Harmony Hub can command the outputs (Q1…Q4) of each associated ZBRRH receiver.

Recommendations

NOTICE
EQUIPMENT DAMAGE AND INFORMATION LOSS
The delay between 2 Modbus request to the Harmony Hub outputs must be greater than
1 second.
Failure to follow these instructions can result in equipment damage.

In order not to saturate the radio channel, it is recommended to write this request only when the
value of current request is different from the value of the previous request.

Output Registers
The output channel data table (2100…2339) is composed with 60 sub-sections for the 60 outputs.
Each sub-section is 4 registers long.
For the output channel N (0…59):the output data register address = 2100 + 4 * N
The following table presents the Output command registers:

112 EIO0000001177 01/2020

 Modbus Registers

Register Name Access Status Description

Address type
2100 Output 00 RW Bit 0…Bit 7: Action status Command Q1 of Harmony Hub Output 0
Command Q1  0x00: Off

2101 Output 00 RW  0x5A: Blink Command Q2 of Harmony Hub Output 0

Command Q2  0xFF: On

2102 Output 00 RW Command Q3 of Harmony Hub Output 0

Command Q3
2103 Output 00 RW Command Q4 of Harmony Hub Output 0
Command Q4
2104 Output 01…58 RW Bit 0…Bit 7: Action status Command Qx of Harmony Hub Output
… Command Qx  0x00: Off 1…58
2335  0x5A: Blink
 0xFF: On

2336 Output 59 RW Bit 0…Bit 7: Action status Command Q1 of Harmony Hub Output 59
Command Q1  0x00: Off

2337 Output 59 RW  0x5A: Blink Command Q2 of Harmony Hub Output 59

Command Q2  0xFF: On

2338 Output 59 RW Command Q3 of Harmony Hub Output 59

Command Q3
2339 Output 59 RW Command Q4 of Harmony Hub Output 59
Command Q4
RW: Read and write.

EIO0000001177 01/2020 113

Modbus Registers

Section 7.4
Action Registers

Action Registers

What Is in This Section?

This section contains the following topics:
Topic Page
Action Register 115
Action Codes 116

114 EIO0000001177 01/2020

 Modbus Registers

Action Register

Overview
Action registers permits to command Harmony Hub via Modbus. These registers are dedicated for
advanced users.

Command Action
The following table presents the Command Action registers:

Register Name Access Status Description

Address type
2000 Command Action R Bit 0: CE: Clear Error -
Bit 1: CC: Clear RF Counter
2001 - R - -
…
2009
2010 Command R Bit 0…Bit 7: Client ID Stores the Modbus action and
Device Module  0: None the Client ID.
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action Codes (see page 116)

2011 R Action parameters -
…
2031
2032 - R - -
…
2099
R: Read only.

EIO0000001177 01/2020 115

Modbus Registers

Action Codes

Overview
This section contains the action codes details of the register 2010: Command Device Module
Action (see page 115).
Action codes:
 1: Off-line association (see page 116)
 2: On-line association (see page 118)
 3: Remove device (see page 119)
 4: Clear all devices (see page 119)
 5: Start teach (see page 119)
 6: Stop teach (see page 120)
 15: Start remote configuration (see page 120)
 16: Stop remote configuration (see page 121)
 17: Get device - Write (see page 121)
 18: Get device - Read (see page 121)
 22: Teach Static (see page 123)
 24: Start teach all (see page 124)
 26: Teach Output (see page 124)
 27: Remove Output (see page 125)

Action Code 1 - Off-Line Association

The following table presents the Action code 1:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 1: Off-line association

0001 Type / Input ID R Bit 0…Bit 7: Type of transmitter -

 0: none
 1…6: type number

Bit 8…Bit 15: Input ID

 0…59: Input ID

R: Read only.
RW: Read and write.

116 EIO0000001177 01/2020

 Modbus Registers

Offset Name Access Status Description

Register type
0002 Association R Bit 0…Bit 7: Address type -
Mode  0: none
 1: Address type Source ID on 4 bytes.
 2: Address type IEEE on 8 bytes.

Bit 8…Bit 15: Association Mode

 0: none
 1: Static (No security)
 2: OTA Sensor (Security Sensor)
 3: OTA (No security)
 4: OTA box (Security box)

0003 - R Address (MSB) Source ID 2015 and 2016

0004 - R Address
IEEE 2013 to 2016
0005 - R Address
0006 - R Address (LSB)
0007 Security Mode R Bit 8…Bit 15: Reserved 0 – for new OTA sensors
Bit 0…Bit 7: Security Mode commissioning[1:5] for
 0: None restoring commissioned
 1: L0 (Static, No security) sensors or for STATIC
 2: L1 (Static, Long OOB) sensors
 3: L2 (Static, Long Shared)
 4: L3 (Static, Full OOB)
 5: L4 (Static, Full Shared)

Security Long: signature with frame counter

over 4 bytes Security Full: signature +
encryption
0008 - R Bit 8…Bit 15: Security Key B0 -
Bit 0…Bit 7: Security Key B1
0009 - R Bit 8…Bit 15: Security Key B2 -
Bit 0…Bit 7: Security Key B3
0010 - R Bit 8…Bit 15: Security Key B4 -
Bit 0…Bit 7: Security Key B5
0011 - R Bit 8…Bit 15: Security Key B6 -
Bit 0…Bit 7: Security Key B7
0012 - R Bit 8…Bit 15: Security Key B8 -
Bit 0…Bit 7: Security Key B9
0013 - R Bit 8…Bit 15: Security Key B10 -
Bit 0…Bit 7: Security Key B11
R: Read only.
RW: Read and write.

EIO0000001177 01/2020 117

Modbus Registers

Offset Name Access Status Description

Register type
0014 - R Bit 8…Bit 15: Security Key B12 -
Bit 0…Bit 7: Security Key B13
0015 - R Bit 8…Bit 15: Security Key B14 -
Bit 0…Bit 7: Security Key B15
0016 - R Parameter 1 Type 1 and 2 only
0017 - R Parameter 2 Type 2 only
0018 - R Parameter 3 -
0019 - R Parameter 4 -
0020 - R Parameter 5 -
R: Read only.
RW: Read and write.

Action Code 2 - On-Line Association

The following table presents the Action code 2:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 2: On-line association

0001 Input ID R Bit 0…Bit 7: Reserved -

Bit 8…Bit 15: Input ID
 0…59: Input ID

R: Read only.
RW: Read and write.

118 EIO0000001177 01/2020

 Modbus Registers

Action Code 3 - Remove Device

The following table presents the Action code 3:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 3: Remove device

0001 Input ID R Bit 0…Bit 7: Reserved -

Bit 8…Bit 15: Input ID
 0…59: Input ID

R: Read only.
RW: Read and write.

Action Code 4 - Clear All Devices

The following table presents the Action code 4:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 4: Clear all devices

R: Read only.
RW: Read and write.

Action Code 05 - Start Teach

The following table presents the Action code 5:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 5: Start teach

R: Read only.
RW: Read and write.

EIO0000001177 01/2020 119

Modbus Registers

Offset Name Access Status Description

Register type
0001 Input ID R Bit 8…Bit 15: Input ID 1 [0:59]: input ID
Bit 0…Bit 7: Input ID 2 0xFF: no Input
If no input selected, calls
0002 Input ID R Bit 8…Bit 15: Input ID 3
Bit 0…Bit 7: Input ID 4 Action "Teach All"
If only one input selected,
0003 Input ID R Bit 8…Bit 15: Input ID 5 calls Action "On-Line
Bit 0…Bit 7: Input ID 6 Association"
R: Read only.
RW: Read and write.

Action Code 06 - Stop Teach

The following table presents the Action code 6:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 6: Stop teach

R: Read only.
RW: Read and write.

Action Code 15 - Start Remote Configuration

The following table presents the Action code 6:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 15: Start remote configuration

R: Read only.
RW: Read and write.

120 EIO0000001177 01/2020

 Modbus Registers

Action Code 16: Stop Remote Configuration

The following table presents the Action code 6:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 16: Stop remote configuration

R: Read only.
RW: Read and write.

Action Code 17 - Get Device - Write

The following table presents the Action code 17:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 17: Get device

0001 Input ID R Bit 0…Bit 7: Reserved -

Bit 8…Bit 15: Input ID
 0…59: Input ID

R: Read only.
RW: Read and write.

Action Code 18 - Get Device - Read

The following table presents the Action code 17:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action code

 17: Get device

R: Read only.
RW: Read and write.

EIO0000001177 01/2020 121

Modbus Registers

Offset Name Access Status Description

Register type
0001 Type / Input ID R Bit 0…Bit 7: Type of transmitter -
 0: none
 1…6: type number

Bit 8…Bit 15: Input ID

 0…59: Input ID

0002 Association R Bit 0…Bit 7: Address type -

Mode  0: none
 1: Address type Source ID on 4 bytes.
 2: Address type IEEE on 8 bytes.

Bit 8…Bit 15: Association Mode

 0: none
 1: Static (No security)
 2: OTA Sensor (Security Sensor)
 3: OTA (No security)
 4: OTA box (Security box)

0003 - R Address (MSB) Source ID 2015 and 2016

0004 - R Address
IEEE 2013 to 2016
0005 - R Address
0006 - R Address (LSB)
0007 Security Mode R Bit 8…Bit 15: Reserved 0 – for new OTA sensors
Bit 0…Bit 7: Security Mode commissioning[1:5] for
 0: None restoring commissioned
 1: L0 (Static, No security) sensors or for STATIC
 2: L1 (Static, Long OOB) sensors
 3: L2 (Static, Long Shared)
 4: L3 (Static, Full OOB)
 5: L4 (Static, Full Shared)

Security Long: signature with frame counter

over 4 bytes
Security Full: signature + encryption
0008 - R Bit 8…Bit 15: Security Key B0 -
Bit 0…Bit 7: Security Key B1
0009 - R Bit 8…Bit 15: Security Key B2 -
Bit 0…Bit 7: Security Key B3
0010 - R Bit 8…Bit 15: Security Key B4 -
Bit 0…Bit 7: Security Key B5
0011 - R Bit 8…Bit 15: Security Key B6 -
Bit 0…Bit 7: Security Key B7
R: Read only.
RW: Read and write.

122 EIO0000001177 01/2020

 Modbus Registers

Offset Name Access Status Description

Register type
0012 - R Bit 8…Bit 15: Security Key B8 -
Bit 0…Bit 7: Security Key B9
0013 - R Bit 8…Bit 15: Security Key B10 -
Bit 0…Bit 7: Security Key B11
0014 - R Bit 8…Bit 15: Security Key B12 -
Bit 0…Bit 7: Security Key B13
0015 - R Bit 8…Bit 15: Security Key B14 -
Bit 0…Bit 7: Security Key B15
0016 - R Parameter 1 Type 1 and 2 only
0017 - R Parameter 2 Type 2 only
0018 - R Parameter 3 -
R: Read only.
RW: Read and write.

Action Code 22 - Teach Static

The following table presents the Action code 22:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action codes

 22: Teach Static

0001 Input ID R Bit 0…Bit 7: Reserved -

Bit 8…Bit 15: Input ID
 0…59: Input ID

R: Read only.
RW: Read and write.

EIO0000001177 01/2020 123

Modbus Registers

Action Code 24 - Start Teach All

The following table presents the Action code 24:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action codes

 24: Start teach all

R: Read only.
RW: Read and write.

Action Code 26 - Teach Output

The following table presents the Action code 26:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action codes

 26 - Teach Output

0001 Receiver R Bit 0…Bit 7: Reserved -

Number Bit 8…Bit 15: Receiver Number
 0…59: Receiver Number

R: Read only.
RW: Read and write.

124 EIO0000001177 01/2020

 Modbus Registers

Action Code 27 - Remove Output

The following table presents the Action code 27:

Offset Name Access Status Description

Register type
0000 Command R Bit 0…Bit 7: Client ID -
Device Module  0: None
Action  1…15: Client ID generated by the client

Bit 8…Bit 15: Action codes

 27: Remove Output

0001 Receiver R Bit 0…Bit 7: Reserved -

Number Bit 8…Bit 15: Receiver Number
 0…59: Receiver Number

R: Read only.
RW: Read and write.

EIO0000001177 01/2020 125

Modbus Registers

Section 7.5
Diagnostic Registers

Diagnostic Registers

What Is in This Section?

This section contains the following topics:
Topic Page
Device Diagnostics 127
Communication Diagnostics 133
Error Codes 136

126 EIO0000001177 01/2020

 Modbus Registers

Device Diagnostics

Overview
Device Diagnostic is composed by:
 4000…4009: Product Information (see page 127)
 4010…4015: Binding List Information (see page 128)
 4016…4039: Radio Communication Information (see page 129)
 4040…4099: Modbus Serial Line Communication Information (see page 131)
 4100…4999: Input Channel Transmitter Information (see page 131)

Product Information
The following table presents the product information registers:

Register Name Access Status Description

Address type
4000 Device name R 1: ZBRN1 Stores the device name.
2: ZBRN2
4001 Firmware version R Example for 0146: V3.26 Stores the firmware version.
4002 Communication R Bit 0: ZBRN2 (Modbus serial line) Stores the communication
protocol Bit 1: ZBRN1 (Ethernet) protocol used by
Harmony Hub.
4003 Configuration R Bit 0: The device is being configured Stores the configuration
through the user interface. status of the device.
Bit 1: The device is being configured
through the SD card interface.
Bit 2: The device is being configured
through the Modbus interface.
4004 Detected error R For more details, refer to Harmony Hub Stores the code of the
error codes (see page 136). detected error.
4005 Communication R Bit 0: ZBRN2 (Modbus serial line) Stores the communication
status Bit 1: ZBRN1 (Ethernet) protocol used by
Harmony Hub.
4006 Configuration file R Example for 0121: V01.21 Stores the configuration file
version FFFF H: No file used version.
4007 Client ID R Bit 0…Bit 3 Stores the client ID.
0: None
1…15: Client ID
R: Read only.
RW: Read and write.

EIO0000001177 01/2020 127

Modbus Registers

Register Name Access Status Description

Address type
4008 Action status R Bit 0…Bit 7: Action status Stores the Modbus action and
 0: Action successful the related status.
 1: Action not successful
 2: Invalid parameter

Bit 8…Bit 15: Action code

 0: None
 1: Off-line association
 2: On-line association
 3: Remove device
 4: Clear all devices
 5: Start teach
 5: Stop teach
 15: Start remote configuration
 16: Stop remote configuration
 17: Get device
 22: Update the radio connection
 24: Start teach all
 26: Teach Output
 27: Unteach Output

4009 Input R Bit 0…Bit 7: Current input for action Get -

Device
R: Read only.
RW: Read and write.

Binding List Information

The following table presents the binding list information registers:

Register Name Access Status Description

Address type
4010 Number of max R - Stores the maximal quantity
binding of sensors on the binding list.
4011 Bound quantity R - Stores the number of inputs
occupied (with associated off-
line and associated on-line
sensors)
4012 Paired quantity R - Stores the number of inputs
associated on-line
4013 No paired R - Stores the number of inputs
quantity associated off-line
R: Read only.
RW: Read and write.

128 EIO0000001177 01/2020

 Modbus Registers

Register Name Access Status Description

Address type
4014 Number of max R - Stores the number of
Device types transmitter types supported
4015 Device type R Bit field Stores the flags to show the
enable  Bit 0: Type 0 (free) supported transmitter types.
 Bit x: Type x

R: Read only.
RW: Read and write.

Radio Communication Information

The following table presents the radio communication information registers:

Register Name Access Status Description

Address type
4016 Radio R Bit 0…Bit 7: xx Stores the ZigBee stack
connection version: Vxx.yy.zz
4017 R Bit 0…Bit 7: zz
firmware version
Bit 8…Bit 15: yy
4018 Radio R Two registers to store the double word Stores the number of packets
connection - value. received by radio connection.
4019 R
Packets received 4018: Stores the most significant word.
counter 4019: Stores the least significant word.
The value is incremented each time
Harmony Hub receives a packet from an
associated transmitter.
4020 Radio R Two registers to store the double word Stores the number of non-
connection - non- value. operational packets received
4021 R
operational 4020: Stores the most significant word. by radio connection.
packets received 4021: Stores the least significant word.
counter The value is incremented each time
Harmony Hub receives a non-operational
packet from an associated transmitter.
4022 Radio R Two registers to store the double word Stores the number of packets
connection - value. sent by radio connection.
4023 R
Packets sent 4022: Stores the most significant word.
counter 4023: Stores the least significant word.
The value is incremented each time
Harmony Hub sends a packet to an
associated transmitter.
4024 Radio channel R 11...26: The radio channel with frequency Stores the details of the radio
2.405 GHz (channel 11...26 IEEE channel.
802.15.4).
R: Read only.
RW: Read and write.

EIO0000001177 01/2020 129

Modbus Registers

Register Name Access Status Description

Address type
4025 Emitted radio R -22…4: Signal strength in dBm Stores the details of the signal
signal strength -127: Starting or OFF strength for emission.
-128: Error detected.
4026 Radio R 0: OFF Stores the details of the radio
connection state 20: HOLD connection state.
21: INIT
22: SCAN
23: RUN
24: Commissioning
FE H: Starting
FF H: Error detected.
4027 Radio device R 0: None (off) Stores the current radio
type 1: Green power device type.
2: ZigBee green power concentrator
3: ZigBee green power router
4: Controller under upgrade
24: Commissioning
FE H: Starting
FF H: Error detected.
4028 Radio Pan ID R 0001 H…FFFE H Stores the radio Pan ID.
0000 H: Off, starting or error detected
4029 Radio short R 0000 H…FFFC H Stores the radio short
address FFFD H: Off,or error detected address.
FFFE H: Starting
4030 Radio IEEE R Four registers to store the IEEE address. Stores the radio IEEE
address 4030: Stores the most significant word. address.
4031
4033: Stores the least significant word.
4032
4033
4034 Radio R The value is incremented each time Stores the number of radio
connection - Harmony Hub radio connection restarts. connection restarts.
Boot counter
4035 Reserved - - -
…
4039
R: Read only.
RW: Read and write.

130 EIO0000001177 01/2020

 Modbus Registers

Modbus Serial Line Communication Information

The following table presents the Modbus serial line communication information registers:

Register Name Access Status Description

Address type
4040 Modbus boot R The value is incremented each time Stores the number of Modbus
counter Harmony Hub Modbus controller restarts. controller restarts.
4041 Reserved - - -
…
4049
4050 Modbus error R The value is incremented each time Stores the number of Modbus
counter Harmony Hub Modbus controller detects an detected errors.
error.
4051 Reserved - - -
…
4089
4090 Modbus system R Four registers to store the Modbus system Stores the Modbus system
clock clock. clock (ms).
4091
4090: Stores the most significant word.
4092 4093: Stores the least significant word.
4093
4094 Reserved - - -
…
4099
R: Read only.
RW: Read and write.

Input Channel Transmitter Information

The input channel data table (4100…4999) is composed with 60 sub-sections for the 60 inputs.
Each sub-section is 15 registers long.
For the input channel N (0…59): the first input data register address = 4100 + 14 * N
The following table presents the input channel 0 transmitter information registers:

Register Name Access Status Description

Address type
4100 Green power - R Two registers to store the double word value. Stores the number of the
4101 Input 0 4100: Stores the most significant word. Green power - input 0 frame
Frame counter 4101: Stores the least significant word. counter.
The value is incremented each time
Harmony Hub input 0 receives a frame from an
associated transmitter.
R: Read only. RW: Read and write.

EIO0000001177 01/2020 131

Modbus Registers

Register Name Access Status Description

Address type
4102 Green power - R Two registers to store the double word value. Stores the details of the
4103 Input 0 4102: Stores the most significant word. Green power - input 0 time
Time stamp 4103: Stores the least significant word. stamp (μs/320).
The value is updated each time Harmony Hub
input 0 receives a frame from an associated
transmitter.
4104 Green power - R Two registers to store the double word value. Stores the number of the
4105 Input 0 R 4104: Stores the most significant word. Green power - input 0
Packets 4105: Stores the least significant word. packets received since last
received The value is incremented each time restart.
counter Harmony Hub receives a packet from an
associated transmitter.
4106 Green power - R Two registers to store the double word value. Stores the number of the
Input 0 4106: Stores the most significant word. Green power - input 0 non-
4107 R
Non-operational 4107: Stores the least significant word. operational packets
packets The value is incremented each time received since last restart.
received Harmony Hub receives a non-operational
counter packet from an associated transmitter.
4108 Green power - R Two registers to store the double word value. Stores the number of the
Input 0 4108: Stores the most significant word. Green power - input 0 lost
4109 R
Lost packets 4109: Stores the least significant word. packets since last restart.
received The value is incremented each time
counter Harmony Hub detects a lost packet from an
associated transmitter.
4110 Green power - R Bit 0…Bit 7: LQI (0…255) Stores the radio signal
Input 0 Bit 8…Bit 15: Radio reception power (- strength of the Green power
Radio link 128…127 dBm) input 0
strength
4111 Green power - R Bit 0…Bit 7: Detected error code. Stores the teach status for
Input 0 Refer to Transmitter Error Codes the Green power input 0.
Teach status (see page 138)
Bit 8…Bit 15: Teach status
 1: Sensor is selected for a teach action

4112 - - - Reserved
…
4113
4114 Green power - R Bit 0…Bit 7: Type 2 sensor timeout Stores the clamp type and
Input 0 Bit 8…Bit 15: Type 2 clamp type timeout.
Type 2 sensor
details
R: Read only. RW: Read and write.

132 EIO0000001177 01/2020

 Modbus Registers

Communication Diagnostics

Overview
The communication diagnostic memory table depends on the device communication:
 Modbus Serial Line Communication Diagnostics (see page 133)
 Modbus TCP Communication Diagnostics (see page 134)

Modbus Serial Line Communication Diagnostics

The following table presents the Modbus serial line communication diagnostics registers:

Register Name Access Status Description

Address type
5000 Actual baud rate R 1: 1200 bps Stores the baud rate at
2: 2400 bps which the data is sent.
3: 4800 bps
4: 9600 bps
5: 19,200 bps
6: 38,400 bps
7: 115,200 bps
5001 Actual frame R 1: The frame format sent is 8 data bits, even Stores the data frame
setting parity, and 1 stop bit. format received by
2: The frame format sent is 8 data bits, odd Harmony Hub.
parity, and 1 stop bit.
3: The frame format sent is 8 data bits, no
parity, and 2 stop bits.
5002 Number of R Two registers to store the double word Stores the number of
5003 packages R value. packages received by
received 5002: Stores the most significant word. Harmony Hub.
5003: Stores the least significant word.
5004 Number of non- R Two registers to store the double word Stores the number of non-
5005 operational R value. operational packages
packages 5004: Stores the most significant word. received by Harmony Hub.
received 5005: Stores the least significant word.
5006 Number of R Two registers to store the double word Stores the number of
5007 packages sent R value. packages sent by the
5006: Stores the most significant word. transmitters.
5007: Stores the least significant word.
5008 Number of non- R Two registers to store the double word Stores the number of non-
5009 operational R value. operational packages sent
packages sent 5008: Stores the most significant word. by the transmitters.
5009: Stores the least significant word.
R: Read only.

EIO0000001177 01/2020 133

Modbus Registers

Register Name Access Status Description

Address type
5010 - - - Reserved
…
5999
R: Read only.

Modbus TCP Communication Diagnostics

The following table presents the Modbus TCP communication diagnostics registers:

Register Name Access Status Description

Address type
5000 IP address R Two registers to store the four bytes value. Stores the IP address used.
0.0.0.0 … 255.255.255.255
5001
5002 IP mask R Two registers to store the four bytes value. Stores the IP mask used.
0.0.0.0 … 255.255.255.255
5003
5004 IP gateway R Two registers to store the four bytes value. Stores the IP gateway used.
0.0.0.0 … 255.255.255.255
5005
5006 MAC address R Three registers to store the MAC address. Stores the MAC address
used.
5007
5008
5009 - - - Reserved
…
5018
5019 Number of R Two registers to store the double word Stores the number of
packages value. packages received by
5020 R
received 5019: Stores the most significant word. Harmony Hub.
5020: Stores the least significant word.
5021 Number of non- R Two registers to store the double word Stores the number of non-
operational value. operational packages
5022 R
packages 5021: Stores the most significant word. received by Harmony Hub.
received 5022: Stores the least significant word.
5023 Number of R Two registers to store the double word Stores the number of
packages sent value. packages sent by
5024 R
5023: Stores the most significant word. Harmony Hub.
5024: Stores the least significant word.
5025 Number of non- R Two registers to store the double word Stores the number of non-
operational value. operational packages sent
5026 R
packages sent 5025: Stores the most significant word. by the transmitters.
5026: Stores the least significant word.
R: Read only.

134 EIO0000001177 01/2020

 Modbus Registers

Register Name Access Status Description

Address type
5027 - - - Reserved
…
5999
R: Read only.

EIO0000001177 01/2020 135

Modbus Registers

Error Codes

Overview

Harmony Hub Error Codes

The detected errors of the Harmony Hub are stored in the 4004 register (see page 127).
They are displayed in the HMI via rdy>diag>ds>ER.00.
The following table presents Harmony Hub error codes:

Error Code Detected error Range Description

00 General No error detected
01 Target not supported
02 Invalid version of Industrial configuration
03 Industrial configuration not found
04 Invalid Industrial configuration
05 Assert Error
10 SD memory card The SD card cannot be accessed
For more details on
11 The SD card is write protected
the SD card files, refer
12 to File management Not enough space available in the SD card
13 and diagnostics Invalid parameter
(see page 194).
14 Invalid network configuration file
15 Invalid device configuration file
16 More than one network configuration file in the net folder
17 More than one device configuration file in the device folder
18 No network configuration file in the net folder
19 No device configuration file in the device folder

136 EIO0000001177 01/2020

 Modbus Registers

Error Code Detected error Range Description

20 Green Power COM_FCS_ERROR
21 Invalid Status Code in response
22 Process Timeout
23 Request Invalid
24 Request Execution Timeout
25 Invalid parameter
26 Decode Message Error
27 Module Invalid Capacity
28 Incompatible Version
29 Start/Stop Process
2A Error during start Process
2B Error during run Process
2C Error during upgrade Process
2D Undefined message
30 Ethernet Duplicate IP address
31 Invalid IP address
32 Communication module detected error
33 Communication module not supported
34 Communication module not detected
40 Data Error while processing device data
41 Error while processing device commissioning
50 Watchdog Harmony Hub Reset
51 Other Reset
60 Backup Invalid configuration slot 1
61 Invalid configuration slot 2
62 Invalid configuration slot 1 and slot 2
63 Initialization configuration slot 1
64 Initialization configuration slot 2
65 Store configuration slot 1
66 Store configuration slot 2
67 Store 2 configuration slot 1
68 Store 2 configuration slot 2
70 Modbus Modbus Invalid configuration
80 Action Trace Action Process

EIO0000001177 01/2020 137

Modbus Registers

Transmitter Error Codes

The transmitter detected errors are stored in the 4111 register (see page 131).
They are displayed in the HMI via rdy>diag>in.21>i-.00>ER.00.
The following table presents the transmitter error codes:

Error Code Detected error Range Description

00 General No error detected
10 Commissioning Commissioning unsupported
11 Commissioning Error Device type
12 Commissioning Error Manufacturer ID
13 Commissioning Error Manufacturer Product ID
14 Commissioning Error Security
15 Commissioning Error Device Capacity
16 Commissioning Error Cluster List
20 Data Data Command ID filter
21 No data
22 Data unsupported Command ID
23 Data Error parse Length Manufacturer ID
24 Data Error parse Length Cluster ID
25 Data Error parse Length Attribute Id
26 Data Error parse Length data,
27 Data unsupported data type,
28 Data Error Search Attribute
29 Data Mismatch data type
2A Data Parse Error
2B Data Error
30…37 Process E3 Reserved

138 EIO0000001177 01/2020

 Modbus Registers

Error Code Detected error Range Description

40 Process ZCL Process ZCL Invalid Metering Value 1
41 Process ZCL Invalid Metering Value 2
42 Process ZCL Invalid Metering Value 3
43 Process ZCL Invalid Metering Value 4
44 Process ZCL Invalid Electrical measurement Current value 1
45 Process ZCL Invalid Electrical measurement Current value 2
46 Process ZCL Invalid Electrical measurement Voltage value 1
47 Process ZCL Invalid Electrical measurement Voltage value 2
48 Process ZCL Invalid Electrical measurement Power value 1
49 Process ZCL Invalid Electrical measurement Power value 2
50 Process Process Error

EIO0000001177 01/2020 139

Modbus Registers

Section 7.6
Configuration Registers

Configuration Registers

What Is in This Section?

This section contains the following topics:
Topic Page
Device Configuration 141
Communication Configuration 146

140 EIO0000001177 01/2020

 Modbus Registers

Device Configuration

Overview
Device configuration is composed by:
 6000…6099: Channel Configuration (see page 141)
 6100…6199: Teaching List (see page 142)
 6200…6399: Input Parameters 1…2 (see page 143)
 6400…6699: MAC Addresses (see page 143)
 6700…6999: Input Parameters 3…5 (see page 145)

Channel Configuration
The following table presents the channel configuration for all inputs registers:

Register Name Access Input Channel Status Description

Address type Channel
6000 Radio RW – 0: None (off) Stores the radio communication
communicati 1: Green power mode.
on mode 2: ZigBee green power
concentrator
3: ZigBee green power router
6001 Radio RW – 11...26: The radio channel Stores the radio channel.
channel with frequency 2.405 GHz
(channel 11...26 IEEE
802.15.4).
6002 Radio RW – 0001 H…FFFF H Stores the radio Pan ID.
Pan ID
6003 Emitted RW – -22…4: Signal strength in Stores the details of the signal
radio signal dBm strength for emission.
strength
6004 Reserved – – – –
…
6009
6010 Table RW – 0: One UID per Harmony Hub Stores the table selection.
selection 1…4: One UID per sensor
6011 Reserved – – – –
…
6019
RW: Read and write.

EIO0000001177 01/2020 141

Modbus Registers

Register Name Access Input Channel Status Description

Address type Channel
6020 Holding time RW – 0: 100 ms Stores the holding time for all
1: 200 ms the input channels.
2: 300 ms
3: 400 ms
4: 500 ms
5: 1 s
6021 Reserved – – – –
…
6099
RW: Read and write.

Holding time:
A 16-bit register stores the holding time of the input channels.

Teaching List
The following table presents the teaching list registers:

Register Name Access Input Channel Status Description

Address type Channel
6100 Teaching list RW 0…59 Bit 0 to 2: Stores the details of the
…  0: The channel is transmitter used.
6159 disabled.
 1…6: The type 1…6
transmitter is used.
Bits3 to 13 are not used.
Bit 14: Pairing status
 0: Sensor associated
online.
 1: Sensor associated
offline.
Bit 15: Address type length
 0: Address type Source Id
on 4 bytes.
 1: Address type IEEE on
8 bytes.
6160 Reserved – – – –
…
6199
RW: Read and write.

Teaching list:

142 EIO0000001177 01/2020

 Modbus Registers

A 16-bit register stores the details of the transmitters used.

Input Parameters 1…2

The following table presents the input parameters registers 1…2:

Register Name Access Input Channel Status Description

Address type Channel
6200 Input RW 0…59 Holding time. Stores the input parameter 1 list.
… parameter 1
6259 list
6260 Reserved – – – –
…
6299
6300 Input RW 0…59 – Stores the input parameter 2 list.
… parameter 2 Output Association - Channel
6359 list
6360 Reserved – – – –
…
6399
RW: Read and write.

MAC Addresses
The following table presents the MAC addresses registers:

Register Name Access Input Channel Status Description

Address type Channel
6400 Transmitter RW 0…59 srcID4: First byte of the MAC Stores the MAC addresses of the
… ID/MAC address. transmitters.
6519 addresses srcID5: Second byte of the Two registers are used to store MAC
MAC address. address of one transmitter.
srcID6: Third byte of the MAC Example:
address. Transmitter ID (written on the
srcID7: Fourth byte of the transmitter label) = 030079B1.
MAC address. Registers 6410–6411, input channel
5.
6410: stores 0300 (2 bytes of the
transmitter ID).
6411: stores 79B1 (2 bytes of the
transmitter ID).
RW: Read and write.

EIO0000001177 01/2020 143

Modbus Registers

Register Name Access Input Channel Status Description

Address type Channel
6520 Transmitter RW 0…59 srcID0: First byte of the MAC Stores the MAC extended
… ID/MAC address. addresses of the transmitters.
6639 extended srcID1: Second byte of the Two registers are used to store
addresses MAC address. extended MAC address of one
srcID2: Third byte of the MAC transmitter.
address. Example:
srcID3: Fourth byte of the Transmitter ID (written on the
MAC address. transmitter label) = 030079B1.
Registers 6530–5331, input channel
5.
6530: stores 0300 (2 bytes of the
transmitter ID).
6531: stores 79B1 (2 bytes of the
transmitter ID).
6640 Reserved – – – –
…
6699
RW: Read and write.

Transmitter/MAC addresses:
Two registers of 16 bits store the MAC address of the transmitters.
The first byte of the MAC address is stored in 8 bits of register 1.
The second byte of the MAC address is stored in 8 bits of register 1.
The third byte of the MAC address is stored in 8 bits of register 2.
The fourth byte of the MAC address is stored in 8 bits of register 2.

144 EIO0000001177 01/2020

 Modbus Registers

Input Parameters 3…5

The following table presents the input parameters registers 3…5:

Register Name Access Input Channel Status Description

Address type Channel
6700 Input RW 0…59 – Stores the input parameter 3 list.
… parameter 3 Output association - Q1…Q4
6759 list
6760 Reserved – – – –
…
6799
6800 Input RW 0…59 – Stores the input parameter 4 list.
… parameter 4
6859 list
6860 Reserved – – – –
…
6899
6900 Input RW 0…59 – Stores the input parameter 5 list.
… parameter 5
6959 list
6960 Reserved – – – –
…
6999
RW: Read and write.

EIO0000001177 01/2020 145

Modbus Registers

Communication Configuration

Overview
The communication configuration memory table depends on the device communication:
 Modbus Serial Line Communication Configuration (see page 133)
 Modbus TCP Communication Configuration (see page 134)

Modbus Serial Line Communication Configuration

Register Name Access Status Description

Address type
7000 Baud rate RW 1: 1200 bps Stores the baud rate at
2: 2400 bps which the data is sent.
3: 4800 bps
4: 9600 bps
5: 19,200 bps
6: 38,400 bps
7: 115,200 bps
7001 Frame setting RW 0: Automatic detection Stores the data frame
2: The frame format sent is 8 data bits, odd format received by
parity, and 1 stop bit. Harmony Hub.
3: The frame format sent is 8 data bits, no
parity, and 2 stop bits.
7002 Slave ID RW 1…247 Stores the Modbus slave ID
of Harmony Hub.
7003 Auto detection RW 0: Auto detection mode is disabled. Stores the auto detection
1: Auto detection mode is enabled. mode.
7004 - - - Reserved
…
7999
RW: Read and write.

146 EIO0000001177 01/2020

 Modbus Registers

Modbus TCP Communication Configuration

Register Name Access Status Description

Address type
7000 IP address RW Two registers to store the four bytes value. Stores the IP address.
7001 0.0.0.0 … 255.255.255.255

7002 IP mask RW Two registers to store the four bytes value. Stores the IP mask.
0.0.0.0 … 255.255.255.255
7003
7004 IP gateway RW Two registers to store the four bytes value. Stores the IP gateway.
0.0.0.0 … 255.255.255.255
7005
7006 IP mode RW 0: DHCP Stores the IP mode.
1: BOOTP
2: Stored.
3: Default.
7007 IP name RW 0…255 Stores the IP name.
7008 - - - Reserved
…
7999
RW: Read and write.

EIO0000001177 01/2020 147

Modbus Registers

148 EIO0000001177 01/2020

 Harmony Hub
Radio
EIO0000001177 01/2020

Chapter 8
Radio

Radio

Radio Communication

Introduction
Harmony Hub is equipped with:
 A radio receiver: Harmony Hub receives radio frames from wireless transmitters.
 A radio transmitter: Harmony Hub transmit radio frames to ZBRRH receiver.

Radio Communication Specifications

The following table shows the specifications of the radio communication:

Characteristics Specifications
Frequency 2.405 GHz (channel 11 IEEE 802.15.4)
Maximum distance 100 m (328.08 ft) (when Harmony Hub is in free field)

For more details, refer to Maximum Distances (see page 31).

EIO0000001177 01/2020 149

Radio

ZBRA2 External Antenna

The ZBRA2 external antenna is an accessory, which you have to order separately.
You can connect it to Harmony Hub to improve the signal reception.
To install the ZBRA2 external antenna, open the protective plug and connect the antenna as shown
in the following figure:

1 Protective plug
2 Radio connector

NOTE: Only the ZBRA2 external antenna can be connected to the radio connector.
The following table shows the specifications of ZBRA2 antenna:

Parameters Specifications
Bandwidth 83...100 MHz
Frequency 2400...2483 MHz
Gain >3 dBi
Impedance 50 ohms
Polarization Vertical
RF connector Radial R 300113100
Cable length 2 m (6.56 ft)

150 EIO0000001177 01/2020

 Radio

Mounting Tips for The ZBRA2 External Antenna

The ZBRA2 external antenna is to be placed on the top of the metal cabinet where Harmony Hub
is installed as shown in the following figure:

The antenna is equipped with a magnet at the bottom to mount it on the metal cabinet.
When the ZBRA2 external antenna is connected to Harmony Hub, you can also use the ZBRA1
relay antenna.

EIO0000001177 01/2020 151

Radio

Mounting Tips for The ZBRA1 Relay Antenna

The ZBRA1 relay antenna and Harmony Hub are installed with regard to their vertical axis as
shown in the following figure:

The relay antenna is used to bypass the obstacle as shown in the following figure:

152 EIO0000001177 01/2020

 Radio

You can also use the relay antenna to amplify the signal before an obstacle that cannot be
bypassed, such as a factory building as shown in the following figure:

NOTE: In this case, if there is no relay antenna, the signal received by Harmony Hub may not be
sufficient.
The following table shows the differences between ZBRA1 and ZBRA2:

ZBRA1 ZBRA2
An active antenna (transceiver) for increasing A passive antenna for increasing the signal
the signal reception. reception without saturating the bandwidth.
Repeats the signal received from the Does not repeat the signal received from the
transmitter and amplifies it. transmitter.
Consumes power. Does not consume power.

EIO0000001177 01/2020 153

Radio

FCC USA and IC Canada Compliance Statement (ZBRN1 and ZBRN2)

This device complies with part 15 of the FCC Rules and Industry Canada license-exempt RSS
standard(s). Operation is subject to the following 2 conditions:
1) This device may not cause harmful interference.
2) This device must accept any interference received, including interference that may cause
undesired operation.
Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio
exempts de licence. L'exploitation est autorisée aux deux conditions suivante:
1) L’appareil ne doit pas produire de brouillage.
2) L’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage
est susceptible d’en compromettre le fonctionnement.
NOTE: This equipment has been tested and found to comply with the limits for a Class B digital
device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable
protection against harmful interference in a residential installation. This equipment generates,
uses, and can radiate radio frequency energy and, if not installed and used in accordance with the
instructions, may cause harmful interference to radio communications. However, there is no
guarantee that interference will not occur in a particular installation. If this equipment does cause
harmful interference to radio or television reception, which can be determined by turning the
equipment off and on, the user is encouraged to try to correct the interference by one or more of
the following measures:
 Reorient or relocate the receiving antenna.
 Increase the separation between the equipment and receiver.
 Connect the equipment into an outlet on a circuit different from that to which the receiver is
connected.
 Consult the dealer or an experienced radio/TV technician for help.

Under Industry Canada regulations, this radio transmitter may only operate using an antenna of a
type and maximum (or lesser) gain approved for the transmitter by Industry Canada. To reduce
potential radio interference to other users, the antenna type and its gain should be so chosen that
the equivalent isotropically radiated power (e.i.r.p.) is not more than that necessary for successful
communication. This radio transmitter (IC: 7002C-ZBRN1, 7002C-ZBRN2 ) has been approved by
Industry Canada to operate with the antenna types listed below with the maximum permissible gain
and required antenna impedance for each antenna type indicated. Antenna types not included in
this list, having a gain greater than the maximum gain indicated for that type, are strictly prohibited
for use with this device.

154 EIO0000001177 01/2020

 Radio

Conformément à la réglementation d'Industrie Canada, le présent émetteur radio peut fonctionner

avec une antenne d'un type et d'un gain maximal (ou inférieur) approuvé pour l'émetteur par
Industrie Canada. Dans le but de réduire les risques de brouillage radioélectrique à l'intention des
autres utilisateurs, il faut choisir le type d'antenne et son gain de sorte que la puissance isotrope
rayonnée équivalente (p.i.r.e.) ne dépasse pas l'intensité nécessaire à l'établissement d'une
communication satisfaisante. Le présent émetteur radio (identifier IC: 7002C-ZBRN1, 7002C-
ZBRN2) a été approuvé par Industrie Canada pour fonctionner avec les types d'antenne énumérés
ci-dessous et ayant un gain admissible maximal et l'impédance requise pour chaque type
d'antenne. Les types d'antenne non inclus dans cette liste, ou dont le gain est supérieur au gain
maximal indiqué, sont strictement interdits pour l'exploitation de l'émetteur.
 ZBRN1 and ZBRN2: Maximal gain of internal antenna = 6 dB / allowed impedance: 50 Ohm.
 ZBRA2: Maximal gain of external antenna (including cable) = 1 dB / allowed impedance:
50 Ohm.
Any changes or modifications not expressly approved by Schneider Electric could void the user's
authority to operate the equipment.

EIO0000001177 01/2020 155

Radio

156 EIO0000001177 01/2020

 Harmony Hub
User Interface
EIO0000001177 01/2020

Chapter 9
User Interface

User Interface

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
9.1 Overview 158
9.2 Configuration Menu 166
9.3 Diagnostic Menu 183
9.4 SD Card Menu 187

EIO0000001177 01/2020 157

User Interface

Section 9.1
Overview

Overview

What Is in This Section?

This section contains the following topics:
Topic Page
Principle 159
Modes 162
Menu Structure 165

158 EIO0000001177 01/2020

 User Interface

Principle

Jog Dial Operation

The following table shows the operation of the jog dial:

Input Keys Function

Turn the jog dial clockwise/counterclockwise for menu navigation and to
increase/decrease the parameter values.

Press once the jog dial for less than 3 s to validate the parameters entered.

Press twice the jog dial to return to the previous menu.

Press and maintain the jog dial for more than 3 s to return to the Ready mode
immediately.
When Harmony Hub is in the Ready mode, press the jog dial for more than 3 s to lock
the user interface.
When Harmony Hub is locked, press the jog dial for more than 3 s to unlock the user
interface.

NOTE: If there is no action on the jog dial after 3 minutes, Harmony Hub automatically switches to
Ready mode. For more information, refer to Modes (see page 162).

EIO0000001177 01/2020 159

User Interface

User Interface LEDs

The following figure shows LEDs on the user interface:

Item LED Color Function

1 Power Green On: The unit is turned on.
Off: The unit is turned off.
2 Communication Yellow Flashing: Communication for the Ethernet or Modbus
serial line is detected on the bus.
Off: No communication for the Ethernet or Modbus serial
line is detected on the bus.
3 Radio signal strength Green/Yellow The LED color indicates the strength of the radio signal.
See Radio Signal Strength LED (see page 161).
4 Lock Red On: The user interface is locked.
Off: The user interface is unlocked.
5 Err Red On: Harmony Hub has detected an error.
Off: Harmony Hub did not detect an error.
6 Rem Red On: Harmony Hub is in auto teach mode and is remotely
configured.
Off: Harmony Hub is not remotely configured.
7 Conf Red On: Configuration menu is active.
Off: Configuration menu is not active.
8 Diag Red On: Diagnostic menu is active.
Off: Diagnostic menu is not active.

160 EIO0000001177 01/2020

 User Interface

Item LED Color Function

9 Display Red Slow flashing: The parameter value can be changed
through the jog dial.
Fast flashing 3 times: The parameter setting was
successful.

Radio Signal Strength LED

The following figure shows the status of the radio signal strength LED:

EIO0000001177 01/2020 161

User Interface

Modes

Operating Modes
Harmony Hub has the following 3 basic operating modes:
 Ready
 Configuration
 Diagnostic

Ready Mode
The normal working state of Harmony Hub is Ready mode. When Harmony Hub is switched on, it
displays the protocol (for example, SL for serial line) and the firmware version (for example, 01.00).
Then, it switches to Ready mode, and the power LED turns on.
The following figure shows the default screen in Ready mode:

In Ready mode, Harmony Hub receives the input signal from the transmitter, the input/output LED
turns on, and the radio signal strength LED indicates the strength of the input signal.
The following figure shows the input status in run mode:

NOTE: The 7 segment display shows the channel number and input value for 1 s.
The red LED indicates that the user interface is locked.
All the parameters of the device are set in Configuration mode. All parameters are accessible as
read-only values in Diagnostic mode.
You can switch from Ready mode to Configuration or Diagnostic modes by pressing the jog dial
once when Harmony Hub is in Ready mode.
You can turn the jog dial clockwise or counterclockwise to navigate through the different menus
while in Ready mode.
In online auto binding mode, the dedicated LED turns on and the 7 segment LED displays the
current binding channel.
The following figure shows the default screen in online auto binding mode:

NOTE: You can exit from auto-binding mode by rotating the jog dial clockwise or counterclockwise.

162 EIO0000001177 01/2020

 User Interface

Configuration Mode
The following table shows the properties of the Configuration menu:

Menu Parameters (Can Be Configured)

Input Configuration (see page 169) Allows you to do the following operations:
 Auto teach.
 Auto unteach.
 Manual teach.
 Manual unteach.
 Output association.

Output Configuration Allows you to do the following operations:

(see page 175)  Teach.
 Unteach.

Serial Line Menu (see page 177) Allows you to set the following:
 Manual baud rate
 Manual frame format
 Auto baud rate
 Auto frame format

IP Setting Menu (see page 179) Allows you to do the following operations:
 Select the DHCP mode.
 Select the BOOTP mode.
 Select the static IP mode.
 Set the 4 bytes IP address.
 Set the 4 bytes subnet mask.
 Set the 4 bytes gateway address.
 Save the IP address.

Radio frequency menu Allows you to do the following operations:

(see page 181)  Active/deactivate the radio communication
 Set the power transmission level
 Set the radio frequency channel

Factory Mode (see page 182) Allows you to do the following operations:
 Reset the communication parameter to the default value.
 Reset all the parameters to the default value.
 Set the PAN ID Harmony Hub MAC/ID

EIO0000001177 01/2020 163

User Interface

Diagnostic Mode
The following table shows the properties of the Diagnostic menu:

Menu Parameters Displayed

Input status Status of the transmitter.
Output status Status of the receiver
Serial link information  Slave ID.
 Baud rate.
 Frame format.

Ethernet information  IP address.

 Subnet mask.
 Gateway address.
 MAC address.

Radio frequency  RF state (run or OFF)

 RF channel
 RF power transmission level (in dBm)
 PAN ID
 Green Power Brick version

Device status  Code of the detected error.

 Device reference (ZBRN1/ZBRN2).
 Firmware version.
 Industrial Configuration Version.

For further information, refer to Diagnostic Menu (see page 183).

SD Card
The following table shows the properties of the SD card menu:

Menu Parameters
Save all parameters Allows you to save all the parameters in the SD card.
Load all parameters Allows you to load all the parameters from the SD card.
For further information, refer to SD Card Menu (see page 187).

164 EIO0000001177 01/2020

 User Interface

Menu Structure

Overview
The following figure shows the menu structure:

EIO0000001177 01/2020 165

User Interface

Section 9.2
Configuration Menu

Configuration Menu

What Is in This Section?

This section contains the following topics:
Topic Page
Configuration Menu Overview 167
Input Configuration Menu 169
Output Configuration Menu 175
Communication Menus 177
Radio Frequency Menu 181
Factory Mode 182

166 EIO0000001177 01/2020

 User Interface

Configuration Menu Overview

Introduction
You can enter all the settings for Harmony Hub from the Configuration menu. When you activate
the Configuration menu, configuration LED turns on.
The following figure shows the display screen when Configuration menu is active:

NOTE: In this example, the value 21 represents the total number of configured inputs.

Organization Tree
The following figure shows the Configuration menu structure:

Code Name/Description
Configuration menu.

Input menu. (see page 169)

Output menu. (see page 175)

Serial Line setting menu (see page 177).

It appears only in ZBRN2.

IP Setting menu (see page 179).

It appears only in ZBRN1.

Radio Frequency menu (see page 181).

EIO0000001177 01/2020 167

User Interface

Code Name/Description
Factory mode menu (see page 182).
It allows you to reset the device settings to the default factory mode and set the
Harmony Hub MAC/ID.

168 EIO0000001177 01/2020

 User Interface

Input Configuration Menu

Input Configuration
The following figure shows the organization tree of Input Configuration menu:

Pairing Process Input For more details, refer to Pairing Process Input (see page 171).
Output association For more details, refer to Output Association (see page 173).
Holding time For more details, refer to Holding time menu (see page 174).

EIO0000001177 01/2020 169

User Interface

Code Name/Description Range Factory

Setting
Displays the channel number which is taught. 0–59 0

Transmitter not taught. – –

For details, refer to Pairing Process Input (see page 171).

Transmitter taught. – –

Type of Transmitter So –
CL
Et
S1
First byte and second byte of the transmitter MAC/ID. – –
Third byte and fourth byte of the transmitter MAC/ID.

Input Holding Time Menu (see page 174). – –

Output association-Channel (see page 173). – –

Unteach all the transmitters. – –

Launch auto teach process for the inputs with an ID – –

configured but not yet paired (6 input maximum).

Auto teach mode. – –

170 EIO0000001177 01/2020

 User Interface

Pairing Process Input

The following figure shows the pairing process for type 0 devices (push-buttons and limit switches):

1 For other type of transmitter, refer to Pairing Procedures Input (see page 54).

Code Name/Description Range Factory

Setting
Transmitter taught. – –

Transmitter not taught. – –

Type of Transmitter So –
cL
Et
S1
teach mode. – –

EIO0000001177 01/2020 171

User Interface

Code Name/Description Range Factory

Setting
The transmitter is already taught. Duplication of MAC – –
addresses is not allowed.

Enter the 4 bytes of the MAC/ID of the transmitter. – –

Enter the 4 bytes of the MAC/ID of the transmitter then launch – –

the auto teach process

First byte of the transmitter MAC/ID. 00…FF 00

Second byte of the transmitter MAC/ID. 00…FF
Third byte of the transmitter MAC/ID. 00…FF
Fourth byte of the transmitter MAC/ID. 00…FF

172 EIO0000001177 01/2020

 User Interface

Output Association - Channel

Code Name/Description Range Factory

Setting
Output association. – –

Receiver associated. – –

Receiver not associated. – –

Q1 output of the transmitter associated to the input. – –

Q4 output of the transmitter not associated to the input. – –

EIO0000001177 01/2020 173

User Interface

Input Holding Time Menu

The following figure shows the organization tree of Input Holding Time menu:

Code Name/Description Range Factory Setting

Input holding time setting menu. 1 = 100 ms 1 = 100 ms
2 = 200 ms
3 = 300 ms
4 = 400 ms
5 = 500 ms
10 = 1 s

174 EIO0000001177 01/2020

 User Interface

Output Configuration Menu

Output Configuration
The following figure shows the organization tree of Output menu:

Code Name/Description Range Factory

Setting
Reset associated receiver. – –

Receiver taught. – –

Receiver not taught. – –

EIO0000001177 01/2020 175

User Interface

Code Name/Description Range Factory

Setting
Teach mode. – –

DEL UnTeach mode. – –

176 EIO0000001177 01/2020

 User Interface

Communication Menus

Overview

Code Name/Description
Serial Line setting menu (see page 177).
It appears only in ZBRN2.

IP Setting menu (see page 179).

It appears only in ZBRN1.

Serial Line Menu

The following figure shows the organization tree of Serial Line menu:

EIO0000001177 01/2020 177

User Interface

Code Name/Description Range Factory

Setting
Slave address menu. 1–247 1
It allows you to set the slave address.

Enables auto detection mode. All the parameters – Auto

(baud rate and frame setting) are set automatically.

Allows you to set the baud rate and frame setting – –

manually.

Baud rate menu. 1.2 = 1200 bps –

It allows you to select the baud rate value from the list.
2.4 = 2400 bps
4.8 = 4800 bps
9.6 = 9600 bps
19.2 = 19,200 bps
38.4 = 38,400 bps
115 = 15,200 bps
Frame setting menu. 8e1 = Even parity Auto
It allows you to select the frame format from the list.
8o1 = Odd parity
8n2 = No parity

178 EIO0000001177 01/2020

 User Interface

IP Setting Menu
The following figure shows the organization tree of IP Setting menu:

Code Name/Description Range Factory

Setting
Harmony Hub uses DHCP mode to set the network-specific - -
parameters.

In DHCP mode, enter the device name. Harmony Hub gets 000–159 000
the IP address from the DHCP server.
Example: The complete device name is ZBRN1_078 when
the value is set to 78.

EIO0000001177 01/2020 179

User Interface

Code Name/Description Range Factory

Setting
Harmony Hub uses BOOTP mode to set the network-specific - -
parameters.

BOOTP mode Harmony Hub gets the IP address from – –

BOOTP server.

Harmony Hub uses static IP mode to set the network-specific – –

parameters.

In static IP mode, the IP address, subnet mask, and gateway – –

are entered manually using the jog dial.

Enter the 4 bytes of the subnet address. – –

Enter the 4 bytes of the gateway address. – –

Enable the IP address and return to the previous menu. – –

180 EIO0000001177 01/2020

 User Interface

Radio Frequency Menu

Radio Frequency Menu

The following figure shows the organization tree of Radio Frequency menu:

Code Name/Description
Activate/deactivate the radio communication.

Select the radio frequency channel (11…26).

Enter the PAN ID of the Harmony Hub (0000 H…FFFF H).

Quit to return to the previous menu.

EIO0000001177 01/2020 181

User Interface

Factory Mode

Factory Mode
The following figure shows the organization tree of Factory Mode menu:

Code Name/Description
Reset all the parameter values to default setting.

The 4 bytes of the MAC/ID of the Harmony Hub.

If the MAC/ID is empty (00.00.00.00), contact your Schneider Electric Local
Support.

Quit to return to the previous menu.

182 EIO0000001177 01/2020

 User Interface

Section 9.3
Diagnostic Menu

Diagnostic Menu

Diagnostic Menu

Introduction
Diagnostic menu gives the information about various settings of the device and the detected error
status. When you activate the Diagnostic menu, Diagnostic LED turns on.
The following figure shows the display screen when the Diagnostic menu is active:

NOTE: In this example, the value 21 represents the total number of configured inputs.

EIO0000001177 01/2020 183

User Interface

Organization Tree
The following figure shows the Diagnostic menus:

Code Name/Description
Diagnostic menu.

184 EIO0000001177 01/2020

 User Interface

Code Name/Description
Displays the binding information, such as the current binding number.
Displays:
 Type of transmitter
 First byte and second byte of the transmitter MAC/ID.
 Third byte and fourth byte of the transmitter MAC/ID.
 Received Signal Strength Indication (dB).
 Transmitter Error Codes (see page 138).
 Reserved.

Displays the binding information, such as the current binding number.

Displays the serial information:

 Slave address
 Current baud rate
 Frame setting

Displays the IP information:

 IP address
 Subnet mask
 Gateway
 MAC address

EIO0000001177 01/2020 185

User Interface

Code Name/Description
Displays the radio frequency status:
 RF state (run or OFF)
 RF channel
 RF power transmission level (in dBm)
 PAN ID
 Green Power Brick version

Displays the Harmony Hub device status:

 Harmony Hub error codes (see page 136)
 Product version
 Application version
 Industrial configuration version
 First byte of the MAC/ID of Harmony Hub
Second byte of the MAC/ID of Harmony Hub
 Third byte of the MAC/ID of Harmony Hub
Fourth byte of the MAC/ID of Harmony Hub
 Firmware update action (only when SD:/EA_sme.txt is present)

NOTE: To clear a detected error, press the jog dial when selecting the code of the
detected error parameter.

NOTE: The serial line information menu exists only for ZBRN2. The IP information menu exists
only for ZBRN1.

186 EIO0000001177 01/2020

 User Interface

Section 9.4
SD Card Menu

SD Card Menu

SD Card Menu

Introduction
The SD card menu allows you to back up and restore the binding and network parameters.

Organization Tree
The following figure shows the SD card menus:

Code Name/Description
The SD card setting menu allows you to back up and restore the binding and network
parameters.

Allows you to save all the parameters in the SD card.

To validate this parameter, select Yes from the submenu.

Loads all the parameters from the SD card.

To validate this parameter, select Yes from the submenu.

Allows you to save all the binding information in the SD card.

To validate this parameter, select Yes from the submenu.

NOTE: The SD card menu appears only if the SD card is inserted into the device.

EIO0000001177 01/2020 187

User Interface

188 EIO0000001177 01/2020

 Harmony Hub
SD Card
EIO0000001177 01/2020

Chapter 10
SD Card

SD Card

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Introduction 190
Functions 192
File Management and Diagnostics 194

EIO0000001177 01/2020 189

SD Card

Introduction

General
The secure digital card (SD card) is an ultra small flash memory card designed to provide high-
capacity memory in a small size. The minimum capacity of the SD card is 16 Mb.

SD Card Insertion and Removal

CAUTION
UNINTENDED EQUIPMENT OPERATION
 Do not expose the SD card to any of the following:
 Electrostatic or electromagnetic sources.
 Heat, sunlight, water, or moisture.
 High radiation. High-level radiation can erase the content of the SD card.

 Avoid impact to the SD card.

Failure to follow these instructions can result in injury or equipment damage.

The following figure shows how to insert the SD card into Harmony Hub:

Push to insert the SD card into the SD card slot on Harmony Hub. Make sure that the SD card is
inserted properly.

190 EIO0000001177 01/2020

 SD Card

The following figure shows how to remove the SD card from Harmony Hub:

Push to remove the SD card from the SD card slot on Harmony Hub.

EIO0000001177 01/2020 191

SD Card

Functions

Supported Features
The SD card supports the following features:
 Saving the configuration and network parameters (see page 192)
 Loading the configuration and network parameters (see page 192)
 Firmware update operation (see page 192)

Saving the Configuration

The following steps explain how to save the configuration and network parameters:

Step Action
1 Insert an empty SD card into Harmony Hub.
2 On the SD card menu, select Save all.
3 Select Yes from the submenu to validate the action.
4 Wait until Yes stop blinking.
5 This action creates 2 subfolders in the SD card:
 \device: Stores the device configuration file ZBRNxxDEV.CSV.
 \net: Stores the network configuration file ZBRNxxNET.CSV

NOTE: You can update the .CSV files manually and load them into Harmony Hub afterwards.

Loading the Configuration

The following steps explain how to load the device configuration and network parameters:

Step Action
1 Insert the SD card into Harmony Hub.
2 Make sure that the files you want to load are located in the appropriate SD card subfolders
(create \device and \net subfolders if they do not exist in the SD card):
 \device: Stores the device configuration file ZBRNxxDEV.CSV
 \net: Stores the network configuration file ZBRNxxNET.CSV

3 On the SD card menu, select Load all.

4 Select Yes from the submenu to validate the action.
5 Wait until Yes stop blinking.

192 EIO0000001177 01/2020

 SD Card

Firmware Update
This feature allows the user to update Harmony Hub firmware with the SD card.
NOTE: A firmware update does not erase Harmony Hub configuration. Modbus settings, RF
settings, and binding list are kept in memory after firmware update.
NOTE:
The firmware requires upgrading in the following cases:
 Schneider Electric recommends or requires the upgrade.
 There is a new functionality that is required and is only available by firmware upgrade.

In all other cases, it is not necessary to upgrade the firmware.

While using “FWUP” action on the HMI menu, it is possible to see “FWUP” and Err.
LED blinking for 2 seconds. This indicates that the SD card is asking for “checking and repair”.
Therefore, the action is interrupted and the SD card is “repaired”. A second try at this action
launches “FWUP” action.
The following steps explain how to update Harmony Hub firmware:

Step Action
1 Load Harmony_Hub_Vxx.xx.zip from Schneider Electric Website depending on the firmware
version.
2 Verify the SHA in the release note.
3 Copy the content of the zip file into the SD Card.
4 Insert SD card into Harmony Hub (unlocked).
5 Restart Harmony Hub.
6 The Radio signal strength LED becomes orange for 1 s during restart, indicating a success of
the update.

NOTE: User application can be updated with the HMI menu “FWUP”.

EIO0000001177 01/2020 193

SD Card

File Management and Diagnostics

File Management
The following table shows the file names with the path used in the SD card:

Files Description
User application
SD:/device/ZBRNxxDEV.CSV Device configuration file including the transmitters binding list.
SD:/device/ZBRNxxDEV.CSV.bcki Backup file (1).
SD:/net/ZBRNxxNET.CSV Network configuration file including Harmony Hub general
settings.
SD:/net/ZBRNxxNET.CSV.bcki Backup file (1).
SD:/diag/ZBRNxxdiag.CSV Diagnostic file including the transmitters diagnostic information.
SD:/diag/ZBRNxxdiag.CSV.bcki Backup file (1).
FW Updates
SD:/EA_image/gp/xxxx.bin Binary file for the update of the CC2530 application.
Path SD:/EA_image/gp/ is default path when using “FWUP”
NOTE: By default, the first file found in the folder is taken for
update. Other files are ignored.
SD:/EA_image/fw_app/xxxx.bin Binary file for the update of the user application.
Path SD:/EA_image/fw_app/ is default path when using “FWUP”
NOTE: By default, the first file found in the folder is taken for
update. Other files are ignored.
SD:/EA_sme.txt Enables and displays the menu “FWUP” (Firmware Update) (for
“gp” and “ap” updates only).
This file is empty.
SD:/ap_fwup.txt Enables the update of the user application.
Can be created by the user to load .bin file from a specific path,
and update the application on the restart of Harmony Hub.
Can be generated automatically when using “FWUP”.
SD:/gp_fwup.txt Enables the update of the green power application.
Can be created by the user to load .bin file from a specific path.
Can be generated automatically when using “FWUP”.
Industrial configuration
SD:/EA_image/indus/xxxx.bin Binary file for the update of the industrial configuration.
Path SD:/EA_image/indus/ can be modified.
(1) i: [0…5]. When new files are stored in the SD card, instead of erasing previous files, Harmony Hub saves
the files with extension bcki. Harmony Hub can store 6 older files, bck0 is the most recent.

194 EIO0000001177 01/2020

 SD Card

Files Description
SD:/indus_up.txt Enables the update of the industrial parameters on the restart of
Harmony Hub.
Must be created by the user to load .bin file from a specific path.
(1) i: [0…5]. When new files are stored in the SD card, instead of erasing previous files, Harmony Hub saves
the files with extension bcki. Harmony Hub can store 6 older files, bck0 is the most recent.

SD Card Diagnostics
The following table shows the diagnostic details of the SD card:

Code of the Device Indication Description

Detected
Error
00 The SD Card menu is SD card is present in Harmony Hub.
available.
The SD Card menu is not SD card is not present in Harmony Hub.
available.
10 Error LED turns on. SD card cannot be accessed or is not compatible.
11 Error LED turns on. SD card is write-protected.
12 Error LED turns on. Not enough space in the SD card.
13 Error LED turns on. Invalid parameter in the SD card.
14 Error LED turns on. Network configuration file ZBRNxxNET.CSV is invalid.
15 Error LED turns on. Device configuration file ZBRNxxDEV.CSV is invalid.
16 Error LED turns on. More than 1 network configuration file is stored in the Net folder
while restoring, which is not allowed.
17 Error LED turns on. More than 1 Device configuration file is stored in the Net folder
while restoring, which is not allowed.
18 Error LED turns on. Network configuration file is not available in the SD card.
19 Error LED turns on. Device configuration file is not available in the SD card.

EIO0000001177 01/2020 195

SD Card

Device Configuration File

The Device configuration file ZBRNxxDEV.CSV contains the sensors binding list.
Location in the SD card: SD:/device/ZBRNxxDEV.CSV.
Device configuration file content:

Parameter Value Description

name
Input [0: 59] -
Enable True / False True: A transmitter is associated
False: The input is free
Association [1:4] 1: Static (No security)
mode 2: OTA Sensor (Security Sensor)
3: OTA (No security)
4: OTA Box (Security Box)
Type [Type1: Type6] Type1: Push-button or limit switches
Type2…Type3: Reserved
Type4: Humidity and thermal monitoring sensors
Type5: Thermal monitoring sensors
Type6: Generic ZigBee, PowerTag sensors
Address [00000001 H: Unique ZigBee ID of the transmitter.
FFFFFFFE H]
Security Type [0:5] Handles both security level and security type parameters (These
parameters are updated automatically in the gateway once the
transmitter is associated online).
Security Key Format Encryption key
00:00….00:00
(16 bytes)
Param1 Type1: [1:6] Type1: Holding time
1: 100 ms
2: 200 ms
3: 300 ms
4: 400 ms
5: 500 ms
6: 1 s
Type2: [0: 65635] Reserved
Param2 Type1: [0: 59] Output number associated (Receiver associated)
Type2: [0: 100] Reserved
Param3 Type1: [0: 3] Q1…Q4 controlled output of the associated receiver

196 EIO0000001177 01/2020

 SD Card

Example of Device configuration file with four transmitters:

Input Enable Association Type Address Security Security Param1 Param2 Param3
Type (1) key (2) (2)

0 True 1 Type 1 03005EAA H 1 5 2 4

1 True 2 Type 5 FFC12430 H 0
2 True 2 Type 6 E2000356 H 0
3 True 2 Type 4 FF900F90 H 0
(1) “Security Type” for Type 1 is set to 1 since transmitters are paired with No security.
“Security Type” for Type 4 and Type 5 is set to 0 since we want to take sensor’s security. Once the sensor is
Associated Online, this parameter will be automatically set to its right value.
“Security Type” for Type 6 is set to 0 since the sensor in the example is secured.
(2) “Param2” for Type 1 is set from 0 to 59 since output is enabled. If output is disabled, then “Param2” is 0.“Param3”
for Type 1 is set from 1 to 4 since output is enabled. If output is disabled, then “Param3” is 0.

Example of Device configuration file with one receiver:

Output Enable
0 False
1 False
2 True
3 False

CSV files generated by SD card (with SAll HMI command) present 120 lines, one per input and
output. It is not mandatory to write those 120 lines: Harmony Hub only consider lines with “Enable”
parameter set to True.
Same Device Configuration File edited:
Input;Enable;Association;Type;Address;Security Type (1);Security key;Param1;Param2;Param3
0;TRUE;1;Type 1;03005EAA H;1;;5;2;4
1;TRUE;2;Type 5;FFC12430 H;0;;;;
2;TRUE;2;Type 6;E2000356 H;0;;;;
3;TRUE;2;Type 4;FF900F90 H;0;;;;
Output;Enable;;;;;;;;
2;TRUE;;;;;;;;

EIO0000001177 01/2020 197

SD Card

Network Configuration File

The Network configuration file ZBRNxxNET.CSV contains Harmony Hub parameters.
Location in the SD card: SD:/net/ZBRNxxNET.CSV.
Network configuration file content:

Parameter Name Value Default Description

Value
General settings
RF mode [0:3] 1 0: Off
1: Green Power
2: ZigBee Green Power Concentrator
3: ZigBee Green Power Router
Channel [11:26] 11 Radio channel
PanID [0001 H: FFFF H Radio Panel ID
FFFF H]
PWTX [-22:4] 0 Radio Power TX
Modbus settings
Auto detection TRUE / TRUE TRUE: Automatic detection of Master Modbus Settings
FALSE FALSE: Baud rate and Frame setting are set by eponym
parameters
Baud rate [1:7] 5 1: 1200 bps
2: 2400 bps
3: 4800 bps
4: 9600 bps
5: 19200 bps
6: 38400 bps
7: 115200 bps
Frame setting [1:3] 1 1: 8e1 (8 data bits, even parity, 1 stop bit)
2: 8o1 (8 data bits, odd parity, 1 stop bit)
3: 8n2 (8 data bits, no parity, 1 stop bit)
Table selection [0:4] 0 0: One UID per Harmony Hub
[1:4]: One UID per device
Default settings
Holding time [1:6] 1 1: 100 ms
2: 200 ms
3: 300 ms
4: 400 ms
5: 500 ms
6: 1000 ms
Default voltage [0:65535] 2300 Reserved
Default CosPhi [0:100] 100 Reserved

198 EIO0000001177 01/2020

 SD Card

Diagnostic File
The diagnostic file ZBRNxxDIAG.CSV contains the transmitters information.
Location in the SD card: SD:/diag/ZBRNxxDIAG.CSV.
Diagnostic file content:

Parameter name Value Description

Input [0: 59] -
Status [On-Line, Off-Line] Off-Line: the input parameters are configured (via SD card,
Modbus or screen menu) but no radio exchanges have been
performed
On-Line: Input is paired, radio exchanges have been
performed.
Type [Type1: Type6] Type1: Push-button or limit switches
Type2…Type3: Reserved
Type4: Humidity and Thermal monitoring sensors
Type5: Thermal monitoring sensors
Type6: Generic ZigBee, PowerTag sensors
Address [00000001 H: FFFFFFFE H] Unique ZigBee ID of the sensor
RSSI UINT8 Radio reception power
Unit: dBm
Invalid value: -128
PCBA temperature INT16 Device temperature
[-200; 200]
Unit: °C
Invalid value: 8000 H
Battery Voltage UINT8 Internal battery voltage
Invalid value:
FF H

EIO0000001177 01/2020 199