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.

Display.hpp@6:b6bafd0a7013, 2016-05-12 (annotated)

Committer:
IanBenzMaxim
Date:
Thu May 12 14:40:14 2016 -0500
Revision:
6:b6bafd0a7013
Parent:
1:e1c7c1c636af
Child:
24:434330962308
Updated following downstream restructuring in OneWire library.

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 #ifndef _DISPLAY_HPP
IanBenzMaxim 1:e1c7c1c636af 35 #define _DISPLAY_HPP
IanBenzMaxim 1:e1c7c1c636af 36
IanBenzMaxim 6:b6bafd0a7013 37 #include <stdint.h>
IanBenzMaxim 6:b6bafd0a7013 38 #include <stddef.h>
IanBenzMaxim 1:e1c7c1c636af 39 #include <string>
IanBenzMaxim 1:e1c7c1c636af 40
IanBenzMaxim 1:e1c7c1c636af 41 namespace mbed { class I2C; }
IanBenzMaxim 1:e1c7c1c636af 42
IanBenzMaxim 1:e1c7c1c636af 43 /// Interface to the Newhaven Display NHD-C0220BiZ-FS(RGB)-FBW-3VM LCD module
IanBenzMaxim 1:e1c7c1c636af 44 /// and MAX7306 PWM LED driver for backlight color selection.
IanBenzMaxim 1:e1c7c1c636af 45 class Display
IanBenzMaxim 1:e1c7c1c636af 46 {
IanBenzMaxim 1:e1c7c1c636af 47 public:
IanBenzMaxim 1:e1c7c1c636af 48 /// Display line referenced from top
IanBenzMaxim 1:e1c7c1c636af 49 enum Line
IanBenzMaxim 1:e1c7c1c636af 50 {
IanBenzMaxim 1:e1c7c1c636af 51 FirstLine = 0,
IanBenzMaxim 1:e1c7c1c636af 52 SecondLine
IanBenzMaxim 1:e1c7c1c636af 53 };
IanBenzMaxim 1:e1c7c1c636af 54
IanBenzMaxim 1:e1c7c1c636af 55 /// 24-bit RGB color for the backlight.
IanBenzMaxim 1:e1c7c1c636af 56 struct Color
IanBenzMaxim 1:e1c7c1c636af 57 {
IanBenzMaxim 6:b6bafd0a7013 58 uint8_t R, G, B;
IanBenzMaxim 6:b6bafd0a7013 59 Color(uint8_t R, uint8_t G, uint8_t B)
IanBenzMaxim 1:e1c7c1c636af 60 : R(R), G(G), B(B) { }
IanBenzMaxim 1:e1c7c1c636af 61 };
IanBenzMaxim 1:e1c7c1c636af 62
IanBenzMaxim 1:e1c7c1c636af 63 /// Length in character os a display line.
IanBenzMaxim 6:b6bafd0a7013 64 static const size_t lineLength = 20;
IanBenzMaxim 1:e1c7c1c636af 65
IanBenzMaxim 1:e1c7c1c636af 66 /// @param I2C_interface A configured I2C interface to use for communication.
IanBenzMaxim 1:e1c7c1c636af 67 /// @param LCD_I2C_address LCD module bus address in mbed format.
IanBenzMaxim 1:e1c7c1c636af 68 /// @param LED_driver_I2C_addr PWM LED driver (MAX7306) bus address in mbed format.
IanBenzMaxim 6:b6bafd0a7013 69 Display(mbed::I2C & I2C_intf, uint8_t LCD_I2C_addr, uint8_t LED_driver_I2C_addr);
IanBenzMaxim 1:e1c7c1c636af 70
IanBenzMaxim 1:e1c7c1c636af 71 /// Initialize display components.
IanBenzMaxim 1:e1c7c1c636af 72 void initialize(void);
IanBenzMaxim 1:e1c7c1c636af 73
IanBenzMaxim 1:e1c7c1c636af 74 /// Clear all display lines.
IanBenzMaxim 1:e1c7c1c636af 75 void clearDisplay(void);
IanBenzMaxim 1:e1c7c1c636af 76
IanBenzMaxim 1:e1c7c1c636af 77 /// Clear a specific display line.
IanBenzMaxim 1:e1c7c1c636af 78 void clearLine(Line line);
IanBenzMaxim 1:e1c7c1c636af 79
IanBenzMaxim 1:e1c7c1c636af 80 /// Write a single character to the display at the current cursor position.
IanBenzMaxim 6:b6bafd0a7013 81 void writeCharacter(uint8_t character);
IanBenzMaxim 1:e1c7c1c636af 82
IanBenzMaxim 1:e1c7c1c636af 83 /// Write text to the display at the current cursor position.
IanBenzMaxim 1:e1c7c1c636af 84 void writeText(const std::string & text);
IanBenzMaxim 1:e1c7c1c636af 85
IanBenzMaxim 1:e1c7c1c636af 86 /// Set cursor to a certain line and zero-index position within the line.
IanBenzMaxim 6:b6bafd0a7013 87 void setCursorPosition(Line line, size_t position = 0);
IanBenzMaxim 1:e1c7c1c636af 88
IanBenzMaxim 1:e1c7c1c636af 89 /// Writes text to the display starting at the beginning of the line.
IanBenzMaxim 1:e1c7c1c636af 90 void writeLine(const std::string & text, Line line);
IanBenzMaxim 1:e1c7c1c636af 91
IanBenzMaxim 1:e1c7c1c636af 92 /// Writes text to the display starting at the beginning of the line and clears the remainder of the line.
IanBenzMaxim 1:e1c7c1c636af 93 void writeCompleteLine(const std::string & text, Line line);
IanBenzMaxim 1:e1c7c1c636af 94
IanBenzMaxim 1:e1c7c1c636af 95 // Writes a message to the display with text wrapping allowed at spaces.
IanBenzMaxim 1:e1c7c1c636af 96 void writeMessage(const std::string & text);
IanBenzMaxim 1:e1c7c1c636af 97
IanBenzMaxim 1:e1c7c1c636af 98 // Set the display backlight to a certain color.
IanBenzMaxim 1:e1c7c1c636af 99 void setBackLightColor(const Color & color);
IanBenzMaxim 1:e1c7c1c636af 100
IanBenzMaxim 1:e1c7c1c636af 101 private:
IanBenzMaxim 1:e1c7c1c636af 102 mbed::I2C & m_I2C_intf;
IanBenzMaxim 6:b6bafd0a7013 103 uint8_t m_LCD_I2C_addr, m_LED_driver_I2C_addr;
IanBenzMaxim 1:e1c7c1c636af 104
IanBenzMaxim 1:e1c7c1c636af 105 void initializeLCD(void);
IanBenzMaxim 1:e1c7c1c636af 106 void initializeLED_Driver(void);
IanBenzMaxim 1:e1c7c1c636af 107 };
IanBenzMaxim 1:e1c7c1c636af 108
IanBenzMaxim 1:e1c7c1c636af 109 #endif