Direct IoT Device Integration

This section is a guide to integrating a Direct IoT (Internet of Things) device. If the device communicates with the BioT cloud through a gateway, please refer to the Gateway Integration Guide.

Step 1 - Pair Your Device(s) with BioT

Pairing permits the device to communicate with BioT.
To pair a device, perform the following steps:

  1. Create a device entity that represents the physical device in BioT (see Adding a New Device).
  2. Generate and download a permanent device security certificate in BioT (the certificate is a bundle of 3 files). These files consist of a private key file, a CA (certificate authority) file and a certificate file. These files will be used to connect to IoT.
  3. Store the certificate on the device.
  4. The certificate bundle will also include a unique "clientId" and IoT endpoint URL. The URL is the IoT address that the device should connect to. The device should be configured with the unique "clientId" and used to identify the device when publishing messages to IoT.

📘

Note

Regarding Step 3 above (storing the certificate), while it is useful to store the certificate in the device's file system during integration, it is not recommended to do so for production devices. The certificate is used in communication between the device and the cloud. If the certificate is stolen, it can be used to impersonate your device. You should consider a more secure storage method.

BioT supports the following methods of provisioning devices with certificates and activating them:

  • The POC (Proof of Concept) Method
  • The On Site (Mobile Method)
  • The Factory Method

More than one method can be used, according to the product life-cycle and environment of use.

The POC Method

Use the BioT Manufacturer Portal to add a device and download the certificate. The certificate you download is already activated. See more info in Generate and Download a Permanent Device Security Certificate.

The On-Site (Mobile) Method

In some cases, it makes sense to have a mobile app that sets up the IoT device (using BLE (Bluetooth Low Energy) or similar means) with some mandatory parameters (e.g. the WiFi network name (SSID) and credentials). The app may also execute the following using the BioT API:

  1. Create a device entity that represents the physical device in BioT (see Adding a New Device).
  2. Generate and download a permanent device security certificate in BioT (the certificate is a bundle of 3 files). These files consist of a private key file, a CA (certificate authority) file and a certificate file. These files will be used to connect to IoT.
  3. Transfer the certificate to the device (through BLE for example).
  4. Set the clientId, received when downloading the certificate to the device.
  5. Continue the integration according to the Gateway Integration

The Factory Method

In some cases, you may decide to manufacture in bulk a large quantity of devices that are already paired when leaving the factory. For this, you will probably develop a factory (desktop) application. The application may use the BioT APIs and the following logic:

  1. Login to BioT (using the factory user).
  2. Add the devices in bulk.
  3. Generate and download certificates for the entire bulk.
  4. Install the certificates - one per manufactured device.
  5. Set the clientId, received when downloading the certificate to the device.

See the API documentation for more information.


What’s Next
Did this page help you?