Simple Mbed Cloud Client application using features of K64 & K66
Connect to Mbed Cloud!
This example was customized a bit for FRDM-K66 and FRDM-K64F.
It depends on having an SD Card plugged in for storage of credentials. It could be changed later to use a SPI flash or other storage on a shield or wired in.
The app keeps track of how many times switch 2 (SW2) is pressed. The value can be retrieved via a GET request to Mbed Cloud.
Also, it will blink a pattern based on milisecond (ms) timing values that can be sent from Mbed Cloud. The pattern can be sent with a PUT request and the blinking sequence can be triggered by a POST request.
Revision 9:ae1f6fe932dc, committed 2018-05-10
- Comitter:
- maclobdell
- Date:
- Thu May 10 06:28:06 2018 -0500
- Parent:
- 8:ace9e5de6491
- Child:
- 10:3f30c0e55a8e
- Commit message:
- update to new public version of cloud client
Changed in this revision
--- a/main.cpp Mon Feb 19 20:37:36 2018 +0000
+++ b/main.cpp Thu May 10 06:28:06 2018 -0500
@@ -1,205 +1,175 @@
-// ----------------------------------------------------------------------------
-// Copyright 2016-2017 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.
-// ----------------------------------------------------------------------------
-
-#include "mbed.h"
-#include "mbed-trace/mbed_trace.h"
-#include "mbed-trace-helper.h"
-#include "simple-mbed-cloud-client.h"
-#include "key-config-manager/kcm_status.h"
-#include "key-config-manager/key_config_manager.h"
-#include "SDBlockDevice.h"
-#include "FATFileSystem.h"
-#include "EthernetInterface.h"
-
-/* The following app uses Mbed Cloud with SD Card storage, button, & led */
-
-// Placeholder to hardware that trigger events (timer, button, etc)
-//Ticker timer;
-/* K64 & K66 */
-InterruptIn sw2(SW2);
-DigitalOut led2(LED2);
-/* */
-
-// Placeholder for storage
-/* K64 & K66 */
-SDBlockDevice sd(PTE3, PTE1, PTE2, PTE4);
-FATFileSystem fs("sd");
-/* */
-
-// Pointers to the resources that will be created in main_application().
-static MbedCloudClientResource* pattern_ptr;
-static MbedCloudClientResource* button_ptr;
-
-// Pointer to mbedClient, used for calling close function.
-static SimpleMbedCloudClient *client;
-
-static bool button_pressed = false;
-static int button_count = 0;
-
-void button_press() {
- button_pressed = true;
- ++button_count;
- button_ptr->set_value(button_count);
-}
-
-void pattern_updated(const char *) {
- printf("PUT received, new value: %s\n", pattern_ptr->get_value().c_str());
- // Placeholder for PUT action
-}
-
-void blink_callback(void *) {
- String pattern_str = pattern_ptr->get_value();
- const char *pattern = pattern_str.c_str();
- printf("POST received. LED pattern = %s\n", pattern);
- // Placeholder for POST action
- // The pattern is something like 500:200:500, so parse that.
- // LED blinking is done while parsing.
-
- while (*pattern != '\0') {
- //make a short blink on the led
- led2 = 0;
- wait_ms(20);
- led2 = 1;
- // Wait for requested time.
- wait_ms(atoi(pattern));
- // Search for next value.
- pattern = strchr(pattern, ':');
- if(!pattern) {
- //we're done, give one last blink to end the pattern
- led2 = 0;
- wait_ms(20);
- led2 = 1;
- break; // while
- }
- pattern++;
- }
-}
-
-void button_callback(const M2MBase& object, const NoticationDeliveryStatus status)
-{
- printf("Button notification. Callback: (%s)\n", object.uri_path());
- // Placeholder for GET
-}
-
-
-int main(void)
-{
- // Requires DAPLink 245+ (https://github.com/ARMmbed/DAPLink/pull/364)
- // Older versions: workaround to prevent possible deletion of credentials:
- wait(2);
-
- // Misc OS setup
- srand(time(NULL));
-
- // Placeholder for network
- EthernetInterface net;
-
- printf("Start Simple Mbed Cloud Client\n");
-
- // Initialize SD card
- int status = sd.init();
- if (status != BD_ERROR_OK) {
- printf("Failed to init SD card\r\n");
- return -1;
- }
-
- // Mount the file system (reformatting on failure)
- status = fs.mount(&sd);
- if (status) {
- printf("Failed to mount FAT file system, reformatting...\r\n");
- status = fs.reformat(&sd);
- if (status) {
- printf("Failed to reformat FAT file system\r\n");
- return -1;
- } else {
- printf("Reformat and mount complete\r\n");
- }
- }
-
- printf("Connecting to the network using Ethernet...\n");
-
- status = net.connect();
- if (status) {
- printf("Connection to Network Failed %d!\n", status);
- return -1;
- } else {
- const char *ip_addr = net.get_ip_address();
- printf("Connected successfully\n");
- printf("IP address %s\n", ip_addr);
- }
-
- SimpleMbedCloudClient mbedClient(&net);
- // Save pointer to mbedClient so that other functions can access it.
- client = &mbedClient;
-
- status = mbedClient.init();
- if (status) {
- return -1;
- }
-
- printf("Client initialized\r\n");
-
- // Mbed Cloud Client resource setup
- MbedCloudClientResource *button = mbedClient.create_resource("3200/0/5501", "button_resource");
- button->set_value("0");
- button->methods(M2MMethod::GET);
- button->observable(true);
- button->attach_notification_callback(button_callback);
- button_ptr = button;
-
- MbedCloudClientResource *pattern = mbedClient.create_resource("3201/0/5853", "pattern_resource");
- pattern->set_value("500:500:500:500");
- pattern->methods(M2MMethod::GET | M2MMethod::PUT);
- pattern->attach_put_callback(pattern_updated);
- pattern_ptr = pattern;
-
- MbedCloudClientResource *blink = mbedClient.create_resource("3201/0/5850", "blink_resource");
- blink->methods(M2MMethod::POST);
- blink->attach_post_callback(blink_callback);
-
- mbedClient.register_and_connect();
-
- // Wait for client to finish registering
- while (!mbedClient.is_client_registered()) {
- wait_ms(100);
- }
-
- // Placeholder for callback to update local resource when GET comes.
- //timer.attach(&button_press, 5.0);
- sw2.mode(PullUp);
- sw2.fall(button_press);
- button_count = 0;
-
- // Check if client is registering or registered, if true sleep and repeat.
- while (mbedClient.is_register_called()) {
- //static int button_count = 0;
-
- wait_ms(100);
-
- if (button_pressed) {
- button_pressed = false;
- //printf("button clicked %d times\r\n", ++button_count);
- //button->set_value(button_count);
- printf("button clicked %d times\r\n", button_count);
- }
-
- }
-
- // Client unregistered, exit program.
- return 0;
-}
+// ----------------------------------------------------------------------------
+// Copyright 2016-2018 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.
+// ----------------------------------------------------------------------------
+
+#include "mbed.h"
+#include "simple-mbed-cloud-client.h"
+#include "SDBlockDevice.h"
+#include "FATFileSystem.h"
+#include "EthernetInterface.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;
+Thread thread1;
+
+// Storage implementation definition, currently using SDBlockDevice (SPI flash, DataFlash, and internal flash are also available)
+/* K64 & K66 */
+InterruptIn sw2(SW2);
+DigitalOut led2(LED2);
+/* K64 & K66 */
+SDBlockDevice sd(PTE3, PTE1, PTE2, PTE4);
+FATFileSystem fs("sd", &sd);
+
+// Declaring pointers for access to Mbed Cloud Client resources outside of main()
+MbedCloudClientResource *button_res;
+MbedCloudClientResource *pattern_res;
+
+static bool button_pressed = false;
+static int button_count = 0;
+
+void button_press() {
+ button_pressed = true;
+ ++button_count;
+ button_res->set_value(button_count);
+}
+
+/**
+ * PUT handler
+ * @param resource The resource that triggered the callback
+ * @param newValue Updated value for the resource
+ */
+void pattern_updated(MbedCloudClientResource *resource, m2m::String newValue) {
+ printf("PUT received, new value: %s\n", newValue.c_str());
+}
+
+/**
+ * POST handler
+ * @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 blink_callback(MbedCloudClientResource *resource, const uint8_t *buffer, uint16_t size) {
+ printf("POST received. Going to blink LED pattern: %s\n", pattern_res->get_value().c_str());
+
+ static DigitalOut augmentedLed(LED1); // LED that is used for blinking the pattern
+
+ // Parse the pattern string, and toggle the LED in that pattern
+ string s = std::string(pattern_res->get_value().c_str());
+ size_t i = 0;
+ size_t pos = s.find(':');
+ while (pos != string::npos) {
+ wait_ms(atoi(s.substr(i, pos - i).c_str()));
+ augmentedLed = !augmentedLed;
+
+ i = ++pos;
+ pos = s.find(':', pos);
+
+ if (pos == string::npos) {
+ wait_ms(atoi(s.substr(i, s.length()).c_str()));
+ augmentedLed = !augmentedLed;
+ }
+ }
+}
+
+/**
+ * Notification callback handler
+ * @param resource The resource that triggered the callback
+ * @param status The delivery status of the notification
+ */
+void button_callback(MbedCloudClientResource *resource, const NoticationDeliveryStatus status) {
+ printf("Button notification, status %s (%d)\n", MbedCloudClientResource::delivery_status_to_string(status), status);
+}
+
+/**
+ * Registration callback handler
+ * @param endpoint Information about the registered endpoint such as the name (so you can find it back in portal)
+ */
+void registered(const ConnectorClientEndpointInfo *endpoint) {
+ printf("Connected to Mbed Cloud. Endpoint Name: %s\n", endpoint->internal_endpoint_name.c_str());
+}
+
+int main(void) {
+ printf("Starting Simple Mbed Cloud Client example\n");
+ printf("Connecting to the network using Ethernet...\n");
+
+ // Connect to the internet (DHCP is expected to be on)
+ EthernetInterface net;
+ nsapi_error_t status = net.connect();
+
+ if (status != 0) {
+ printf("Connecting to the network failed %d!\n", status);
+ return -1;
+ }
+
+ printf("Connected to the network successfully. IP address: %s\n", net.get_ip_address());
+
+ // SimpleMbedCloudClient handles registering over LwM2M to Mbed Cloud
+ SimpleMbedCloudClient client(&net, &sd, &fs);
+ int client_status = client.init();
+ if (client_status != 0) {
+ printf("Initializing Mbed Cloud Client failed (%d)\n", client_status);
+ return -1;
+ }
+
+ // Creating resources, which can be written or read from the cloud
+ 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);
+
+ pattern_res = client.create_resource("3201/0/5853", "blink_pattern");
+ pattern_res->set_value("500:500:500:500:500:500:500:500");
+ pattern_res->methods(M2MMethod::GET | M2MMethod::PUT);
+ pattern_res->attach_put_callback(pattern_updated);
+
+ MbedCloudClientResource *blink_res = client.create_resource("3201/0/5850", "blink_action");
+ blink_res->methods(M2MMethod::POST);
+ blink_res->attach_post_callback(blink_callback);
+
+ printf("Initialized Mbed Cloud Client. Registering...\n");
+
+ // Callback that fires when registering is complete
+ client.on_registered(®istered);
+
+ // Register with Mbed Cloud
+ client.register_and_connect();
+
+ // Setup the button
+ sw2.mode(PullUp);
+
+ // The button fall handler is placed in the event queue so it will run in
+ // thread context instead of ISR context, which allows safely updating the cloud resource
+ sw2.fall(eventQueue.event(&button_press));
+ button_count = 0;
+
+ // Start the event queue in a separate thread so the main thread continues
+ thread1.start(callback(&eventQueue, &EventQueue::dispatch_forever));
+
+ while(1)
+ {
+ wait_ms(100);
+
+ if (button_pressed) {
+ button_pressed = false;
+ printf("button clicked %d times\r\n", button_count);
+ }
+
+ }
+}
--- a/mbed-os.lib Mon Feb 19 20:37:36 2018 +0000 +++ b/mbed-os.lib Thu May 10 06:28:06 2018 -0500 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/mbed-os/#caeaa49d68c67ee00275cece10cd88e0ed0f6ed3 +https://github.com/ARMmbed/mbed-os/#caeaa49d68c67ee00275cece10cd88e0ed0f6ed3
--- a/mbed_app.json Mon Feb 19 20:37:36 2018 +0000
+++ b/mbed_app.json Thu May 10 06:28:06 2018 -0500
@@ -1,22 +1,53 @@
-{
- "macros": [
- "MBEDTLS_USER_CONFIG_FILE=\"mbedTLSConfig_mbedOS.h\"",
- "MBED_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
- "MBED_CLOUD_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
- "PAL_DTLS_PEER_MIN_TIMEOUT=5000",
- "MBED_CONF_APP_MAIN_STACK_SIZE=4608"
- ],
- "target_overrides": {
- "*": {
- "platform.stdio-baud-rate": 115200,
- "platform.stdio-convert-newlines": true,
- "mbed-trace.enable": null
- }
- },
- "config": {
- "developer-mode": {
- "help": "Enable Developer mode to skip Factory enrollment",
- "value": 1
- }
- }
-}
+{
+ "macros": [
+ "MBEDTLS_USER_CONFIG_FILE=\"mbedTLSConfig_mbedOS.h\"",
+ "PAL_USER_DEFINED_CONFIGURATION=\"sotp_fs_config_MbedOS.h\"",
+ "MBED_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
+ "MBED_CLOUD_CLIENT_USER_CONFIG_FILE=\"mbed_cloud_client_user_config.h\"",
+ "PAL_DTLS_PEER_MIN_TIMEOUT=5000",
+ "MBED_CONF_APP_MAIN_STACK_SIZE=4608",
+ "ARM_UC_USE_PAL_BLOCKDEVICE=1",
+ "MBED_CLOUD_CLIENT_UPDATE_STORAGE=ARM_UCP_FLASHIAP_BLOCKDEVICE"
+ ],
+ "target_overrides": {
+ "*": {
+ "platform.stdio-baud-rate": 115200,
+ "platform.stdio-convert-newlines": true,
+ "update-client.storage-address" : "(1024*1024*64)",
+ "update-client.storage-size" : "(1024*1024*2)",
+ "update-client.storage-locations": "1",
+ "mbed-trace.enable": null
+ }
+ },
+ "config": {
+ "format-storage-layer-on-error": {
+ "help": "Whether to format the storage layer when it cannot be read - always disable for production devices!",
+ "value": 1
+ },
+ "developer-mode": {
+ "help": "Enable Developer mode to skip Factory enrollment",
+ "value": 1
+ },
+
+ "sotp-section-1-address": {
+ "help": "Flash sector address for SOTP sector 1",
+ "macro_name": "PAL_INTERNAL_FLASH_SECTION_1_ADDRESS",
+ "value": null
+ },
+ "sotp-section-1-size": {
+ "help": "Flash sector size for SOTP sector 1",
+ "macro_name": "PAL_INTERNAL_FLASH_SECTION_1_SIZE",
+ "value": null
+ },
+ "sotp-section-2-address": {
+ "help": "Flash sector address for SOTP sector 2",
+ "macro_name": "PAL_INTERNAL_FLASH_SECTION_2_ADDRESS",
+ "value": null
+ },
+ "sotp-section-2-size": {
+ "help": "Flash sector size for SOTP sector 2",
+ "macro_name": "PAL_INTERNAL_FLASH_SECTION_2_SIZE",
+ "value": null
+ }
+ }
+}
--- a/mbed_cloud_client_user_config.h Mon Feb 19 20:37:36 2018 +0000 +++ b/mbed_cloud_client_user_config.h Thu May 10 06:28:06 2018 -0500 @@ -1,56 +1,59 @@ -// ---------------------------------------------------------------------------- -// Copyright 2016-2017 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. -// ---------------------------------------------------------------------------- - -// This file is a template and it's intented to be copied to the application -// Enable this configuration - -#ifndef MBED_CLOUD_CLIENT_USER_CONFIG_H -#define MBED_CLOUD_CLIENT_USER_CONFIG_H - - -#define MBED_CLOUD_CLIENT_ENDPOINT_TYPE "default" - -// Enable either TCP or UDP, but no both -#define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP -// MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP - -#define MBED_CLOUD_CLIENT_LIFETIME 3600 - -#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE -#define SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE 1024 - -// set flag to enable update support in mbed Cloud client -#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE - -// set download buffer size in bytes (min. 1024 bytes) - -// Use larger buffers in Linux // -#ifdef __linux__ -#define MBED_CLOUD_CLIENT_UPDATE_BUFFER (2 * 1024 * 1024) -#else -#define MBED_CLOUD_CLIENT_UPDATE_BUFFER 2048 -#endif - -// Developer flags for Update feature -#if MBED_CONF_APP_DEVELOPER_MODE == 1 - #define MBED_CLOUD_DEV_UPDATE_CERT - #define MBED_CLOUD_DEV_UPDATE_ID -#endif // MBED_CONF_APP_DEVELOPER_MODE - -#endif // MBED_CLOUD_CLIENT_USER_CONFIG_H - +// ---------------------------------------------------------------------------- +// Copyright 2016-2017 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. +// ---------------------------------------------------------------------------- + +// This file is a template and it's intented to be copied to the application +// Enable this configuration + +#ifndef MBED_CLOUD_CLIENT_USER_CONFIG_H +#define MBED_CLOUD_CLIENT_USER_CONFIG_H + +#ifdef MBED_CONF_APP_ENDPOINT_TYPE +#define MBED_CLOUD_CLIENT_ENDPOINT_TYPE MBED_CONF_APP_ENDPOINT_TYPE +#else +#define MBED_CLOUD_CLIENT_ENDPOINT_TYPE "default" +#endif + +// Enable either TCP or UDP, but no both +#define MBED_CLOUD_CLIENT_TRANSPORT_MODE_TCP +// MBED_CLOUD_CLIENT_TRANSPORT_MODE_UDP + +#define MBED_CLOUD_CLIENT_LIFETIME 3600 + +#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE +#define SN_COAP_MAX_BLOCKWISE_PAYLOAD_SIZE 1024 + +// set flag to enable update support in mbed Cloud client +#define MBED_CLOUD_CLIENT_SUPPORT_UPDATE + +// set download buffer size in bytes (min. 1024 bytes) + +// Use larger buffers in Linux // +#ifdef __linux__ +#define MBED_CLOUD_CLIENT_UPDATE_BUFFER (2 * 1024 * 1024) +#else +#define MBED_CLOUD_CLIENT_UPDATE_BUFFER 2048 +#endif + +// Developer flags for Update feature +#if MBED_CONF_APP_DEVELOPER_MODE == 1 + #define MBED_CLOUD_DEV_UPDATE_CERT + #define MBED_CLOUD_DEV_UPDATE_ID +#endif // MBED_CONF_APP_DEVELOPER_MODE + +#endif // MBED_CLOUD_CLIENT_USER_CONFIG_H +
--- a/sd-driver.lib Mon Feb 19 20:37:36 2018 +0000 +++ b/sd-driver.lib Thu May 10 06:28:06 2018 -0500 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/sd-driver/#f4ab55df7768cfcb049b522bebd30218ee729c81 +https://github.com/ARMmbed/sd-driver/#f4ab55df7768cfcb049b522bebd30218ee729c81
--- a/simple-mbed-cloud-client.lib Mon Feb 19 20:37:36 2018 +0000 +++ b/simple-mbed-cloud-client.lib Thu May 10 06:28:06 2018 -0500 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/simple-mbed-cloud-client/#2cabb6ba035e130093f0de193db1fed5eff9df43 +https://github.com/armmbed/simple-mbed-cloud-client/#3b72d712ccdb1fbdfa1bdec5209b52f5b813d819