IoT User Reference for Connector-As-a-Service (Aka PDaaS)

As Device Owner, you have access to the IoT-Connector Portal which enables you to claim, manage devices and connected application. This page guides you through those steps.

Table of Contents


Find Hardware

Note: This section requires an Exosite account.

You have an application, however haven't find the proper IoT-Device yet. You want an off-the-shelf device without any need for firmware development.

The Exchange IoT-Marketplace provides a selection of compatible hardware ready to be used in your application.

Make your selection and follow the link on the details page to navigate to the Manufacturer device Portal to learn more and acquire the device.


Claiming Devices

You have your new IoT-Device at hand, the next step is to register it by claiming its ownership.

Along with your device a Claim Code or Claim QR Code should be provided by the Manufacturer.

Note:


ExoSense

If you are an ExoSense user or what to use ExoSense application, you can make the claim from the ExoSense user interface directly.

0. Enable ExoSense Claiming

ExoSense claiming is an option which might not be enabled on your instance by default.

On ExoSense UI navigate to the FEATURES tab of the Setup panel.

ExoSense menu devices

ExoSense menu devices

Among the flags available find User Device Claiming Support and enable it.

ExoSense menu devices

If the option is not visible, please contact support@exosite.com.

First make sure your ExoSense instance enables the owned Device IoT-Connector. This steps requires to be the instance administrator with access to the Exosite account. If you don't know about it, contact your instance administrator.

Then follow the steps from Link IoT-Connector to the Application.

2. Claim Device from ExoSense

Navigate to the ExoSense devices management page from the left menu.

ExoSense menu devices

On the right side of the panel, you will find an ADD DEVICE button.

ExoSense new device btn

Which brings you to the claiming page.

ExoSense Claim

Enter the Claim Code or scan the QR Code. The device will then be added and ready to use.


Using a QR Code

If a QR Code is provided with your device, use your mobile device to scan the QR Code (You might need to install a QR code reader) and the IoT Portal will prompt you to authenticate yourself via a login.

Once authenticated you will see the Device Claim form automatically filled up. If you already have an Applications setup you can assign the device to it at this stage. Click on CLAIM and you should see the device on owned devices list.

If the device doesn't appear or an error occur:

  1. Confirm the claim code is correct.
  2. Contact support from the IoT-Connector Portal link.

Using a Raw Code

With a Claim Code, you will need to navigate to the provided IoT-Connector Portal Url.

If a link is not provided with the Claim Code, you might need to find the link on the related item on the Exchange IoT-Marketplace, IoT-Connector section.

Once logged-in on the IoT-Connector Portal, you will find the Device management page with a CLAIM DEVICE button. Enter your code and press CLAIM. The device will show on your owned devices list.

If the device doesn't appear or an error occur:

  1. Confirm the claim code is correct.
  2. Contact support from the IoT-Connector Portal link.

Managing Devices

The Devices page of the IoT-Connector Portal displays all claimed devices. As well you can find information such as the last seen IpAddress and connection time.

Device Details

Clicking on one device will display the device details along with the current reported raw values.

While you can assign the device to an App when claiming the device you can also re-assign the device to a different app or multiple apps from the Device details page using the ADD TO APP button.

If you don't have any application configured see the Managing Applications section.

Resetting Ownership

As well, the device details page provides a way to reset the device Ownership & linked applications. The claim code remains the same so you can use the same Claim Code once again later on. This also allows you to give ownership of the Device to another user.


Managing Applications

Compatible IoT Application can be linked to the owned Devices providing high level feature, reporting and control. IoT Connectors-as-a-Service provides different options to get your Device data on a dashboard.

pdaas_apps

Managed Applications

Connector-As-a-Service providers have the opportunity to integrate multi-tenants applications to provide a plug-&-play experience to the Device Owners.

If enabled the device owners will see the provided application registration link from the IoT-Connector Portal under the Apps page. As application provider to promote an application as "managed" you will need to provide your application Id with the Connector-as-a-Service publisher. See the publish guide for more info.


Murano Application

Applications hosted on the Murano platform benefit for privileged performance and security as all traffic from the device connectivity to the Application is made internal to the platform.

Several compatible Applications are ready to be used. Find them from the Exchange IoT-Marketplace, Application or Murano Application sections.

Find more information about Application here.

To use a Murano Application (Including ExoSense) with your devices, you need to link the IoT-Connector to the ExoSense instance.

  1. Navigate to the Exchange IoT-Marketplace, IoT-Connector section
  2. Find your device model.
  3. On the detail page, click on the ADD TO APPLICATION button.
  4. Select your Application instance and apply.

Find more information on the Link-Connector-App documentation.

Now your application is eligible to connect to any Devices from this IoT-Connector.

Authenticate the Application

You now need to authenticate your App to the IoT-Connector Portal account.

  1. Navigate to the Murano Application management page. If you don't have access, contact your administrator.
  2. Under Services find the IoT-Connector
  3. On the settings page, a link to the IoT-Connector Portal is available with an authentication token
  4. Follow the link, if not already: login
  5. The Murano App will display on your App list

Build Compatible Murano Application

If you want to develop your IoT user experience from scratch, follow the Murano development documentation.

Any custom Murano Application is able to interact with Device claimed in the IoT-Connector Portal.

If you want to integrate the claiming logic for a multi-tenant application, read the Guide on integrating a device claim compatible Application.


External Application

The IoT-Connector Portal exposes an Application API enabling the integration of any HTTP compatible application on the Internet.

Find a step by step guide on the External Application guide: Connect External Application.

Forward Device Data

To forward device Data to External application an HTTPS callback URL needs to be defined in the Apps settings.

Note: The application still need to be able to process the provided data structure as documented on the IoT-Connector Portal API Documentation.

Once a device is sending data, the Apps Details page will display the success for failure of the callback.

Tips: An easy way to trouble-shoot your Application connectivity is to use an account on https://requestbin.com and setup your Endpoint as follow.

HTTPS Callback URL: https://<requestbin endpoint id>.x.pipedream.net/`

Authentication

To authenticate request to the callback endpoint callback request will fill a 'Secret' string in the standard Authorization header. The 'Secret' is generated automatically and you will be prompted to copy it during App creation. IMPORTANT: You cannot access the 'Secret' value any so save it in a safe place.

You can also input your own 'Secret' value in the App details page instead of using the generated value.

Following options for the header formatting are supported to pass the 'Secret':


Device API

External applications can also actively interact with Devices such as listing devices, fetching values and sending commands.

For this purpose a default secure Application API is available. While the standard API is common to all Connector-as-a-Service each connector can extent the API. So refer to the API menu tab from the IoT-Connector Portal which provides an API documentation for the details of the endpoints. Which is typically available under https://<Iot portal sub domain>.apps.exosite.io/docs.

Authentication

The Device API supports a Basic authentication as follow:

Authorization: Basic <Base64(<App Id>:<Secret>)>

AWS Integration Example

To go further, see a full example to Connect an AWS Lambda Application.