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@13:433fcff306ad, 2018-12-16 (annotated)

Committer:
screamer
Date:
Sun Dec 16 13:35:34 2018 +0000
Revision:
13:433fcff306ad
Parent:
11:0bddeb20bafc
Child:
14:1ac188d5404d
Inline documentation to main application

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 0:ea30ba97a865 25 // An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
screamer 0:ea30ba97a865 26 // 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 0:ea30ba97a865 27 EventQueue eventQueue;
screamer 0:ea30ba97a865 28
screamer 13:433fcff306ad 29 // 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 30 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 31
screamer 7:24d524c2bdcc 32 // Default block device available on the target board
screamer 1:37392c1b4cf8 33 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 7:24d524c2bdcc 34
screamer 7:24d524c2bdcc 35 #if COMPONENT_SD || COMPONENT_NUSD
screamer 7:24d524c2bdcc 36 // Use FATFileSystem for SD card type blockdevices
screamer 7:24d524c2bdcc 37 FATFileSystem fs("fs", bd);
screamer 7:24d524c2bdcc 38 #else
screamer 7:24d524c2bdcc 39 // Use LittleFileSystem for non-SD block devices to enable wear leveling and other functions
screamer 7:24d524c2bdcc 40 LittleFileSystem fs("fs", bd);
screamer 7:24d524c2bdcc 41 #endif
screamer 0:ea30ba97a865 42
screamer 1:37392c1b4cf8 43 // Default User button for GET example
screamer 4:05845431da95 44 InterruptIn button(BUTTON1);
screamer 1:37392c1b4cf8 45 // Default LED to use for PUT/POST example
screamer 1:37392c1b4cf8 46 DigitalOut led(LED1);
screamer 7:24d524c2bdcc 47 // Temperature reading from microcontroller
screamer 1:37392c1b4cf8 48 AnalogIn adc_temp(ADC_TEMP);
screamer 7:24d524c2bdcc 49 // Voltage reference reading from microcontroller
screamer 1:37392c1b4cf8 50 AnalogIn adc_vref(ADC_VREF);
screamer 0:ea30ba97a865 51
screamer 1:37392c1b4cf8 52 #define SENSORS_POLL_INTERVAL 1.0
screamer 0:ea30ba97a865 53
screamer 1:37392c1b4cf8 54 // Declaring pointers for access to Pelion Client resources outside of main()
screamer 1:37392c1b4cf8 55 MbedCloudClientResource *res_button;
screamer 1:37392c1b4cf8 56 MbedCloudClientResource *res_led;
screamer 1:37392c1b4cf8 57 MbedCloudClientResource *res_temperature;
screamer 1:37392c1b4cf8 58 MbedCloudClientResource *res_voltage;
screamer 1:37392c1b4cf8 59
screamer 1:37392c1b4cf8 60 // When the device is registered, this variable will be used to access various useful information, like device ID etc.
screamer 1:37392c1b4cf8 61 static const ConnectorClientEndpointInfo* endpointInfo;
screamer 0:ea30ba97a865 62
screamer 0:ea30ba97a865 63 /**
screamer 0:ea30ba97a865 64 * PUT handler
screamer 0:ea30ba97a865 65 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 66 * @param newValue Updated value for the resource
screamer 0:ea30ba97a865 67 */
screamer 1:37392c1b4cf8 68 void led_put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 11:0bddeb20bafc 69 printf("PUT received. New value: %s\n", newValue.c_str());
screamer 1:37392c1b4cf8 70 led = atoi(newValue.c_str());
screamer 0:ea30ba97a865 71 }
screamer 0:ea30ba97a865 72
screamer 0:ea30ba97a865 73 /**
screamer 0:ea30ba97a865 74 * POST handler
screamer 0:ea30ba97a865 75 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 76 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:ea30ba97a865 77 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:ea30ba97a865 78 * @param size Size of the body
screamer 0:ea30ba97a865 79 */
screamer 1:37392c1b4cf8 80 void led_post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 11:0bddeb20bafc 81 printf("POST received. Payload: %s\n", res_led->get_value().c_str());
screamer 1:37392c1b4cf8 82 led = atoi(res_led->get_value().c_str());
screamer 1:37392c1b4cf8 83 }
screamer 0:ea30ba97a865 84
screamer 1:37392c1b4cf8 85 /**
screamer 1:37392c1b4cf8 86 * Button function triggered by the physical button press.
screamer 1:37392c1b4cf8 87 */
screamer 1:37392c1b4cf8 88 void button_press() {
screamer 1:37392c1b4cf8 89 int v = res_button->get_value_int() + 1;
screamer 1:37392c1b4cf8 90 res_button->set_value(v);
screamer 1:37392c1b4cf8 91 printf("Button clicked %d times\n", v);
screamer 0:ea30ba97a865 92 }
screamer 0:ea30ba97a865 93
screamer 0:ea30ba97a865 94 /**
screamer 0:ea30ba97a865 95 * Notification callback handler
screamer 0:ea30ba97a865 96 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 97 * @param status The delivery status of the notification
screamer 0:ea30ba97a865 98 */
screamer 0:ea30ba97a865 99 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 0:ea30ba97a865 100 printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:ea30ba97a865 101 }
screamer 0:ea30ba97a865 102
screamer 0:ea30ba97a865 103 /**
screamer 0:ea30ba97a865 104 * Registration callback handler
screamer 0:ea30ba97a865 105 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 0:ea30ba97a865 106 */
screamer 0:ea30ba97a865 107 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 7:24d524c2bdcc 108 printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 1:37392c1b4cf8 109 endpointInfo = endpoint;
screamer 0:ea30ba97a865 110 }
screamer 0:ea30ba97a865 111
screamer 1:37392c1b4cf8 112 /**
screamer 1:37392c1b4cf8 113 * Update sensors and report their values.
screamer 1:37392c1b4cf8 114 * This function is called periodically.
screamer 1:37392c1b4cf8 115 */
screamer 1:37392c1b4cf8 116 void sensors_update() {
screamer 1:37392c1b4cf8 117 float temp = adc_temp.read()*100;
screamer 1:37392c1b4cf8 118 float vref = adc_vref.read();
screamer 1:37392c1b4cf8 119 printf("ADC temp: %6.4f C, vref: %6.4f %%\r\n", temp, vref);
screamer 1:37392c1b4cf8 120 if (endpointInfo) {
screamer 1:37392c1b4cf8 121 res_temperature->set_value(temp);
screamer 1:37392c1b4cf8 122 res_voltage->set_value(vref);
screamer 1:37392c1b4cf8 123 }
screamer 1:37392c1b4cf8 124 }
screamer 1:37392c1b4cf8 125
screamer 1:37392c1b4cf8 126
screamer 0:ea30ba97a865 127 int main(void) {
screamer 8:579904ba4ba1 128 printf("\nStarting Simple Pelion Device Management Client example\n");
screamer 1:37392c1b4cf8 129
screamer 1:37392c1b4cf8 130 // If the User button is pressed ons start, then format storage.
screamer 7:24d524c2bdcc 131 DigitalIn *user_button = new DigitalIn(BUTTON1);
screamer 7:24d524c2bdcc 132 #if TARGET_DISCO_L475VG_IOT01A
screamer 7:24d524c2bdcc 133 // The user button on DISCO_L475VG_IOT01A works the other way around
screamer 7:24d524c2bdcc 134 const int PRESSED = 0;
screamer 7:24d524c2bdcc 135 #else
screamer 1:37392c1b4cf8 136 const int PRESSED = 1;
screamer 7:24d524c2bdcc 137 #endif
screamer 1:37392c1b4cf8 138 if (user_button->read() == PRESSED) {
screamer 1:37392c1b4cf8 139 printf("User button is pushed on start. Formatting the storage...\n");
screamer 7:24d524c2bdcc 140 int storage_status = fs.reformat(bd);
screamer 1:37392c1b4cf8 141 if (storage_status != 0) {
screamer 7:24d524c2bdcc 142 if (bd->erase(0, bd->size()) == 0) {
screamer 7:24d524c2bdcc 143 if (fs.format(bd) == 0) {
screamer 1:37392c1b4cf8 144 storage_status = 0;
screamer 1:37392c1b4cf8 145 printf("The storage reformatted successfully.\n");
screamer 1:37392c1b4cf8 146 }
screamer 1:37392c1b4cf8 147 }
screamer 1:37392c1b4cf8 148 }
screamer 1:37392c1b4cf8 149 if (storage_status != 0) {
screamer 1:37392c1b4cf8 150 printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
screamer 1:37392c1b4cf8 151 }
screamer 8:579904ba4ba1 152 } else {
screamer 8:579904ba4ba1 153 printf("You can hold the user button during boot to format the storage and change the device identity.\n");
screamer 1:37392c1b4cf8 154 }
screamer 0:ea30ba97a865 155
screamer 0:ea30ba97a865 156 // Connect to the internet (DHCP is expected to be on)
screamer 10:f3ec71d2ec83 157 printf("Connecting to the network using the default network interface...\n");
screamer 1:37392c1b4cf8 158 net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 159
screamer 1:37392c1b4cf8 160 nsapi_error_t net_status = -1;
screamer 1:37392c1b4cf8 161 for (int tries = 0; tries < 3; tries++) {
screamer 1:37392c1b4cf8 162 net_status = net->connect();
screamer 1:37392c1b4cf8 163 if (net_status == NSAPI_ERROR_OK) {
screamer 1:37392c1b4cf8 164 break;
screamer 1:37392c1b4cf8 165 } else {
screamer 1:37392c1b4cf8 166 printf("Unable to connect to network. Retrying...\n");
screamer 1:37392c1b4cf8 167 }
screamer 1:37392c1b4cf8 168 }
screamer 1:37392c1b4cf8 169
screamer 1:37392c1b4cf8 170 if (net_status != NSAPI_ERROR_OK) {
screamer 1:37392c1b4cf8 171 printf("ERROR: Connecting to the network failed (%d)!\n", net_status);
screamer 0:ea30ba97a865 172 return -1;
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 1:37392c1b4cf8 179 // SimpleMbedCloudClient handles registering over LwM2M to Pelion DM
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 1:37392c1b4cf8 183 printf("ERROR: 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 1:37392c1b4cf8 188 res_button = client.create_resource("3200/0/5501", "button_count");
screamer 1:37392c1b4cf8 189 res_button->set_value(0);
screamer 1:37392c1b4cf8 190 res_button->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 191 res_button->observable(true);
screamer 1:37392c1b4cf8 192 res_button->attach_notification_callback(button_callback);
screamer 1:37392c1b4cf8 193
screamer 1:37392c1b4cf8 194 res_led = client.create_resource("3201/0/5853", "led_state");
screamer 1:37392c1b4cf8 195 res_led->set_value(1);
screamer 1:37392c1b4cf8 196 res_led->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 1:37392c1b4cf8 197 res_led->attach_put_callback(led_put_callback);
screamer 0:ea30ba97a865 198
screamer 1:37392c1b4cf8 199 // Sensor resources
screamer 1:37392c1b4cf8 200 res_temperature = client.create_resource("3303/0/5700", "temperature");
screamer 1:37392c1b4cf8 201 res_temperature->set_value(0);
screamer 1:37392c1b4cf8 202 res_temperature->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 203 res_temperature->observable(true);
screamer 0:ea30ba97a865 204
screamer 1:37392c1b4cf8 205 res_voltage = client.create_resource("3316/0/5700", "voltage");
screamer 1:37392c1b4cf8 206 res_voltage->set_value(0);
screamer 1:37392c1b4cf8 207 res_voltage->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 208 res_voltage->observable(true);
screamer 0:ea30ba97a865 209
screamer 11:0bddeb20bafc 210 printf("Initialized Pelion Device Management Client. Registering...\n");
screamer 0:ea30ba97a865 211
screamer 0:ea30ba97a865 212 // Callback that fires when registering is complete
screamer 0:ea30ba97a865 213 client.on_registered(&registered);
screamer 0:ea30ba97a865 214
screamer 1:37392c1b4cf8 215 // Register with Pelion DM
screamer 0:ea30ba97a865 216 client.register_and_connect();
screamer 0:ea30ba97a865 217
screamer 7:24d524c2bdcc 218 int i = 600; // wait up 60 seconds before attaching sensors and button events
screamer 1:37392c1b4cf8 219 while (i-- > 0 && !client.is_client_registered()) {
screamer 1:37392c1b4cf8 220 wait_ms(100);
screamer 1:37392c1b4cf8 221 }
screamer 1:37392c1b4cf8 222
screamer 1:37392c1b4cf8 223 button.fall(eventQueue.event(&button_press));
screamer 1:37392c1b4cf8 224
screamer 0:ea30ba97a865 225 // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
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 0:ea30ba97a865 232 #endif