background image

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.

u

During the firmware update, ensure that the device is connected to the supply voltage.

u

Click on [Load software file] and select new firmware file (*.tar).

u

Click on [Update] to start the update process.

w

The firmware of the device is updated.

The firmware update may take several minutes.

w

If 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

Summary of Contents for ZB0929

Page 1: ...Operating instructions Gateway ZB0929 11455705 00 04 2022 GB ...

Page 2: ...m 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...

Page 3: ...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 ...

Page 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 ...

Page 5: ...rpose Ò 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...

Page 6: ...ade 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 ...

Page 7: ...Gateway ZB0929 7 5 Installation u Position the device close to the sensor u If necessary use the supplied mounting accessories for installation ...

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

Page 9: ...Gateway ZB0929 9 7 Electrical connection u Connect the device with the supplied power supply ...

Page 10: ...es blue w The device opens a wireless LAN access point w The serial number and password for the initial set up is on the type label on the back of the gateway u Connect PC smartphone etc to the wireless LAN access point The name of the wireless LAN access point is ifmgw serial number u Enter the password w Windows 10 may ask for a PIN code as primary access point password Use the option password u...

Page 11: ... 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 u Configure 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 conn...

Page 12: ...Wifi u Search for and select a wireless LAN network under Add Wifi network w Do not use any special characters except _ in the name and password for the wireless LAN network w The wireless LAN network must already be active when the gateway is started up 8 2 3 Mobile network connection u Insert the SIM card before connecting the power supply u Open the micro SIM card slot u Unlock and open the car...

Page 13: ... u TLS encryption must be enabled or disabled according to the MQTT broker settings w The ports 1883 and 8883 are usually reserved for MQTT u Establish a new rule to the effect that the ports are released for communication in the Windows Defender Firewall w Some MQTT brokers refuse a connection without username and password in the default settings w If TLS encryption is not used it has to be deact...

Page 14: ...tory settings 8 4 Sensor setup w Recommendation Due to the mesh topology arrange the sensors around the gateway that is supplied with voltage u Press the sensor button briefly switch on the device w Green sensor LED lights up briefly and goes out again u Wait until the sensor LED lights up a second time w Green sensor LED lights up a second time connection with the gateway established w Red sensor...

Page 15: ...s an MQTT client and always requires an MQTT broker u Configure and activate MQTT communication in the gateway w The device publishes under the MQTT topic ifm VWV SID with SID being a placeholder for the sensor s serial number w By subscribing to the topic ifm VWV all sensors are displayed ...

Page 16: ... 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 ...

Page 17: ...Maintenance repair and disposal The unit is maintenance free u It is not possible to repair the unit u After use dispose of the unit in an environmentally friendly way in accordance with the applicable national regulations ...

Page 18: ...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...

Page 19: ...u Click on Load software file and select new firmware file tar u Click on Update to start the update process w The firmware of the device is updated The firmware update may take several minutes w If 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...

Page 20: ...val 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 ...

Page 21: ...ces that send data to the IoT Core e g setdata The response syntax of the IoT Core is cid id data value resp_data code diag_code Field Parameter Description cid id Correlation ID for the assignment of request and response data resp_data Values returned by the IoT Core syntax depending on the service Optional only required for services that receive data from the IoT Core e g getdata code diag_code ...

Page 22: ...ad the device description and the address tree of the device u Send the following POST request to the device code request cid 1 adr gettree w The device returns the device description as structured JSON object u Identify all substructures and the data points contained therein in the tree structure of the JSON object u Identify the applicable services for the access to substructures and the data po...

Page 23: ...deviceinfo serialnumber Response code 200 cid 5 adr getdatamulti data iotCore version code 200 data 1 0 0 0 deviceinfo serialnumber code 200 data ifm12345 12 3 6 Defined tree structure The tree structure of the IoT Core interface is divided into various substructures These include information about the device functions for updating the device firmware and the IoT core interface The nodes structure...

Page 24: ...ces Services Description getdata Read the data point 12 3 6 2 IoT Core information and update Substructure ip address 8001 iotCore Profile software updateablesoftware Available data points Data points Description Access iotCore installstatus Installation status r container URI for the new IoT Core application software rw type Type of software to be updated iotCore r version Current IoT Core applic...

Page 25: ...ensors connected to the gateway For each connected sensor an additional substructure with the corresponding data is created in the nodes substructure The fact that further devices are included in this structure is indicated via the devicegroupmanager profile The nodes devicestatuschanged datachange event can be used to detect changes in the sensor list and thus in the nodes subtree Substructure ip...

Page 26: ...ilable data points Substructure Description nodes vwv node serial number A substructure with type device is created for each connected sensor Applicable services Services Description devicestatus datachanged subscribe Event subscription devicestatus datachanged unsubscribe Event unsubscription devicestatus datachanged triggerevent Trigger in case of event 12 3 6 5 Sensors Each VWV00x sensor has it...

Page 27: ...e r vendor Vendor r r read only Applicable services Services Description getdata Read the data point 12 3 6 7 Sensor process data The sensor data is located in the processdatanode substructure For the purpose of clarity the latter is listed below with all substructures Depending on the VWV00x sensor variant only data of the existing measuring axes is displayed The processdata profile has been assi...

Page 28: ...ue r temperature measurement temperature unit Unit of the temperature value r temperature measurement timestamp Time at which the measured value was received in the gateway r r read only 12 3 6 8 Sensor configuration The data point measurement interval has the parameter profile assigned to it Substructure ip address 8001 nodes vwv node serial number nodeconfig Profile Available data points Data po...

Reviews: