Example program for simple-mbed-client, connecting a device to mbed Device Connector.

Dependencies:   simple-mbed-client

Fork of simple-mbed-client-example by Jan Jongboom

This is an example on how to connect to mbed Device Connector using simple-mbed-client. It can connect over Ethernet, WiFi (using an ESP8266 module or an ODIN board), Thread and 6LoWPAN.

After cloning this repository update `mbed_app.json` to reflect your connectivity method. For docs on configuring connectivity, see easy-connect.

End to end example

For an end-to-end example of using Simple mbed Client to connect devices to mbed Device Connector see Building an internet connected lighting system.

Entropy (or lack thereof)

On all platforms except the K64F and K22F the library is compiled without TLS entropy sources. This means that your code is inherently unsafe and should not be deployed to any production systems. To enable entropy, remove the MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES and MBEDTLS_TEST_NULL_ENTROPY macros from mbed_app.json.

Files at this revision

API Documentation at this revision

Comitter:
Jan Jongboom
Date:
Fri Dec 02 15:44:32 2016 +0800
Parent:
33:dc49713510e7
Child:
35:4b11d20d60e9
Commit message:
Move to mbed OS 5.2.3, get rid of Semaphore

Changed in this revision

easy-connect.lib Show annotated file Show diff for this revision Revisions of this file
main.cpp Show annotated file Show diff for this revision Revisions of this file
mbed-os.lib Show annotated file Show diff for this revision Revisions of this file
mbed_app.json Show annotated file Show diff for this revision Revisions of this file
mbedtls_mbed_client_config.h Show annotated file Show diff for this revision Revisions of this file
simple-mbed-client.lib Show annotated file Show diff for this revision Revisions of this file
--- a/easy-connect.lib	Wed Sep 28 12:39:13 2016 +0300
+++ b/easy-connect.lib	Fri Dec 02 15:44:32 2016 +0800
@@ -1,1 +1,1 @@
-https://github.com/armmbed/easy-connect/#5a733bd2750342660d9021bfc9b3583ca8c62668
+https://github.com/armmbed/easy-connect/#67d50bbba064b284ec7710e217f0f689c4ed1d78
--- a/main.cpp	Wed Sep 28 12:39:13 2016 +0300
+++ b/main.cpp	Fri Dec 02 15:44:32 2016 +0800
@@ -3,62 +3,84 @@
 #include "easy-connect.h"
 #include "simple-mbed-client.h"
 
-Serial pc(USBTX, USBRX);
+EventQueue eventQueue(32 * EVENTS_EVENT_SIZE);  // Event queue!
+
 SimpleMbedClient client;
 
-DigitalOut led(LED1);
-DigitalOut blinkLed(LED2);
-InterruptIn btn(MBED_CONF_APP_BUTTON);
-Semaphore updates(0);
+// Declare peripherals
+DigitalOut connectivityLed(LED2); // Blinks while connecting, turns solid when connected
+DigitalOut augmentedLed(LED1, BUILTIN_LED_OFF);  // LED that can be controlled through Connector
+InterruptIn btn(MBED_CONF_APP_BUTTON); // Button that sends it's count to Connector
 
+Ticker connectivityTicker;
+
+// Callback function when the pattern resource is updated
 void patternUpdated(string v) {
     printf("New pattern: %s\n", v.c_str());
 }
 
+// Define resources here. They act as normal variables, but are exposed to the internet...
 SimpleResourceInt btn_count = client.define_resource("button/0/clicks", 0, M2MBase::GET_ALLOWED);
 SimpleResourceString pattern = client.define_resource("led/0/pattern", "500:500:500:500:500:500:500", &patternUpdated);
 
 void fall() {
-    updates.release();
+    btn_count = btn_count + 1;
+    printf("Button count is now %d\r\n", static_cast<int>(btn_count));
 }
 
-void toggleLed() {
-    led = !led;
+void toggleConnectivityLed() {
+    connectivityLed = !connectivityLed;
 }
 
 void registered() {
-    pc.printf("Registered\r\n");
-}
-void unregistered() {
-    pc.printf("Unregistered\r\n");
+    printf("Registered\r\n");
+
+    connectivityTicker.detach();
+    connectivityLed = BUILTIN_LED_ON;
 }
 
 void play(void* args) {
+    connectivityLed = BUILTIN_LED_OFF;
+
+    // Parse the pattern string, and toggle the LED in that pattern
     stringstream ss(pattern);
     string item;
     while(getline(ss, item, ':')) {
         wait_ms(atoi((const char*)item.c_str()));
-        blinkLed = !blinkLed;
+        augmentedLed = !augmentedLed;
     }
+
+    augmentedLed = BUILTIN_LED_OFF;
+    connectivityLed = BUILTIN_LED_ON;
 }
 
 int main() {
-    pc.baud(115200);
+    // Run a separate Thread to process events in
+    rtos::Thread et;
+    et.start(callback(&eventQueue, &EventQueue::dispatch_forever));
 
-    btn.fall(&fall);
+    // Handle interrupts on the eventQueue - so we don't do things in interrupt context
+    btn.fall(eventQueue.event(&fall));
 
-    Ticker t;
-    t.attach(&toggleLed, 1.0f);
+    // Toggle the built-in LED every second (until we're connected, see `registered` function)
+    connectivityTicker.attach(eventQueue.event(toggleConnectivityLed), 1.0f);
 
+    // Keep alive ticker (every 25 seconds)
+    eventQueue.call_every(25000, callback(&client, &SimpleMbedClient::keep_alive));
+
+    // Functions can be executed through mbed Device Connector via POST calls
     client.define_function("led/0/play", &play);
 
+    // Connect to the internet (see mbed_app.json for the connectivity method)
     NetworkInterface* network = easy_connect(true);
     if (!network) {
         return 1;
     }
 
+    // Connect to mbed Device Connector
     struct MbedClientOptions opts = client.get_default_options();
     opts.ServerAddress = MBED_SERVER_ADDRESS;
+
     bool setup = client.setup(opts, network);
     if (!setup) {
         printf("Client setup failed\n");
@@ -66,14 +88,6 @@
     }
 
     client.on_registered(&registered);
-    client.on_unregistered(&unregistered);
 
-    while (1) {
-        int v = updates.wait(25000);
-        if (v == 1) {
-            btn_count = btn_count + 1;
-            printf("Button count is now %d\n", static_cast<int>(btn_count));
-        }
-        client.keep_alive();
-    }
+    while (1) {}
 }
--- a/mbed-os.lib	Wed Sep 28 12:39:13 2016 +0300
+++ b/mbed-os.lib	Fri Dec 02 15:44:32 2016 +0800
@@ -1,1 +1,1 @@
-https://github.com/mbedmicro/mbed/#21dd7008a1540c02150f1b87c12294301db979bb
+https://github.com/mbedmicro/mbed/#d5de476f74dd4de27012eb74ede078f6330dfc3f
--- a/mbed_app.json	Wed Sep 28 12:39:13 2016 +0300
+++ b/mbed_app.json	Fri Dec 02 15:44:32 2016 +0800
@@ -4,6 +4,10 @@
             "help": "options are ETHERNET,WIFI_ESP8266,MESH_LOWPAN_ND,MESH_THREAD",
             "value": "ETHERNET"
         },
+        "mesh_radio_type": {
+        	"help": "options are ATMEL, MCR20",
+        	"value": "ATMEL"
+        },
         "esp8266-tx": {
             "help": "Pin used as TX (connects to ESP8266 RX)",
             "value": "D1"
@@ -24,14 +28,30 @@
         "button": {
             "help": "Pin which you'll use as button (can be overriden per target below)",
             "value": "BUTTON1"
+        },
+        "builtin_led_on": {
+            "help": "Value to write to built-in LEDs to turn them on",
+            "value": 1,
+            "macro_name": "BUILTIN_LED_ON"
+        },
+        "builtin_led_off": {
+            "help": "Value to write to built-in LEDs to turn them off",
+            "value": 0,
+            "macro_name": "BUILTIN_LED_OFF"
         }
     },
+    "macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_mbed_client_config.h\""],
     "target_overrides": {
         "*": {
-            "target.features_add": ["IPV4", "IPV6"]
+            "target.features_add": ["NANOSTACK", "LOWPAN_ROUTER", "COMMON_PAL"],
+            "mbed-mesh-api.6lowpan-nd-channel-page": 0,
+            "mbed-mesh-api.6lowpan-nd-channel": 12,
+            "mbed-trace.enable": 0
         },
         "K64F": {
-            "button": "SW2"
+            "button": "SW2",
+            "builtin_led_on": 0,
+            "builtin_led_off": 1
         },
         "HEXIWEAR": {
             "button": "PTA12",
@@ -42,6 +62,14 @@
             "button": "USER_BUTTON",
             "esp8266-tx": "D8",
             "esp8266-rx": "D2"
+        },
+        "NUCLEO_F411RE": {
+            "button": "USER_BUTTON",
+            "esp8266-tx": "D8",
+            "esp8266-rx": "D2"
+        },
+        "NUMAKER_PFM_NUC472": {
+            "button": "SW1"
         }
     }
 }
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbedtls_mbed_client_config.h	Fri Dec 02 15:44:32 2016 +0800
@@ -0,0 +1,111 @@
+/**
+ *  Minimal configuration for using mbedtls as part of mbed-client
+ *
+ *  NOTE! This is an optimized, minimal configuration for mbed Client.
+ *  We know it works with mbed Client but if you want to add more
+ *  services/communications to the application yourself - please ensure
+ *  you update this configuration accordingly. The default configuration
+ *  can be found from mbedTLS Github:
+ *
+ *  https://github.com/ARMmbed/mbedtls/blob/development/include/mbedtls/config.h
+ *
+ *
+ *  Copyright (C) 2006-2016, 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.
+ *
+ *  This file is part of mbed TLS (https://tls.mbed.org)
+ */
+
+
+#ifndef MBEDTLS_CUSTOM_CONFIG_H
+#define MBEDTLS_CUSTOM_CONFIG_H
+
+/* System support */
+#define MBEDTLS_HAVE_ASM
+
+/* mbed TLS feature support */
+#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
+#define MBEDTLS_ECP_NIST_OPTIM
+#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
+#define MBEDTLS_SSL_PROTO_TLS1_2
+#define MBEDTLS_SSL_PROTO_DTLS
+#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
+#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
+#define MBEDTLS_SSL_EXPORT_KEYS
+
+/* mbed TLS modules */
+#define MBEDTLS_AES_C
+#define MBEDTLS_ASN1_PARSE_C
+#define MBEDTLS_ASN1_WRITE_C
+#define MBEDTLS_BIGNUM_C
+#define MBEDTLS_CIPHER_C
+#define MBEDTLS_CTR_DRBG_C
+#define MBEDTLS_ECP_C
+#define MBEDTLS_ENTROPY_C
+#define MBEDTLS_MD_C
+#define MBEDTLS_OID_C
+#define MBEDTLS_PK_C
+#define MBEDTLS_PK_PARSE_C
+#define MBEDTLS_SHA256_C
+#define MBEDTLS_SSL_COOKIE_C
+#define MBEDTLS_SSL_CLI_C
+#define MBEDTLS_SSL_SRV_C
+#define MBEDTLS_SSL_TLS_C
+
+// XXX mbedclient needs these: mbedtls_x509_crt_free, mbedtls_x509_crt_init, mbedtls_x509_crt_parse
+#define MBEDTLS_X509_USE_C
+#define MBEDTLS_X509_CRT_PARSE_C
+
+// XXX: clean these up!!
+#define MBEDTLS_SHA512_C
+#define MBEDTLS_ECDH_C
+#define MBEDTLS_GCM_C
+
+#define MBEDTLS_ECDH_C
+#define MBEDTLS_ECDSA_C
+#define MBEDTLS_X509_CRT_PARSE_C
+
+// Remove RSA, save 20KB at total
+#undef MBEDTLS_RSA_C
+#undef MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
+
+// Remove error messages, save 10KB of ROM
+#undef MBEDTLS_ERROR_C
+
+// Remove selftesting and save 11KB of ROM
+#undef MBEDTLS_SELF_TEST
+
+// Reduces ROM size by 30 kB
+#undef MBEDTLS_ERROR_STRERROR_DUMMY
+#undef MBEDTLS_VERSION_FEATURES
+#undef MBEDTLS_DEBUG_C
+
+// needed for parsing the certificates
+#define MBEDTLS_PEM_PARSE_C
+// dep of the previous
+#define MBEDTLS_BASE64_C
+
+// Reduce IO buffer to save RAM, default is 16KB
+#define MBEDTLS_SSL_MAX_CONTENT_LEN 2048
+
+// define to save 8KB RAM at the expense of ROM
+#undef MBEDTLS_AES_ROM_TABLES
+
+// Save ROM and a few bytes of RAM by specifying our own ciphersuite list
+#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
+
+#include "mbedtls/check_config.h"
+
+#endif /* MBEDTLS_CUSTOM_CONFIG_H */
\ No newline at end of file
--- a/simple-mbed-client.lib	Wed Sep 28 12:39:13 2016 +0300
+++ b/simple-mbed-client.lib	Fri Dec 02 15:44:32 2016 +0800
@@ -1,1 +1,1 @@
-https://developer.mbed.org/teams/sandbox/code/simple-mbed-client/#26810c6b58e1
+https://developer.mbed.org/teams/sandbox/code/simple-mbed-client/#a98cabe88e0f