IFM ZB0929 User manual

Operating instructions
Gateway
ZB0929
11455705 / 0004 / 2022
GB

ZB0929 Gateway
2
Contents
1 Preliminary note ............................................................. 3
2 Symbols used............................................................... 4
3 Safety instructions............................................................ 5
3.1 Interference with medical devices........................................... 5
4 Intended use................................................................ 6
5 Installation.................................................................. 7
6 Operating and display elements................................................. 8
7 Electrical connection.......................................................... 9
8 Set-up..................................................................... 10
8.1 Gateway configuration ................................................... 10
8.2 Connecting to the Internet / network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.2.1 Ethernet connection ................................................. 11
8.2.2 Wireless LAN connection ............................................. 12
8.2.3 Mobile network connection............................................ 12
8.2.4 MQTT connection................................................... 13
8.3 Gateway - Changing the access password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
8.4 Sensor setup........................................................... 14
9 Connection to a backend ...................................................... 15
9.1 Connection to an MQTT broker............................................. 15
10 Approvals.................................................................. 16
10.1 Overview.............................................................. 16
10.2 Europe / EU declaration of conformity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
11 Maintenance, repair and disposal................................................ 17
12 ifm IoT Core ................................................................ 18
12.1 General information...................................................... 18
12.2 Updating the firmware via the IoT Core Visualizer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.2.1 Starting the ifm IoT Core Visualizer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
12.2.2 Updating the firmware................................................ 19
12.3 Accessing the ifm IoT Core using a REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
12.3.1 GET request....................................................... 19
12.3.1.1 Example: GET request.......................................... 20
12.3.2 POST request...................................................... 20
12.3.2.1 Example: POST request to read data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.3.2.2 Example: POST request to write data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
12.3.3 Diagnostic codes.................................................... 22
12.3.4 Getting started ..................................................... 22
12.3.5 General functions................................................... 22
12.3.5.1 Example: Reading several parameter values of the gateway simultaneously . 23
12.3.6 Defined tree structure................................................ 23
12.3.6.1 Gateway information............................................ 24
12.3.6.2 IoT Core information and update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
12.3.6.3 Firmware information and update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
12.3.6.4 Sensors connected to the gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
12.3.6.5 Sensors...................................................... 26
12.3.6.6 Sensor information............................................. 27
12.3.6.7 Sensor process data............................................ 27
12.3.6.8 Sensor configuration............................................ 28

Gateway ZB0929
3
1 Preliminary note
You will find instructions, technical data, approvals, accessories and further information using the QR
code on the unit / packaging or at www.ifm.com.

ZB0929 Gateway
4
2 Symbols used
Requirement
Instructions
Reaction, result
[...] Designation of keys, buttons or indications
Cross-reference
Important note
Non-compliance may result in malfunction or interference.
Information
Supplementary note

Gateway ZB0929
5
3 Safety instructions
• The unit described is a subcomponent for integration into a system.
– The system architect is responsible for the safety of the system.
– The system architect undertakes to perform a risk assessment and to create documentation in
accordance with legal and normative requirements to be provided to the operator and user of
the system. This documentation must contain all necessary information and safety instructions
for the operator, the user and, if applicable, for any service personnel authorised by the
architect of the system.
• Read this document before setting up the product and keep it during the entire service life.
• The product must be suitable for the corresponding applications and environmental conditions
without any restrictions.
• Only use the product for its intended purpose (Ò Intended use).
• If the operating instructions or the technical data are not adhered to, personal injury and/or damage
to property may occur.
• The manufacturer assumes no liability or warranty for any consequences caused by tampering with
the product or incorrect use by the operator.
• Installation, electrical connection, set-up, operation and maintenance of the product must be
carried out by qualified personnel authorised by the machine operator.
• Protect units and cables against damage.
3.1 Interference with medical devices
The device emits radio waves that may interfere with the operation of electronic devices in the vicinity,
including pacemakers, hearing aids and defibrillators.
If you have a pacemaker or other implanted medical product, do not use the device without first
consulting your doctor or the manufacturer of your medical product. Keep a safe distance between the
device and your medical devices and refrain from further use of the device if you observe permanent
impairment of your medical product.

ZB0929 Gateway
6
4 Intended use
• The gateway, being an MQTT client, transmits sensor data to a backend system via an MQTT
broker. In the backend system, the sensor data is made available for visualisation and can be used
to carry out evaluations and create alarm rules.
• The gateway is connected to the Internet or network either via a wired Ethernet connection,
wirelessly via a mobile network (NB-IoT, 2G or LTE Cat M1) or via a wireless LAN connection.
The device must not be operated within a radius of 20 km around Ny-Ålesund, Spitsbergen,
Norway.

Gateway ZB0929
7
5 Installation
uPosition the device close to the sensor.
uIf necessary, use the supplied mounting accessories for installation.

ZB0929 Gateway
8
6 Operating and display elements
LED
5
4
123
1: USB connection
2: Mains connection
3: Ethernet connection
4: Micro-SIM card slot
5: Configuration button

Gateway ZB0929
9
7 Electrical connection
uConnect the device with the supplied power supply.

ZB0929 Gateway
10
8 Set-up
The device switches on automatically when connected to the power supply.
The device’s status LED indicates whether the device can access the set PING address.
Recommendation:
Take the address of the backend used (e.g. the MQTT broker) as PING address in order to be
able to visually check the connection status.
Status LED Colour State Meaning
Green On The device can access the set ping address and is con-
nected to the Internet/network.
Blue On The device starts up.
Flashes The device is in local configuration mode.
Red On The device cannot access the set ping address and is not
connected to the Internet/network.
uOpen the configuration mode and check the settings.
8.1 Gateway configuration
In order to activate the configuration mode, make sure the device start up is completed. Observe the
status LED, which is either red or green, for this purpose.
uPress the configuration key for at least 10 s until the status LED flashes blue.
wThe device opens a wireless LAN access point.
wThe serial number and password for the initial set-up is on the type label on the back of the
gateway.
uConnect PC, smartphone etc. to the wireless LAN access point. The name of the wireless LAN
access point is "ifmgw-[serial number]".
uEnter the password.
wWindows 10 may ask for a PIN code as primary access point password. Use the option
'password'.
uOpen the browser on the PC, smartphone, etc.
uOpen the address 192.168.0.1:3001 in the browser.
wNo HTTPS command can be used to open the gateway’s web server (http://... is not
possible).
wAs of firmware 6.x, the address 192.168.0.1 must be used without indicating a port.
wIf the gateway’s LAN connection is already configured with a static IP in the address space
of 192.168.0.xxx and the gateway is connected to the PC via Ethernet, the configuration
interface is accessible at 192.168.1.1(:3001).
uMake the necessary configurations.
(E.g. change password for gateway access, check error log, set up connection via wireless LAN,
LAN or mobile network or make MQTT broker settings → chapter “Connecting to the Internet /
network”).
uRestart the gateway by pressing [Quit].

Gateway ZB0929
11
8.2 Connecting to the Internet / network
8.2.1 Ethernet connection
uThe configuration for the Ethernet connection can be found in the configuration menu under
"Configure LAN settings"
uUse the RJ45 socket for Ethernet connection.
If a Dynamic Host Configuration Protocol (DHCP) server is available, the DHCP client can be
activated.
If the DHCP client is deactivated, a static IP address can be configured.
The IP address range of device and PC must match the subnet mask.
Address
Address,
segment relating to the
network address
Address,
segment relating to the
station address
Subnet mask 255.255.255.0 255.255.255. 0
Wireless gateway ZB0929 e.g.
192.168.0.15
192.168.0. e.g. 15
PC e.g.
192.168.0.10
192.168.0. e.g. 10
uConfigure a DNS server if necessary.
The device can independently send out ping commands,
thus allowing for confirmation that a particular host in a network can be reached. The status LED
provides visual information on the connection to the set ping address.
In case of a local connection, the host’s IP address, e.g. 192.168.0.10, can be used as ping address. If
an internet connection is required (e.g. when using a cloud), any domain can also be used as ping
address (e.g. www.ifm.com).
Time synchronisation requires an NTP server. If there is no NTP server, the time can be set manually.
wIf the gateway is disconnected for a longer period, the time has to be corrected in the
configuration menu.

ZB0929 Gateway
12
The MAC address of the gateway can be found in the Ethernet setting.
8.2.2 Wireless LAN connection
The gateway can be configured as a wireless LAN client → Configuration menu under [Configure Wifi]
uSearch for and select a wireless LAN network under [Add Wifi network].
wDo not use any special characters (except _-!?) in the name and password for the wireless
LAN network.
wThe wireless LAN network must already be active when the gateway is started up.
8.2.3 Mobile network connection
uInsert the SIM card before connecting the power supply.
uOpen the micro-SIM card slot.
uUnlock and open the card holder.

Gateway ZB0929
13
uInsert the micro-SIM card with the contacts facing down and close everything.
uSupply the gateway with voltage.
uOpen the [Gateway configuration] chapter.
uConfiguration for the mobile communications connection → Configuration menu under [Configure
SIM settings].
uConfigure the SIM settings.
uRestart the gateway by pressing [Quit].
8.2.4 MQTT connection
uConfiguration for the MQTT data connection → Configuration menu under [Configure MQTT
settings].
uActivate MQTT connection
uSet the broker’s IP address and the port.
uSet the user name and password, if necessary.
uTLS encryption must be enabled or disabled according to the MQTT broker settings.
wThe ports [1883] and [8883] are usually reserved for MQTT.
uEstablish a new rule to the effect that the ports are released for communication in the
Windows Defender Firewall.
wSome MQTT brokers refuse a connection without username and password in the default
settings.
wIf TLS encryption is not used, it has to be deactivated. Otherwise, no connection can be
established.
MQTT data
wThe device is an MQTT client and always requires an MQTT broker.
The device publishes under the MQTT topic "ifm/VWV/{SID}", with {SID} being a placeholder for the
sensor’s serial number.
The gateway sends the data to the MQTT broker, deleting it afterwards. In case of disconnection, the
data is only retained for a few minutes.

ZB0929 Gateway
14
The data is sent as a JSON message and includes the following elements:
JSON information Meaning
SensorNodeId Unique serial number of the sensor
GatewayId Unique gateway number of the gateway
Temperature Temperature value in °C
Vibration”: {"RMS":{"Y":4}} Effective value of the vibration velocity, division by 100 results
in an mm/s value, e.g. 4/100 = 0.04 mm/s
Timestamp Timestamp in xx
BatteryAlert Battery status
"0" means that there is still sufficient battery capacity, "1" indi-
cates that the battery will still last for about 3 months.
The BatteryAlert information is only sent with a "True” value.
BatteryVoltage is not recommended as a status indicator.
8.3 Gateway - Changing the access password
Configuration for the gateway password → Configuration menu under [Change Gateway Wifi
password].
uIf necessary, change the factory-set gateway password.
wThe password cannot be reset to factory settings.
8.4 Sensor setup
wRecommendation:
Due to the mesh topology, arrange the sensors around the gateway that is supplied with
voltage.
uPress the sensor button briefly (switch on the device).
wGreen sensor LED lights up briefly and goes out again.
uWait until the sensor LED lights up a second time.
wGreen sensor LED lights up a second time: connection with the gateway established.
wRed sensor LED lights up a second time: no connection with the gateway.
uPosition the sensor closer to the gateway and check the connection again by briefly pressing the
sensor button.
wUpon initial set-up, the sensor LED may briefly light up in red despite an active connection to
the gateway. Check by pressing the button again. If the connection is successful, the sensor
LED should then light up green twice.
wIf the sensor is already switched on, the connection can be checked again by briefly pressing
the button.
Switch off the sensor:
uPress the button for at least 5 seconds until the LED lights up red for approx. 4 seconds.
You will find detailed information about the sensors at www.ifm.com.

Gateway ZB0929
15
9 Connection to a backend
9.1 Connection to an MQTT broker
The device is an MQTT client and always requires an MQTT broker.
uConfigure and activate MQTT communication in the gateway.
wThe device publishes under the MQTT topic "ifm/VWV/{SID}", with {SID} being a placeholder for
the sensor’s serial number.
wBy subscribing to the topic "ifm/VWV/#" all sensors are displayed.

ZB0929 Gateway
16
10 Approvals
If approvals are granted, the approval texts of the respective countries shall apply.
10.1 Overview
The overview of the approval status of a device is available on our website at www.ifm.com.
10.2 Europe / EU declaration of conformity
ifm electronic gmbh hereby declares that the device corresponds to the directive 2014/53/EU.
You can find the EU declaration of conformity at the following Internet address:
www.documentation.ifm.com.

Gateway ZB0929
17
11 Maintenance, repair and disposal
The unit is maintenance-free.
uIt is not possible to repair the unit.
uAfter use, dispose of the unit in an environmentally friendly way in accordance with the applicable
national regulations.

ZB0929 Gateway
18
12 ifm IoT Core
12.1 General information
The device has an ifm IoT Core software interface.
The ifm IoT core enables the user to address the device via a REST API from IT networks and to
integrate it into Internet of Things applications.
In addition, the ifm IoT Core Visualizer provides a graphical user interface to access data and services
of the ifm IoT Core via a browser.
A device description is stored on the device. This device description is a structured, machine-readable
data object in JSON format. All current values of parameters, process data, diagnostic data and
device information are mapped in this data object. These data values can be read and changed by
means of services. Moreover, services for updating the firmware and the ifm IoT Core interface and for
triggering on-demand measurements of the connected sensors are offered.
The following pages are intended to provide an overview of communication with an ifm IoT Core.
12.2 Updating the firmware via the IoT Core Visualizer
12.2.1 Starting the ifm IoT Core Visualizer
To start the ifm IoT Core Visualizer:
Requirements:
üThe device is in normal operating mode.
üThe device is connected to the IT network via the IoT port.
üThe device is in the same subnet as the PC.
uStart the web browser.
uEnter the address of the ifm IoT Core Visualizer: http://ipaddress:8001/web/subscribe (e.g.
http://192.168.178.1:8001/web/subscribe )
wThe browser shows the ifm IoT Core Visualizer.
The navigation menu gives the user access to the following functions:

Gateway ZB0929
19
• [Notification]: Create and manage notifications ( subscribe / unsubscribe )
• [Elements]: View the data structure of the IoT core tree and copy URLs for query
• [Parameter]: Read and write sensor parameters
• [Processdata]: Read and write process data
• [Update]: Update the device firmware and IoT core software
12.2.2 Updating the firmware
The [Update] menu page of the ifm IoT Core Visualizer provides information on the current firmware
version and the IoT Core version.
uDuring the firmware update, ensure that the device is connected to the supply voltage.
uClick on [Load software file] and select new firmware file (*.tar).
uClick on [Update] to start the update process.
wThe firmware of the device is updated.
The firmware update may take several minutes.
wIf the update process has been successful, the device will restart automatically.
12.3 Accessing the ifm IoT Core using a REST API
Using a REST API, the user can access the ifm IoT Core via HTTP requests.
The following request methods are available.
12.3.1 GET request
Using the GET method the user has read access to a data point.
The syntax of the request to the ifm IoT Core is:
http://[ip address]:8001/datapoint/service
Parameter Description
Ip address IP address of the IoT interface with port 8001
datapoint Data point which is to be accessed
service Service

ZB0929 Gateway
20
The response syntax of the IoT Core is:
{
"cid":id,
"data":{"value":resp_data},
"code":diag_code
}
Parameter Description
id Correlation ID for the assignment of request and response
resp_data Value of the data point; depending on the data type of the data point
diag_code Diagnostic code
12.3.1.1 Example: GET request
Request via browser to query the product code:
http://192.168.0.15:8001/deviceinfo/productcode/getdata
Response:
{
"cid": 1,
"data":{"value":"ZB0929"},
"code":200
}
Request for a measurement outside the set measurement interval.
http://192.168.0.15:8001/nodes/vwv-node-ifm12345/processdatanode/on-demand-
measurement
Measurements outside the measurement interval shorten the life of the product.
A command is sent to the VWV00x sensor with the serial number ifm12345 , triggering an immediate
measurement outside the measurement interval. The measured data must then be queried with the
getdata service under the corresponding data points, e.g. with the request:
http://192.168.0.15/nodes/vwv-node-ifm12345/processdatanode/vibration-measurement-
x/v-rms-x/getdata
12.3.2 POST request
Using the POST method the user has read and write access to a data point.
The syntax of the request to the IoT Core is:
{
"code":"code_id",
"cid":id,
"adr":"/data_point/service",
"data":{req_data}
}