Mbed Service Quickstart Guide

Quoted from ARM’s website, "Extend the reach of your cloud all the way to any IoT device. Mbed Cloud is the first complete chip-to-cloud solution, built for fast IoT deployment. You don't need to recruit a team of experts in every aspect of security, network stacks or technology standards before you can see benefits. Simply take advantage of the industry's largest ecosystem, saving on months of development costs." For more information, please refer to https://cloud.mbed.com/.

Murano mbed service provides a way to connect your mbed cloud accounts to Murano applications. It enables Murano application developers to access device data and device status within Murano via the Murano mbed service.

With Murano mbed service, Murano application developers can connect an mbed cloud to Murano, and have their mbed devices mirrored in Murano’s Advanced Device Connectivity (ADC). This will allow mbed device data and events such as device registration/unregistration to be visible within Murano. With this association, you can use Murano’s feature-rich services to build your IoT solutions with mbed devices.

Requirements

Getting Started

There are several steps required for initializing this service.

Create an application

Create an application in your Murano business. Instructions for creating an application can be found at http://docs.exosite.com/reference/ui/create-application/.

Create and configure a product

Create a product in the same Murano business. Instructions for creating a product can be found at http://docs.exosite.com/reference/ui/create-product/.

Configure your product

  1. Configure Device Identity Format to match the format of an endpoint name from mbed Connector (e.g. prefix = "", type = Opaque, required length = 36)

    Configure Device Identity Format

  2. Choose CIK (Client Identification Key) as the authentication method for HTTP Device API

    Choose CIK

Create Resource

  1. Navigate to the "Resources" tab within the product.

  2. Click "+New Resource" button and fill in Alias as defined in mbed Resource Path but replace ‘/’ with ‘_’; for example, resource path: "/Test/0" → resource alias: ‘_Test_0’

    Note: the following image is only shown when there is a device connected to the mbed cloud account.

    Set Resource Path

  3. Select "String" as "Data format", since the data are reported as String from mbed

    Create Resource

Subscribe/Add Mbed service in Exchange for your application

After the application and product have been created. You can now subscribe to Murano mbed service. For more information on how Murano Exchange works, please refer to http://docs.exosite.com/articles/exchange-overview/.

Configure your mbed service.

In service config tab, fill in API Key, Product ID, endpoint type. Make sure you have your working API Key

Go to the mbed service under service config page of your own solution

  1. Go to your own application-type solution

    Go To Solution

  2. Click "Services" tab and then click "Mbed" at left services navigator

    Choose Mbed

Enter in (1) Product ID (2) API key (3) Endpoint Type as parameters for the mbed service

Config Mbed Service

Note: the match-all star sign (*) doesn’t work for endpoint type, must input a specific type e.g. default

  1. Enter the value for parameter (1) Product ID, please refer to the following screenshots:

    Config Product ID

  2. Enter the value for parameter (2) API key, please refer to the following screenshot:

    Config API Key

  3. Enter the value for parameter (3) Endpoint Type, please refer to the following screenshot:

    Config Endpoint Type

Click "APPLY" button and you should see "Service config updated successfully" message

Apply Config

Check if mbed devices are listed by endpoint/route verification

Check if a new device is created

Go to Device page, and you will see the device, which has been successfully created and provisioned.

List Mbed Devices

Check if data is reporting

Click the device, and you will see the resource value, which has been updated

Check Resource

Associate application with product

  1. Enter the application-type solution page

  2. Click "Services" tab

  3. Click "Products" at left services navigator

  4. Check the checkbox next to the applicable product

  5. Type "Mbedservice" (for example) as script alias next to the "EDIT SCRIPT"

    Note: "Mbed" on its own cannot be used as the Lua Script Alias

    Set Alias

  6. Click "Apply" button

  7. After you see the "Updates completed successfully." message on Snackbar, you have associated application with product successfully

    Apply Alias

Check if mbed devices are listed by calling device2.listIdentities() in endpoint

  1. Click "Endpoints" tab under application page

  2. Click "+ NEW ENDPOINT"

    Add Endpoint

  3. At the "New Route" pop-up, type "mbedservice" (for example) in path field , and click "CREATE" button

    Create Endpoint

  4. Enter the new created endpoint and write down the Lua code as below:

    return Mbedservice.listIdentities()
    

    Note: To successfully use device2 public API, the alias device2 must be substituted with script alias created in the step above (which is Mbedservice as example here); further information about device2 APIs, please refer to: http://docs.exosite.com/reference/services/device2

    Update Script

  5. Click the link for AUTO-GENERATED DOCS

    Go Doc

  6. Click the "Try" for mbed/devices route

    Click Try

  7. Should see all the mbed devices

    Try Result