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@3:66358c889c39, 2019-03-21 (annotated)

Committer:
screamer
Date:
Thu Mar 21 21:57:16 2019 +0000
Revision:
3:66358c889c39
Parent:
1:0880bc9829b9
Child:
5:1456ec2e8485
Add support for Thunderboard Sense 2

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 1:0880bc9829b9 24 //#include "EFM32_CapSenseSlider.h"
screamer 0:bf13418ff7b0 25
screamer 0:bf13418ff7b0 26 // 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 27 NetworkInterface *net = NetworkInterface::get_default_instance();
screamer 0:bf13418ff7b0 28
screamer 0:bf13418ff7b0 29 // Default block device available on the target board
screamer 0:bf13418ff7b0 30 BlockDevice *bd = BlockDevice::get_default_instance();
screamer 0:bf13418ff7b0 31
screamer 0:bf13418ff7b0 32 #if COMPONENT_SD || COMPONENT_NUSD
screamer 0:bf13418ff7b0 33 // Use FATFileSystem for SD card type blockdevices
screamer 3:66358c889c39 34 FATFileSystem fs("fs");
screamer 0:bf13418ff7b0 35 #else
screamer 0:bf13418ff7b0 36 // Use LittleFileSystem for non-SD block devices to enable wear leveling and other functions
screamer 3:66358c889c39 37 LittleFileSystem fs("fs");
screamer 0:bf13418ff7b0 38 #endif
screamer 0:bf13418ff7b0 39
screamer 0:bf13418ff7b0 40 #if USE_BUTTON == 1
screamer 0:bf13418ff7b0 41 InterruptIn button(BUTTON1);
screamer 0:bf13418ff7b0 42 #endif /* USE_BUTTON */
screamer 0:bf13418ff7b0 43
screamer 0:bf13418ff7b0 44 // Default LED to use for PUT/POST example
screamer 0:bf13418ff7b0 45 DigitalOut led(LED1);
screamer 0:bf13418ff7b0 46
screamer 1:0880bc9829b9 47 // Silicon Labs capacitive touch slider
screamer 1:0880bc9829b9 48 // silabs::EFM32_CapSenseSlider capSlider;
screamer 1:0880bc9829b9 49
screamer 0:bf13418ff7b0 50 // Declaring pointers for access to Pelion Device Management Client resources outside of main()
screamer 0:bf13418ff7b0 51 MbedCloudClientResource *button_res;
screamer 0:bf13418ff7b0 52 MbedCloudClientResource *led_res;
screamer 0:bf13418ff7b0 53 MbedCloudClientResource *post_res;
screamer 1:0880bc9829b9 54 // MbedCloudClientResource *slider_res;
screamer 0:bf13418ff7b0 55
screamer 0:bf13418ff7b0 56 // An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
screamer 0:bf13418ff7b0 57 // 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 58 EventQueue eventQueue;
screamer 0:bf13418ff7b0 59
screamer 0:bf13418ff7b0 60 /**
screamer 0:bf13418ff7b0 61 * PUT handler - sets the value of the built-in LED
screamer 0:bf13418ff7b0 62 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 63 * @param newValue Updated value for the resource
screamer 0:bf13418ff7b0 64 */
screamer 0:bf13418ff7b0 65 void put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
screamer 0:bf13418ff7b0 66 printf("PUT received. New value: %s\n", newValue.c_str());
screamer 0:bf13418ff7b0 67 led = atoi(newValue.c_str());
screamer 0:bf13418ff7b0 68 }
screamer 0:bf13418ff7b0 69
screamer 0:bf13418ff7b0 70 /**
screamer 0:bf13418ff7b0 71 * POST handler - prints the content of the payload
screamer 0:bf13418ff7b0 72 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 73 * @param buffer If a body was passed to the POST function, this contains the data.
screamer 0:bf13418ff7b0 74 * Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
screamer 0:bf13418ff7b0 75 * @param size Size of the body
screamer 0:bf13418ff7b0 76 */
screamer 0:bf13418ff7b0 77 void post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
screamer 0:bf13418ff7b0 78 printf("POST received (length %u). Payload: ", size);
screamer 0:bf13418ff7b0 79 for (size_t ix = 0; ix < size; ix++) {
screamer 0:bf13418ff7b0 80 printf("%02x ", buffer[ix]);
screamer 0:bf13418ff7b0 81 }
screamer 0:bf13418ff7b0 82 printf("\n");
screamer 0:bf13418ff7b0 83 }
screamer 0:bf13418ff7b0 84
screamer 0:bf13418ff7b0 85 /**
screamer 0:bf13418ff7b0 86 * Button handler
screamer 0:bf13418ff7b0 87 * This function will be triggered either by a physical button press or by a ticker every 5 seconds (see below)
screamer 0:bf13418ff7b0 88 */
screamer 0:bf13418ff7b0 89 void button_press() {
screamer 0:bf13418ff7b0 90 int v = button_res->get_value_int() + 1;
screamer 0:bf13418ff7b0 91 button_res->set_value(v);
screamer 0:bf13418ff7b0 92 printf("Button clicked %d times\n", v);
screamer 0:bf13418ff7b0 93 }
screamer 0:bf13418ff7b0 94
screamer 0:bf13418ff7b0 95 /**
screamer 1:0880bc9829b9 96 * Callback for touching/untouching the capacitive touch slider
screamer 1:0880bc9829b9 97 */
screamer 1:0880bc9829b9 98 // void touchCallback(void) {
screamer 1:0880bc9829b9 99 // if (capSlider.isTouched()) {
screamer 1:0880bc9829b9 100 // segmentDisplay.Write("Touch");
screamer 1:0880bc9829b9 101 // } else {
screamer 1:0880bc9829b9 102 // segmentDisplay.Write("Untouch");
screamer 1:0880bc9829b9 103 // }
screamer 1:0880bc9829b9 104 // }
screamer 1:0880bc9829b9 105
screamer 1:0880bc9829b9 106 /**
screamer 1:0880bc9829b9 107 * Callback for sliding the cap slider
screamer 1:0880bc9829b9 108 */
screamer 1:0880bc9829b9 109 // void slideCallback(void) {
screamer 1:0880bc9829b9 110 // printf("Slider notification, status %d\n", capSlider.get_position());
screamer 1:0880bc9829b9 111 // }
screamer 1:0880bc9829b9 112
screamer 1:0880bc9829b9 113 /**
screamer 0:bf13418ff7b0 114 * Notification callback handler
screamer 0:bf13418ff7b0 115 * @param resource The resource that triggered the callback
screamer 0:bf13418ff7b0 116 * @param status The delivery status of the notification
screamer 0:bf13418ff7b0 117 */
screamer 0:bf13418ff7b0 118 void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
screamer 0:bf13418ff7b0 119 printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
screamer 0:bf13418ff7b0 120 }
screamer 0:bf13418ff7b0 121
screamer 0:bf13418ff7b0 122 /**
screamer 0:bf13418ff7b0 123 * Registration callback handler
screamer 0:bf13418ff7b0 124 * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
screamer 0:bf13418ff7b0 125 */
screamer 0:bf13418ff7b0 126 void registered(const ConnectorClientEndpointInfo *endpoint) {
screamer 0:bf13418ff7b0 127 printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
screamer 0:bf13418ff7b0 128 }
screamer 0:bf13418ff7b0 129
screamer 0:bf13418ff7b0 130 int main(void) {
screamer 0:bf13418ff7b0 131 printf("\nStarting Simple Pelion Device Management Client example\n");
screamer 0:bf13418ff7b0 132
screamer 3:66358c889c39 133 int storage_status = fs.mount(bd);
screamer 3:66358c889c39 134 if (storage_status != 0) {
screamer 3:66358c889c39 135 printf("Storage mounting failed.\n");
screamer 3:66358c889c39 136 }
screamer 3:66358c889c39 137
screamer 0:bf13418ff7b0 138 #if USE_BUTTON == 1
screamer 0:bf13418ff7b0 139 // If the User button is pressed ons start, then format storage.
screamer 3:66358c889c39 140 bool btn_pressed = (button.read() == MBED_CONF_APP_BUTTON_PRESSED_STATE);
screamer 3:66358c889c39 141 if (btn_pressed) {
screamer 3:66358c889c39 142 printf("User button is pushed on start...\n");
screamer 3:66358c889c39 143 }
screamer 3:66358c889c39 144 #else
screamer 3:66358c889c39 145 bool btn_pressed = FALSE;
screamer 3:66358c889c39 146 #endif /* USE_BUTTON */
screamer 3:66358c889c39 147
screamer 3:66358c889c39 148 if (storage_status || btn_pressed) {
screamer 3:66358c889c39 149 printf("Formatting the storage...\n");
screamer 0:bf13418ff7b0 150 int storage_status = StorageHelper::format(&fs, bd);
screamer 0:bf13418ff7b0 151 if (storage_status != 0) {
screamer 0:bf13418ff7b0 152 printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
screamer 0:bf13418ff7b0 153 }
screamer 0:bf13418ff7b0 154 } else {
screamer 0:bf13418ff7b0 155 printf("You can hold the user button during boot to format the storage and change the device identity.\n");
screamer 0:bf13418ff7b0 156 }
screamer 0:bf13418ff7b0 157
screamer 0:bf13418ff7b0 158 // Connect to the Internet (DHCP is expected to be on)
screamer 0:bf13418ff7b0 159 printf("Connecting to the network using the default network interface...\n");
screamer 0:bf13418ff7b0 160 net = NetworkInterface::get_default_instance();
screamer 0:bf13418ff7b0 161
screamer 0:bf13418ff7b0 162 nsapi_error_t net_status = NSAPI_ERROR_NO_CONNECTION;
screamer 0:bf13418ff7b0 163 while ((net_status = net->connect()) != NSAPI_ERROR_OK) {
screamer 0:bf13418ff7b0 164 printf("Unable to connect to network (%d). Retrying...\n", net_status);
screamer 0:bf13418ff7b0 165 }
screamer 0:bf13418ff7b0 166
screamer 0:bf13418ff7b0 167 printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
screamer 0:bf13418ff7b0 168
screamer 0:bf13418ff7b0 169 printf("Initializing Pelion Device Management Client...\n");
screamer 0:bf13418ff7b0 170
screamer 0:bf13418ff7b0 171 // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management
screamer 0:bf13418ff7b0 172 SimpleMbedCloudClient client(net, bd, &fs);
screamer 0:bf13418ff7b0 173 int client_status = client.init();
screamer 0:bf13418ff7b0 174 if (client_status != 0) {
screamer 0:bf13418ff7b0 175 printf("Pelion Client initialization failed (%d)\n", client_status);
screamer 0:bf13418ff7b0 176 return -1;
screamer 0:bf13418ff7b0 177 }
screamer 0:bf13418ff7b0 178
screamer 0:bf13418ff7b0 179 // Creating resources, which can be written or read from the cloud
screamer 0:bf13418ff7b0 180 button_res = client.create_resource("3200/0/5501", "button_count");
screamer 0:bf13418ff7b0 181 button_res->set_value(0);
screamer 0:bf13418ff7b0 182 button_res->methods(M2MMethod::GET);
screamer 0:bf13418ff7b0 183 button_res->observable(true);
screamer 0:bf13418ff7b0 184 button_res->attach_notification_callback(button_callback);
screamer 0:bf13418ff7b0 185
screamer 0:bf13418ff7b0 186 led_res = client.create_resource("3201/0/5853", "led_state");
screamer 0:bf13418ff7b0 187 led_res->set_value(led.read());
screamer 0:bf13418ff7b0 188 led_res->methods(M2MMethod::GET | M2MMethod::PUT);
screamer 0:bf13418ff7b0 189 led_res->attach_put_callback(put_callback);
screamer 0:bf13418ff7b0 190
screamer 0:bf13418ff7b0 191 post_res = client.create_resource("3300/0/5605", "execute_function");
screamer 0:bf13418ff7b0 192 post_res->methods(M2MMethod::POST);
screamer 0:bf13418ff7b0 193 post_res->attach_post_callback(post_callback);
screamer 0:bf13418ff7b0 194
screamer 0:bf13418ff7b0 195 printf("Initialized Pelion Device Management Client. Registering...\n");
screamer 0:bf13418ff7b0 196
screamer 0:bf13418ff7b0 197 // Callback that fires when registering is complete
screamer 0:bf13418ff7b0 198 client.on_registered(&registered);
screamer 0:bf13418ff7b0 199
screamer 0:bf13418ff7b0 200 // Register with Pelion DM
screamer 0:bf13418ff7b0 201 client.register_and_connect();
screamer 0:bf13418ff7b0 202
screamer 0:bf13418ff7b0 203 #if USE_BUTTON == 1
screamer 0:bf13418ff7b0 204 // The button fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 0:bf13418ff7b0 205 button.fall(eventQueue.event(&button_press));
screamer 0:bf13418ff7b0 206 printf("Press the user button to increment the LwM2M resource value...\n");
screamer 0:bf13418ff7b0 207 #else
screamer 0:bf13418ff7b0 208 // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
screamer 0:bf13418ff7b0 209 Ticker timer;
screamer 0:bf13418ff7b0 210 timer.attach(eventQueue.event(&button_press), 5.0);
screamer 0:bf13418ff7b0 211 printf("Simulating button press every 5 seconds...\n");
screamer 0:bf13418ff7b0 212 #endif /* USE_BUTTON */
screamer 0:bf13418ff7b0 213
screamer 0:bf13418ff7b0 214 // You can easily run the eventQueue in a separate thread if required
screamer 0:bf13418ff7b0 215 eventQueue.dispatch_forever();
screamer 0:bf13418ff7b0 216 }
screamer 0:bf13418ff7b0 217
screamer 0:bf13418ff7b0 218 #endif /* MBED_TEST_MODE */