ST / Mbed OS pelion-example-common

Mbed OS Device Management example for various ST boards.

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

• DISCO_L475E_IOT01A - onboard WiFI and onboard QSPI flash. Board specific example using onboard sensors is available here.
• DISCO_F413H - onboard WiFI and onboard QSPI flash.
• DISCO_F469NI - WizFi310 WiFI shield and onboard QSPI flash (see WiFi shield instructions).
• DISCO_F746NG - onboard Ethernet and using onboard QSPI flash.
• DISCO_F769NI - onboard Ethernet and using onboard QSPI flash.
• DISCO_L496AG - WizFi310 WiFI shield and onboard QSPI flash (see WiFi shield instructions).
• NUCLEO_F207ZG - onboard Ethernet and wired SD card (SD card wiring instructions).
• NUCLEO_F412ZG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
• NUCLEO_F429ZI - onboard Ethernet and wired SD card (SD card wiring instructions).
• NUCLEO_F746ZG - onboard Ethernet and wired SD card (SD card wiring instructions).
• NUCLEO_F767ZI - onboard Ethernet and wired SD card (SD card wiring instructions).
• NUCLEO_L476RG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
• NUCLEO_L496ZG - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).
• NUCLEO_L4R5ZI - WizFi310 WiFI shield and SD card shield (see WiFi shield instructions).

Follow the Quick-Start instructions: https://cloud.mbed.com/quick-start

Example functionality

This example showcases the following device functionality:

• Read ADC temperature and ADC vref, and report them as Pelion LWM2M resources (see image below).
• On user button click, increment Pelion LWM2M button resource.
• Allow the user to change the state of the board LED from Pelion LWM2M led_state resource and PUT request.

SD card wiring

The ST Nucleo family of boards don't have storage onboard and therefore you will need an SD card. A limitation on ST Nucleo 144 boards is that there's a conflict between Ethernet and SPI pins on Arduino D11. Due to this, the SD card must be wired to different SPI bus that doesn't conflict with other functionality. The image below provide instructions on how to wire an SD card to a non-conflicting SPI instance.

If you are not a first-time Pelion Device Management user your device's SD card may already have connect and update certificates on it. If this is the case, remove and manually format your micro SD card, flash the binary to the device and then re-insert your micro SD card.

WiFi shield setup/wiring

Some ST Nucleo and Discovery boards don't have IP connectivity option, but bundled with a WiFi shield, they can take benefit of full device management capabilities. See links to reference images below on how to wire WizFI310 WiFi shield and/or SD card shield:

• ST DISCO_F469NI + WizFi310 WiFi Shield
• ST DISCO_L496AG + WizFi310 WiFi Shield
• ST NUCLEO_F412ZG + WizFi310 WiFi Shield + SD card shield
• ST NUCLEO_L476RG + WizFi310 WiFi Shield + SD card shield
• ST NUCLEO_L496ZG + WizFi310 WiFi Shield + SD card shield
• ST NUCLEO_L4R5ZI + WizFi310 WiFi Shield + SD card shield

Use this example with Mbed CLI

1. Import the application into your desktop:

mbed import /teams/ST/code/pelion-example-common

cd pelion-example-common

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. Compile and program:

mbed compile -t <toolchain> -m <TARGET_BOARD>

(supported toolchains : GCC_ARM / ARM / IAR)

diff -r a5a85e6482b9 -r 7e760f65ed78 mbed_cloud_client_user_config.h
--- a/mbed_cloud_client_user_config.h	Fri Jan 04 18:45:54 2019 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,59 +0,0 @@
-// ----------------------------------------------------------------------------
-// Copyright 2016-2017 ARM Ltd.
-//
-// SPDX-License-Identifier: Apache-2.0
-//
-// 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.
-// ----------------------------------------------------------------------------
-
-// This file is a template and it's intented to be copied to the application
-// Enable this configuration
-
-#ifndef MBED_CLOUD_CLIENT_USER_CONFIG_H
-#define MBED_CLOUD_CLIENT_USER_CONFIG_H
-
-#ifdef MBED_CONF_APP_ENDPOINT_TYPE
-#define MBED_CLOUD_CLIENT_ENDPOINT_TYPE         MBED_CONF_APP_ENDPOINT_TYPE
-#else
-#define MBED_CLOUD_CLIENT_ENDPOINT_TYPE         "default"
-#endif
-
-// Enable either TCP or UDP, but no both
-#define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP
-// MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP
-
-#define MBED_CLOUD_CLIENT_LIFETIME              3600
-
-#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE
-#define SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE       1024
-
-// set flag to enable update support in mbed Cloud client
-#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE
-
-// set download buffer size in bytes (min. 1024 bytes)
-
-// Use larger buffers in Linux //
-#ifdef __linux__
-#define MBED_CLOUD_CLIENT_UPDATE_BUFFER          (2 * 1024 * 1024)
-#else
-#define MBED_CLOUD_CLIENT_UPDATE_BUFFER          2048
-#endif
-
-// Developer flags for Update feature
-#if MBED_CONF_APP_DEVELOPER_MODE == 1
-    #define MBED_CLOUD_DEV_UPDATE_CERT
-    #define MBED_CLOUD_DEV_UPDATE_ID
-#endif // MBED_CONF_APP_DEVELOPER_MODE
-
-#endif // MBED_CLOUD_CLIENT_USER_CONFIG_H
-