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@5:766c011942b4, 2018-12-11 (annotated)

Committer:
screamer
Date:
Tue Dec 11 00:25:42 2018 +0000
Revision:
5:766c011942b4
Parent:
4:05845431da95
Child:
7:24d524c2bdcc
Use BUTTON1 instead of USER_BUTTON for reseting the board

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 0:ea30ba97a865 29 // Default network interface object
screamer 0:ea30ba97a865 30 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 31
screamer 1:37392c1b4cf8 32 // Default block device
screamer 1:37392c1b4cf8 33 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 1:37392c1b4cf8 34 SlicingBlockDevice sd(bd, 0, 2*1024*1024);
screamer 1:37392c1b4cf8 35 LittleFileSystem fs("fs", &sd);
screamer 0:ea30ba97a865 36
screamer 1:37392c1b4cf8 37 // Default User button for GET example
screamer 4:05845431da95 38 InterruptIn button(BUTTON1);
screamer 1:37392c1b4cf8 39 // Default LED to use for PUT/POST example
screamer 1:37392c1b4cf8 40 DigitalOut led(LED1);
screamer 1:37392c1b4cf8 41 // Default temperature reading from microcontroller
screamer 1:37392c1b4cf8 42 AnalogIn adc_temp(ADC_TEMP);
screamer 1:37392c1b4cf8 43 // Voltage reference from microcontroller
screamer 1:37392c1b4cf8 44 AnalogIn adc_vref(ADC_VREF);
screamer 0:ea30ba97a865 45
screamer 1:37392c1b4cf8 46 #define SENSORS_POLL_INTERVAL 1.0
screamer 0:ea30ba97a865 47
screamer 1:37392c1b4cf8 48 // Declaring pointers for access to Pelion Client resources outside of main()
screamer 1:37392c1b4cf8 49 MbedCloudClientResource *res_button;
screamer 1:37392c1b4cf8 50 MbedCloudClientResource *res_led;
screamer 1:37392c1b4cf8 51 MbedCloudClientResource *res_temperature;
screamer 1:37392c1b4cf8 52 MbedCloudClientResource *res_voltage;
screamer 1:37392c1b4cf8 53
screamer 1:37392c1b4cf8 54 // When the device is registered, this variable will be used to access various useful information, like device ID etc.
screamer 1:37392c1b4cf8 55 static const ConnectorClientEndpointInfo* endpointInfo;
screamer 0:ea30ba97a865 56
screamer 0:ea30ba97a865 57 /**
screamer 0:ea30ba97a865 58 * PUT handler
screamer 0:ea30ba97a865 59 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 60 * @param newValue Updated value for the resource
screamer 0:ea30ba97a865 61 */
screamer 1:37392c1b4cf8 62 void led_put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 0:ea30ba97a865 63 printf("PUT received, new value: %s\n", newValue.c_str());
screamer 1:37392c1b4cf8 64 led = atoi(newValue.c_str());
screamer 0:ea30ba97a865 65 }
screamer 0:ea30ba97a865 66
screamer 0:ea30ba97a865 67 /**
screamer 0:ea30ba97a865 68 * POST handler
screamer 0:ea30ba97a865 69 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 70 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:ea30ba97a865 71 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:ea30ba97a865 72 * @param size Size of the body
screamer 0:ea30ba97a865 73 */
screamer 1:37392c1b4cf8 74 void led_post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 1:37392c1b4cf8 75 printf("POST received. Going to blink LED pattern: %s\n", res_led->get_value().c_str());
screamer 1:37392c1b4cf8 76 led = atoi(res_led->get_value().c_str());
screamer 1:37392c1b4cf8 77 }
screamer 0:ea30ba97a865 78
screamer 1:37392c1b4cf8 79 /**
screamer 1:37392c1b4cf8 80 * Button function triggered by the physical button press.
screamer 1:37392c1b4cf8 81 */
screamer 1:37392c1b4cf8 82 void button_press() {
screamer 1:37392c1b4cf8 83 int v = res_button->get_value_int() + 1;
screamer 1:37392c1b4cf8 84 res_button->set_value(v);
screamer 1:37392c1b4cf8 85 printf("Button clicked %d times\n", v);
screamer 0:ea30ba97a865 86 }
screamer 0:ea30ba97a865 87
screamer 0:ea30ba97a865 88 /**
screamer 0:ea30ba97a865 89 * Notification callback handler
screamer 0:ea30ba97a865 90 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 91 * @param status The delivery status of the notification
screamer 0:ea30ba97a865 92 */
screamer 0:ea30ba97a865 93 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 0:ea30ba97a865 94 printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:ea30ba97a865 95 }
screamer 0:ea30ba97a865 96
screamer 0:ea30ba97a865 97 /**
screamer 0:ea30ba97a865 98 * Registration callback handler
screamer 0:ea30ba97a865 99 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 0:ea30ba97a865 100 */
screamer 0:ea30ba97a865 101 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 0:ea30ba97a865 102 printf("Connected to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 1:37392c1b4cf8 103 endpointInfo = endpoint;
screamer 0:ea30ba97a865 104 }
screamer 0:ea30ba97a865 105
screamer 1:37392c1b4cf8 106 /**
screamer 1:37392c1b4cf8 107 * Update sensors and report their values.
screamer 1:37392c1b4cf8 108 * This function is called periodically.
screamer 1:37392c1b4cf8 109 */
screamer 1:37392c1b4cf8 110 void sensors_update() {
screamer 1:37392c1b4cf8 111 float temp = adc_temp.read()*100;
screamer 1:37392c1b4cf8 112 float vref = adc_vref.read();
screamer 1:37392c1b4cf8 113 printf("ADC temp: %6.4f C, vref: %6.4f %%\r\n", temp, vref);
screamer 1:37392c1b4cf8 114 if (endpointInfo) {
screamer 1:37392c1b4cf8 115 res_temperature->set_value(temp);
screamer 1:37392c1b4cf8 116 res_voltage->set_value(vref);
screamer 1:37392c1b4cf8 117 }
screamer 1:37392c1b4cf8 118 }
screamer 1:37392c1b4cf8 119
screamer 1:37392c1b4cf8 120
screamer 0:ea30ba97a865 121 int main(void) {
screamer 0:ea30ba97a865 122 printf("Starting Simple Pelion Device Management Client example\n");
screamer 1:37392c1b4cf8 123
screamer 1:37392c1b4cf8 124 // If the User button is pressed ons start, then format storage.
screamer 1:37392c1b4cf8 125 const int PRESSED = 1;
screamer 5:766c011942b4 126 DigitalIn *user_button = new DigitalIn(BUTTON1);
screamer 1:37392c1b4cf8 127 if (user_button->read() == PRESSED) {
screamer 1:37392c1b4cf8 128 printf("User button is pushed on start. Formatting the storage...\n");
screamer 1:37392c1b4cf8 129 int storage_status = fs.reformat(&sd);
screamer 1:37392c1b4cf8 130 if (storage_status != 0) {
screamer 1:37392c1b4cf8 131 if (sd.erase(0, sd.size()) == 0) {
screamer 1:37392c1b4cf8 132 if (fs.format(&sd) == 0) {
screamer 1:37392c1b4cf8 133 storage_status = 0;
screamer 1:37392c1b4cf8 134 printf("The storage reformatted successfully.\n");
screamer 1:37392c1b4cf8 135 }
screamer 1:37392c1b4cf8 136 }
screamer 1:37392c1b4cf8 137 }
screamer 1:37392c1b4cf8 138 if (storage_status != 0) {
screamer 1:37392c1b4cf8 139 printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
screamer 1:37392c1b4cf8 140 }
screamer 1:37392c1b4cf8 141 }
screamer 0:ea30ba97a865 142
screamer 0:ea30ba97a865 143 // Connect to the internet (DHCP is expected to be on)
screamer 1:37392c1b4cf8 144 printf("Connecting to the network using Wifi...\n");
screamer 1:37392c1b4cf8 145 net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 146
screamer 1:37392c1b4cf8 147 nsapi_error_t net_status = -1;
screamer 1:37392c1b4cf8 148 for (int tries = 0; tries < 3; tries++) {
screamer 1:37392c1b4cf8 149 net_status = net->connect();
screamer 1:37392c1b4cf8 150 if (net_status == NSAPI_ERROR_OK) {
screamer 1:37392c1b4cf8 151 break;
screamer 1:37392c1b4cf8 152 } else {
screamer 1:37392c1b4cf8 153 printf("Unable to connect to network. Retrying...\n");
screamer 1:37392c1b4cf8 154 }
screamer 1:37392c1b4cf8 155 }
screamer 1:37392c1b4cf8 156
screamer 1:37392c1b4cf8 157 if (net_status != NSAPI_ERROR_OK) {
screamer 1:37392c1b4cf8 158 printf("ERROR: Connecting to the network failed (%d)!\n", net_status);
screamer 0:ea30ba97a865 159 return -1;
screamer 0:ea30ba97a865 160 }
screamer 0:ea30ba97a865 161
screamer 0:ea30ba97a865 162 printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
screamer 0:ea30ba97a865 163
screamer 1:37392c1b4cf8 164 // SimpleMbedCloudClient handles registering over LwM2M to Pelion DM
screamer 0:ea30ba97a865 165 SimpleMbedCloudClient client(net, bd, &fs);
screamer 0:ea30ba97a865 166 int client_status = client.init();
screamer 0:ea30ba97a865 167 if (client_status != 0) {
screamer 1:37392c1b4cf8 168 printf("ERROR: Pelion Client initialization failed (%d)\n", client_status);
screamer 0:ea30ba97a865 169 return -1;
screamer 0:ea30ba97a865 170 }
screamer 0:ea30ba97a865 171
screamer 0:ea30ba97a865 172 // Creating resources, which can be written or read from the cloud
screamer 1:37392c1b4cf8 173 res_button = client.create_resource("3200/0/5501", "button_count");
screamer 1:37392c1b4cf8 174 res_button->set_value(0);
screamer 1:37392c1b4cf8 175 res_button->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 176 res_button->observable(true);
screamer 1:37392c1b4cf8 177 res_button->attach_notification_callback(button_callback);
screamer 1:37392c1b4cf8 178
screamer 1:37392c1b4cf8 179 res_led = client.create_resource("3201/0/5853", "led_state");
screamer 1:37392c1b4cf8 180 res_led->set_value(1);
screamer 1:37392c1b4cf8 181 res_led->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 1:37392c1b4cf8 182 res_led->attach_put_callback(led_put_callback);
screamer 0:ea30ba97a865 183
screamer 1:37392c1b4cf8 184 // Sensor resources
screamer 1:37392c1b4cf8 185 res_temperature = client.create_resource("3303/0/5700", "temperature");
screamer 1:37392c1b4cf8 186 res_temperature->set_value(0);
screamer 1:37392c1b4cf8 187 res_temperature->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 188 res_temperature->observable(true);
screamer 0:ea30ba97a865 189
screamer 1:37392c1b4cf8 190 res_voltage = client.create_resource("3316/0/5700", "voltage");
screamer 1:37392c1b4cf8 191 res_voltage->set_value(0);
screamer 1:37392c1b4cf8 192 res_voltage->methods(M2MMethod::GET);
screamer 1:37392c1b4cf8 193 res_voltage->observable(true);
screamer 0:ea30ba97a865 194
screamer 0:ea30ba97a865 195 printf("Initialized Pelion Client. Registering...\n");
screamer 0:ea30ba97a865 196
screamer 0:ea30ba97a865 197 // Callback that fires when registering is complete
screamer 0:ea30ba97a865 198 client.on_registered(&registered);
screamer 0:ea30ba97a865 199
screamer 1:37392c1b4cf8 200 // Register with Pelion DM
screamer 0:ea30ba97a865 201 client.register_and_connect();
screamer 0:ea30ba97a865 202
screamer 1:37392c1b4cf8 203 int i = 600; // wait 60 seconds
screamer 1:37392c1b4cf8 204 while (i-- > 0 && !client.is_client_registered()) {
screamer 1:37392c1b4cf8 205 wait_ms(100);
screamer 1:37392c1b4cf8 206 }
screamer 1:37392c1b4cf8 207
screamer 1:37392c1b4cf8 208 button.fall(eventQueue.event(&button_press));
screamer 1:37392c1b4cf8 209
screamer 0:ea30ba97a865 210 // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 0:ea30ba97a865 211 Ticker timer;
screamer 1:37392c1b4cf8 212 timer.attach(eventQueue.event(&sensors_update), SENSORS_POLL_INTERVAL);
screamer 0:ea30ba97a865 213
screamer 0:ea30ba97a865 214 // You can easily run the eventQueue in a separate thread if required
screamer 0:ea30ba97a865 215 eventQueue.dispatch_forever();
screamer 0:ea30ba97a865 216 }
screamer 0:ea30ba97a865 217 #endif