Connect gateways running Bosch IoT Gateway Software


The Bosch IoT Suite for Asset Communication package allows connecting gateways running Bosch IoT Gateway Software, as well as all edge devices that are connected to these gateways.
This is possible via the Gateway Software Protocol Adapter of the Bosch IoT Hub, which enables the connection between the Bosch IoT Gateway Runtime and the Bosch IoT Hub service.

Set up the Gateway Runtime

  1. Open the Service Subscriptions page of Bosch IoT Suite portal.

  2. Scroll to the corresponding Asset Communication package you subscribed in the previous step.

  3. Click Gateway Runtimes to open the download page.

  4. At Download pre-configured IoT Runtimes, select and download the appropriate Bosch IoT Gateway Software runtime image which fits best your gateway.

    The evaluation images' license is limited to 3 months after the subscription date.

    As an alternative, you can build your own Gateway Runtime image via the Bosch IoT Gateway SDK by downloading the appropriate SDK and Connectivity Add-On.


  5. Unpack the runtime on your local machine or directly on the gateway (hardware) device.
    If you downloaded the Bosch IoT Gateway SDK - install it by the appropriate script file and unpack the Connectivity Add-On.

Gateway registration

The following procedure should be followed every time when a new gateway has to be connected.

  1. Register your gateway via the Device Provisioning API - as described in Getting started > Device provisioning.
    The ID must follow the pattern: <namespace>:<gateway-identifier>.

  2. Save the result of the Device Provisioning API call to a file named provisioning.json
    (e.g. use the Download button and rename the file on your local machine).

  3. Transfer the provisioning.json file to the vms folder of your Bosch IoT Gateway Software - Runtime image.

  4. Launch the Gateway Runtime by starting the appropriate server script.
    The launch script is located at <gateway-software-root-directory>/osgi/bin/vms/<vm-name>.
    Example for Windows: C:/GW/osgi/bin/vms/jdk/server.bat

    See Starting the Framework for details.

  5. Upon success, the gateway will use the credentials from provisioning.json and connect automatically to the cloud service (using the Gateway Software Protocol Adapter).
    Further, a "digital twin" representation of the gateway and its resources will be automatically created in the Bosch IoT Things service.

Check the Things representation

In case you want to see the gateway on the Things UI, see Make things accessible for the Things dashboard.

In case everything was successful, you should see the gateway and its resources when you request your things via Bosch IoT Things HTTP API.

After authorization, you can view a specific thing by executing GET/things.
A successful response (code 200) will look in a similar way as in the screenshot below.


Check the connection state from the gateway side

To verify if the connection is successful from the gateway side, please execute the following command:

serv -p -class

The response will show the connection state via the property connected, while the eventStats property provides statistics on the sent events.

An example response would be:

Service #0, registered by bundle #210 (Bosch IoT Manager :: GS Agent :: Things Agent FI)
Service Property Property Value
Service ID 578
Object Class
Real service object
service.bundleid 210
service.scope singleton
eventStats [
Tue Jul 30 09:25:35 UTC 2019-Tue Jul 30 09:26:05 UTC 2019: 9/9 -> Success
Tue Jul 30 09:26:07 UTC 2019-Tue Jul 30 09:26:50 UTC 2019: 8/8 -> Success
Tue Jul 30 09:26:52 UTC 2019-Tue Jul 30 09:27:53 UTC 2019: 80/80 -> Success
Tue Jul 30 09:27:55 UTC 2019-Tue Jul 30 09:28:05 UTC 2019: 7/7 -> Success
Tue Jul 30 09:28:22 UTC 2019-Tue Jul 30 09:28:33 UTC 2019: 6/6 -> Success
Tue Jul 30 09:28:36 UTC 2019-Tue Jul 30 09:28:36 UTC 2019: 2/2 -> Success
Tue Jul 30 09:28:41 UTC 2019-Tue Jul 30 09:28:42 UTC 2019: 1/1 -> Success
Tue Jul 30 09:28:45 UTC 2019-Tue Jul 30 09:28:45 UTC 2019: 1/1 -> Success
Tue Jul 30 09:29:33 UTC 2019-Tue Jul 30 09:29:33 UTC 2019: 1/1 -> Success
Tue Jul 30 09:29:45 UTC 2019-Tue Jul 30 09:29:56 UTC 2019: 8/8 -> Success
Tue Jul 30 09:29:58 UTC 2019-Tue Jul 30 09:30:08 UTC 2019: 8/8 -> Success
Tue Jul 30 09:30:26 UTC 2019-Tue Jul 30 09:30:27 UTC 2019: 1/1 -> Success
Tue Jul 30 09:31:42 UTC 2019-Tue Jul 30 09:31:53 UTC 2019: 7/7 -> Success
Tue Jul 30 09:32:19 UTC 2019-Tue Jul 30 09:32:19 UTC 2019: 1/1 -> Success
Tue Jul 30 09:32:23 UTC 2019-Tue Jul 30 09:32:23 UTC 2019: 1/1 -> Success
Tue Jul 30 09:32:27 UTC 2019-Tue Jul 30 09:32:27 UTC 2019: 1/1 -> Success
Tue Jul 30 12:00:09 UTC 2019-Tue Jul 30 12:00:10 UTC 2019: 11/11 -> Success
Tue Jul 30 12:03:56 UTC 2019-Tue Jul 30 12:03:56 UTC 2019: 4/4 -> Success
Tue Jul 30 12:22:11 UTC 2019-Tue Jul 30 12:22:12 UTC 2019: 2/2 -> Success
connected true
commandStats []

In case of connection problems please check and alter your gateway's proxy settings.

Connect edge devices to the gateway

Bosch IoT Gateway Software enables connecting a variety of edge devices speaking different protocols.

Find details in the Bosch IoT Gateway Software guides for: ZigBee, Z-Wave, Cameras, ONVIF, KNX, DECT, Home Connect, SPINE, SHIP, Modbus, Bluetooth LE.

Before you start, you need to ensure that your Gateway Runtime has the needed support for the device connectivity protocol of your choosing available - if not, you need to update your image.

All Bosch IoT Gateway Software device connectivity modules come with extensive guides that help you:

  • Install and configure the module and your devices using the Setup Guides.

  • Explore module functionalities via the Web Console using the User Guides.

Detailed information on how the mapping between an edge device/gateway and a thing is achieved is available in our Gateway Software Protocol Adapter page.