3.7 ZigBee Interface

The ZigBee functionality is only available in the 2N^® SmartCom PRO version equipped with a ZigBee interface. The ZigBee parameters depend on the module mounted (radio frequency, e.g.). You can define up to 16 terminals within one network to communicate with 2N^® SmartCom PRO, which works as a coordinator for this network. The ZigBee communication technology, based on the IEEE 802.15.4 – ZigBee standard, is one of the wireless PANs (Personal Area Networks). PANs also include a very popular IEEE 802.15.1 – Bluetooth technology, which is mostly applied in consumer electronics. However, there are a lot of industrial applications where Bluetooth is inapplicable. Therefore, ZigBee has been introduced as a new wireless communication standard suitable for industrial automation too. At present, over 60 companies including the world automation leaders are involved in ZigBee development and extension. ZigBee has been designed as a simple and flexible technology for extensive wireless networks that require no huge data transmissions. ZigBee features reliability, easy and undemanding implementation, low power requirements and, last but not least, cost efficiency. Based on multi-step ad-hoc routing, ZigBee provides long-distance communication without direct radio visibility of the devices involved. It is primarily applied in industry and sensor networks and works at 2.4 GHz in licenceless zones (general permission). The bit rate is 20, 40, 250 kbit/s. Thanks to these merits, ZigBee is widely applied in many areas. For our purpose, its use in the available functions will be described. See below for the list of parameters including descriptions.

At present, 2N^® SmartCom PRO behaves as a Master, i.e. the main network coordinator to which devices get connected. A sufficient amount of clusters have been mounted to help you comfortably control your air conditioners, ZigBee keypads, sockets, moisture and other meters, street lighting and many other systems. 

Now let us briefly describe the ZigBee properties. Each device is identified by its IEEE address. One or more endpoints (EPs) are defined for each device and function clusters are defined for each EP. One cluster may occur just once in each EP. Let us give a simple example. Suppose we have a device that measures temperature and is equipped with 3 relays that switch other devices. In this case, the device will have 3 EPs with one ONOFF cluster each and there will be a DEVTEMP cluster in one of them. The simplified record in the device list would be as follows:

^SCZB: ID: 6, STATE: ONLINE, IEEE_ADDR: 00:12:4B:00:04:26:35:C1, SIG: 43%, UPDATED: 307332129283893

EP2: ONOFF: 0, DEVTEMP: 25,00, 

EP3: ONOFF: 1,

EP4: ONOFF: 0,

2N^® SmartCom PRO constitutes a wireless PAN to which devices log in. The meters are listed in a table, which can include a lot of independent meters. The count of the meters is determined by the firmware version. Generally, there can be up to 32 devices depending on the customer's requirements. The first step is to properly configure a wireless network and so the first set of commands relates to network setup and device adding. The next step is description of clusters and related functions. Refer to the ZigBee alliance web sites for detailed specifications. Now let us describe the PAN configuration AT commands.

Network Configuration

AT^SCZB="ADD",<16 HEX>[,<dev_id>]

• The command adds a device to the list. <16 HEX> means a sixteen-character IEEE address. Ask your meter manufacturer for these data.
  • <dev_id> – this optional parameter specifies the meter list position. If it is not used, a new device is added to the first free list position. 

T^SCZB="ADD",00124B00042635C1,6

AT^SCZB?

• The command reads out the meter list. The response can be as follows:

AT^SCZB?<br>
^SCZB: ID: 1, STATE: CONFIGURED, IEEE_ADDR: 00:12:4B:00:05:18:E7:42, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 2, STATE: CONFIGURED, IEEE_ADDR: 00:12:4B:00:04:26:35:C1, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 3, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 4, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 5, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 6, STATE: CONFIGURED, IEEE_ADDR: 00:12:4B:00:04:26:35:C1, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 7, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 8, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 9, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
^SCZB: ID: 10, STATE: SLOT_FREE, IEEE_ADDR: 00:00:00:00:00:00:00:00, SIG: 0%, CAP: UNKNOWN<br>
OK

AT^SCZB="DEL",<dev_id>

• The command removes a device from the list. The parameter setting depends on the count of records in the list. One record is only removed.

AT^SCZB="CLEAR"

• The command removes all devices from the list.

AT^SCZB="PANID"[<4 HEX>]

• The command sets the network identifier to the value specified in the parameter.
  • <4 HEX> – gives the new network name. The setting options are 4 hexadecimal characters (0–F).

AT^SCZB="PANID_READ"

• The command reads out the current value of the PANID parameter.

AT^SCZB="CHANNEL"[<8 HEX>]

The command sets the used channel to the value set by the parameter.

• <8 HEX> – gives the new network name. The setting options are 8 hexadecimal characters (0–F). The values of the last 8 positions are entered without 0x.
• It is a channel bit mask. The default value is 0x00000800–channel 11.

• In case the optional parameter is not entered, the command only reads out the currently set value. It does not return a mask but a string with the selected channel number.

AT^SCZB="CHANNEL_READ"

AT^SCZB="PRECFGKEY"[<32 HEX>]

AT^SCZB="PRECFGKEY_ENABLE"[<0-1>]

AT^SCZB="TCLK"[<32 HEX>]

AT^SCZB="IEEE_ADDR"

AT^SCZB="MODULE_TYPE"

AT^SCZB="RESTART"

AT^SCZB="POLL",<dev_id>

AT^SCZB="POLL_TIME",<time>

AT^SCZB="PERMIT_JOIN",<dev_id>,<time>

AT^SCZB="PERMIT_JOIN_ALL",<time>

Description of Function Commands

Remember to enter the dev_id of the device to which the command is to be sent. Also enter the end_point (EP) to identify the cluster in the given device. The default EP is always 2, but can have any value theoretically: 2, 3 and 4 are the most frequent values. These two parameters are the requisites of the commands below and so their meanings will not be described in every command.

Every sent command is followed by a response with one of the following 4 states:

1. <DATA> <OK> – displays description of the set/measured values and the command is terminated with an OK sequence: everything is OK.
2. <ERROR> – means that an invalid parameter was sent or an error occurred while processing.
3. <TIMEOUT> – means that the command was sent to the device but the device failed to respond within the timeout.
4. <ZCLERROR:[code]> – means that an error was detected in the ZigBee protocol. A numerical error code is displayed. See the ZigBee data sheet for details.

AT^SCZB="ANLGVAL",<dev_id>,<EP>

• The command reads out the value of the analogue input in a device on the selected end_point.

AT^SCZB="BASIC",<dev_id>,<EP>

• The command reads out all the values included in the BASIC cluster.
  • The following information can be included, for example: (BASIC_ZCL_VER, BASIC_APP_VER, BASIC_STACK_VER, BASIC_HW_VER, BASIC_MAN_NAME, BASIC_MODEL_ID, BASIC_PWR_SRC, BASIC_LOC_DESC, ONOFF, POWCFG_MAINS_VOLTAGE, POWCFG_BATTERY_VOLTAGE)

AT^SCZB="DEVTEMP",<dev_id>,<EP>

• The command reads out the current device temperature.

AT^SCZB="FAN",<dev_id>,<EP>

• The command returns the current state of the fan.

AT^SCZB="FAN_MODE",<dev_id>,<EP>,<value>

• The command sets the fan mode to the defined value.

AT^SCZB="HMDT",<dev_id>,<EP>

• The command returns the moisture value in % with the accuracy of 2 decimal places.

AT^SCZB="LC",<dev_id>,<EP>

• The command returns the Level Control value (position of the aerodynamic air flow compensator, "flap").

AT^SCZB="LC_MOVE_TO_LEVEL",<dev_id>,<EP>,<level>[,<transition_time>]

• The command sets the Level Control value (flap position). The optional transition_time parameter in tenths of a second defines when the position is to be set. If time is not set, the change will be made immediately.

AT^SCZB="METER",<dev_id>,<EP>

• The command writes out the immediate consumption values. The output includes two numbers: the first specifies the immediate power output and the other the total output withdrawn (the parameter is adjusted to the needs of electric meters and so it displays the [W, Wh] units. In general, however, any meter can be used and the values then specify energy [J] or flow rate [m3/h]).

AT^SCZB="MSTVAL",<dev_id>,<EP>

• The command reads out the Multi State Value. Used mostly for error codes.

AT^SCZB="ONOFF",<dev_id>,<EP>

• The command returns the 1/0 value depending on the immediate setting.

AT^SCZB="ONOFF_SET",<dev_id>,<EP>,<state>

• The command sets the switch to the value specified in the state parameter. Setting options: 1 – enabled, 0 – disabled.

AT^SCZB="TEMP",<dev_id>,<EP>

• The command returns a temperature value in °C with the accuracy of two decimal places.

AT^SCZB="THERM",<dev_id>,<EP>

• The command reads out and displays the currently set thermostat mode.

AT^SCZB="THERM_MODE",<dev_id>,<EP>,<value>

• The command sets the thermostat mode to the defined value: 2 hexadecimal characters. Refer to the table below.

AT^SCZB="THERM_TEMP_HEAT",<dev_id>,<EP>,<value>

• The command sets the heating temperature in °C with the accuracy of two decimal places.

AT^SCZB="THERM_TEMP_COOL",<dev_id>,<EP>,<value>

• The command sets the cooling temperature in °C with the accuracy of two decimal places.

AT^SCZB="TIME",<dev_id>,<EP>

• The command returns the currently set time value and time status.

AT^SCZB="TIME_SET",<dev_id>,<EP>,<utc_time>

AT^SCZB="GROUP_ADD",<dev_id>,<EP>,<group_id>[,<group_name>]

AT^SCZB="GROUP_MEMBERSHIP",<dev_id>,<EP>,<group_id>

AT^SCZB="GROUP_REMOVE",<dev_id>,<EP>,<group_id>

AT^SCZB="GROUP_REMOVE_ALL",<dev_id>,<EP>

AT^SCZB="SCENE_RECALL_ALL",<group_id>,<scene_id>