Jim Carver
Garage Door Monitor and Opener
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
Introduction
This system implements a simple garage door opener and environmental monitor. The hardware connects to the internet using Wi-Fi then on to the Pelion Device Management Platform which provides device monitoring and secure firmware updates over the air (FOTA). Pelion Device Management provides a flexible set of REST APIs which we will use to communicate to a web application running on an EC-2 instance in AWS. The web application will serve a web page where we can monitor and control our garage..
This project is intended to work on the DISCO-L475VG-IOT01A from ST Microelectronics It implements a simple actuator to drive a relay to simulate pushing the "open" button on older style garage doors which do not use a rolling code interface.
The system is designed to be mounted over the door so that the on board time of flight sensor can be used to detect if the door is open or closed.
The system also monitors temperature, humidity and barometric pressure.
Hardware Requirements:
DISCO-L475G-IOT01A https://os.mbed.com/platforms/ST-Discovery-L475E-IOT01A/
Seeed Studio Grove Relay module https://www.seeedstudio.com/Grove-Relay.html
Seeed Studio Grove cable, I used this one: https://www.seeedstudio.com/Grove-4-pin-Male-Jumper-to-Grove-4-pin-Conversion-Cable-5-PCs-per-Pack.html
Connect to the PMOD connector like this:
This shows how I installed so that the time of flight sensor can detect when the door is open
To use the project:
You will also need a Pelion developers account.
I suggest you first use the Pelion quick state to become familiar with Pelion Device Management. https://os.mbed.com/guides/connect-device-to-pelion/1/?board=ST-Discovery-L475E-IOT01A
Web Interface
For my web interface I am running node-red under Ubuntu in an EC2 instance on AWS. This can run for 12 month within the constraints of their free tier. Here is a tutorial: https://nodered.org/docs/getting-started/aws
You will also need to install several node-red add ons:
sudo npm install -g node-red-dashboard
sudo npm install -g node-red-contrib-mbed-cloud
sudo npm istall -g node-red-contrib-moment
After starting node-red import the contents of GarageFlow.txt from the project, pin the flow into the page.
To enable your web app to access your Pelion account you need an API key.
First you will neet to use your Pelion account to create an API key.
Now we need to apply that API key to your Node-Red flow.
Revision 1:e86b1cffc402, committed 2018-02-23
- Comitter:
- adustm
- Date:
- Fri Feb 23 18:38:12 2018 +0100
- Parent:
- 0:72fe5fb6309c
- Child:
- 2:def96d631971
- Commit message:
- Add initial files
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp Fri Feb 23 18:38:12 2018 +0100
@@ -0,0 +1,167 @@
+// ----------------------------------------------------------------------------
+// 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 "ISM43362Interface.h"
+
+// Placeholder to hardware that trigger events (timer, button, etc)
+Ticker timer;
+
+// Placeholder for storage
+SDBlockDevice sd(SPI_MOSI, SPI_MISO, SPI_SCK, SPI_CS);
+FATFileSystem fs("sd");
+
+// Pointers to the resources that will be created in main_application().
+static MbedCloudClientResource* pattern_ptr;
+
+// Pointer to mbedClient, used for calling close function.
+static SimpleMbedCloudClient *client;
+
+static bool button_pressed = false;
+
+void button_press() {
+ button_pressed = true;
+}
+
+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.
+}
+
+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
+ printf("Start Simple Mbed Cloud Client\n");
+ ISM43362Interface net(MBED_CONF_APP_WIFI_SPI_MOSI, MBED_CONF_APP_WIFI_SPI_MISO, MBED_CONF_APP_WIFI_SPI_SCLK, MBED_CONF_APP_WIFI_SPI_NSS, MBED_CONF_APP_WIFI_RESET, MBED_CONF_APP_WIFI_DATAREADY, MBED_CONF_APP_WIFI_WAKEUP, false);
+
+
+ // 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 Wifi...\n");
+
+ status = net.connect(MBED_CONF_APP_WIFI_SSID, MBED_CONF_APP_WIFI_PASSWORD, (strlen(MBED_CONF_APP_WIFI_PASSWORD) > 1) ? NSAPI_SECURITY_WPA_WPA2 : NSAPI_SECURITY_NONE);
+ 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) {
+ printf("FAILED\r\n");
+ 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);
+
+ 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);
+
+ // 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("Simulated button clicked %d times\r\n", ++button_count);
+ button->set_value(button_count);
+ }
+ }
+
+ // Client unregistered, exit program.
+ return 0;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed_app.json Fri Feb 23 18:38:12 2018 +0100
@@ -0,0 +1,67 @@
+{
+ "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=6000",
+ "MBED_CONF_APP_THREAD_STACK_SIZE=6000"
+ ],
+ "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
+ },
+ "wifi-ssid": {
+ "help": "WiFi SSID",
+ "value": "\"SSID\""
+ },
+ "wifi-password": {
+ "help": "WiFi Password",
+ "value": "\"PASSWORD\""
+ },
+ "wifi-tx": {
+ "help": "TX pin for serial connection to external device",
+ "value": "D1"
+ },
+ "wifi-rx": {
+ "help": "RX pin for serial connection to external device",
+ "value": "D0"
+ },
+ "wifi-spi_miso": {
+ "help": "SPI-MISO connection to external device",
+ "value": "PC_11"
+ },
+ "wifi-spi_mosi": {
+ "help": "SPI-MOSI connection to external device",
+ "value": "PC_12"
+ },
+ "wifi-spi_sclk": {
+ "help": "SPI-CLOCK connection to external device",
+ "value": "PC_10"
+ },
+ "wifi-spi_nss": {
+ "help": "SPI chip select of external device",
+ "value": "PE_0"
+ },
+ "wifi-reset": {
+ "help": "WIFI module reset pin",
+ "value": "PE_8"
+ },
+ "wifi-dataready": {
+ "help": "WIFI module data ready pin",
+ "value": "PE_1"
+ },
+ "wifi-wakeup": {
+ "help": "WIFI module wakeup pin",
+ "value": "PB_12"
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed_cloud_client_user_config.h Fri Feb 23 18:38:12 2018 +0100 @@ -0,0 +1,56 @@ +// ---------------------------------------------------------------------------- +// 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 +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed_cloud_dev_credentials.c Fri Feb 23 18:38:12 2018 +0100
@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+#ifndef __MBED_CLOUD_DEV_CREDENTIALS_H__
+#define __MBED_CLOUD_DEV_CREDENTIALS_H__
+
+#if MBED_CONF_APP_DEVELOPER_MODE == 1
+#error "Replace mbed_cloud_dev_credentials.c with your own developer cert."
+#endif
+
+#include <inttypes.h>
+
+const char MBED_CLOUD_DEV_BOOTSTRAP_ENDPOINT_NAME[] = "";
+const char MBED_CLOUD_DEV_ACCOUNT_ID[] = "";
+const char MBED_CLOUD_DEV_BOOTSTRAP_SERVER_URI[] = "";
+
+const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE[] =
+{ 0x0 };
+
+const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE[] =
+{ 0x0 };
+
+const uint8_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY[] =
+{ 0x0 };
+
+const char MBED_CLOUD_DEV_MANUFACTURER[] = "dev_manufacturer";
+
+const char MBED_CLOUD_DEV_MODEL_NUMBER[] = "dev_model_num";
+
+const char MBED_CLOUD_DEV_SERIAL_NUMBER[] = "0";
+
+const char MBED_CLOUD_DEV_DEVICE_TYPE[] = "dev_device_type";
+
+const char MBED_CLOUD_DEV_HARDWARE_VERSION[] = "dev_hardware_version";
+
+const uint32_t MBED_CLOUD_DEV_MEMORY_TOTAL_KB = 0;
+const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_CERTIFICATE);
+const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_SERVER_ROOT_CA_CERTIFICATE);
+const uint32_t MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY_SIZE = sizeof(MBED_CLOUD_DEV_BOOTSTRAP_DEVICE_PRIVATE_KEY);
+
+#endif //__MBED_CLOUD_DEV_CREDENTIALS_H__
+
\ No newline at end of file