Silicon Labs / Mbed OS pelion-example-common

Mbed OS Device Management example for various Silicon Labs 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:

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

Thunderboard Sense 2 EFM32 Giant Gecko 11

Example functionality

This example showcases the following device functionality:

  • 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.

Use this example with Mbed CLI

1. Import the application into your desktop:

mbed import https://os.mbed.com/teams/SiliconLabs/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:1456ec2e8485, 2019-03-27 (annotated)

Committer:
screamer
Date:
Wed Mar 27 19:02:10 2019 +0000
Revision:
5:1456ec2e8485
Parent:
3:66358c889c39 
Improve inline documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:bf13418ff7b0 1 // ----------------------------------------------------------------------------
screamer 0:bf13418ff7b0 2 // Copyright 2016-2018 ARM Ltd.
screamer 0:bf13418ff7b0 3 //
screamer 0:bf13418ff7b0 4 // SPDX-License-Identifier: Apache-2.0
screamer 0:bf13418ff7b0 5 //
screamer 0:bf13418ff7b0 6 // Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:bf13418ff7b0 7 // you may not use this file except in compliance with the License.
screamer 0:bf13418ff7b0 8 // You may obtain a copy of the License at
screamer 0:bf13418ff7b0 9 //
screamer 0:bf13418ff7b0 10 // http://www.apache.org/licenses/LICENSE-2.0
screamer 0:bf13418ff7b0 11 //
screamer 0:bf13418ff7b0 12 // Unless required by applicable law or agreed to in writing, software
screamer 0:bf13418ff7b0 13 // distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:bf13418ff7b0 14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:bf13418ff7b0 15 // See the License for the specific language governing permissions and
screamer 0:bf13418ff7b0 16 // limitations under the License.
screamer 0:bf13418ff7b0 17 // ----------------------------------------------------------------------------
screamer 0:bf13418ff7b0 18 #ifndef MBED_TEST_MODE
screamer 0:bf13418ff7b0 19
screamer 0:bf13418ff7b0 20 #include "mbed.h"
screamer 0:bf13418ff7b0 21 #include "simple-mbed-cloud-client.h"
screamer 0:bf13418ff7b0 22 #include "FATFileSystem.h"
screamer 0:bf13418ff7b0 23 #include "LittleFileSystem.h"
screamer 0:bf13418ff7b0 24
screamer 0:bf13418ff7b0 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:bf13418ff7b0 26 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:bf13418ff7b0 27
screamer 0:bf13418ff7b0 28 // Default block device available on the target board
screamer 0:bf13418ff7b0 29 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 0:bf13418ff7b0 30
screamer 0:bf13418ff7b0 31 #if COMPONENT_SD || COMPONENT_NUSD
screamer 0:bf13418ff7b0 32 // Use FATFileSystem for SD card type blockdevices
screamer 3:66358c889c39 33 FATFileSystem fs("fs");
screamer 0:bf13418ff7b0 34 #else
screamer 0:bf13418ff7b0 35 // Use LittleFileSystem for non-SD block devices to enable wear leveling and other functions
screamer 3:66358c889c39 36 LittleFileSystem fs("fs");
screamer 0:bf13418ff7b0 37 #endif
screamer 0:bf13418ff7b0 38
screamer 5:1456ec2e8485 39 // Default User button for GET example
screamer 0:bf13418ff7b0 40 InterruptIn button(BUTTON1);
screamer 0:bf13418ff7b0 41 // Default LED to use for PUT/POST example
screamer 5:1456ec2e8485 42 DigitalOut led(LED1, 0);
screamer 1:0880bc9829b9 43
screamer 0:bf13418ff7b0 44 // Declaring pointers for access to Pelion Device Management Client resources outside of main()
screamer 5:1456ec2e8485 45 MbedCloudClientResource *res_button;
screamer 5:1456ec2e8485 46 MbedCloudClientResource *res_led;
screamer 5:1456ec2e8485 47 MbedCloudClientResource *res_post;
screamer 0:bf13418ff7b0 48
screamer 0:bf13418ff7b0 49 // An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
screamer 0:bf13418ff7b0 50 // 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:bf13418ff7b0 51 EventQueue eventQueue;
screamer 0:bf13418ff7b0 52
screamer 5:1456ec2e8485 53 // When the device is registered, this variable will be used to access various useful information, like device ID etc.
screamer 5:1456ec2e8485 54 static const ConnectorClientEndpointInfo* endpointInfo;
screamer 5:1456ec2e8485 55
screamer 0:bf13418ff7b0 56 /**
screamer 0:bf13418ff7b0 57 * PUT handler - sets the value of the built-in LED
screamer 0:bf13418ff7b0 58 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 59 * @param newValue Updated value for the resource
screamer 0:bf13418ff7b0 60 */
screamer 0:bf13418ff7b0 61 void put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 5:1456ec2e8485 62 printf("*** PUT received, new value: %s \n", newValue.c_str());
screamer 0:bf13418ff7b0 63 led = atoi(newValue.c_str());
screamer 0:bf13418ff7b0 64 }
screamer 0:bf13418ff7b0 65
screamer 0:bf13418ff7b0 66 /**
screamer 0:bf13418ff7b0 67 * POST handler - prints the content of the payload
screamer 0:bf13418ff7b0 68 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 69 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:bf13418ff7b0 70 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:bf13418ff7b0 71 * @param size Size of the body
screamer 0:bf13418ff7b0 72 */
screamer 0:bf13418ff7b0 73 void post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 5:1456ec2e8485 74 printf("*** POST received (length %u). Payload: ", size);
screamer 0:bf13418ff7b0 75 for (size_t ix = 0; ix < size; ix++) {
screamer 0:bf13418ff7b0 76 printf("%02x ", buffer[ix]);
screamer 0:bf13418ff7b0 77 }
screamer 0:bf13418ff7b0 78 printf("\n");
screamer 0:bf13418ff7b0 79 }
screamer 0:bf13418ff7b0 80
screamer 0:bf13418ff7b0 81 /**
screamer 0:bf13418ff7b0 82 * Button handler
screamer 0:bf13418ff7b0 83 * This function will be triggered either by a physical button press or by a ticker every 5 seconds (see below)
screamer 0:bf13418ff7b0 84 */
screamer 0:bf13418ff7b0 85 void button_press() {
screamer 5:1456ec2e8485 86 int v = res_button->get_value_int() + 1;
screamer 5:1456ec2e8485 87 res_button->set_value(v);
screamer 5:1456ec2e8485 88 printf("*** Button clicked %d times \n", v);
screamer 0:bf13418ff7b0 89 }
screamer 0:bf13418ff7b0 90
screamer 0:bf13418ff7b0 91 /**
screamer 0:bf13418ff7b0 92 * Notification callback handler
screamer 0:bf13418ff7b0 93 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 94 * @param status The delivery status of the notification
screamer 0:bf13418ff7b0 95 */
screamer 0:bf13418ff7b0 96 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 5:1456ec2e8485 97 printf("*** Button notification, status %s (%d) \n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:bf13418ff7b0 98 }
screamer 0:bf13418ff7b0 99
screamer 0:bf13418ff7b0 100 /**
screamer 0:bf13418ff7b0 101 * Registration callback handler
screamer 0:bf13418ff7b0 102 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 0:bf13418ff7b0 103 */
screamer 0:bf13418ff7b0 104 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 0:bf13418ff7b0 105 printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 5:1456ec2e8485 106 endpointInfo = endpoint;
screamer 0:bf13418ff7b0 107 }
screamer 0:bf13418ff7b0 108
screamer 0:bf13418ff7b0 109 int main(void) {
screamer 0:bf13418ff7b0 110 printf("\nStarting Simple Pelion Device Management Client example\n");
screamer 0:bf13418ff7b0 111
screamer 3:66358c889c39 112 int storage_status = fs.mount(bd);
screamer 3:66358c889c39 113 if (storage_status != 0) {
screamer 3:66358c889c39 114 printf("Storage mounting failed.\n");
screamer 3:66358c889c39 115 }
screamer 0:bf13418ff7b0 116 // If the User button is pressed ons start, then format storage.
screamer 3:66358c889c39 117 bool btn_pressed = (button.read() == MBED_CONF_APP_BUTTON_PRESSED_STATE);
screamer 3:66358c889c39 118 if (btn_pressed) {
screamer 3:66358c889c39 119 printf("User button is pushed on start...\n");
screamer 3:66358c889c39 120 }
screamer 3:66358c889c39 121
screamer 3:66358c889c39 122 if (storage_status || btn_pressed) {
screamer 3:66358c889c39 123 printf("Formatting the storage...\n");
screamer 0:bf13418ff7b0 124 int storage_status = StorageHelper::format(&fs, bd);
screamer 0:bf13418ff7b0 125 if (storage_status != 0) {
screamer 0:bf13418ff7b0 126 printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
screamer 0:bf13418ff7b0 127 }
screamer 0:bf13418ff7b0 128 } else {
screamer 0:bf13418ff7b0 129 printf("You can hold the user button during boot to format the storage and change the device identity.\n");
screamer 0:bf13418ff7b0 130 }
screamer 0:bf13418ff7b0 131
screamer 0:bf13418ff7b0 132 // Connect to the Internet (DHCP is expected to be on)
screamer 0:bf13418ff7b0 133 printf("Connecting to the network using the default network interface...\n");
screamer 0:bf13418ff7b0 134 net = NetworkInterface::get_default_instance();
screamer 0:bf13418ff7b0 135
screamer 0:bf13418ff7b0 136 nsapi_error_t net_status = NSAPI_ERROR_NO_CONNECTION;
screamer 0:bf13418ff7b0 137 while ((net_status = net->connect()) != NSAPI_ERROR_OK) {
screamer 0:bf13418ff7b0 138 printf("Unable to connect to network (%d). Retrying...\n", net_status);
screamer 0:bf13418ff7b0 139 }
screamer 0:bf13418ff7b0 140
screamer 0:bf13418ff7b0 141 printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
screamer 0:bf13418ff7b0 142
screamer 0:bf13418ff7b0 143 printf("Initializing Pelion Device Management Client...\n");
screamer 0:bf13418ff7b0 144
screamer 0:bf13418ff7b0 145 // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management
screamer 0:bf13418ff7b0 146 SimpleMbedCloudClient client(net, bd, &fs);
screamer 0:bf13418ff7b0 147 int client_status = client.init();
screamer 0:bf13418ff7b0 148 if (client_status != 0) {
screamer 0:bf13418ff7b0 149 printf("Pelion Client initialization failed (%d)\n", client_status);
screamer 0:bf13418ff7b0 150 return -1;
screamer 0:bf13418ff7b0 151 }
screamer 0:bf13418ff7b0 152
screamer 0:bf13418ff7b0 153 // Creating resources, which can be written or read from the cloud
screamer 5:1456ec2e8485 154 res_button = client.create_resource("3200/0/5501", "Button Count");
screamer 5:1456ec2e8485 155 res_button->set_value(0);
screamer 5:1456ec2e8485 156 res_button->methods(M2MMethod::GET);
screamer 5:1456ec2e8485 157 res_button->observable(true);
screamer 5:1456ec2e8485 158 res_button->attach_notification_callback(button_callback);
screamer 0:bf13418ff7b0 159
screamer 5:1456ec2e8485 160 res_led = client.create_resource("3201/0/5853", "LED State");
screamer 5:1456ec2e8485 161 res_led->set_value(led.read());
screamer 5:1456ec2e8485 162 res_led->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 5:1456ec2e8485 163 res_led->attach_put_callback(put_callback);
screamer 0:bf13418ff7b0 164
screamer 5:1456ec2e8485 165 res_post = client.create_resource("3300/0/5605", "Execute Function");
screamer 5:1456ec2e8485 166 res_post->methods(M2MMethod::POST);
screamer 5:1456ec2e8485 167 res_post->attach_post_callback(post_callback);
screamer 0:bf13418ff7b0 168
screamer 0:bf13418ff7b0 169 printf("Initialized Pelion Device Management Client. Registering...\n");
screamer 0:bf13418ff7b0 170
screamer 0:bf13418ff7b0 171 // Callback that fires when registering is complete
screamer 0:bf13418ff7b0 172 client.on_registered(&registered);
screamer 0:bf13418ff7b0 173
screamer 0:bf13418ff7b0 174 // Register with Pelion DM
screamer 0:bf13418ff7b0 175 client.register_and_connect();
screamer 0:bf13418ff7b0 176
screamer 0:bf13418ff7b0 177 // The button fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 0:bf13418ff7b0 178 button.fall(eventQueue.event(&button_press));
screamer 0:bf13418ff7b0 179 printf("Press the user button to increment the LwM2M resource value...\n");
screamer 0:bf13418ff7b0 180
screamer 0:bf13418ff7b0 181 // You can easily run the eventQueue in a separate thread if required
screamer 0:bf13418ff7b0 182 eventQueue.dispatch_forever();
screamer 0:bf13418ff7b0 183 }
screamer 0:bf13418ff7b0 184
screamer 0:bf13418ff7b0 185 #endif /* MBED_TEST_MODE */