u-blox / Mbed OS pelion-example-common

Generic Pelion Device Management example for various U-blox-based boards.

Dependencies:   ublox-at-cellular-interface ublox-cellular-base

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:

For Odin-W2 please go to Repository link

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

UBLOX_C030_U201

UBLOX_C030_R412M

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.
  • (currently disabled) Read ADC temperature and ADC vref, and report them as Pelion LWM2M resources.

Use this example with Mbed CLI

1. Import the application into your desktop:

mbed import https://os.mbed.com/teams/ublox/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:a076a1bbe630, 2018-12-10 (annotated)

Committer:
screamer
Date:
Mon Dec 10 21:58:43 2018 +0000
Revision:
0:a076a1bbe630
Child:
1:a50c1e691ff1
Initial revision

Who changed what in which revision?

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