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@0:ea30ba97a865, 2018-12-10 (annotated)

Committer:
screamer
Date:
Mon Dec 10 20:14:17 2018 +0000
Revision:
0:ea30ba97a865
Child:
1:37392c1b4cf8
Initial revision

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 0:ea30ba97a865 23
screamer 0:ea30ba97a865 24 // An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
screamer 0:ea30ba97a865 25 // 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 26 EventQueue eventQueue;
screamer 0:ea30ba97a865 27
screamer 0:ea30ba97a865 28 // Default block device
screamer 0:ea30ba97a865 29 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 0:ea30ba97a865 30 FATFileSystem fs("fs");
screamer 0:ea30ba97a865 31
screamer 0:ea30ba97a865 32 // Default network interface object
screamer 0:ea30ba97a865 33 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:ea30ba97a865 34
screamer 0:ea30ba97a865 35 // Declaring pointers for access to Pelion Device Management Client resources outside of main()
screamer 0:ea30ba97a865 36 MbedCloudClientResource *button_res;
screamer 0:ea30ba97a865 37 MbedCloudClientResource *pattern_res;
screamer 0:ea30ba97a865 38
screamer 0:ea30ba97a865 39 // This function gets triggered by the timer. It's easy to replace it by an InterruptIn and fall() mode on a real button
screamer 0:ea30ba97a865 40 void fake_button_press() {
screamer 0:ea30ba97a865 41 int v = button_res->get_value_int() + 1;
screamer 0:ea30ba97a865 42
screamer 0:ea30ba97a865 43 button_res->set_value(v);
screamer 0:ea30ba97a865 44
screamer 0:ea30ba97a865 45 printf("Simulated button clicked %d times\n", v);
screamer 0:ea30ba97a865 46 }
screamer 0:ea30ba97a865 47
screamer 0:ea30ba97a865 48 /**
screamer 0:ea30ba97a865 49 * PUT handler
screamer 0:ea30ba97a865 50 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 51 * @param newValue Updated value for the resource
screamer 0:ea30ba97a865 52 */
screamer 0:ea30ba97a865 53 void pattern_updated(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 0:ea30ba97a865 54 printf("PUT received, new value: %s\n", newValue.c_str());
screamer 0:ea30ba97a865 55 }
screamer 0:ea30ba97a865 56
screamer 0:ea30ba97a865 57 /**
screamer 0:ea30ba97a865 58 * POST handler
screamer 0:ea30ba97a865 59 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 60 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:ea30ba97a865 61 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:ea30ba97a865 62 * @param size Size of the body
screamer 0:ea30ba97a865 63 */
screamer 0:ea30ba97a865 64 void blink_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 0:ea30ba97a865 65 printf("POST received. Going to blink LED pattern: %s\n", pattern_res->get_value().c_str());
screamer 0:ea30ba97a865 66
screamer 0:ea30ba97a865 67 static DigitalOut augmentedLed(LED1); // LED that is used for blinking the pattern
screamer 0:ea30ba97a865 68
screamer 0:ea30ba97a865 69 // Parse the pattern string, and toggle the LED in that pattern
screamer 0:ea30ba97a865 70 string s = std::string(pattern_res->get_value().c_str());
screamer 0:ea30ba97a865 71 size_t i = 0;
screamer 0:ea30ba97a865 72 size_t pos = s.find(':');
screamer 0:ea30ba97a865 73 while (pos != string::npos) {
screamer 0:ea30ba97a865 74 wait_ms(atoi(s.substr(i, pos - i).c_str()));
screamer 0:ea30ba97a865 75 augmentedLed = !augmentedLed;
screamer 0:ea30ba97a865 76
screamer 0:ea30ba97a865 77 i = ++pos;
screamer 0:ea30ba97a865 78 pos = s.find(':', pos);
screamer 0:ea30ba97a865 79
screamer 0:ea30ba97a865 80 if (pos == string::npos) {
screamer 0:ea30ba97a865 81 wait_ms(atoi(s.substr(i, s.length()).c_str()));
screamer 0:ea30ba97a865 82 augmentedLed = !augmentedLed;
screamer 0:ea30ba97a865 83 }
screamer 0:ea30ba97a865 84 }
screamer 0:ea30ba97a865 85 }
screamer 0:ea30ba97a865 86
screamer 0:ea30ba97a865 87 /**
screamer 0:ea30ba97a865 88 * Notification callback handler
screamer 0:ea30ba97a865 89 * @param resource The resource that triggered the callback
screamer 0:ea30ba97a865 90 * @param status The delivery status of the notification
screamer 0:ea30ba97a865 91 */
screamer 0:ea30ba97a865 92 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 0:ea30ba97a865 93 printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:ea30ba97a865 94 }
screamer 0:ea30ba97a865 95
screamer 0:ea30ba97a865 96 /**
screamer 0:ea30ba97a865 97 * Registration callback handler
screamer 0:ea30ba97a865 98 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 0:ea30ba97a865 99 */
screamer 0:ea30ba97a865 100 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 0:ea30ba97a865 101 printf("Connected to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 0:ea30ba97a865 102 }
screamer 0:ea30ba97a865 103
screamer 0:ea30ba97a865 104 int main(void) {
screamer 0:ea30ba97a865 105 printf("Starting Simple Pelion Device Management Client example\n");
screamer 0:ea30ba97a865 106 printf("Connecting to the network...\n");
screamer 0:ea30ba97a865 107
screamer 0:ea30ba97a865 108 // Connect to the internet (DHCP is expected to be on)
screamer 0:ea30ba97a865 109 nsapi_error_t status = net->connect();
screamer 0:ea30ba97a865 110
screamer 0:ea30ba97a865 111 if (status != NSAPI_ERROR_OK) {
screamer 0:ea30ba97a865 112 printf("Connecting to the network failed %d!\n", status);
screamer 0:ea30ba97a865 113 return -1;
screamer 0:ea30ba97a865 114 }
screamer 0:ea30ba97a865 115
screamer 0:ea30ba97a865 116 printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
screamer 0:ea30ba97a865 117
screamer 0:ea30ba97a865 118 // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management
screamer 0:ea30ba97a865 119 SimpleMbedCloudClient client(net, bd, &fs);
screamer 0:ea30ba97a865 120 int client_status = client.init();
screamer 0:ea30ba97a865 121 if (client_status != 0) {
screamer 0:ea30ba97a865 122 printf("Pelion Client initialization failed (%d)\n", client_status);
screamer 0:ea30ba97a865 123 return -1;
screamer 0:ea30ba97a865 124 }
screamer 0:ea30ba97a865 125
screamer 0:ea30ba97a865 126 // Creating resources, which can be written or read from the cloud
screamer 0:ea30ba97a865 127 button_res = client.create_resource("3200/0/5501", "button_count");
screamer 0:ea30ba97a865 128 button_res->set_value(0);
screamer 0:ea30ba97a865 129 button_res->methods(M2MMethod::GET);
screamer 0:ea30ba97a865 130 button_res->observable(true);
screamer 0:ea30ba97a865 131 button_res->attach_notification_callback(button_callback);
screamer 0:ea30ba97a865 132
screamer 0:ea30ba97a865 133 pattern_res = client.create_resource("3201/0/5853", "blink_pattern");
screamer 0:ea30ba97a865 134 pattern_res->set_value("500:500:500:500:500:500:500:500");
screamer 0:ea30ba97a865 135 pattern_res->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 0:ea30ba97a865 136 pattern_res->attach_put_callback(pattern_updated);
screamer 0:ea30ba97a865 137
screamer 0:ea30ba97a865 138 MbedCloudClientResource *blink_res = client.create_resource("3201/0/5850", "blink_action");
screamer 0:ea30ba97a865 139 blink_res->methods(M2MMethod::POST);
screamer 0:ea30ba97a865 140 blink_res->attach_post_callback(blink_callback);
screamer 0:ea30ba97a865 141
screamer 0:ea30ba97a865 142 printf("Initialized Pelion Client. Registering...\n");
screamer 0:ea30ba97a865 143
screamer 0:ea30ba97a865 144 // Callback that fires when registering is complete
screamer 0:ea30ba97a865 145 client.on_registered(&registered);
screamer 0:ea30ba97a865 146
screamer 0:ea30ba97a865 147 // Register with Pelion Device Management
screamer 0:ea30ba97a865 148 client.register_and_connect();
screamer 0:ea30ba97a865 149
screamer 0:ea30ba97a865 150 // Placeholder for callback to update local resource when GET comes.
screamer 0:ea30ba97a865 151 // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 0:ea30ba97a865 152 Ticker timer;
screamer 0:ea30ba97a865 153 timer.attach(eventQueue.event(&fake_button_press), 5.0);
screamer 0:ea30ba97a865 154
screamer 0:ea30ba97a865 155 // You can easily run the eventQueue in a separate thread if required
screamer 0:ea30ba97a865 156 eventQueue.dispatch_forever();
screamer 0:ea30ba97a865 157 }
screamer 0:ea30ba97a865 158 #endif