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.

https://os.mbed.com/media/uploads/JimCarver/garageopener.jpg

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:

https://os.mbed.com/media/uploads/JimCarver/opener.jpg

This shows how I installed so that the time of flight sensor can detect when the door is open

https://os.mbed.com/media/uploads/JimCarver/opener1.jpg https://os.mbed.com/media/uploads/JimCarver/opener2.jpg

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.

https://os.mbed.com/media/uploads/JimCarver/api_portal.jpg

Now we need to apply that API key to your Node-Red flow.

https://os.mbed.com/media/uploads/JimCarver/api_node-red.jpg

Committer:
JimCarver
Date:
Thu Dec 05 19:03:48 2019 +0000
Revision:
37:ec1124e5ec1f
Parent:
18:a15bfe7aaebd
Bug fix

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 18:a15bfe7aaebd 1 /*******************************************************************************
screamer 18:a15bfe7aaebd 2 Copyright © 2015, STMicroelectronics International N.V.
screamer 18:a15bfe7aaebd 3 All rights reserved.
screamer 18:a15bfe7aaebd 4
screamer 18:a15bfe7aaebd 5 Redistribution and use in source and binary forms, with or without
screamer 18:a15bfe7aaebd 6 modification, are permitted provided that the following conditions are met:
screamer 18:a15bfe7aaebd 7 * Redistributions of source code must retain the above copyright
screamer 18:a15bfe7aaebd 8 notice, this list of conditions and the following disclaimer.
screamer 18:a15bfe7aaebd 9 * Redistributions in binary form must reproduce the above copyright
screamer 18:a15bfe7aaebd 10 notice, this list of conditions and the following disclaimer in the
screamer 18:a15bfe7aaebd 11 documentation and/or other materials provided with the distribution.
screamer 18:a15bfe7aaebd 12 * Neither the name of STMicroelectronics nor the
screamer 18:a15bfe7aaebd 13 names of its contributors may be used to endorse or promote products
screamer 18:a15bfe7aaebd 14 derived from this software without specific prior written permission.
screamer 18:a15bfe7aaebd 15
screamer 18:a15bfe7aaebd 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
screamer 18:a15bfe7aaebd 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
screamer 18:a15bfe7aaebd 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
screamer 18:a15bfe7aaebd 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
screamer 18:a15bfe7aaebd 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
screamer 18:a15bfe7aaebd 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
screamer 18:a15bfe7aaebd 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
screamer 18:a15bfe7aaebd 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
screamer 18:a15bfe7aaebd 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
screamer 18:a15bfe7aaebd 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
screamer 18:a15bfe7aaebd 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
screamer 18:a15bfe7aaebd 27 ********************************************************************************/
screamer 18:a15bfe7aaebd 28
screamer 18:a15bfe7aaebd 29
screamer 18:a15bfe7aaebd 30 #ifndef _VL53L0X_PLATFORM_H_
screamer 18:a15bfe7aaebd 31 #define _VL53L0X_PLATFORM_H_
screamer 18:a15bfe7aaebd 32
screamer 18:a15bfe7aaebd 33 #include "VL53L0X_def.h"
screamer 18:a15bfe7aaebd 34 #include "VL53L0X_platform_log.h"
screamer 18:a15bfe7aaebd 35 #include "VL53L0X_i2c_platform.h"
screamer 18:a15bfe7aaebd 36
screamer 18:a15bfe7aaebd 37 #ifdef __cplusplus
screamer 18:a15bfe7aaebd 38 extern "C" {
screamer 18:a15bfe7aaebd 39 #endif
screamer 18:a15bfe7aaebd 40
screamer 18:a15bfe7aaebd 41 /**
screamer 18:a15bfe7aaebd 42 * @file vl53l0_platform.h
screamer 18:a15bfe7aaebd 43 *
screamer 18:a15bfe7aaebd 44 * @brief All end user OS/platform/application porting
screamer 18:a15bfe7aaebd 45 */
screamer 18:a15bfe7aaebd 46
screamer 18:a15bfe7aaebd 47 /**
screamer 18:a15bfe7aaebd 48 * @defgroup VL53L0X_platform_group VL53L0 Platform Functions
screamer 18:a15bfe7aaebd 49 * @brief VL53L0 Platform Functions
screamer 18:a15bfe7aaebd 50 * @{
screamer 18:a15bfe7aaebd 51 */
screamer 18:a15bfe7aaebd 52
screamer 18:a15bfe7aaebd 53 /**
screamer 18:a15bfe7aaebd 54 * @struct VL53L0X_Dev_t
screamer 18:a15bfe7aaebd 55 * @brief Generic PAL device type that does link between API and platform abstraction layer
screamer 18:a15bfe7aaebd 56 *
screamer 18:a15bfe7aaebd 57 */
screamer 18:a15bfe7aaebd 58 typedef struct {
screamer 18:a15bfe7aaebd 59 VL53L0X_DevData_t Data; /*!< embed ST Ewok Dev data as "Data"*/
screamer 18:a15bfe7aaebd 60
screamer 18:a15bfe7aaebd 61 /*!< user specific field */
screamer 18:a15bfe7aaebd 62 uint8_t I2cDevAddr; /*!< i2c device address user specific field */
screamer 18:a15bfe7aaebd 63 uint8_t comms_type; /*!< Type of comms : VL53L0X_COMMS_I2C or VL53L0X_COMMS_SPI */
screamer 18:a15bfe7aaebd 64 uint16_t comms_speed_khz; /*!< Comms speed [kHz] : typically 400kHz for I2C */
screamer 18:a15bfe7aaebd 65
screamer 18:a15bfe7aaebd 66 } VL53L0X_Dev_t;
screamer 18:a15bfe7aaebd 67
screamer 18:a15bfe7aaebd 68
screamer 18:a15bfe7aaebd 69 /**
screamer 18:a15bfe7aaebd 70 * @brief Declare the device Handle as a pointer of the structure @a VL53L0X_Dev_t.
screamer 18:a15bfe7aaebd 71 *
screamer 18:a15bfe7aaebd 72 */
screamer 18:a15bfe7aaebd 73 typedef VL53L0X_Dev_t *VL53L0X_DEV;
screamer 18:a15bfe7aaebd 74
screamer 18:a15bfe7aaebd 75 /**
screamer 18:a15bfe7aaebd 76 * @def PALDevDataGet
screamer 18:a15bfe7aaebd 77 * @brief Get ST private structure @a VL53L0X_DevData_t data access
screamer 18:a15bfe7aaebd 78 *
screamer 18:a15bfe7aaebd 79 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 80 * @param field ST structure field name
screamer 18:a15bfe7aaebd 81 * It maybe used and as real data "ref" not just as "get" for sub-structure item
screamer 18:a15bfe7aaebd 82 * like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
screamer 18:a15bfe7aaebd 83 */
screamer 18:a15bfe7aaebd 84 #define PALDevDataGet(Dev, field) (Dev->Data.field)
screamer 18:a15bfe7aaebd 85
screamer 18:a15bfe7aaebd 86 /**
screamer 18:a15bfe7aaebd 87 * @def PALDevDataSet(Dev, field, data)
screamer 18:a15bfe7aaebd 88 * @brief Set ST private structure @a VL53L0X_DevData_t data field
screamer 18:a15bfe7aaebd 89 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 90 * @param field ST structure field name
screamer 18:a15bfe7aaebd 91 * @param data Data to be set
screamer 18:a15bfe7aaebd 92 */
screamer 18:a15bfe7aaebd 93 #define PALDevDataSet(Dev, field, data) (Dev->Data.field)=(data)
screamer 18:a15bfe7aaebd 94
screamer 18:a15bfe7aaebd 95
screamer 18:a15bfe7aaebd 96 /**
screamer 18:a15bfe7aaebd 97 * @defgroup VL53L0X_registerAccess_group PAL Register Access Functions
screamer 18:a15bfe7aaebd 98 * @brief PAL Register Access Functions
screamer 18:a15bfe7aaebd 99 * @{
screamer 18:a15bfe7aaebd 100 */
screamer 18:a15bfe7aaebd 101
screamer 18:a15bfe7aaebd 102 /**
screamer 18:a15bfe7aaebd 103 * Lock comms interface to serialize all commands to a shared I2C interface for a specific device
screamer 18:a15bfe7aaebd 104 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 105 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 106 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 107 */
screamer 18:a15bfe7aaebd 108 VL53L0X_Error VL53L0X_LockSequenceAccess(VL53L0X_DEV Dev);
screamer 18:a15bfe7aaebd 109
screamer 18:a15bfe7aaebd 110 /**
screamer 18:a15bfe7aaebd 111 * Unlock comms interface to serialize all commands to a shared I2C interface for a specific device
screamer 18:a15bfe7aaebd 112 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 113 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 114 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 115 */
screamer 18:a15bfe7aaebd 116 VL53L0X_Error VL53L0X_UnlockSequenceAccess(VL53L0X_DEV Dev);
screamer 18:a15bfe7aaebd 117
screamer 18:a15bfe7aaebd 118
screamer 18:a15bfe7aaebd 119 /**
screamer 18:a15bfe7aaebd 120 * Writes the supplied byte buffer to the device
screamer 18:a15bfe7aaebd 121 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 122 * @param index The register index
screamer 18:a15bfe7aaebd 123 * @param pdata Pointer to uint8_t buffer containing the data to be written
screamer 18:a15bfe7aaebd 124 * @param count Number of bytes in the supplied byte buffer
screamer 18:a15bfe7aaebd 125 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 126 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 127 */
screamer 18:a15bfe7aaebd 128 VL53L0X_Error VL53L0X_WriteMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
screamer 18:a15bfe7aaebd 129
screamer 18:a15bfe7aaebd 130 /**
screamer 18:a15bfe7aaebd 131 * Reads the requested number of bytes from the device
screamer 18:a15bfe7aaebd 132 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 133 * @param index The register index
screamer 18:a15bfe7aaebd 134 * @param pdata Pointer to the uint8_t buffer to store read data
screamer 18:a15bfe7aaebd 135 * @param count Number of uint8_t's to read
screamer 18:a15bfe7aaebd 136 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 137 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 138 */
screamer 18:a15bfe7aaebd 139 VL53L0X_Error VL53L0X_ReadMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
screamer 18:a15bfe7aaebd 140
screamer 18:a15bfe7aaebd 141 /**
screamer 18:a15bfe7aaebd 142 * Write single byte register
screamer 18:a15bfe7aaebd 143 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 144 * @param index The register index
screamer 18:a15bfe7aaebd 145 * @param data 8 bit register data
screamer 18:a15bfe7aaebd 146 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 147 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 148 */
screamer 18:a15bfe7aaebd 149 VL53L0X_Error VL53L0X_WrByte(VL53L0X_DEV Dev, uint8_t index, uint8_t data);
screamer 18:a15bfe7aaebd 150
screamer 18:a15bfe7aaebd 151 /**
screamer 18:a15bfe7aaebd 152 * Write word register
screamer 18:a15bfe7aaebd 153 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 154 * @param index The register index
screamer 18:a15bfe7aaebd 155 * @param data 16 bit register data
screamer 18:a15bfe7aaebd 156 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 157 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 158 */
screamer 18:a15bfe7aaebd 159 VL53L0X_Error VL53L0X_WrWord(VL53L0X_DEV Dev, uint8_t index, uint16_t data);
screamer 18:a15bfe7aaebd 160
screamer 18:a15bfe7aaebd 161 /**
screamer 18:a15bfe7aaebd 162 * Write double word (4 byte) register
screamer 18:a15bfe7aaebd 163 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 164 * @param index The register index
screamer 18:a15bfe7aaebd 165 * @param data 32 bit register data
screamer 18:a15bfe7aaebd 166 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 167 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 168 */
screamer 18:a15bfe7aaebd 169 VL53L0X_Error VL53L0X_WrDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t data);
screamer 18:a15bfe7aaebd 170
screamer 18:a15bfe7aaebd 171 /**
screamer 18:a15bfe7aaebd 172 * Read single byte register
screamer 18:a15bfe7aaebd 173 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 174 * @param index The register index
screamer 18:a15bfe7aaebd 175 * @param data pointer to 8 bit data
screamer 18:a15bfe7aaebd 176 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 177 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 178 */
screamer 18:a15bfe7aaebd 179 VL53L0X_Error VL53L0X_RdByte(VL53L0X_DEV Dev, uint8_t index, uint8_t *data);
screamer 18:a15bfe7aaebd 180
screamer 18:a15bfe7aaebd 181 /**
screamer 18:a15bfe7aaebd 182 * Read word (2byte) register
screamer 18:a15bfe7aaebd 183 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 184 * @param index The register index
screamer 18:a15bfe7aaebd 185 * @param data pointer to 16 bit data
screamer 18:a15bfe7aaebd 186 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 187 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 188 */
screamer 18:a15bfe7aaebd 189 VL53L0X_Error VL53L0X_RdWord(VL53L0X_DEV Dev, uint8_t index, uint16_t *data);
screamer 18:a15bfe7aaebd 190
screamer 18:a15bfe7aaebd 191 /**
screamer 18:a15bfe7aaebd 192 * Read dword (4byte) register
screamer 18:a15bfe7aaebd 193 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 194 * @param index The register index
screamer 18:a15bfe7aaebd 195 * @param data pointer to 32 bit data
screamer 18:a15bfe7aaebd 196 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 197 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 198 */
screamer 18:a15bfe7aaebd 199 VL53L0X_Error VL53L0X_RdDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t *data);
screamer 18:a15bfe7aaebd 200
screamer 18:a15bfe7aaebd 201 /**
screamer 18:a15bfe7aaebd 202 * Threat safe Update (read/modify/write) single byte register
screamer 18:a15bfe7aaebd 203 *
screamer 18:a15bfe7aaebd 204 * Final_reg = (Initial_reg & and_data) |or_data
screamer 18:a15bfe7aaebd 205 *
screamer 18:a15bfe7aaebd 206 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 207 * @param index The register index
screamer 18:a15bfe7aaebd 208 * @param AndData 8 bit and data
screamer 18:a15bfe7aaebd 209 * @param OrData 8 bit or data
screamer 18:a15bfe7aaebd 210 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 211 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 212 */
screamer 18:a15bfe7aaebd 213 VL53L0X_Error VL53L0X_UpdateByte(VL53L0X_DEV Dev, uint8_t index, uint8_t AndData, uint8_t OrData);
screamer 18:a15bfe7aaebd 214
screamer 18:a15bfe7aaebd 215 /** @} end of VL53L0X_registerAccess_group */
screamer 18:a15bfe7aaebd 216
screamer 18:a15bfe7aaebd 217
screamer 18:a15bfe7aaebd 218 /**
screamer 18:a15bfe7aaebd 219 * @brief execute delay in all polling API call
screamer 18:a15bfe7aaebd 220 *
screamer 18:a15bfe7aaebd 221 * A typical multi-thread or RTOs implementation is to sleep the task for some 5ms (with 100Hz max rate faster polling is not needed)
screamer 18:a15bfe7aaebd 222 * if nothing specific is need you can define it as an empty/void macro
screamer 18:a15bfe7aaebd 223 * @code
screamer 18:a15bfe7aaebd 224 * #define VL53L0X_PollingDelay(...) (void)0
screamer 18:a15bfe7aaebd 225 * @endcode
screamer 18:a15bfe7aaebd 226 * @param Dev Device Handle
screamer 18:a15bfe7aaebd 227 * @return VL53L0X_ERROR_NONE Success
screamer 18:a15bfe7aaebd 228 * @return "Other error code" See ::VL53L0X_Error
screamer 18:a15bfe7aaebd 229 */
screamer 18:a15bfe7aaebd 230 VL53L0X_Error VL53L0X_PollingDelay(VL53L0X_DEV Dev); /* usually best implemented as a real function */
screamer 18:a15bfe7aaebd 231
screamer 18:a15bfe7aaebd 232 /** @} end of VL53L0X_platform_group */
screamer 18:a15bfe7aaebd 233
screamer 18:a15bfe7aaebd 234 #ifdef __cplusplus
screamer 18:a15bfe7aaebd 235 }
screamer 18:a15bfe7aaebd 236 #endif
screamer 18:a15bfe7aaebd 237
screamer 18:a15bfe7aaebd 238 #endif /* _VL53L0X_PLATFORM_H_ */
screamer 18:a15bfe7aaebd 239
screamer 18:a15bfe7aaebd 240
screamer 18:a15bfe7aaebd 241
screamer 18:a15bfe7aaebd 242