Maxim Integrated / Mbed 2 deprecated DeepCover Embedded Security in IoT

MAXREFDES143#: DeepCover Embedded Security in IoT Authenticated Sensing & Notification

Dependencies:   MaximInterface mbed

The MAXREFDES143# is an Internet of Things (IoT) embedded security reference design, built to protect an industrial sensing node by means of authentication and notification to a web server. The hardware includes a peripheral module representing a protected sensor node monitoring operating temperature and remaining life of a filter (simulated through ambient light sensing) and an mbed shield representing a controller node responsible for monitoring one or more sensor nodes. The design is hierarchical with each controller node communicating data from connected sensor nodes to a web server that maintains a centralized log and dispatches notifications as necessary. The mbed shield contains a Wi-Fi module, a DS2465 coprocessor with 1-Wire® master function, an LCD, LEDs, and pushbuttons. The protected sensor node contains a DS28E15 authenticator, a DS7505 temperature sensor, and a MAX44009 light sensor. The mbed shield communicates to a web server by the onboard Wi-Fi module and to the protected sensor node with I2C and 1-Wire. The MAXREFDES143# is equipped with a standard shield connector for immediate testing using an mbed board such as the MAX32600MBED#. The simplicity of this design enables rapid integration into any star-topology IoT network requiring the heightened security with low overhead provided by the SHA-256 symmetric-key algorithm.

More information about the MAXREFDES143# is available on the Maxim Integrated website.

main.cpp@5:63232ef22abe, 2016-04-20 (annotated)

Committer:
IanBenzMaxim
Date:
Wed Apr 20 20:13:33 2016 +0000
Revision:
5:63232ef22abe
Parent:
4:71d578d3af22
Child:
6:b6bafd0a7013
Always give the user a chance to provision when an invalid sensor node is detected before retrying authentication.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 1:e1c7c1c636af 1 /*******************************************************************************
IanBenzMaxim 1:e1c7c1c636af 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 1:e1c7c1c636af 3 *
IanBenzMaxim 1:e1c7c1c636af 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 1:e1c7c1c636af 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 1:e1c7c1c636af 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 1:e1c7c1c636af 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 1:e1c7c1c636af 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 1:e1c7c1c636af 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 1:e1c7c1c636af 10 *
IanBenzMaxim 1:e1c7c1c636af 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 1:e1c7c1c636af 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 1:e1c7c1c636af 13 *
IanBenzMaxim 1:e1c7c1c636af 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 1:e1c7c1c636af 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 1:e1c7c1c636af 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 1:e1c7c1c636af 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 1:e1c7c1c636af 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 1:e1c7c1c636af 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 1:e1c7c1c636af 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 1:e1c7c1c636af 21 *
IanBenzMaxim 1:e1c7c1c636af 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 1:e1c7c1c636af 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 1:e1c7c1c636af 24 * Products, Inc. Branding Policy.
IanBenzMaxim 1:e1c7c1c636af 25 *
IanBenzMaxim 1:e1c7c1c636af 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 1:e1c7c1c636af 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 1:e1c7c1c636af 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 1:e1c7c1c636af 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 1:e1c7c1c636af 30 * ownership rights.
IanBenzMaxim 1:e1c7c1c636af 31 *******************************************************************************
IanBenzMaxim 1:e1c7c1c636af 32 */
IanBenzMaxim 1:e1c7c1c636af 33
IanBenzMaxim 1:e1c7c1c636af 34 #include <sstream>
IanBenzMaxim 1:e1c7c1c636af 35
IanBenzMaxim 1:e1c7c1c636af 36 #include "common.hpp"
IanBenzMaxim 1:e1c7c1c636af 37 #include "WebServerInterface.hpp"
IanBenzMaxim 1:e1c7c1c636af 38 #include "Factory.hpp"
IanBenzMaxim 1:e1c7c1c636af 39 #include "SensorNode.hpp"
IanBenzMaxim 1:e1c7c1c636af 40 #include "OneWire_Masters/DS2465/DS2465.hpp"
IanBenzMaxim 1:e1c7c1c636af 41 #include "Display.hpp"
IanBenzMaxim 1:e1c7c1c636af 42 #include "RomId.hpp"
IanBenzMaxim 1:e1c7c1c636af 43 #include "ESP8266.hpp"
IanBenzMaxim 1:e1c7c1c636af 44 #include "mbed.h"
IanBenzMaxim 1:e1c7c1c636af 45
IanBenzMaxim 1:e1c7c1c636af 46 /// Main status for the program.
IanBenzMaxim 1:e1c7c1c636af 47 enum Status
IanBenzMaxim 1:e1c7c1c636af 48 {
IanBenzMaxim 1:e1c7c1c636af 49 InitializingController, ///< Configure DS2465 and connect to network.
IanBenzMaxim 1:e1c7c1c636af 50 DisplaySessionId, ///< Display ID for use with website.
IanBenzMaxim 1:e1c7c1c636af 51 SensorNodeNeedsDetection, ///< Prompt user to insert Sensor Node.
IanBenzMaxim 1:e1c7c1c636af 52 DetectingSensorNode, ///< Check if Sensor Node present.
IanBenzMaxim 1:e1c7c1c636af 53 SensorNodeNeedsProvision, ///< Sensor Node needs to be provisioned.
IanBenzMaxim 1:e1c7c1c636af 54 ProvisioningSensorNode, ///< Provisioning Sensor Node to factory defaults.
IanBenzMaxim 1:e1c7c1c636af 55 NormalOperation, ///< The normal demo operation state.
IanBenzMaxim 1:e1c7c1c636af 56 SensorNodeNotAuthentic, ///< Sensor Node failed authentication check.
IanBenzMaxim 1:e1c7c1c636af 57 ControllerInitializationError, ///< Failed to initialize Controller.
IanBenzMaxim 1:e1c7c1c636af 58 ControllerHardwareError, ///< Controller hardware failed unexpectedly.
IanBenzMaxim 1:e1c7c1c636af 59 SensorNodeHardwareError ///< Sensor Node hardware failed unexpectedly.
IanBenzMaxim 1:e1c7c1c636af 60 };
IanBenzMaxim 1:e1c7c1c636af 61
IanBenzMaxim 1:e1c7c1c636af 62 /// @{
IanBenzMaxim 1:e1c7c1c636af 63 /// Configuration options.
IanBenzMaxim 1:e1c7c1c636af 64 static const unsigned int webPostIntervalMs = 10000;
IanBenzMaxim 1:e1c7c1c636af 65 static const unsigned int webPostRetryIntervalMs = 1000;
IanBenzMaxim 1:e1c7c1c636af 66 static const std::uint8_t maxConsecutiveWebPostErrors = 3;
IanBenzMaxim 1:e1c7c1c636af 67 /// @}
IanBenzMaxim 1:e1c7c1c636af 68
IanBenzMaxim 1:e1c7c1c636af 69 /// @{
IanBenzMaxim 1:e1c7c1c636af 70 /// LCD display colors.
IanBenzMaxim 1:e1c7c1c636af 71 static const Display::Color Teal(0x00, 0xB2, 0xA9);
IanBenzMaxim 1:e1c7c1c636af 72 static const Display::Color Red(0xFF, 0x00, 0x00);
IanBenzMaxim 1:e1c7c1c636af 73 static const Display::Color Green(0x00, 0xFF, 0x00);
IanBenzMaxim 1:e1c7c1c636af 74 /// @}
IanBenzMaxim 1:e1c7c1c636af 75
IanBenzMaxim 1:e1c7c1c636af 76 /// @{
IanBenzMaxim 1:e1c7c1c636af 77 /// Peripheral and pin definitions
IanBenzMaxim 1:e1c7c1c636af 78 static Serial pc(USBTX, USBRX);
IanBenzMaxim 1:e1c7c1c636af 79 static DigitalIn provisionButton(P2_0);
IanBenzMaxim 1:e1c7c1c636af 80 static DigitalIn invalidateButton(P1_5);
IanBenzMaxim 1:e1c7c1c636af 81 static DigitalOut tempAlarmLed(P2_1, 1);
IanBenzMaxim 1:e1c7c1c636af 82 static DigitalOut filterLifeAlarmLed(P2_3, 1);
IanBenzMaxim 1:e1c7c1c636af 83 static I2C i2c(P2_6, P2_7);
IanBenzMaxim 1:e1c7c1c636af 84 static Display lcd(i2c, 0x78, 0x98);
IanBenzMaxim 1:e1c7c1c636af 85 static DS2465 ds2465(i2c, 0x30);
IanBenzMaxim 1:e1c7c1c636af 86 static SensorNode sensorNode(i2c, 0x90, 0x94, ds2465);
IanBenzMaxim 1:e1c7c1c636af 87 static Factory factory;
IanBenzMaxim 1:e1c7c1c636af 88 static ESP8266 esp8266(P1_1, P1_0, P1_2, P1_3, 38400);
IanBenzMaxim 1:e1c7c1c636af 89 static WebServerInterface webIntf(esp8266, &pc);
IanBenzMaxim 1:e1c7c1c636af 90 /// @}
IanBenzMaxim 1:e1c7c1c636af 91
IanBenzMaxim 1:e1c7c1c636af 92 static bool useInvalidSecret = false; ///< Imitate an invalid controller when posting to web server.
IanBenzMaxim 1:e1c7c1c636af 93 static unsigned int randomSeed = 0; ///< Create extra entropy for challenge.
IanBenzMaxim 1:e1c7c1c636af 94 static Status currentStatus = InitializingController;
IanBenzMaxim 1:e1c7c1c636af 95 static bool result = false;
IanBenzMaxim 1:e1c7c1c636af 96 static std::uint8_t consecutiveWebPostErrors = 0; ///< Account for a few network errors in case of flaky connection.
IanBenzMaxim 1:e1c7c1c636af 97 static Timer webPostTimer; ///< Software timer to track web posting interval.
IanBenzMaxim 5:63232ef22abe 98 static Timer retryTimer; ///< Software timer to track authentication retries.
IanBenzMaxim 1:e1c7c1c636af 99
IanBenzMaxim 1:e1c7c1c636af 100 static void blinkLeds(unsigned int time_ms); ///< Invert LEDs for a given amount of time.
IanBenzMaxim 1:e1c7c1c636af 101 static bool buttonPressed(DigitalIn & button); ///< Checks if button is pressed (returns true) and waits for release.
IanBenzMaxim 1:e1c7c1c636af 102 static void displayStatus(Status status); ///< Display status message on LCD.
IanBenzMaxim 1:e1c7c1c636af 103 static void displaySensorData(const SensorData & sensorData); ///< Display sensor data on the LCD.
IanBenzMaxim 1:e1c7c1c636af 104 static bool readWebSessionId(std::string & sessionId); ///< Read device's web session ID from it's nonvolatile storage.
IanBenzMaxim 1:e1c7c1c636af 105
IanBenzMaxim 1:e1c7c1c636af 106 #ifdef ASSEMBLY_TEST
IanBenzMaxim 1:e1c7c1c636af 107 #include "AssemblyTest.cpp"
IanBenzMaxim 1:e1c7c1c636af 108 #endif
IanBenzMaxim 1:e1c7c1c636af 109
IanBenzMaxim 1:e1c7c1c636af 110 int main()
IanBenzMaxim 1:e1c7c1c636af 111 {
IanBenzMaxim 1:e1c7c1c636af 112 blinkLeds(500);
IanBenzMaxim 1:e1c7c1c636af 113
IanBenzMaxim 1:e1c7c1c636af 114 #ifdef ASSEMBLY_TEST
IanBenzMaxim 1:e1c7c1c636af 115 assemblyTest();
IanBenzMaxim 1:e1c7c1c636af 116 #endif
IanBenzMaxim 1:e1c7c1c636af 117
IanBenzMaxim 1:e1c7c1c636af 118 while (true)
IanBenzMaxim 1:e1c7c1c636af 119 {
IanBenzMaxim 1:e1c7c1c636af 120 Status nextStatus = currentStatus;
IanBenzMaxim 1:e1c7c1c636af 121 switch (currentStatus)
IanBenzMaxim 1:e1c7c1c636af 122 {
IanBenzMaxim 1:e1c7c1c636af 123 case InitializingController:
IanBenzMaxim 1:e1c7c1c636af 124 pc.baud(115200);
IanBenzMaxim 1:e1c7c1c636af 125 i2c.frequency(100000);
IanBenzMaxim 1:e1c7c1c636af 126 webPostTimer.start();
IanBenzMaxim 1:e1c7c1c636af 127
IanBenzMaxim 1:e1c7c1c636af 128 // Set initial LCD state
IanBenzMaxim 1:e1c7c1c636af 129 lcd.initialize();
IanBenzMaxim 1:e1c7c1c636af 130 displayStatus(currentStatus);
IanBenzMaxim 1:e1c7c1c636af 131
IanBenzMaxim 1:e1c7c1c636af 132 // Connect to Wifi network
IanBenzMaxim 1:e1c7c1c636af 133 result = webIntf.initialize();
IanBenzMaxim 1:e1c7c1c636af 134
IanBenzMaxim 1:e1c7c1c636af 135 // Read session ID
IanBenzMaxim 1:e1c7c1c636af 136 if (result)
IanBenzMaxim 1:e1c7c1c636af 137 {
IanBenzMaxim 1:e1c7c1c636af 138 result = readWebSessionId(webIntf.sessionId);
IanBenzMaxim 1:e1c7c1c636af 139 }
IanBenzMaxim 1:e1c7c1c636af 140
IanBenzMaxim 1:e1c7c1c636af 141 // Provision DS2465 with master secret and page data
IanBenzMaxim 1:e1c7c1c636af 142 if (result)
IanBenzMaxim 1:e1c7c1c636af 143 {
IanBenzMaxim 1:e1c7c1c636af 144 result = factory.provision(ds2465);
IanBenzMaxim 1:e1c7c1c636af 145 }
IanBenzMaxim 1:e1c7c1c636af 146
IanBenzMaxim 1:e1c7c1c636af 147 if (result)
IanBenzMaxim 1:e1c7c1c636af 148 {
IanBenzMaxim 1:e1c7c1c636af 149 nextStatus = DisplaySessionId;
IanBenzMaxim 1:e1c7c1c636af 150 }
IanBenzMaxim 1:e1c7c1c636af 151 else
IanBenzMaxim 1:e1c7c1c636af 152 {
IanBenzMaxim 1:e1c7c1c636af 153 nextStatus = ControllerInitializationError;
IanBenzMaxim 1:e1c7c1c636af 154 }
IanBenzMaxim 1:e1c7c1c636af 155 break;
IanBenzMaxim 1:e1c7c1c636af 156
IanBenzMaxim 1:e1c7c1c636af 157 case DisplaySessionId:
IanBenzMaxim 1:e1c7c1c636af 158 // Wait for user to press Provision button
IanBenzMaxim 1:e1c7c1c636af 159 if (buttonPressed(provisionButton))
IanBenzMaxim 1:e1c7c1c636af 160 {
IanBenzMaxim 1:e1c7c1c636af 161 nextStatus = SensorNodeNeedsDetection;
IanBenzMaxim 1:e1c7c1c636af 162 }
IanBenzMaxim 1:e1c7c1c636af 163 break;
IanBenzMaxim 1:e1c7c1c636af 164
IanBenzMaxim 1:e1c7c1c636af 165 case SensorNodeNeedsDetection:
IanBenzMaxim 1:e1c7c1c636af 166 // Wait for user to press Provision button
IanBenzMaxim 1:e1c7c1c636af 167 if (buttonPressed(provisionButton))
IanBenzMaxim 1:e1c7c1c636af 168 {
IanBenzMaxim 1:e1c7c1c636af 169 nextStatus = DetectingSensorNode;
IanBenzMaxim 1:e1c7c1c636af 170 }
IanBenzMaxim 1:e1c7c1c636af 171 break;
IanBenzMaxim 1:e1c7c1c636af 172
IanBenzMaxim 1:e1c7c1c636af 173 case DetectingSensorNode:
IanBenzMaxim 1:e1c7c1c636af 174 // Perform Sensor Node detection sequence
IanBenzMaxim 1:e1c7c1c636af 175 switch (sensorNode.detect(randomSeed))
IanBenzMaxim 1:e1c7c1c636af 176 {
IanBenzMaxim 1:e1c7c1c636af 177 case SensorNode::UnableToCommunicate:
IanBenzMaxim 1:e1c7c1c636af 178 default:
IanBenzMaxim 1:e1c7c1c636af 179 nextStatus = SensorNodeHardwareError;
IanBenzMaxim 1:e1c7c1c636af 180 break;
IanBenzMaxim 1:e1c7c1c636af 181
IanBenzMaxim 1:e1c7c1c636af 182 case SensorNode::NotProvisioned:
IanBenzMaxim 1:e1c7c1c636af 183 nextStatus = SensorNodeNeedsProvision;
IanBenzMaxim 1:e1c7c1c636af 184 break;
IanBenzMaxim 1:e1c7c1c636af 185
IanBenzMaxim 1:e1c7c1c636af 186 case SensorNode::NotAuthentic:
IanBenzMaxim 1:e1c7c1c636af 187 nextStatus = SensorNodeNotAuthentic;
IanBenzMaxim 1:e1c7c1c636af 188 break;
IanBenzMaxim 1:e1c7c1c636af 189
IanBenzMaxim 1:e1c7c1c636af 190 case SensorNode::Authentic:
IanBenzMaxim 1:e1c7c1c636af 191 nextStatus = NormalOperation;
IanBenzMaxim 1:e1c7c1c636af 192 break;
IanBenzMaxim 1:e1c7c1c636af 193 }
IanBenzMaxim 1:e1c7c1c636af 194 break;
IanBenzMaxim 1:e1c7c1c636af 195
IanBenzMaxim 1:e1c7c1c636af 196 case SensorNodeNeedsProvision:
IanBenzMaxim 1:e1c7c1c636af 197 // Wait for user to press Provision button
IanBenzMaxim 1:e1c7c1c636af 198 if (buttonPressed(provisionButton))
IanBenzMaxim 1:e1c7c1c636af 199 {
IanBenzMaxim 1:e1c7c1c636af 200 nextStatus = ProvisioningSensorNode;
IanBenzMaxim 1:e1c7c1c636af 201 }
IanBenzMaxim 1:e1c7c1c636af 202 break;
IanBenzMaxim 1:e1c7c1c636af 203
IanBenzMaxim 1:e1c7c1c636af 204 case ProvisioningSensorNode:
IanBenzMaxim 1:e1c7c1c636af 205 if (!buttonPressed(invalidateButton)) // Provision normally
IanBenzMaxim 1:e1c7c1c636af 206 {
IanBenzMaxim 1:e1c7c1c636af 207 if (factory.provision(sensorNode, true))
IanBenzMaxim 1:e1c7c1c636af 208 {
IanBenzMaxim 1:e1c7c1c636af 209 nextStatus = NormalOperation;
IanBenzMaxim 1:e1c7c1c636af 210 }
IanBenzMaxim 1:e1c7c1c636af 211 else
IanBenzMaxim 1:e1c7c1c636af 212 {
IanBenzMaxim 1:e1c7c1c636af 213 nextStatus = SensorNodeNotAuthentic;
IanBenzMaxim 1:e1c7c1c636af 214 }
IanBenzMaxim 1:e1c7c1c636af 215 }
IanBenzMaxim 1:e1c7c1c636af 216 else // Invalidate button also pressed; Load invalid secret
IanBenzMaxim 1:e1c7c1c636af 217 {
IanBenzMaxim 1:e1c7c1c636af 218 // Provision with invalid secret
IanBenzMaxim 1:e1c7c1c636af 219 if (factory.provision(sensorNode, false))
IanBenzMaxim 1:e1c7c1c636af 220 {
IanBenzMaxim 1:e1c7c1c636af 221 nextStatus = NormalOperation;
IanBenzMaxim 1:e1c7c1c636af 222 }
IanBenzMaxim 1:e1c7c1c636af 223 else
IanBenzMaxim 1:e1c7c1c636af 224 {
IanBenzMaxim 1:e1c7c1c636af 225 nextStatus = SensorNodeHardwareError;
IanBenzMaxim 1:e1c7c1c636af 226 }
IanBenzMaxim 1:e1c7c1c636af 227 }
IanBenzMaxim 1:e1c7c1c636af 228 break;
IanBenzMaxim 1:e1c7c1c636af 229
IanBenzMaxim 1:e1c7c1c636af 230 case NormalOperation:
IanBenzMaxim 1:e1c7c1c636af 231 // Check if user pressed Provision button
IanBenzMaxim 1:e1c7c1c636af 232 if (buttonPressed(provisionButton))
IanBenzMaxim 1:e1c7c1c636af 233 {
IanBenzMaxim 1:e1c7c1c636af 234 // Re-provision Sensor Node
IanBenzMaxim 1:e1c7c1c636af 235 nextStatus = ProvisioningSensorNode;
IanBenzMaxim 1:e1c7c1c636af 236 }
IanBenzMaxim 1:e1c7c1c636af 237 // Check if user pressed Invalidate button
IanBenzMaxim 1:e1c7c1c636af 238 else if (buttonPressed(invalidateButton))
IanBenzMaxim 1:e1c7c1c636af 239 {
IanBenzMaxim 1:e1c7c1c636af 240 // Toggle between using valid and invalid secret
IanBenzMaxim 1:e1c7c1c636af 241 // 1 blink = invalid; 2 blinks = valid
IanBenzMaxim 1:e1c7c1c636af 242 useInvalidSecret = !useInvalidSecret;
IanBenzMaxim 1:e1c7c1c636af 243 blinkLeds(100);
IanBenzMaxim 1:e1c7c1c636af 244 if (!useInvalidSecret)
IanBenzMaxim 1:e1c7c1c636af 245 {
IanBenzMaxim 1:e1c7c1c636af 246 wait_ms(100);
IanBenzMaxim 1:e1c7c1c636af 247 blinkLeds(100);
IanBenzMaxim 1:e1c7c1c636af 248 }
IanBenzMaxim 1:e1c7c1c636af 249 }
IanBenzMaxim 1:e1c7c1c636af 250 // Check node and display measurements
IanBenzMaxim 1:e1c7c1c636af 251 else
IanBenzMaxim 1:e1c7c1c636af 252 {
IanBenzMaxim 1:e1c7c1c636af 253 SensorData sensorData;
IanBenzMaxim 1:e1c7c1c636af 254 // Read sensor data with authentication
IanBenzMaxim 1:e1c7c1c636af 255 switch (sensorNode.authenticatedReadSensorData(randomSeed, sensorData))
IanBenzMaxim 1:e1c7c1c636af 256 {
IanBenzMaxim 1:e1c7c1c636af 257 case SensorNode::Authentic:
IanBenzMaxim 1:e1c7c1c636af 258 // Update measurements on LCD
IanBenzMaxim 1:e1c7c1c636af 259 displaySensorData(sensorData);
IanBenzMaxim 1:e1c7c1c636af 260
IanBenzMaxim 1:e1c7c1c636af 261 // Update alarm LEDs
IanBenzMaxim 1:e1c7c1c636af 262 tempAlarmLed = !sensorData.tempAlarm(); // Active Low
IanBenzMaxim 1:e1c7c1c636af 263 filterLifeAlarmLed = !sensorData.filterLifeAlarm(); // Active Low
IanBenzMaxim 1:e1c7c1c636af 264
IanBenzMaxim 1:e1c7c1c636af 265 // Send measurements to web if time interval reached
IanBenzMaxim 1:e1c7c1c636af 266 if (webPostTimer.read_ms() >= webPostIntervalMs)
IanBenzMaxim 1:e1c7c1c636af 267 {
IanBenzMaxim 1:e1c7c1c636af 268 // Format, sign, and transmit data to web server
IanBenzMaxim 1:e1c7c1c636af 269 result = webIntf.authPostHttpEvent(ds2465, SensorDataEvent, WebServerInterface::formatSensorDataPostBody(sensorData), !useInvalidSecret);
IanBenzMaxim 1:e1c7c1c636af 270 if (result)
IanBenzMaxim 1:e1c7c1c636af 271 {
IanBenzMaxim 1:e1c7c1c636af 272 // Reset timer count after logging sample complete
IanBenzMaxim 1:e1c7c1c636af 273 webPostTimer.reset();
IanBenzMaxim 1:e1c7c1c636af 274 consecutiveWebPostErrors = 0;
IanBenzMaxim 1:e1c7c1c636af 275 }
IanBenzMaxim 1:e1c7c1c636af 276 // There was likely an error establishing a web connection
IanBenzMaxim 1:e1c7c1c636af 277 else if (++consecutiveWebPostErrors < maxConsecutiveWebPostErrors)
IanBenzMaxim 1:e1c7c1c636af 278 {
IanBenzMaxim 1:e1c7c1c636af 279 // Wait and try again
IanBenzMaxim 1:e1c7c1c636af 280 wait_ms(webPostRetryIntervalMs);
IanBenzMaxim 1:e1c7c1c636af 281 }
IanBenzMaxim 1:e1c7c1c636af 282 // Too many retry attempts
IanBenzMaxim 1:e1c7c1c636af 283 else
IanBenzMaxim 1:e1c7c1c636af 284 {
IanBenzMaxim 1:e1c7c1c636af 285 // Assume we have lost network connection
IanBenzMaxim 1:e1c7c1c636af 286 nextStatus = ControllerHardwareError;
IanBenzMaxim 1:e1c7c1c636af 287 }
IanBenzMaxim 1:e1c7c1c636af 288 }
IanBenzMaxim 1:e1c7c1c636af 289 break;
IanBenzMaxim 1:e1c7c1c636af 290
IanBenzMaxim 1:e1c7c1c636af 291 case SensorNode::NotAuthentic:
IanBenzMaxim 1:e1c7c1c636af 292 nextStatus = SensorNodeNotAuthentic;
IanBenzMaxim 1:e1c7c1c636af 293 break;
IanBenzMaxim 1:e1c7c1c636af 294
IanBenzMaxim 1:e1c7c1c636af 295 case SensorNode::UnableToCommunicate:
IanBenzMaxim 1:e1c7c1c636af 296 default:
IanBenzMaxim 1:e1c7c1c636af 297 nextStatus = SensorNodeHardwareError;
IanBenzMaxim 1:e1c7c1c636af 298 break;
IanBenzMaxim 1:e1c7c1c636af 299 }
IanBenzMaxim 1:e1c7c1c636af 300 }
IanBenzMaxim 1:e1c7c1c636af 301 break;
IanBenzMaxim 1:e1c7c1c636af 302
IanBenzMaxim 1:e1c7c1c636af 303 case SensorNodeNotAuthentic:
IanBenzMaxim 5:63232ef22abe 304 // Wait for some time before retrying authentication
IanBenzMaxim 5:63232ef22abe 305 retryTimer.reset();
IanBenzMaxim 5:63232ef22abe 306 retryTimer.start();
IanBenzMaxim 5:63232ef22abe 307 do
IanBenzMaxim 1:e1c7c1c636af 308 {
IanBenzMaxim 5:63232ef22abe 309 // Wait for user to press Provision button
IanBenzMaxim 5:63232ef22abe 310 if (buttonPressed(provisionButton))
IanBenzMaxim 5:63232ef22abe 311 {
IanBenzMaxim 5:63232ef22abe 312 nextStatus = ProvisioningSensorNode;
IanBenzMaxim 5:63232ef22abe 313 break;
IanBenzMaxim 5:63232ef22abe 314 }
IanBenzMaxim 5:63232ef22abe 315 // Try to authenticate and return to normal operation
IanBenzMaxim 5:63232ef22abe 316 else if (webPostTimer.read_ms() >= webPostIntervalMs)
IanBenzMaxim 1:e1c7c1c636af 317 {
IanBenzMaxim 5:63232ef22abe 318 // Send event message to server
IanBenzMaxim 5:63232ef22abe 319 result = webIntf.authPostHttpEvent(ds2465, InvalidSensorEvent, "", !useInvalidSecret);
IanBenzMaxim 5:63232ef22abe 320 if (result)
IanBenzMaxim 5:63232ef22abe 321 {
IanBenzMaxim 5:63232ef22abe 322 // Reset timer count after logging complete
IanBenzMaxim 5:63232ef22abe 323 webPostTimer.reset();
IanBenzMaxim 5:63232ef22abe 324 consecutiveWebPostErrors = 0;
IanBenzMaxim 5:63232ef22abe 325
IanBenzMaxim 5:63232ef22abe 326 // Try to authenticate again
IanBenzMaxim 5:63232ef22abe 327 nextStatus = SensorNodeNeedsDetection;
IanBenzMaxim 5:63232ef22abe 328 }
IanBenzMaxim 5:63232ef22abe 329 else if (++consecutiveWebPostErrors < maxConsecutiveWebPostErrors)
IanBenzMaxim 5:63232ef22abe 330 {
IanBenzMaxim 5:63232ef22abe 331 // There was likely an error establishing a web connection
IanBenzMaxim 5:63232ef22abe 332 // Wait and try again
IanBenzMaxim 5:63232ef22abe 333 wait_ms(webPostRetryIntervalMs);
IanBenzMaxim 5:63232ef22abe 334 }
IanBenzMaxim 5:63232ef22abe 335 else
IanBenzMaxim 5:63232ef22abe 336 {
IanBenzMaxim 5:63232ef22abe 337 nextStatus = ControllerHardwareError;
IanBenzMaxim 5:63232ef22abe 338 break;
IanBenzMaxim 5:63232ef22abe 339 }
IanBenzMaxim 1:e1c7c1c636af 340 }
IanBenzMaxim 5:63232ef22abe 341 } while (retryTimer.read_ms() < webPostIntervalMs);
IanBenzMaxim 5:63232ef22abe 342 retryTimer.stop();
IanBenzMaxim 1:e1c7c1c636af 343 break;
IanBenzMaxim 1:e1c7c1c636af 344
IanBenzMaxim 1:e1c7c1c636af 345 case ControllerInitializationError:
IanBenzMaxim 1:e1c7c1c636af 346 case ControllerHardwareError:
IanBenzMaxim 1:e1c7c1c636af 347 case SensorNodeHardwareError:
IanBenzMaxim 1:e1c7c1c636af 348 default:
IanBenzMaxim 1:e1c7c1c636af 349 // Do nothing until user resets
IanBenzMaxim 1:e1c7c1c636af 350 break;
IanBenzMaxim 1:e1c7c1c636af 351 }
IanBenzMaxim 1:e1c7c1c636af 352 // Check if status changed
IanBenzMaxim 1:e1c7c1c636af 353 if (currentStatus != nextStatus)
IanBenzMaxim 1:e1c7c1c636af 354 {
IanBenzMaxim 1:e1c7c1c636af 355 currentStatus = nextStatus;
IanBenzMaxim 1:e1c7c1c636af 356 displayStatus(currentStatus); // Display status message on LCD
IanBenzMaxim 1:e1c7c1c636af 357 }
IanBenzMaxim 1:e1c7c1c636af 358
IanBenzMaxim 1:e1c7c1c636af 359 // Change seed value on every loop pass
IanBenzMaxim 1:e1c7c1c636af 360 randomSeed++;
IanBenzMaxim 1:e1c7c1c636af 361 }
IanBenzMaxim 1:e1c7c1c636af 362 }
IanBenzMaxim 1:e1c7c1c636af 363
IanBenzMaxim 1:e1c7c1c636af 364 /// Blink all LEDs for a certain amount of time.
IanBenzMaxim 1:e1c7c1c636af 365 /// @param time_ms Time in ms to blink for.
IanBenzMaxim 1:e1c7c1c636af 366 static void blinkLeds(unsigned int time_ms)
IanBenzMaxim 1:e1c7c1c636af 367 {
IanBenzMaxim 1:e1c7c1c636af 368 tempAlarmLed = !tempAlarmLed;
IanBenzMaxim 1:e1c7c1c636af 369 filterLifeAlarmLed = !filterLifeAlarmLed;
IanBenzMaxim 1:e1c7c1c636af 370 wait_ms(time_ms);
IanBenzMaxim 1:e1c7c1c636af 371 tempAlarmLed = !tempAlarmLed;
IanBenzMaxim 1:e1c7c1c636af 372 filterLifeAlarmLed = !filterLifeAlarmLed;
IanBenzMaxim 1:e1c7c1c636af 373 }
IanBenzMaxim 1:e1c7c1c636af 374
IanBenzMaxim 1:e1c7c1c636af 375 /// Check if a button is pressed and wait for it to be release.
IanBenzMaxim 1:e1c7c1c636af 376 /// @param button Active low button to check.
IanBenzMaxim 1:e1c7c1c636af 377 /// @returns True if pressed.
IanBenzMaxim 1:e1c7c1c636af 378 static bool buttonPressed(DigitalIn & button)
IanBenzMaxim 1:e1c7c1c636af 379 {
IanBenzMaxim 1:e1c7c1c636af 380 const int buttonPressed = 0; // Active low
IanBenzMaxim 1:e1c7c1c636af 381 if (button == buttonPressed)
IanBenzMaxim 1:e1c7c1c636af 382 {
IanBenzMaxim 1:e1c7c1c636af 383 while (button == buttonPressed) ;
IanBenzMaxim 1:e1c7c1c636af 384 return true;
IanBenzMaxim 1:e1c7c1c636af 385 }
IanBenzMaxim 1:e1c7c1c636af 386 // else
IanBenzMaxim 1:e1c7c1c636af 387 return false;
IanBenzMaxim 1:e1c7c1c636af 388 }
IanBenzMaxim 1:e1c7c1c636af 389
IanBenzMaxim 1:e1c7c1c636af 390 /// Display the current status of the Controller on the LCD display.
IanBenzMaxim 1:e1c7c1c636af 391 static void displayStatus(Status status)
IanBenzMaxim 1:e1c7c1c636af 392 {
IanBenzMaxim 1:e1c7c1c636af 393 switch (status)
IanBenzMaxim 1:e1c7c1c636af 394 {
IanBenzMaxim 1:e1c7c1c636af 395 case InitializingController:
IanBenzMaxim 1:e1c7c1c636af 396 lcd.writeMessage("Initializing Controller...");
IanBenzMaxim 1:e1c7c1c636af 397 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 398 break;
IanBenzMaxim 1:e1c7c1c636af 399
IanBenzMaxim 1:e1c7c1c636af 400 case DisplaySessionId:
IanBenzMaxim 1:e1c7c1c636af 401 lcd.writeLine("ID: " + webIntf.sessionId, Display::FirstLine);
IanBenzMaxim 1:e1c7c1c636af 402 lcd.writeLine("Provision to begin", Display::SecondLine);
IanBenzMaxim 1:e1c7c1c636af 403 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 404 break;
IanBenzMaxim 1:e1c7c1c636af 405
IanBenzMaxim 1:e1c7c1c636af 406 case SensorNodeNeedsDetection:
IanBenzMaxim 1:e1c7c1c636af 407 lcd.writeMessage("Insert Sensor Node and press Provision");
IanBenzMaxim 1:e1c7c1c636af 408 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 409 break;
IanBenzMaxim 1:e1c7c1c636af 410
IanBenzMaxim 1:e1c7c1c636af 411 case DetectingSensorNode:
IanBenzMaxim 1:e1c7c1c636af 412 lcd.writeMessage("Detecting Sensor Node...");
IanBenzMaxim 1:e1c7c1c636af 413 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 414 break;
IanBenzMaxim 1:e1c7c1c636af 415
IanBenzMaxim 1:e1c7c1c636af 416 case SensorNodeNeedsProvision:
IanBenzMaxim 1:e1c7c1c636af 417 lcd.writeMessage("Sensor Node Needs Provision");
IanBenzMaxim 1:e1c7c1c636af 418 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 419 break;
IanBenzMaxim 1:e1c7c1c636af 420
IanBenzMaxim 1:e1c7c1c636af 421 case ProvisioningSensorNode:
IanBenzMaxim 1:e1c7c1c636af 422 lcd.writeMessage("Provisioning Sensor Node");
IanBenzMaxim 1:e1c7c1c636af 423 lcd.setBackLightColor(Teal);
IanBenzMaxim 1:e1c7c1c636af 424 break;
IanBenzMaxim 1:e1c7c1c636af 425
IanBenzMaxim 1:e1c7c1c636af 426 case NormalOperation:
IanBenzMaxim 1:e1c7c1c636af 427 // Everything handled in displaySensorData()
IanBenzMaxim 1:e1c7c1c636af 428 break;
IanBenzMaxim 1:e1c7c1c636af 429
IanBenzMaxim 1:e1c7c1c636af 430 case SensorNodeNotAuthentic:
IanBenzMaxim 1:e1c7c1c636af 431 lcd.writeMessage("Sensor Node Not Authentic");
IanBenzMaxim 1:e1c7c1c636af 432 lcd.setBackLightColor(Red);
IanBenzMaxim 1:e1c7c1c636af 433 break;
IanBenzMaxim 1:e1c7c1c636af 434
IanBenzMaxim 1:e1c7c1c636af 435 case ControllerInitializationError:
IanBenzMaxim 1:e1c7c1c636af 436 lcd.writeMessage("Initialization Error Check Wi-Fi");
IanBenzMaxim 1:e1c7c1c636af 437 lcd.setBackLightColor(Red);
IanBenzMaxim 1:e1c7c1c636af 438 break;
IanBenzMaxim 1:e1c7c1c636af 439
IanBenzMaxim 1:e1c7c1c636af 440 case ControllerHardwareError:
IanBenzMaxim 1:e1c7c1c636af 441 lcd.writeMessage("Controller Hardware Error");
IanBenzMaxim 1:e1c7c1c636af 442 lcd.setBackLightColor(Red);
IanBenzMaxim 1:e1c7c1c636af 443 break;
IanBenzMaxim 1:e1c7c1c636af 444
IanBenzMaxim 1:e1c7c1c636af 445 case SensorNodeHardwareError:
IanBenzMaxim 1:e1c7c1c636af 446 lcd.writeMessage("Sensor Node Hardware Error");
IanBenzMaxim 1:e1c7c1c636af 447 lcd.setBackLightColor(Red);
IanBenzMaxim 1:e1c7c1c636af 448 break;
IanBenzMaxim 1:e1c7c1c636af 449 }
IanBenzMaxim 1:e1c7c1c636af 450 }
IanBenzMaxim 1:e1c7c1c636af 451
IanBenzMaxim 1:e1c7c1c636af 452 /// Display sensor data on the LCD display during normal operation.
IanBenzMaxim 1:e1c7c1c636af 453 static void displaySensorData(const SensorData & sensorData)
IanBenzMaxim 1:e1c7c1c636af 454 {
IanBenzMaxim 1:e1c7c1c636af 455 std::ostringstream stream;
IanBenzMaxim 1:e1c7c1c636af 456 stream << "Chiller Temp: " << (int)sensorData.temp << "C";
IanBenzMaxim 1:e1c7c1c636af 457 lcd.writeCompleteLine(stream.str(), Display::FirstLine);
IanBenzMaxim 1:e1c7c1c636af 458 stream.str(""); // Clear stream
IanBenzMaxim 1:e1c7c1c636af 459 stream << "Filter Life: " << (unsigned int)sensorData.filterLife << "%";
IanBenzMaxim 1:e1c7c1c636af 460 lcd.writeCompleteLine(stream.str(), Display::SecondLine);
IanBenzMaxim 1:e1c7c1c636af 461 lcd.setBackLightColor((sensorData.tempAlarm() || sensorData.filterLifeAlarm()) ? Red : Green);
IanBenzMaxim 1:e1c7c1c636af 462 }
IanBenzMaxim 1:e1c7c1c636af 463
IanBenzMaxim 1:e1c7c1c636af 464 /// Read the Session ID to use with the web server from ROM.
IanBenzMaxim 1:e1c7c1c636af 465 /// @note Session ID is taken from the ROM ID of the MAX66242.
IanBenzMaxim 1:e1c7c1c636af 466 /// @param[out] Session ID string.
IanBenzMaxim 1:e1c7c1c636af 467 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 468 static bool readWebSessionId(std::string & sessionId)
IanBenzMaxim 1:e1c7c1c636af 469 {
IanBenzMaxim 1:e1c7c1c636af 470 const uint8_t I2C_address = 0x32;
IanBenzMaxim 1:e1c7c1c636af 471 const uint8_t ROM_address = 0x68;
IanBenzMaxim 1:e1c7c1c636af 472 RomId romId;
IanBenzMaxim 1:e1c7c1c636af 473
IanBenzMaxim 1:e1c7c1c636af 474 // Set register pointer
IanBenzMaxim 4:71d578d3af22 475 if (i2c.write(I2C_address, reinterpret_cast<const char *>(&ROM_address), 1) != 0)
IanBenzMaxim 1:e1c7c1c636af 476 return false;
IanBenzMaxim 1:e1c7c1c636af 477 // Read ROM ID
IanBenzMaxim 4:71d578d3af22 478 if (i2c.read(I2C_address, reinterpret_cast<char *>(&(static_cast<RomId::ByteBuffer &>(romId))), RomId::byteLen) != 0)
IanBenzMaxim 1:e1c7c1c636af 479 return false;
IanBenzMaxim 1:e1c7c1c636af 480 // Check if CRC valid
IanBenzMaxim 1:e1c7c1c636af 481 if (!romId.crc8Valid())
IanBenzMaxim 1:e1c7c1c636af 482 return false;
IanBenzMaxim 1:e1c7c1c636af 483 sessionId = byteArrayToHexString(romId, RomId::byteLen);
IanBenzMaxim 1:e1c7c1c636af 484 return true;
IanBenzMaxim 1:e1c7c1c636af 485 }