First draft with working version on K64F, Ethernet only

Author: Yogesh Pande

README.md

@@ -1 +1,30 @@
-WIP
+# Pelion Client Mbed OS Example
+
+Features:
+- Mbed OS 5.13
+- Supports Update
+- 200 lines of codes + credential sources
+
+# Deploying
+
+Because the point of this repository is to propose the change ideas, mbed-cloud-client patching is required before compilation.
+
+    mbed import new-mbed-os-pelion-example
+    cd new-mbed-os-pelion-example
+    git checkout -b reduced-configuration -t origin/reduced-configuration
+    ./patch-mbed-cloud-client.sh
+
+# Compilation
+
+    mbed target K64F
+    mbed toolchain GCC_ARM
+    mbed compile
+    
+
+# Program Flow
+
+1. Bootstrap
+1. Register
+1. Send enter through putty/minicom to simulate button
+1. Send 'i' to print endpoint name
+1. Send Ctrl-C through putty/minicom to unregister

main.cpp

@@ -17,180 +17,180 @@
 // ----------------------------------------------------------------------------
 #ifndef MBED_TEST_MODE
 #include "mbed.h"
-#include "simplem2mclient.h"
-#include "platform_setup.h"
+#include "kv_config.h"
+#include "mbed-cloud-client/MbedCloudClient.h" // Required for new MbedCloudClient()
+#include "factory_configurator_client.h"       // Required for fcc_* functions and FCC_* defines
+#include "m2mresource.h"                       // Required for M2MResource
 
-#ifndef MBED_CONF_MBED_CLOUD_CLIENT_DISABLE_CERTIFICATE_ENROLLMENT
-#include "certificate_enrollment_user_cb.h"
-#endif
+#include "mbed-trace/mbed_trace.h"             // Required for mbed_trace_*
+#include "mbed-trace-helper.h"                 // Required for mbed_trace_mutex_*
 
 // Pointers to the resources that will be created in main_application().
-static M2MResource* button_res;
-static M2MResource* pattern_res;
-static M2MResource* blink_res;
+static MbedCloudClient *cloud_client;
+static bool cloud_client_registered = false;
 
-// 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;
+static M2MResource* m2m_get_res;
+static M2MResource* m2m_put_res;
+static M2MResource* m2m_post_res;
 
-// Pointer to mbedClient, used for calling close function.
-static SimpleM2MClient *client;
 
-void pattern_updated(const char *)
+void print_client_ids(void)
 {
-    printf("PUT received, new value: %s\n", pattern_res->get_value_string().c_str());
+    printf("Account ID: %s\r\n", cloud_client->endpoint_info()->account_id.c_str());
+    printf("ID: %s\r\n", cloud_client->endpoint_info()->endpoint_name.c_str());
+    printf("Endpoint Name: %s\r\n", cloud_client->endpoint_info()->internal_endpoint_name.c_str());
 }
 
-void blink_callback(void *)
+void button_press(void)
 {
-    String pattern_string = pattern_res->get_value_string();
-    const char *pattern = pattern_string.c_str();
-    printf("LED pattern = %s\n", pattern);
-
-    // The pattern is something like 500:200:500, so parse that.
-    // LED blinking is done while parsing.
-    // TBD
-    blink_res->send_delayed_post_response();
+    m2m_get_res->set_value(m2m_get_res->get_value_int() + 1);
+    printf("\nCounter %" PRId64, m2m_get_res->get_value_int());
 }
 
-// TODO: move somewhere in the helper folder
-void notification_status_callback(const M2MBase& object,
-                            const M2MBase::MessageDeliveryStatus status,
-                            const M2MBase::MessageType /*type*/)
+void put_update(const char* /*object_name*/)
 {
-    switch(status) {
-        case M2MBase::MESSAGE_STATUS_BUILD_ERROR:
-            printf("Message status callback: (%s) error when building CoAP message\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_RESEND_QUEUE_FULL:
-            printf("Message status callback: (%s) CoAP resend queue full\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_SENT:
-            printf("Message status callback: (%s) Message sent to server\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_DELIVERED:
-            printf("Message status callback: (%s) Message delivered\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_SEND_FAILED:
-            printf("Message status callback: (%s) Message sending failed\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_SUBSCRIBED:
-            printf("Message status callback: (%s) subscribed\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_UNSUBSCRIBED:
-            printf("Message status callback: (%s) subscription removed\n", object.uri_path());
-            break;
-        case M2MBase::MESSAGE_STATUS_REJECTED:
-            printf("Message status callback: (%s) server has rejected the message\n", object.uri_path());
-            break;
-        default:
-            break;
-    }
+    printf("PUT update %d\r\n", (int)m2m_put_res->get_value_int());
+}
+
+void execute_post(void */*arguments*/)
+{
+    printf("POST executed\r\n");
+}
+
+void client_registered(void)
+{
+    printf("Client registered: \r\n");
+    print_client_ids();
+    cloud_client_registered = true;
+}
+
+void client_unregistered(void)
+{
+    printf("Client unregistered\r\n");
+    cloud_client_registered = false;
 }
 
-// This function is called when a POST request is received for resource 5000/0/1.
-void unregister(void *)
+void client_error(int err)
 {
-    printf("Unregister resource executed\n");
-    client->close();
+    printf("client_error(%d) -> %s\r\n", err, cloud_client->error_description());
 }
 
-// This function is called when a POST request is received for resource 5000/0/2.
-void factory_reset(void *)
+void update_progress(uint32_t progress, uint32_t total)
 {
-    printf("Factory reset resource executed\n");
-    client->close();
-    kcm_status_e kcm_status = kcm_factory_reset();
-    if (kcm_status != KCM_STATUS_SUCCESS) {
-        printf("Failed to do factory reset - %d\n", kcm_status);
-    } else {
-        printf("Factory reset completed. Now restart the device\n");
+    uint8_t percent = (uint8_t)((uint64_t)progress * 100 / total);
+    printf("Update progress = %" PRIu8 "%%\r\n", percent);
+}
+
+void update_authorize(int32_t request)
+{
+    switch (request) {
+        case MbedCloudClient::UpdateRequestDownload:
+            printf("Download authorized\r\n");
+            cloud_client->update_authorize(MbedCloudClient::UpdateRequestDownload);
+            break;
+
+        case MbedCloudClient::UpdateRequestInstall:
+            printf("Update authorized -> reboot\r\n");
+            cloud_client->update_authorize(MbedCloudClient::UpdateRequestInstall);
+            break;
+
+        default:
+            printf("update_authorize(%" PRId32 "), unknown request", request);
+            break;
     }
 }
 
 int main(void)
 {
-    // Initialize trace-library first
-    if (application_init_mbed_trace() != 0) {
-        printf("Failed initializing mbed trace\n" );
-        return -1;
-    }
+    int status;
 
-    // Initialize platform-specific components
-    if(platform_init() != 0) {
-        printf("ERROR - platform_init() failed!\n");
+    status = mbed_trace_init();
+    if (status != 0) {
+        printf("mbed_trace_init() failed with %d\r\n", status);
         return -1;
     }
 
-    // Print platform information
-    platform_info();
+    mbed_trace_config_set(TRACE_ACTIVE_LEVEL_INFO); // trace level info
 
-    // Initialize network
-    if (!platform_init_connection()) {
-        printf("Network initialized, registering...\n");
-    } else {
+    printf("Init KVStore\r\n");
+    // Mount default kvstore
+    status = kv_init_storage_config();
+    if (status != MBED_SUCCESS) {
+        printf("kv_init_storage_config() - failed, status %d\r\n", status);
         return -1;
     }
 
-    // Print some statistics of the object sizes and their heap memory consumption.
-    // NOTE: This *must* be done before creating MbedCloudClient, as the statistic calculation
-    // creates and deletes M2MSecurity and M2MDevice singleton objects, which are also used by
-    // the MbedCloudClient.
-#ifdef MBED_HEAP_STATS_ENABLED
-    print_m2mobject_stats();
-#endif
-
-    // SimpleClient is used for registering and unregistering resources to a server.
-    SimpleM2MClient mbedClient;
-
-    //  Factory Config Client initialization
-    if (application_init_fcc() != 0) {
-        printf("Failed initializing FCC, exiting application!\n");
+    // Connect with NetworkInterface
+    NetworkInterface *network = NetworkInterface::get_default_instance();
+    if (network == NULL) {
+        printf("Failed to get default NetworkInterface\n");
+        return -1;
+    }
+    status = network->connect();
+    if (status != NSAPI_ERROR_OK) {
+        printf("NetworkInterface failed to connect with %d\n", status);
+        return -1;
+    }
+    printf("Network connected\r\n");
+
+    // Run developer flow
+    printf("Using developer flow\r\n");
+    status = fcc_init();
+    status = fcc_developer_flow();
+    if (status != FCC_STATUS_SUCCESS && status != FCC_STATUS_KCM_FILE_EXIST_ERROR) {
+        printf("fcc_developer_flow() failed with %d\r\n", status);
         return -1;
     }
 
-    // Save pointer to mbedClient so that other functions can access it.
-    client = &mbedClient;
-
-#ifdef MBED_HEAP_STATS_ENABLED
-    printf("Client initialized\r\n");
-    print_heap_stats();
-#endif
-#ifdef MBED_STACK_STATS_ENABLED
-    print_stack_statistics();
-#endif
-
-    // Create resource for button count. Path of this resource will be: 3200/0/5501.
-    button_res = mbedClient.add_cloud_resource(3200, 0, 5501, "button_resource", M2MResourceInstance::INTEGER,
-                              M2MBase::GET_ALLOWED, 0, true, NULL, (void*)notification_status_callback);
-
-    // Create resource for led blinking pattern. Path of this resource will be: 3201/0/5853.
-    pattern_res = mbedClient.add_cloud_resource(3201, 0, 5853, "pattern_resource", M2MResourceInstance::STRING,
-                               M2MBase::GET_PUT_ALLOWED, "500:500:500:500", true, (void*)pattern_updated, (void*)notification_status_callback);
-
-    // Create resource for starting the led blinking. Path of this resource will be: 3201/0/5850.
-    blink_res = mbedClient.add_cloud_resource(3201, 0, 5850, "blink_resource", M2MResourceInstance::STRING,
-                             M2MBase::POST_ALLOWED, "", false, (void*)blink_callback, (void*)notification_status_callback);
-    // Use delayed response
-    blink_res->set_delayed_response(true);
-
-    // Create resource for unregistering the device. Path of this resource will be: 5000/0/1.
-    mbedClient.add_cloud_resource(5000, 0, 1, "unregister", M2MResourceInstance::STRING,
-                 M2MBase::POST_ALLOWED, NULL, false, (void*)unregister, NULL);
-
-    // Create resource for running factory reset for the device. Path of this resource will be: 5000/0/2.
-    mbedClient.add_cloud_resource(5000, 0, 2, "factory_reset", M2MResourceInstance::STRING,
-                 M2MBase::POST_ALLOWED, NULL, false, (void*)factory_reset, NULL);
+    printf("Create resources\r\n");
+    M2MObjectList m2m_obj_list;
 
-    mbedClient.register_and_connect();
+    // GET resource 3200/0/5501
+    m2m_get_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3200, 0, 5501, M2MResourceInstance::INTEGER, M2MBase::GET_ALLOWED);
+    if (m2m_get_res->set_value(0) != true) {
+        printf("m2m_get_res->set_value() failed\r\n");
+        return -1;
+    }
 
-#ifndef MBED_CONF_MBED_CLOUD_CLIENT_DISABLE_CERTIFICATE_ENROLLMENT
-    // Add certificate renewal callback
-    mbedClient.get_cloud_client().on_certificate_renewal(certificate_renewal_cb);
-#endif // MBED_CONF_MBED_CLOUD_CLIENT_DISABLE_CERTIFICATE_ENROLLMENT
+    // PUT resource 3200/0/5500
+    m2m_put_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3342, 0, 5500, M2MResourceInstance::INTEGER, M2MBase::GET_PUT_ALLOWED);
+    if (m2m_put_res->set_value(0) != true) {
+        printf("m2m_led_res->set_value() failed\r\n");
+        return -1;
+    }
+    if (m2m_put_res->set_value_updated_function(put_update) != true) { // PUT sets led
+        printf("m2m_put_res->set_value_updated_function() failed\r\n");
+        return -1;
+    }
 
-    eventQueue.dispatch_forever();
+    m2m_post_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3342, 0, 5500, M2MResourceInstance::INTEGER, M2MBase::POST_ALLOWED);
+    if (m2m_post_res->set_execute_function(execute_post) != true) { // POST toggles led
+        printf("m2m_post_res->set_execute_function() failed\r\n");
+        return -1;
+    }
 
+    printf("Starting Pelion Device Management Client\r\n");
+    cloud_client = new MbedCloudClient(client_registered, client_unregistered, client_error, update_authorize, update_progress);
+    cloud_client->add_objects(m2m_obj_list);
+    cloud_client->setup(network); // cloud_client->setup(NULL); -- https://jira.arm.com/browse/IOTCLT-3114
+
+    printf("Application loop\r\n");
+    while(1) {
+        int in_char = getchar();
+        if (in_char == 'i') {
+            print_client_ids(); // When 'i' is pressed, print endpoint info
+            continue;
+        } else if (in_char > 0 && in_char != 0x03) { // Ctrl+C is 0x03 in Mbed OS and Linux returns negative number
+            button_press(); // Simulate button press
+            continue;
+        }
+        printf("Unregistering\r\n");
+        cloud_client->close();
+        while (cloud_client_registered == true) {
+            wait(1);
+        }
+        break;
+    }
     return 0;
 }