Nuvoton / Mbed OS mbed-os-example-pelion

NuMaker Pelion Device Management example

Fork of mbed-os-example-pelion by cc li

main.cpp@0:f78ec4a22e67, 2019-10-09 (annotated)

Committer:
ccli8
Date:
Wed Oct 09 14:19:44 2019 +0800
Revision:
0:f78ec4a22e67
Child:
5:ae686808e015
Support Nuvoton targets



Based on mbed-os-pelion-example master/mbed-bootloader 4.1.0/mbed-cloud-client 4.0.0,

support Nuvoton targets:

1.  Support Nuvoton targets:

    -   NUMAKER_PFM_NUC472

    -   NUMAKER_PFM_M487

    -   NUMAKER_IOT_M487 V1.3

        Compared to V1.2, V1.3 adds support for ESP8266 RTS/CTS/RST pins. V1.3 is incompatible with V1.2 on ESP8266.

    -   NUMAKER_IOT_M263A

2.  Change storage to NUSD (SD card in SDIO bus mode) from SD (SD card SPI bus mode)

    (1) Add COMPONENT_NUSD.lib.

    (2) Add component NUSD (target.components_add).

    (3) Change default BlockDevice to NUSD:

        Override BlockDevice::get_default_instance (nusd.provide-default-blockdevice).

        Required since mbed-cloud-client 2.1.0 (arm_uc_blockdevice_ext) or in:

        mbed-bootloader/modules/storage/pal-blockdevice/source/arm_uc_pal_blockdevice_mbed.cpp

    (4) Enable kvstore with blockdevice type being "other".

        i)  Override get_other_blockdevice() (nusd.provide-kvstore-other-blockdevice).

        ii) Configure storage type to "FILESYSTEM".

        iii)Configure file system type to "LITTLE".

        vi) Configure block device type to "other".

        v)  Configure external size to 64MiB, which cannot overlap with update-client.

            storage-address/update-client.storage-size.

3.  Change back UARTSerial tx/rx buffer size from 1024/1024 to 256/256. This can reduce

    memory footprint by (1024 - 256) * 2 = 1.5KiB. Because this configuration influences

    both ESP8266 and default console (platfrom/mbed_retarget.cpp), memory reduction can

    achieve 1.5KiB x 2 = 3KiB.

4.  Enlarge ESP8266 'send tcp data' timeout on Nuvoton targets

    Pelion connection has some failure rate with this. Enlarging ESP8266_SEND_TIMEOUT

    can just relieve the issue. A ticket has raised to address it:

    https://github.com/ARMmbed/mbed-os/issues/11544

5.  Requirements for mbed-os version:

    -   mbed-os 5.13.0 (or afterwards) to support kvstore with block device type being "other"

    -   mbed-os 5.13.1 (or afterwards) to fix 'undefined pal_plat_osEntropyInject(...)' error

    -   mbed-os 5.14.0 (or afterwards) to support NUMAKER_IOT_M263A

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ccli8 0:f78ec4a22e67 1 // ----------------------------------------------------------------------------
ccli8 0:f78ec4a22e67 2 // Copyright 2016-2019 ARM Ltd.
ccli8 0:f78ec4a22e67 3 //
ccli8 0:f78ec4a22e67 4 // SPDX-License-Identifier: Apache-2.0
ccli8 0:f78ec4a22e67 5 //
ccli8 0:f78ec4a22e67 6 // Licensed under the Apache License, Version 2.0 (the "License");
ccli8 0:f78ec4a22e67 7 // you may not use this file except in compliance with the License.
ccli8 0:f78ec4a22e67 8 // You may obtain a copy of the License at
ccli8 0:f78ec4a22e67 9 //
ccli8 0:f78ec4a22e67 10 // http://www.apache.org/licenses/LICENSE-2.0
ccli8 0:f78ec4a22e67 11 //
ccli8 0:f78ec4a22e67 12 // Unless required by applicable law or agreed to in writing, software
ccli8 0:f78ec4a22e67 13 // distributed under the License is distributed on an "AS IS" BASIS,
ccli8 0:f78ec4a22e67 14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ccli8 0:f78ec4a22e67 15 // See the License for the specific language governing permissions and
ccli8 0:f78ec4a22e67 16 // limitations under the License.
ccli8 0:f78ec4a22e67 17 // ----------------------------------------------------------------------------
ccli8 0:f78ec4a22e67 18 #ifndef MBED_TEST_MODE
ccli8 0:f78ec4a22e67 19 #include "mbed.h"
ccli8 0:f78ec4a22e67 20 #include "kv_config.h"
ccli8 0:f78ec4a22e67 21 #include "mbed-cloud-client/MbedCloudClient.h" // Required for new MbedCloudClient()
ccli8 0:f78ec4a22e67 22 #include "factory_configurator_client.h" // Required for fcc_* functions and FCC_* defines
ccli8 0:f78ec4a22e67 23 #include "m2mresource.h" // Required for M2MResource
ccli8 0:f78ec4a22e67 24
ccli8 0:f78ec4a22e67 25 #include "mbed-trace/mbed_trace.h" // Required for mbed_trace_*
ccli8 0:f78ec4a22e67 26
ccli8 0:f78ec4a22e67 27 // Pointers to the resources that will be created in main_application().
ccli8 0:f78ec4a22e67 28 static MbedCloudClient *cloud_client;
ccli8 0:f78ec4a22e67 29 static bool cloud_client_running = true;
ccli8 0:f78ec4a22e67 30 static NetworkInterface *network = NULL;
ccli8 0:f78ec4a22e67 31
ccli8 0:f78ec4a22e67 32 // Fake entropy needed for non-TRNG boards. Suitable only for demo devices.
ccli8 0:f78ec4a22e67 33 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 };
ccli8 0:f78ec4a22e67 34
ccli8 0:f78ec4a22e67 35 static M2MResource* m2m_get_res;
ccli8 0:f78ec4a22e67 36 static M2MResource* m2m_put_res;
ccli8 0:f78ec4a22e67 37 static M2MResource* m2m_post_res;
ccli8 0:f78ec4a22e67 38 static M2MResource* m2m_deregister_res;
ccli8 0:f78ec4a22e67 39
ccli8 0:f78ec4a22e67 40 void print_client_ids(void)
ccli8 0:f78ec4a22e67 41 {
ccli8 0:f78ec4a22e67 42 printf("Account ID: %s\n", cloud_client->endpoint_info()->account_id.c_str());
ccli8 0:f78ec4a22e67 43 printf("Endpoint name: %s\n", cloud_client->endpoint_info()->internal_endpoint_name.c_str());
ccli8 0:f78ec4a22e67 44 printf("Device Id: %s\n\n", cloud_client->endpoint_info()->endpoint_name.c_str());
ccli8 0:f78ec4a22e67 45 }
ccli8 0:f78ec4a22e67 46
ccli8 0:f78ec4a22e67 47 void button_press(void)
ccli8 0:f78ec4a22e67 48 {
ccli8 0:f78ec4a22e67 49 m2m_get_res->set_value(m2m_get_res->get_value_int() + 1);
ccli8 0:f78ec4a22e67 50 printf("Counter %" PRIu64 "\n", m2m_get_res->get_value_int());
ccli8 0:f78ec4a22e67 51 }
ccli8 0:f78ec4a22e67 52
ccli8 0:f78ec4a22e67 53 void put_update(const char* /*object_name*/)
ccli8 0:f78ec4a22e67 54 {
ccli8 0:f78ec4a22e67 55 printf("PUT update %d\n", (int)m2m_put_res->get_value_int());
ccli8 0:f78ec4a22e67 56 }
ccli8 0:f78ec4a22e67 57
ccli8 0:f78ec4a22e67 58 void execute_post(void* /*arguments*/)
ccli8 0:f78ec4a22e67 59 {
ccli8 0:f78ec4a22e67 60 printf("POST executed\n");
ccli8 0:f78ec4a22e67 61 }
ccli8 0:f78ec4a22e67 62
ccli8 0:f78ec4a22e67 63 void deregister_client(void)
ccli8 0:f78ec4a22e67 64 {
ccli8 0:f78ec4a22e67 65 printf("Unregistering and disconnecting from the network.\n");
ccli8 0:f78ec4a22e67 66 cloud_client->close();
ccli8 0:f78ec4a22e67 67 }
ccli8 0:f78ec4a22e67 68
ccli8 0:f78ec4a22e67 69 void deregister(void* /*arguments*/)
ccli8 0:f78ec4a22e67 70 {
ccli8 0:f78ec4a22e67 71 printf("POST deregister executed\n");
ccli8 0:f78ec4a22e67 72 m2m_deregister_res->send_delayed_post_response();
ccli8 0:f78ec4a22e67 73
ccli8 0:f78ec4a22e67 74 deregister_client();
ccli8 0:f78ec4a22e67 75 }
ccli8 0:f78ec4a22e67 76
ccli8 0:f78ec4a22e67 77 void client_registered(void)
ccli8 0:f78ec4a22e67 78 {
ccli8 0:f78ec4a22e67 79 printf("Client registered.\n");
ccli8 0:f78ec4a22e67 80 print_client_ids();
ccli8 0:f78ec4a22e67 81 }
ccli8 0:f78ec4a22e67 82
ccli8 0:f78ec4a22e67 83 void client_unregistered(void)
ccli8 0:f78ec4a22e67 84 {
ccli8 0:f78ec4a22e67 85 printf("Client unregistered.\n");
ccli8 0:f78ec4a22e67 86 (void) network->disconnect();
ccli8 0:f78ec4a22e67 87 cloud_client_running = false;
ccli8 0:f78ec4a22e67 88 }
ccli8 0:f78ec4a22e67 89
ccli8 0:f78ec4a22e67 90 void client_error(int err)
ccli8 0:f78ec4a22e67 91 {
ccli8 0:f78ec4a22e67 92 printf("client_error(%d) -> %s\n", err, cloud_client->error_description());
ccli8 0:f78ec4a22e67 93 }
ccli8 0:f78ec4a22e67 94
ccli8 0:f78ec4a22e67 95 void update_progress(uint32_t progress, uint32_t total)
ccli8 0:f78ec4a22e67 96 {
ccli8 0:f78ec4a22e67 97 uint8_t percent = (uint8_t)((uint64_t)progress * 100 / total);
ccli8 0:f78ec4a22e67 98 printf("Update progress = %" PRIu8 "%%\n", percent);
ccli8 0:f78ec4a22e67 99 }
ccli8 0:f78ec4a22e67 100
ccli8 0:f78ec4a22e67 101 int main(void)
ccli8 0:f78ec4a22e67 102 {
ccli8 0:f78ec4a22e67 103 int status;
ccli8 0:f78ec4a22e67 104
ccli8 0:f78ec4a22e67 105 status = mbed_trace_init();
ccli8 0:f78ec4a22e67 106 if (status != 0) {
ccli8 0:f78ec4a22e67 107 printf("mbed_trace_init() failed with %d\n", status);
ccli8 0:f78ec4a22e67 108 return -1;
ccli8 0:f78ec4a22e67 109 }
ccli8 0:f78ec4a22e67 110
ccli8 0:f78ec4a22e67 111 // Mount default kvstore
ccli8 0:f78ec4a22e67 112 printf("Application ready\n");
ccli8 0:f78ec4a22e67 113 status = kv_init_storage_config();
ccli8 0:f78ec4a22e67 114 if (status != MBED_SUCCESS) {
ccli8 0:f78ec4a22e67 115 printf("kv_init_storage_config() - failed, status %d\n", status);
ccli8 0:f78ec4a22e67 116 return -1;
ccli8 0:f78ec4a22e67 117 }
ccli8 0:f78ec4a22e67 118
ccli8 0:f78ec4a22e67 119 // Connect with NetworkInterface
ccli8 0:f78ec4a22e67 120 printf("Connect to network\n");
ccli8 0:f78ec4a22e67 121 network = NetworkInterface::get_default_instance();
ccli8 0:f78ec4a22e67 122 if (network == NULL) {
ccli8 0:f78ec4a22e67 123 printf("Failed to get default NetworkInterface\n");
ccli8 0:f78ec4a22e67 124 return -1;
ccli8 0:f78ec4a22e67 125 }
ccli8 0:f78ec4a22e67 126 status = network->connect();
ccli8 0:f78ec4a22e67 127 if (status != NSAPI_ERROR_OK) {
ccli8 0:f78ec4a22e67 128 printf("NetworkInterface failed to connect with %d\n", status);
ccli8 0:f78ec4a22e67 129 return -1;
ccli8 0:f78ec4a22e67 130 }
ccli8 0:f78ec4a22e67 131
ccli8 0:f78ec4a22e67 132 printf("Network initialized, connected with IP %s\n\n", network->get_ip_address());
ccli8 0:f78ec4a22e67 133
ccli8 0:f78ec4a22e67 134 // Run developer flow
ccli8 0:f78ec4a22e67 135 printf("Start developer flow\n");
ccli8 0:f78ec4a22e67 136 status = fcc_init();
ccli8 0:f78ec4a22e67 137 if (status != FCC_STATUS_SUCCESS) {
ccli8 0:f78ec4a22e67 138 printf("fcc_init() failed with %d\n", status);
ccli8 0:f78ec4a22e67 139 return -1;
ccli8 0:f78ec4a22e67 140 }
ccli8 0:f78ec4a22e67 141
ccli8 0:f78ec4a22e67 142 // Inject hardcoded entropy for the device. Suitable only for demo devices.
ccli8 0:f78ec4a22e67 143 (void) fcc_entropy_set(MBED_CLOUD_DEV_ENTROPY, sizeof(MBED_CLOUD_DEV_ENTROPY));
ccli8 0:f78ec4a22e67 144 status = fcc_developer_flow();
ccli8 0:f78ec4a22e67 145 if (status != FCC_STATUS_SUCCESS && status != FCC_STATUS_KCM_FILE_EXIST_ERROR && status != FCC_STATUS_CA_ERROR) {
ccli8 0:f78ec4a22e67 146 printf("fcc_developer_flow() failed with %d\n", status);
ccli8 0:f78ec4a22e67 147 return -1;
ccli8 0:f78ec4a22e67 148 }
ccli8 0:f78ec4a22e67 149
ccli8 0:f78ec4a22e67 150 printf("Create resources\n");
ccli8 0:f78ec4a22e67 151 M2MObjectList m2m_obj_list;
ccli8 0:f78ec4a22e67 152
ccli8 0:f78ec4a22e67 153 // GET resource 3200/0/5501
ccli8 0:f78ec4a22e67 154 m2m_get_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3200, 0, 5501, M2MResourceInstance::INTEGER, M2MBase::GET_ALLOWED);
ccli8 0:f78ec4a22e67 155 if (m2m_get_res->set_value(0) != true) {
ccli8 0:f78ec4a22e67 156 printf("m2m_get_res->set_value() failed\n");
ccli8 0:f78ec4a22e67 157 return -1;
ccli8 0:f78ec4a22e67 158 }
ccli8 0:f78ec4a22e67 159
ccli8 0:f78ec4a22e67 160 // PUT resource 3201/0/5853
ccli8 0:f78ec4a22e67 161 m2m_put_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3201, 0, 5853, M2MResourceInstance::INTEGER, M2MBase::GET_PUT_ALLOWED);
ccli8 0:f78ec4a22e67 162 if (m2m_put_res->set_value(0) != true) {
ccli8 0:f78ec4a22e67 163 printf("m2m_led_res->set_value() failed\n");
ccli8 0:f78ec4a22e67 164 return -1;
ccli8 0:f78ec4a22e67 165 }
ccli8 0:f78ec4a22e67 166 if (m2m_put_res->set_value_updated_function(put_update) != true) {
ccli8 0:f78ec4a22e67 167 printf("m2m_put_res->set_value_updated_function() failed\n");
ccli8 0:f78ec4a22e67 168 return -1;
ccli8 0:f78ec4a22e67 169 }
ccli8 0:f78ec4a22e67 170
ccli8 0:f78ec4a22e67 171 // POST resource 3201/0/5850
ccli8 0:f78ec4a22e67 172 m2m_post_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 3201, 0, 5850, M2MResourceInstance::INTEGER, M2MBase::POST_ALLOWED);
ccli8 0:f78ec4a22e67 173 if (m2m_post_res->set_execute_function(execute_post) != true) {
ccli8 0:f78ec4a22e67 174 printf("m2m_post_res->set_execute_function() failed\n");
ccli8 0:f78ec4a22e67 175 return -1;
ccli8 0:f78ec4a22e67 176 }
ccli8 0:f78ec4a22e67 177
ccli8 0:f78ec4a22e67 178 // POST resource 5000/0/1 to trigger deregister.
ccli8 0:f78ec4a22e67 179 m2m_deregister_res = M2MInterfaceFactory::create_resource(m2m_obj_list, 5000, 0, 1, M2MResourceInstance::INTEGER, M2MBase::POST_ALLOWED);
ccli8 0:f78ec4a22e67 180
ccli8 0:f78ec4a22e67 181 // Use delayed response
ccli8 0:f78ec4a22e67 182 m2m_deregister_res->set_delayed_response(true);
ccli8 0:f78ec4a22e67 183
ccli8 0:f78ec4a22e67 184 if (m2m_deregister_res->set_execute_function(deregister) != true) {
ccli8 0:f78ec4a22e67 185 printf("m2m_post_res->set_execute_function() failed\n");
ccli8 0:f78ec4a22e67 186 return -1;
ccli8 0:f78ec4a22e67 187 }
ccli8 0:f78ec4a22e67 188
ccli8 0:f78ec4a22e67 189 printf("Register Pelion Device Management Client\n\n");
ccli8 0:f78ec4a22e67 190 cloud_client = new MbedCloudClient(client_registered, client_unregistered, client_error, NULL, update_progress);
ccli8 0:f78ec4a22e67 191 cloud_client->add_objects(m2m_obj_list);
ccli8 0:f78ec4a22e67 192 cloud_client->setup(network); // cloud_client->setup(NULL); -- https://jira.arm.com/browse/IOTCLT-3114
ccli8 0:f78ec4a22e67 193
ccli8 0:f78ec4a22e67 194 while(cloud_client_running) {
ccli8 0:f78ec4a22e67 195 int in_char = getchar();
ccli8 0:f78ec4a22e67 196 if (in_char == 'i') {
ccli8 0:f78ec4a22e67 197 print_client_ids(); // When 'i' is pressed, print endpoint info
ccli8 0:f78ec4a22e67 198 continue;
ccli8 0:f78ec4a22e67 199 } else if (in_char == 'r') {
ccli8 0:f78ec4a22e67 200 (void) fcc_storage_delete(); // When 'r' is pressed, erase storage and reboot the board.
ccli8 0:f78ec4a22e67 201 printf("Storage erased, rebooting the device.\n\n");
ccli8 0:f78ec4a22e67 202 wait(1);
ccli8 0:f78ec4a22e67 203 NVIC_SystemReset();
ccli8 0:f78ec4a22e67 204 } else if (in_char > 0 && in_char != 0x03) { // Ctrl+C is 0x03 in Mbed OS and Linux returns negative number
ccli8 0:f78ec4a22e67 205 button_press(); // Simulate button press
ccli8 0:f78ec4a22e67 206 continue;
ccli8 0:f78ec4a22e67 207 }
ccli8 0:f78ec4a22e67 208 deregister_client();
ccli8 0:f78ec4a22e67 209 break;
ccli8 0:f78ec4a22e67 210 }
ccli8 0:f78ec4a22e67 211 return 0;
ccli8 0:f78ec4a22e67 212 }
ccli8 0:f78ec4a22e67 213
ccli8 0:f78ec4a22e67 214 #endif /* MBED_TEST_MODE */