Mbed OS example of Pelion device management client

This example is known to work great on the following platforms:

https://os.mbed.com/media/cache/platforms/M46B_mbed.png.250x250_q85.jpg

To use this example, connect ESP8266 Wi-Fi module (Grove UART WiFi) to the AdBun-M46B board as below:

ESP8266 Wi-FiAdBun-M46B
TXPL1 (CN4-22)
RXPL2 (CN4-24)
VINVCC3.3 (CN11-5)
GNDGND (CN11-6)

https://dl.dropboxusercontent.com/s/5j4glkwhjg5m5ay/IMG_7457.jpg

Example functionality

  • Initialize, connect and register to Pelion DM
  • Interact with the user through the serial port (115200 bauds)
    • Press enter through putty/minicom to simulate button
    • Press i to print endpoint name
    • Press Ctrl-C to to unregister
    • Press r to reset storage and reboot (warning: it generates a new device ID!)

Instructions to use this program with Mbed CLI


1. Import the application into your desktop:

mbed import https://os.mbed.com/teams/Toshiba/code/mbed-os-example-pelion/
cd mbed-os-example-pelion


2. Install the CLOUD_SDK_API_KEY

mbed config -G CLOUD_SDK_API_KEY <PELION_DM_API_KEY>

For instructions on how to generate your API key, please see the documentation.

3. Initialize firmware credentials (done once per repository). You can use the following command:

mbed dm init -d "<your company name in Pelion DM>" --model-name "<product model identifier>" -q --force

If above command do not work for your Mbed CLI, please consider upgrading Mbed CLI to version 1.8.x or above.

4. Connect Pins used with Wifi shield (ESP8266) and SD card shield:

5. Edit mbed_app.json to specify Wi-Fi access point information

            "nsapi.default-wifi-ssid"                   : "\"SSID\"",
            "nsapi.default-wifi-password"               : "\"PASSWORD\""

6. Compile and program:

mbed compile -t <toolchain> -m TMPM46B

(supported toolchains : GCC_ARM / ARM / IAR)

TESTS/register_and_read_id.py

Committer:
MACRUM
Date:
2019-12-12
Revision:
0:9f917a7bf2da

File content as of revision 0:9f917a7bf2da:

"""
Copyright 2019 ARM Limited
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

# pylint: disable=missing-docstring,useless-super-delegation
# pylint: disable=method-hidden,relative-import

import time
import json
from pelion_helper import PelionBase


class Testcase(PelionBase):
    def __init__(self):
        PelionBase.__init__(self,
                            name="register_and_read_id",
                            title="Example application can register and prints out its device ID",
                            status="released",
                            type="acceptance",
                            component=["mbed_cloud_client_example"],
                            requirements={
                                "duts": {  # default requirements for all nodes
                                    '*': {
                                        "count": 1,
                                        "type": "hardware",
                                        "application": {
                                            "init_cli_cmds": [],
                                            "post_cli_cmds": []
                                        }
                                    }
                                }
                            })
                                
    def setup(self):
        super(Testcase, self).setup()
        self.__timeout = 120
        self.__endtime = time.time() + self.__timeout


    def case(self):

        while True:
            try:
                self.verify_trace(1, ['Device ID'], True)
                break
            except:
                if time.time() > self.__endtime:
                    raise TestStepFail('Timeout: Did not find Endpoint Name within %d seconds' % self.__timeout)
                else:
                    pass

        # Get the endpoint from the logs
        self.logger.info("Reading device ID from console.")
        dev_id_raw = ""
        dev_id_raw = list(filter(lambda x: "Device ID" in x, self.duts[0].traces))
        device_id = dev_id_raw[0].split()[2]
        self.logger.info("Writing Device ID %s to pelion.tc_cfg", device_id)
        # Store the Device ID to pelion.tc_cfg
        with open("TESTS/pelion.tc_cfg") as stream:
            data = json.load(stream)
            data["device_id"] = device_id

        with open("TESTS/pelion.tc_cfg", 'w') as stream:
            json.dump(data, stream)

        self.verify_registration("registered")

    def teardown(self):
        self.connect_api.stop_notifications()