Mbed OS example of Pelion device management LGUPlus Client

Revision:
2:34933ca5af82
Parent:
1:3f3d8bf46183
--- a/main.cpp	Fri Feb 21 19:20:41 2020 +0000
+++ b/main.cpp	Fri Feb 21 19:27:19 2020 +0000
@@ -1,33 +1,48 @@
-/*
- * Copyright (c) 2017 ARM Limited. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- * Licensed under the Apache License, Version 2.0 (the License); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an AS IS BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// ----------------------------------------------------------------------------
+// Copyright 2016-2020 ARM Ltd.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------
+#ifndef MBED_TEST_MODE
+#include "mbed.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
+#include "key_config_manager.h"                // Required for kcm_factory_reset
 
-#include "mbed.h"
-#include "rtos.h"
-#include "common_functions.h"
-#include "CellularNonIPSocket.h"
-#include "CellularDevice.h"
-#include "UDPSocket.h"
-#include "CellularLog.h"
+#include "mbed-trace/mbed_trace.h"             // Required for mbed_trace_*
+
+// Pointers to the resources that will be created in main_application().
+static MbedCloudClient *cloud_client;
+static bool cloud_client_running = true;
+static NetworkInterface *network = NULL;
+
+// Fake entropy needed for non-TRNG boards. Suitable only for demo devices.
+const uint8_t MBED_CLOUD_DEV_ENTROPY[] = { 0xf6, 0xd6, 0xc0, 0x09, 0x9e, 0x6e, 0xf2, 0x37, 0xdc, 0x29, 0x88, 0xf1, 0x57, 0x32, 0x7d, 0xde, 0xac, 0xb3, 0x99, 0x8c, 0xb9, 0x11, 0x35, 0x18, 0xeb, 0x48, 0x29, 0x03, 0x6a, 0x94, 0x6d, 0xe8, 0x40, 0xc0, 0x28, 0xcc, 0xe4, 0x04, 0xc3, 0x1f, 0x4b, 0xc2, 0xe0, 0x68, 0xa0, 0x93, 0xe6, 0x3a };
 
-#define UDP 0
-#define TCP 1
-#define NONIP 2
+static M2MResource* m2m_get_res;
+static M2MResource* m2m_put_res;
+static M2MResource* m2m_post_res;
+static M2MResource* m2m_deregister_res;
+static M2MResource* m2m_factory_reset_res;
+static SocketAddress sa;
 
-// Number of retries /
-#define RETRY_COUNT 3
+EventQueue queue(32 * EVENTS_EVENT_SIZE);
+Thread t;
+Mutex value_increment_mutex;
 
 void BG96_Modem_PowerON(void)
 {
@@ -41,7 +56,7 @@
     ThisThread::sleep_for(5000);
     
     if(BG96_STATUS)
-        printf("Module Power On\r\n");
+        printf("Module Power On~~\r\n");
     else
         printf("Check Module Power Line!!\r\n");        
 }
@@ -63,265 +78,219 @@
         printf("Check Module Power Line!!\r\n");        
 }
 
-NetworkInterface *iface;
-
-// Echo server hostname
-const char *host_name = MBED_CONF_APP_ECHO_SERVER_HOSTNAME;
-
-// Echo server port (same for TCP and UDP)
-const int port = MBED_CONF_APP_ECHO_SERVER_PORT;
-
-static rtos::Mutex trace_mutex;
-
-#if MBED_CONF_MBED_TRACE_ENABLE
-static void trace_wait()
+void print_client_ids(void)
 {
-    trace_mutex.lock();
+    printf("Account ID: %s\n", cloud_client->endpoint_info()->account_id.c_str());
+    printf("Endpoint name: %s\n", cloud_client->endpoint_info()->internal_endpoint_name.c_str());
+    printf("Device ID: %s\n\n", cloud_client->endpoint_info()->endpoint_name.c_str());
 }
 
-static void trace_release()
+void value_increment(void)
 {
-    trace_mutex.unlock();
+    value_increment_mutex.lock();
+    m2m_get_res->set_value(m2m_get_res->get_value_int() + 1);
+    printf("Counter %" PRIu64 "\n", m2m_get_res->get_value_int());
+    value_increment_mutex.unlock();
 }
 
-static char time_st[50];
-
-static char* trace_time(size_t ss)
+void get_res_update(const char* /*object_name*/)
 {
-    snprintf(time_st, 49, "[%08llums]", Kernel::get_ms_count());
-    return time_st;
+    printf("Counter resource set to %d\n", (int)m2m_get_res->get_value_int());
 }
 
-static void trace_open()
+void put_res_update(const char* /*object_name*/)
 {
-    mbed_trace_init();
-    mbed_trace_prefix_function_set( &trace_time );
+    printf("PUT update %d\n", (int)m2m_put_res->get_value_int());
+}
 
-    mbed_trace_mutex_wait_function_set(trace_wait);
-    mbed_trace_mutex_release_function_set(trace_release);
-
-    mbed_cellular_trace::mutex_wait_function_set(trace_wait);
-    mbed_cellular_trace::mutex_release_function_set(trace_release);
+void execute_post(void* /*arguments*/)
+{
+    printf("POST executed\n");
 }
 
-static void trace_close()
+void deregister_client(void)
 {
-    mbed_cellular_trace::mutex_wait_function_set(NULL);
-    mbed_cellular_trace::mutex_release_function_set(NULL);
-
-    mbed_trace_free();
+    printf("Unregistering and disconnecting from the network.\n");
+    cloud_client->close();
 }
-#endif // #if MBED_CONF_MBED_TRACE_ENABLE
 
-Thread dot_thread(osPriorityNormal, 512);
-
-void print_function(const char *format, ...)
+void deregister(void* /*arguments*/)
 {
-    trace_mutex.lock();
-    va_list arglist;
-    va_start( arglist, format );
-    vprintf(format, arglist);
-    va_end( arglist );
-    trace_mutex.unlock();
+    printf("POST deregister executed\n");
+    m2m_deregister_res->send_delayed_post_response();
+
+    deregister_client();
 }
 
-void dot_event()
+void client_registered(void)
+{
+    printf("Client registered.\n");
+    print_client_ids();
+}
+
+void client_unregistered(void)
 {
-    while (true) {
-        ThisThread::sleep_for(4000);
-        if (iface && iface->get_connection_status() == NSAPI_STATUS_GLOBAL_UP) {
-            break;
-        } else {
-            trace_mutex.lock();
-            printf(".");
-            fflush(stdout);
-            trace_mutex.unlock();
-        }
-    }
+    printf("Client unregistered.\n");
+    (void) network->disconnect();
+    cloud_client_running = false;
+}
+
+void factory_reset(void*)
+{
+    printf("POST factory reset executed\n");
+    m2m_factory_reset_res->send_delayed_post_response();
+
+    kcm_factory_reset();
 }
 
-/**
- * Connects to the Cellular Network
- */
-nsapi_error_t do_connect()
+void client_error(int err)
 {
-    nsapi_error_t retcode = NSAPI_ERROR_OK;
-    uint8_t retry_counter = 0;
+    printf("client_error(%d) -> %s\n", err, cloud_client->error_description());
+}
 
-    while (iface->get_connection_status() != NSAPI_STATUS_GLOBAL_UP) {
-        retcode = iface->connect();
-        if (retcode == NSAPI_ERROR_AUTH_FAILURE) {
-            print_function("\n\nAuthentication Failure. Exiting application\n");
-        } else if (retcode == NSAPI_ERROR_OK) {
-            print_function("\n\nConnection Established.\n");
-        } else if (retry_counter > RETRY_COUNT) {
-            print_function("\n\nFatal connection failure: %d\n", retcode);
-        } else {
-            print_function("\n\nCouldn't connect: %d, will retry\n", retcode);
-            retry_counter++;
-            continue;
-        }
-        break;
-    }
-    return retcode;
+void update_progress(uint32_t progress, uint32_t total)
+{
+    uint8_t percent = (uint8_t)((uint64_t)progress * 100 / total);
+    printf("Update progress = %" PRIu8 "%%\n", percent);
 }
 
-/**
- * Opens:
- * - UDP or TCP socket with the given echo server and performs an echo
- *   transaction retrieving current.
- * - Cellular Non-IP socket for which the data delivery path is decided
- *   by network's control plane CIoT optimisation setup, for the given APN.
- */
-nsapi_error_t test_send_recv()
+int main(void)
 {
-    nsapi_size_or_error_t retcode;
-#if MBED_CONF_APP_SOCK_TYPE == TCP
-    TCPSocket sock;
-#elif MBED_CONF_APP_SOCK_TYPE == UDP
-    UDPSocket sock;
-#elif MBED_CONF_APP_SOCK_TYPE == NONIP
-    CellularNonIPSocket sock;
-#endif
+    int status;    
 
-#if MBED_CONF_APP_SOCK_TYPE == NONIP
-    retcode = sock.open((CellularContext*)iface);
-#else
-    retcode = sock.open(iface);
-#endif
+    status = mbed_trace_init();
+    if (status != 0) {
+        printf("mbed_trace_init() failed with %d\n", status);
+        return -1;
+    }
+    
+    BG96_Modem_PowerON();
 
-    if (retcode != NSAPI_ERROR_OK) {
-#if MBED_CONF_APP_SOCK_TYPE == TCP
-        print_function("TCPSocket.open() fails, code: %d\n", retcode);
-#elif MBED_CONF_APP_SOCK_TYPE == UDP
-        print_function("UDPSocket.open() fails, code: %d\n", retcode);
-#elif MBED_CONF_APP_SOCK_TYPE == NONIP
-        print_function("CellularNonIPSocket.open() fails, code: %d\n", retcode);
-#endif
+    // Mount default kvstore
+    printf("Application ready\n");
+    status = kv_init_storage_config();
+    if (status != MBED_SUCCESS) {
+        printf("kv_init_storage_config() - failed, status %d\n", status);
         return -1;
     }
 
-    int n = 0;
-    const char *echo_string = "TEST";
-    char recv_buf[4];
-
-    sock.set_timeout(15000);
+    // Connect with NetworkInterface
+    printf("Connect to network\n");
+    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;
+    }
+    status = network->get_ip_address(&sa);
+    if (status!=0) {
+        printf("get_ip_address failed with %d\n", status);
+        return -2;
+    }
+    printf("Network initialized, connected with IP %s\n\n", sa.get_ip_address());
 
-#if MBED_CONF_APP_SOCK_TYPE == NONIP
-    retcode = sock.send((void*) echo_string, strlen(echo_string));
-    if (retcode < 0) {
-        print_function("CellularNonIPSocket.send() fails, code: %d\n", retcode);
+    // Run developer flow
+    printf("Start developer flow\n");
+    status = fcc_init();
+    if (status != FCC_STATUS_SUCCESS) {
+        printf("fcc_init() failed with %d\n", status);
         return -1;
-    } else {
-        print_function("CellularNonIPSocket: Sent %d Bytes\n", retcode);
     }
 
-    n = sock.recv((void*) recv_buf, sizeof(recv_buf));
-
-#else
+    // Inject hardcoded entropy for the device. Suitable only for demo devices.
+    (void) fcc_entropy_set(MBED_CLOUD_DEV_ENTROPY, sizeof(MBED_CLOUD_DEV_ENTROPY));
+    status = fcc_developer_flow();
+    if (status != FCC_STATUS_SUCCESS && status != FCC_STATUS_KCM_FILE_EXIST_ERROR && status != FCC_STATUS_CA_ERROR) {
+        printf("fcc_developer_flow() failed with %d\n", status);
+        return -1;
+    }
 
-    SocketAddress sock_addr;
-    retcode = iface->gethostbyname(host_name, &sock_addr);
-    if (retcode != NSAPI_ERROR_OK) {
-        print_function("Couldn't resolve remote host: %s, code: %d\n", host_name, retcode);
+    printf("Create resources\n");
+    M2MObjectList m2m_obj_list;
+
+    // GET resource 3200/0/5501
+    // PUT also allowed for resetting the resource
+    m2m_get_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3200, 0, 5501, M2MResourceInstance::INTEGER, M2MBase::GET_PUT_ALLOWED);
+    if (m2m_get_res->set_value(0) != true) {
+        printf("m2m_get_res->set_value() failed\n");
+        return -1;
+    }
+    if (m2m_get_res->set_value_updated_function(get_res_update) != true) {
+        printf("m2m_get_res->set_value_updated_function() failed\n");
         return -1;
     }
 
-    sock_addr.set_port(port);
-
-#if MBED_CONF_APP_SOCK_TYPE == TCP
-    retcode = sock.connect(sock_addr);
-    if (retcode < 0) {
-        print_function("TCPSocket.connect() fails, code: %d\n", retcode);
+    // PUT resource 3201/0/5853
+    m2m_put_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3201, 0, 5853, M2MResourceInstance::INTEGER, M2MBase::GET_PUT_ALLOWED);
+    if (m2m_put_res->set_value(0) != true) {
+        printf("m2m_put_res->set_value() failed\n");
+        return -1;
+    }
+    if (m2m_put_res->set_value_updated_function(put_res_update) != true) {
+        printf("m2m_put_res->set_value_updated_function() failed\n");
         return -1;
-    } else {
-        print_function("TCP: connected with %s server\n", host_name);
+    }
+
+    // POST resource 3201/0/5850
+    m2m_post_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3201, 0, 5850, M2MResourceInstance::INTEGER, M2MBase::POST_ALLOWED);
+    if (m2m_post_res->set_execute_function(execute_post) != true) {
+        printf("m2m_post_res->set_execute_function() failed\n");
+        return -1;
     }
-    retcode = sock.send((void*) echo_string, strlen(echo_string));
-    if (retcode < 0) {
-        print_function("TCPSocket.send() fails, code: %d\n", retcode);
+
+    // POST resource 5000/0/1 to trigger deregister.
+    m2m_deregister_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 5000, 0, 1, M2MResourceInstance::INTEGER, M2MBase::POST_ALLOWED);
+
+    // Use delayed response
+    m2m_deregister_res->set_delayed_response(true);
+
+    if (m2m_deregister_res->set_execute_function(deregister) != true) {
+        printf("m2m_post_res->set_execute_function() failed\n");
         return -1;
-    } else {
-        print_function("TCP: Sent %d Bytes to %s\n", retcode, host_name);
     }
 
-    n = sock.recv((void*) recv_buf, sizeof(recv_buf));
-#else
-
-    retcode = sock.sendto(sock_addr, (void*) echo_string, strlen(echo_string));
-    if (retcode < 0) {
-        print_function("UDPSocket.sendto() fails, code: %d\n", retcode);
-        return -1;
-    } else {
-        print_function("UDP: Sent %d Bytes to %s\n", retcode, host_name);
+    // optional Device resource for running factory reset for the device. Path of this resource will be: 3/0/6.
+    m2m_factory_reset_res = M2MInterfaceFactory::create_device()->create_resource(M2MDevice::FactoryReset);
+    if (m2m_factory_reset_res) {
+        m2m_factory_reset_res->set_execute_function(factory_reset);
     }
 
-    n = sock.recvfrom(&sock_addr, (void*) recv_buf, sizeof(recv_buf));
-#endif
-#endif
+    printf("Register Pelion Device Management Client\n\n");
 
-    sock.close();
+#ifdef MBED_CLOUD_CLIENT_SUPPORT_UPDATE
+    cloud_client = new MbedCloudClient(client_registered, client_unregistered, client_error, NULL, update_progress);
+#else
+    cloud_client = new MbedCloudClient(client_registered, client_unregistered, client_error);
+#endif // MBED_CLOUD_CLIENT_SUPPORT_UPDATE
+
+    cloud_client->add_objects(m2m_obj_list);
+    cloud_client->setup(network); // cloud_client->setup(NULL); -- https://jira.arm.com/browse/IOTCLT-3114
+
+    t.start(callback(&queue, &EventQueue::dispatch_forever));
+    queue.call_every(5000, value_increment);
 
-    if (n > 0) {
-        print_function("Received from echo server %d Bytes\n", n);
-        return 0;
+    while(cloud_client_running) {
+        int in_char = getchar();
+        if (in_char == 'i') {
+            print_client_ids(); // When 'i' is pressed, print endpoint info
+            continue;
+        } else if (in_char == 'r') {
+            (void) fcc_storage_delete(); // When 'r' is pressed, erase storage and reboot the board.
+            printf("Storage erased, rebooting the device.\n\n");
+            ThisThread::sleep_for(1*1000);
+            NVIC_SystemReset();
+        } else if (in_char > 0 && in_char != 0x03) { // Ctrl+C is 0x03 in Mbed OS and Linux returns negative number
+            value_increment(); // Simulate button press
+            continue;
+        }
+        deregister_client();
+        break;
     }
-
-    return -1;
+    return 0;
 }
 
-int main()
-{
-    print_function("\n\nmbed-os-example-cellular\n");
-    print_function("\n\nBuilt: %s, %s\n", __DATE__, __TIME__);
-#ifdef MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN
-    print_function("\n\n[MAIN], plmn: %s\n", (MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN ? MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN : "NULL"));
-#endif
-
-    print_function("Establishing connection\n");
-    
-    BG96_Modem_PowerON();
-    
-#if MBED_CONF_MBED_TRACE_ENABLE
-    trace_open();
-#else
-    dot_thread.start(dot_event);
-#endif // #if MBED_CONF_MBED_TRACE_ENABLE
-
-#if MBED_CONF_APP_SOCK_TYPE == NONIP
-    iface = CellularContext::get_default_nonip_instance();
-#else
-    iface = CellularContext::get_default_instance();
-#endif
-
-    MBED_ASSERT(iface);
-
-    // sim pin, apn, credentials and possible plmn are taken automatically from json when using NetworkInterface::set_default_parameters()
-    iface->set_default_parameters();
-
-    nsapi_error_t retcode = NSAPI_ERROR_NO_CONNECTION;
-
-    /* Attempt to connect to a cellular network */
-    if (do_connect() == NSAPI_ERROR_OK) {
-        retcode = test_send_recv();
-    }
-
-    if (iface->disconnect() != NSAPI_ERROR_OK) {
-        print_function("\n\n disconnect failed.\n\n");
-    }
-
-    if (retcode == NSAPI_ERROR_OK) {
-        print_function("\n\nSuccess. Exiting \n\n");
-    } else {
-        print_function("\n\nFailure. Exiting \n\n");
-    }
-
-#if MBED_CONF_MBED_TRACE_ENABLE
-    trace_close();
-#else
-    dot_thread.terminate();
-#endif // #if MBED_CONF_MBED_TRACE_ENABLE
-
-    return 0;
-}
-// EOF
+#endif /* MBED_TEST_MODE */