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)

Revision:
6:2fb5057c0e42
Parent:
3:3b2db67b206e
Child:
7:230af466efc4
--- a/main.cpp	Tue Dec 18 18:21:13 2018 +0000
+++ b/main.cpp	Wed Feb 20 15:33:02 2019 +0000
@@ -22,10 +22,6 @@
 #include "FATFileSystem.h"
 #include "LittleFileSystem.h"
 
-// An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
-// 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
-EventQueue eventQueue;
-
 // Default network interface object. Don't forget to change the WiFi SSID/password in mbed_app.json if you're using WiFi.
 NetworkInterface *net = NetworkInterface::get_default_instance();
 
@@ -40,65 +36,54 @@
 LittleFileSystem fs("fs", bd);
 #endif
 
-// Fix for older versions of Mbed OS where BUTTON1 is undefined
-#if TARGET_UBLOX_C030
-#define BUTTON1 PC_13
-#endif
+#if USE_BUTTON == 1
+InterruptIn button(BUTTON1);
+#endif /* USE_BUTTON */
 
-// Default User button for GET example
-InterruptIn button(BUTTON1);
 // Default LED to use for PUT/POST example
 DigitalOut led(LED1);
 
-// Currently disabled until ADC sensors are introduced for U-blox targets.
-#ifdef ENABLE_SENSORS
-// Default temperature reading from microcontroller
-AnalogIn adc_temp(ADC_TEMP);
-// Voltage reference from microcontroller
-AnalogIn adc_vref(ADC_VREF);
-
-#define SENSORS_POLL_INTERVAL 1.0
-#endif /* ENABLE_SENSORS */
+// Declaring pointers for access to Pelion Device Management Client resources outside of main()
+MbedCloudClientResource *button_res;
+MbedCloudClientResource *led_res;
+MbedCloudClientResource *post_res;
 
-// Declaring pointers for access to Pelion Client resources outside of main()
-MbedCloudClientResource *res_button;
-MbedCloudClientResource *res_led;
-#ifdef ENABLE_SENSORS
-MbedCloudClientResource *res_temperature;
-MbedCloudClientResource *res_voltage;
-#endif /* ENABLE_SENSORS */
-
-// When the device is registered, this variable will be used to access various useful information, like device ID etc.
-static const ConnectorClientEndpointInfo* endpointInfo;
+// An event queue is a very useful structure to debounce information between contexts (e.g. ISR and normal threads)
+// 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
+EventQueue eventQueue;
 
 /**
- * PUT handler
+ * PUT handler - sets the value of the built-in LED
  * @param resource The resource that triggered the callback
  * @param newValue Updated value for the resource
  */
-void led_put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
+void put_callback(MbedCloudClientResource *resource, m2m::String newValue) {
     printf("PUT received. New value: %s\n", newValue.c_str());
     led = atoi(newValue.c_str());
 }
 
 /**
- * POST handler
+ * POST handler - prints the content of the payload
  * @param resource The resource that triggered the callback
  * @param buffer If a body was passed to the POST function, this contains the data.
  *               Note that the buffer is deallocated after leaving this function, so copy it if you need it longer.
  * @param size Size of the body
  */
-void led_post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
-    printf("POST received. Payload: %s\n", res_led->get_value().c_str());
-    led = atoi(res_led->get_value().c_str());
+void post_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
+    printf("POST received (length %u). Payload: ", size);
+    for (size_t ix = 0; ix < size; ix++) {
+        printf("%02x ", buffer[ix]);
+    }
+    printf("\n");
 }
 
 /**
- * Button function triggered by the physical button press.
+ * Button handler
+ * This function will be triggered either by a physical button press or by a ticker every 5 seconds (see below)
  */
 void button_press() {
-    int v = res_button->get_value_int() + 1;
-    res_button->set_value(v);
+    int v = button_res->get_value_int() + 1;
+    button_res->set_value(v);
     printf("Button clicked %d times\n", v);
 }
 
@@ -117,105 +102,62 @@
  */
 void registered(const ConnectorClientEndpointInfo *endpoint) {
     printf("Registered to Pelion Device Management. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
-    endpointInfo = endpoint;
 }
 
-/**
- * Update sensors and report their values.
- * This function is called periodically.
- */
-#ifdef ENABLE_SENSORS
-void sensors_update() {
-    float temp = adc_temp.read()*100;
-    float vref = adc_vref.read();
-    printf("ADC temp:  %6.4f C,  vref: %6.4f %%\r\n", temp, vref);
-    if (endpointInfo) {
-        res_temperature->set_value(temp);
-        res_voltage->set_value(vref);
-    }
-}
-#endif /* ENABLE_SENSORS */
-
-
 int main(void) {
     printf("\nStarting Simple Pelion Device Management Client example\n");
 
+#if USE_BUTTON == 1
     // If the User button is pressed ons start, then format storage.
-    DigitalIn *user_button = new DigitalIn(BUTTON1);
-    const int PRESSED = 1;
-    if (user_button->read() == PRESSED) {
+    if (button.read() == MBED_CONF_APP_BUTTON_PRESSED_STATE) {
         printf("User button is pushed on start. Formatting the storage...\n");
-        int storage_status = fs.reformat(bd);
-        if (storage_status != 0) {
-            if (bd->erase(0, bd->size()) == 0) {
-                if (fs.format(bd) == 0) {
-                    storage_status = 0;
-                    printf("The storage reformatted successfully.\n");
-                }
-            }
-        }
+        int storage_status = StorageHelper::format(&fs, bd);
         if (storage_status != 0) {
             printf("ERROR: Failed to reformat the storage (%d).\n", storage_status);
         }
     } else {
         printf("You can hold the user button during boot to format the storage and change the device identity.\n");
     }
+#endif /* USE_BUTTON */
 
-    // Connect to the internet (DHCP is expected to be on)
-    printf("Connecting to the network using default network interface...\n");
+    // Connect to the Internet (DHCP is expected to be on)
+    printf("Connecting to the network using the default network interface...\n");
     net = NetworkInterface::get_default_instance();
 
-    nsapi_error_t net_status = -1;
-    for (int tries = 0; tries < 3; tries++) {
-        net_status = net->connect();
-        if (net_status == NSAPI_ERROR_OK) {
-            break;
-        } else {
-            printf("Unable to connect to network. Retrying...\n");
-        }
-    }
-
-    if (net_status != NSAPI_ERROR_OK) {
-        printf("ERROR: Connecting to the network failed (%d)!\n", net_status);
-        return -1;
+    nsapi_error_t net_status = NSAPI_ERROR_NO_CONNECTION;
+    while ((net_status = net->connect()) != NSAPI_ERROR_OK) {
+        printf("Unable to connect to network (%d). Retrying...\n", net_status);
     }
 
     printf("Connected to the network successfully. IP address: %s\n", net->get_ip_address());
 
-    // SimpleMbedCloudClient handles registering over LwM2M to Pelion DM
+    printf("Initializing Pelion Device Management Client...\n");
+
+    // SimpleMbedCloudClient handles registering over LwM2M to Pelion Device Management
     SimpleMbedCloudClient client(net, bd, &fs);
     int client_status = client.init();
     if (client_status != 0) {
-        printf("ERROR: Pelion Client initialization failed (%d)\n", client_status);
+        printf("Pelion Client initialization failed (%d)\n", client_status);
         return -1;
     }
 
     // Creating resources, which can be written or read from the cloud
-    res_button = client.create_resource("3200/0/5501", "button_count");
-    res_button->set_value(0);
-    res_button->methods(M2MMethod::GET);
-    res_button->observable(true);
-    res_button->attach_notification_callback(button_callback);
-
-    res_led = client.create_resource("3201/0/5853", "led_state");
-    res_led->set_value(1);
-    res_led->methods(M2MMethod::GET | M2MMethod::PUT);
-    res_led->attach_put_callback(led_put_callback);
+    button_res = client.create_resource("3200/0/5501", "button_count");
+    button_res->set_value(0);
+    button_res->methods(M2MMethod::GET);
+    button_res->observable(true);
+    button_res->attach_notification_callback(button_callback);
 
-#ifdef ENABLE_SENSORS
-    // Sensor resources
-    res_temperature = client.create_resource("3303/0/5700", "temperature");
-    res_temperature->set_value(0);
-    res_temperature->methods(M2MMethod::GET);
-    res_temperature->observable(true);
+    led_res = client.create_resource("3201/0/5853", "led_state");
+    led_res->set_value(led.read());
+    led_res->methods(M2MMethod::GET | M2MMethod::PUT);
+    led_res->attach_put_callback(put_callback);
 
-    res_voltage = client.create_resource("3316/0/5700", "voltage");
-    res_voltage->set_value(0);
-    res_voltage->methods(M2MMethod::GET);
-    res_voltage->observable(true);
-#endif /* ENABLE_SENSORS */
+    post_res = client.create_resource("3300/0/5605", "execute_function");
+    post_res->methods(M2MMethod::POST);
+    post_res->attach_post_callback(post_callback);
 
-    printf("Initialized Pelion Client. Registering...\n");
+    printf("Initialized Pelion Device Management Client. Registering...\n");
 
     // Callback that fires when registering is complete
     client.on_registered(&registered);
@@ -223,21 +165,19 @@
     // Register with Pelion DM
     client.register_and_connect();
 
-    int i = 600; // wait up 60 seconds before attaching sensors and button events
-    while (i-- > 0 && !client.is_client_registered()) {
-        wait_ms(100);
-    }
-
+#if USE_BUTTON == 1
+    // The button fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
     button.fall(eventQueue.event(&button_press));
     printf("Press the user button to increment the LwM2M resource value...\n");
-
-#ifdef ENABLE_SENSORS
+#else
     // The timer fires on an interrupt context, but debounces it to the eventqueue, so it's safe to do network operations
     Ticker timer;
-    timer.attach(eventQueue.event(&sensors_update), SENSORS_POLL_INTERVAL);
-#endif /* ENABLE_SENSORS */
+    timer.attach(eventQueue.event(&button_press), 5.0);
+    printf("Simulating button press every 5 seconds...\n");
+#endif /* USE_BUTTON */
 
     // You can easily run the eventQueue in a separate thread if required
     eventQueue.dispatch_forever();
 }
-#endif
+
+#endif /* MBED_TEST_MODE */