ST / Mbed OS pelion-example-common

Mbed OS Device Management example for various ST boards.

DEPRECATED

This example application is not maintained and not recommended. It uses an old version of Mbed OS, Pelion DM and Arm toolchain. It doesn't work with Mbed Studio.

Please use: https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-pelion/

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

DISCO_L475E_IOT01A DISCO_F413H DISCO_F746NG NUCLEO_F429ZI, NUCLEO_F767ZI, NUCLEO_F746ZG,NUCLEO_F207ZG

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.

/media/uploads/screamer/pelion_st_adc_reading.png

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.

/media/uploads/screamer/st_nucleo_144_sd.jpeg?v=4

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:

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)

main.cpp@25:d8a84856bd96, 2019-03-27 (annotated)

Committer:
screamer
Date:
Wed Mar 27 18:17:34 2019 +0000
Revision:
25:d8a84856bd96
Parent:
23:64f3f756acf6 
Improve inline documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:ea30ba97a865 1 // ----------------------------------------------------------------------------
screamer 0:ea30ba97a865 2 // Copyright 2016-2018 ARM Ltd.
screamer 0:ea30ba97a865 3 //
screamer 0:ea30ba97a865 4 // SPDX-License-Identifier: Apache-2.0
screamer 0:ea30ba97a865 5 //
screamer 0:ea30ba97a865 6 // Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:ea30ba97a865 7 // you may not use this file except in compliance with the License.
screamer 0:ea30ba97a865 8 // You may obtain a copy of the License at
screamer 0:ea30ba97a865 9 //
screamer 0:ea30ba97a865 10 // http://www.apache.org/licenses/LICENSE-2.0
screamer 0:ea30ba97a865 11 //
screamer 0:ea30ba97a865 12 // Unless required by applicable law or agreed to in writing, software
screamer 0:ea30ba97a865 13 // distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:ea30ba97a865 14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:ea30ba97a865 15 // See the License for the specific language governing permissions and
screamer 0:ea30ba97a865 16 // limitations under the License.
screamer 0:ea30ba97a865 17 // ----------------------------------------------------------------------------
screamer 0:ea30ba97a865 18 #ifndef MBED_TEST_MODE
screamer 0:ea30ba97a865 19
screamer 0:ea30ba97a865 20 #include "mbed.h"
screamer 0:ea30ba97a865 21 #include "simple-mbed-cloud-client.h"
screamer 0:ea30ba97a865 22 #include "FATFileSystem.h"
screamer 1:37392c1b4cf8 23 #include "LittleFileSystem.h"
screamer 0:ea30ba97a865 24
screamer 13:433fcff306ad 25 // Default network interface object. Don't forget to change the WiFi SSID/password in mbed_app.json if you're using WiFi.
screamer 0:ea30ba97a865 26 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 27
screamer 7:24d524c2bdcc 28 // Default block device available on the target board
screamer 1:37392c1b4cf8 29 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 7:24d524c2bdcc 30
screamer 7:24d524c2bdcc 31 #if COMPONENT_SD || COMPONENT_NUSD
screamer 7:24d524c2bdcc 32 // Use FATFileSystem for SD card type blockdevices
screamer 23:64f3f756acf6 33 FATFileSystem fs("fs");
screamer 7:24d524c2bdcc 34 #else
screamer 7:24d524c2bdcc 35 // Use LittleFileSystem for non-SD block devices to enable wear leveling and other functions
screamer 23:64f3f756acf6 36 LittleFileSystem fs("fs");
screamer 7:24d524c2bdcc 37 #endif
screamer 0:ea30ba97a865 38
screamer 1:37392c1b4cf8 39 // Default User button for GET example
screamer 4:05845431da95 40 InterruptIn button(BUTTON1);
screamer 1:37392c1b4cf8 41 // Default LED to use for PUT/POST example
screamer 25:d8a84856bd96 42 DigitalOut led(LED1, 0);
screamer 25:d8a84856bd96 43
screamer 25:d8a84856bd96 44 // How often to fetch sensor data (in seconds)
screamer 25:d8a84856bd96 45 #define SENSORS_POLL_INTERVAL 3.0
screamer 25:d8a84856bd96 46
screamer 25:d8a84856bd96 47 // Send all sensor data or just limited (useful for when running out of memory)
screamer 25:d8a84856bd96 48 #define SEND_ALL_SENSORS
screamer 25:d8a84856bd96 49
screamer 25:d8a84856bd96 50 // Sensors related includes and initialization
screamer 7:24d524c2bdcc 51 // Temperature reading from microcontroller
screamer 1:37392c1b4cf8 52 AnalogIn adc_temp(ADC_TEMP);
screamer 7:24d524c2bdcc 53 // Voltage reference reading from microcontroller
screamer 1:37392c1b4cf8 54 AnalogIn adc_vref(ADC_VREF);
screamer 0:ea30ba97a865 55
screamer 25:d8a84856bd96 56 // Declaring pointers for access to Pelion Device Management Client resources outside of main()
screamer 25:d8a84856bd96 57 MbedCloudClientResource *res_button;
screamer 25:d8a84856bd96 58 MbedCloudClientResource *res_led;
screamer 25:d8a84856bd96 59 MbedCloudClientResource *res_post;
screamer 0:ea30ba97a865 60
screamer 25:d8a84856bd96 61 // Additional resources for sensor readings
screamer 25:d8a84856bd96 62 #ifdef SEND_ALL_SENSORS
screamer 25:d8a84856bd96 63 MbedCloudClientResource *res_temperature;
screamer 25:d8a84856bd96 64 MbedCloudClientResource *res_voltage;
screamer 25:d8a84856bd96 65 #endif /* SEND_ALL_SENSORS */
screamer 19:7e760f65ed78 66
screamer 19:7e760f65ed78 67 // An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
screamer 19:7e760f65ed78 68 // This is great because things such as network operations are illegal in ISR, so updating a resource in a button's fall() function is not allowed
screamer 19:7e760f65ed78 69 EventQueue eventQueue;
screamer 0:ea30ba97a865 70
screamer 25:d8a84856bd96 71 // When the device is registered, this variable will be used to access various useful information, like device ID etc.
screamer 25:d8a84856bd96 72 static const ConnectorClientEndpointInfo* endpointInfo;
screamer 25:d8a84856bd96 73
screamer 0:ea30ba97a865 74 /**
screamer 19:7e760f65ed78 75 * PUT handler - sets the value of the built-in LED
screamer 0:ea30ba97a865 76 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 77 * @param newValue Updated value for the resource
screamer 0:ea30ba97a865 78 */
screamer 19:7e760f65ed78 79 void put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 11:0bddeb20bafc 80 printf("PUT received. New value: %s\n", newValue.c_str());
screamer 1:37392c1b4cf8 81 led = atoi(newValue.c_str());
screamer 0:ea30ba97a865 82 }
screamer 0:ea30ba97a865 83
screamer 0:ea30ba97a865 84 /**
screamer 19:7e760f65ed78 85 * POST handler - prints the content of the payload
screamer 0:ea30ba97a865 86 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 87 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:ea30ba97a865 88 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:ea30ba97a865 89 * @param size Size of the body
screamer 0:ea30ba97a865 90 */
screamer 19:7e760f65ed78 91 void post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 19:7e760f65ed78 92 printf("POST received (length %u). Payload: ", size);
screamer 19:7e760f65ed78 93 for (size_t ix = 0; ix < size; ix++) {
screamer 19:7e760f65ed78 94 printf("%02x ", buffer[ix]);
screamer 19:7e760f65ed78 95 }
screamer 19:7e760f65ed78 96 printf("\n");
screamer 1:37392c1b4cf8 97 }
screamer 0:ea30ba97a865 98
screamer 1:37392c1b4cf8 99 /**
screamer 19:7e760f65ed78 100 * Button handler
screamer 19:7e760f65ed78 101 * This function will be triggered either by a physical button press or by a ticker every 5 seconds (see below)
screamer 1:37392c1b4cf8 102 */
screamer 1:37392c1b4cf8 103 void button_press() {
screamer 25:d8a84856bd96 104 int v = res_button->get_value_int() + 1;
screamer 25:d8a84856bd96 105 res_button->set_value(v);
screamer 1:37392c1b4cf8 106 printf("Button clicked %d times\n", v);
screamer 0:ea30ba97a865 107 }
screamer 0:ea30ba97a865 108
screamer 0:ea30ba97a865 109 /**
screamer 0:ea30ba97a865 110 * Notification callback handler
screamer 0:ea30ba97a865 111 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 112 * @param status The delivery status of the notification
screamer 0:ea30ba97a865 113 */
screamer 0:ea30ba97a865 114 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 0:ea30ba97a865 115 printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:ea30ba97a865 116 }
screamer 0:ea30ba97a865 117
screamer 0:ea30ba97a865 118 /**
screamer 0:ea30ba97a865 119 * Registration callback handler
screamer 0:ea30ba97a865 120 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 19:7e760f65ed78 121 * When the device is registered, this variable will be used to access various useful information, like device ID etc.
screamer 0:ea30ba97a865 122 */
screamer 0:ea30ba97a865 123 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 7:24d524c2bdcc 124 printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 1:37392c1b4cf8 125 endpointInfo = endpoint;
screamer 0:ea30ba97a865 126 }
screamer 0:ea30ba97a865 127
screamer 1:37392c1b4cf8 128 /**
screamer 1:37392c1b4cf8 129 * Update sensors and report their values.
screamer 1:37392c1b4cf8 130 * This function is called periodically.
screamer 1:37392c1b4cf8 131 */
screamer 1:37392c1b4cf8 132 void sensors_update() {
screamer 1:37392c1b4cf8 133 float temp = adc_temp.read()*100;
screamer 1:37392c1b4cf8 134 float vref = adc_vref.read();
screamer 1:37392c1b4cf8 135 printf("ADC temp: %6.4f C, vref: %6.4f %%\r\n", temp, vref);
screamer 1:37392c1b4cf8 136 if (endpointInfo) {
screamer 25:d8a84856bd96 137 res_temperature->set_value(temp);
screamer 25:d8a84856bd96 138 res_voltage->set_value(vref);
screamer 1:37392c1b4cf8 139 }
screamer 1:37392c1b4cf8 140 }
screamer 1:37392c1b4cf8 141
screamer 1:37392c1b4cf8 142
screamer 0:ea30ba97a865 143 int main(void) {
screamer 8:579904ba4ba1 144 printf("\nStarting Simple Pelion Device Management Client example\n");
screamer 1:37392c1b4cf8 145
screamer 23:64f3f756acf6 146 int storage_status = fs.mount(bd);
screamer 23:64f3f756acf6 147 if (storage_status != 0) {
screamer 23:64f3f756acf6 148 printf("Storage mounting failed.\n");
screamer 23:64f3f756acf6 149 }
screamer 1:37392c1b4cf8 150 // If the User button is pressed ons start, then format storage.
screamer 23:64f3f756acf6 151 bool btn_pressed = (button.read() == MBED_CONF_APP_BUTTON_PRESSED_STATE);
screamer 23:64f3f756acf6 152 if (btn_pressed) {
screamer 23:64f3f756acf6 153 printf("User button is pushed on start...\n");
screamer 23:64f3f756acf6 154 }
screamer 23:64f3f756acf6 155
screamer 23:64f3f756acf6 156 if (storage_status || btn_pressed) {
screamer 23:64f3f756acf6 157 printf("Formatting the storage...\n");
screamer 23:64f3f756acf6 158 int storage_status = StorageHelper::format(&fs, bd);
screamer 1:37392c1b4cf8 159 if (storage_status != 0) {
screamer 23:64f3f756acf6 160 printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
screamer 1:37392c1b4cf8 161 }
screamer 8:579904ba4ba1 162 } else {
screamer 8:579904ba4ba1 163 printf("You can hold the user button during boot to format the storage and change the device identity.\n");
screamer 1:37392c1b4cf8 164 }
screamer 0:ea30ba97a865 165
screamer 19:7e760f65ed78 166 // Connect to the Internet (DHCP is expected to be on)
screamer 10:f3ec71d2ec83 167 printf("Connecting to the network using the default network interface...\n");
screamer 1:37392c1b4cf8 168 net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 169
screamer 19:7e760f65ed78 170 nsapi_error_t net_status = NSAPI_ERROR_NO_CONNECTION;
screamer 19:7e760f65ed78 171 while ((net_status = net->connect()) != NSAPI_ERROR_OK) {
screamer 19:7e760f65ed78 172 printf("Unable to connect to network (%d). Retrying...\n", net_status);
screamer 0:ea30ba97a865 173 }
screamer 0:ea30ba97a865 174
screamer 0:ea30ba97a865 175 printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
screamer 0:ea30ba97a865 176
screamer 8:579904ba4ba1 177 printf("Initializing Pelion Device Management Client...\n");
screamer 7:24d524c2bdcc 178
screamer 19:7e760f65ed78 179 // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management
screamer 0:ea30ba97a865 180 SimpleMbedCloudClient client(net, bd, &fs);
screamer 0:ea30ba97a865 181 int client_status = client.init();
screamer 0:ea30ba97a865 182 if (client_status != 0) {
screamer 19:7e760f65ed78 183 printf("Pelion Client initialization failed (%d)\n", client_status);
screamer 0:ea30ba97a865 184 return -1;
screamer 0:ea30ba97a865 185 }
screamer 0:ea30ba97a865 186
screamer 0:ea30ba97a865 187 // Creating resources, which can be written or read from the cloud
screamer 25:d8a84856bd96 188 res_button = client.create_resource("3200/0/5501", "Button Count");
screamer 25:d8a84856bd96 189 res_button->set_value(0);
screamer 25:d8a84856bd96 190 res_button->methods(M2MMethod::GET);
screamer 25:d8a84856bd96 191 res_button->observable(true);
screamer 25:d8a84856bd96 192 res_button->attach_notification_callback(button_callback);
screamer 1:37392c1b4cf8 193
screamer 25:d8a84856bd96 194 res_led = client.create_resource("3201/0/5853", "LED State");
screamer 25:d8a84856bd96 195 res_led->set_value(led.read());
screamer 25:d8a84856bd96 196 res_led->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 25:d8a84856bd96 197 res_led->attach_put_callback(put_callback);
screamer 19:7e760f65ed78 198
screamer 25:d8a84856bd96 199 res_post = client.create_resource("3300/0/5605", "Execute Function");
screamer 25:d8a84856bd96 200 res_post->methods(M2MMethod::POST);
screamer 25:d8a84856bd96 201 res_post->attach_post_callback(post_callback);
screamer 0:ea30ba97a865 202
screamer 1:37392c1b4cf8 203 // Sensor resources
screamer 25:d8a84856bd96 204 res_temperature = client.create_resource("3303/0/5700", "Temperature (C)");
screamer 25:d8a84856bd96 205 res_temperature->set_value(0);
screamer 25:d8a84856bd96 206 res_temperature->methods(M2MMethod::GET);
screamer 25:d8a84856bd96 207 res_temperature->observable(true);
screamer 0:ea30ba97a865 208
screamer 25:d8a84856bd96 209 res_voltage = client.create_resource("3316/0/5700", "Voltage");
screamer 25:d8a84856bd96 210 res_voltage->set_value(0);
screamer 25:d8a84856bd96 211 res_voltage->methods(M2MMethod::GET);
screamer 25:d8a84856bd96 212 res_voltage->observable(true);
screamer 0:ea30ba97a865 213
screamer 11:0bddeb20bafc 214 printf("Initialized Pelion Device Management Client. Registering...\n");
screamer 0:ea30ba97a865 215
screamer 0:ea30ba97a865 216 // Callback that fires when registering is complete
screamer 0:ea30ba97a865 217 client.on_registered(&registered);
screamer 0:ea30ba97a865 218
screamer 1:37392c1b4cf8 219 // Register with Pelion DM
screamer 0:ea30ba97a865 220 client.register_and_connect();
screamer 0:ea30ba97a865 221
screamer 19:7e760f65ed78 222 // The button fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 1:37392c1b4cf8 223 button.fall(eventQueue.event(&button_press));
screamer 14:1ac188d5404d 224 printf("Press the user button to increment the LwM2M resource value...\n");
screamer 1:37392c1b4cf8 225
screamer 0:ea30ba97a865 226 Ticker timer;
screamer 1:37392c1b4cf8 227 timer.attach(eventQueue.event(&sensors_update), SENSORS_POLL_INTERVAL);
screamer 0:ea30ba97a865 228
screamer 0:ea30ba97a865 229 // You can easily run the eventQueue in a separate thread if required
screamer 0:ea30ba97a865 230 eventQueue.dispatch_forever();
screamer 0:ea30ba97a865 231 }
screamer 19:7e760f65ed78 232
screamer 19:7e760f65ed78 233 #endif /* MBED_TEST_MODE */