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.
DS7505.hpp@1:e1c7c1c636af, 2016-04-14 (annotated)
- Committer:
- IanBenzMaxim
- Date:
- Thu Apr 14 19:48:01 2016 +0000
- Revision:
- 1:e1c7c1c636af
- Child:
- 6:b6bafd0a7013
Add initial source files.
Who changed what in which revision?
User | Revision | Line number | New 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 _DS7505_HPP |
IanBenzMaxim | 1:e1c7c1c636af | 35 | #define _DS7505_HPP |
IanBenzMaxim | 1:e1c7c1c636af | 36 | |
IanBenzMaxim | 1:e1c7c1c636af | 37 | #include <cstdint> |
IanBenzMaxim | 1:e1c7c1c636af | 38 | |
IanBenzMaxim | 1:e1c7c1c636af | 39 | namespace mbed |
IanBenzMaxim | 1:e1c7c1c636af | 40 | { |
IanBenzMaxim | 1:e1c7c1c636af | 41 | class I2C; |
IanBenzMaxim | 1:e1c7c1c636af | 42 | } |
IanBenzMaxim | 1:e1c7c1c636af | 43 | |
IanBenzMaxim | 1:e1c7c1c636af | 44 | /// Interface to the DS7505 temperature sensor. |
IanBenzMaxim | 1:e1c7c1c636af | 45 | class DS7505 |
IanBenzMaxim | 1:e1c7c1c636af | 46 | { |
IanBenzMaxim | 1:e1c7c1c636af | 47 | public: |
IanBenzMaxim | 1:e1c7c1c636af | 48 | enum Result |
IanBenzMaxim | 1:e1c7c1c636af | 49 | { |
IanBenzMaxim | 1:e1c7c1c636af | 50 | Success, |
IanBenzMaxim | 1:e1c7c1c636af | 51 | Hardware_Failure, |
IanBenzMaxim | 1:e1c7c1c636af | 52 | Out_of_Range |
IanBenzMaxim | 1:e1c7c1c636af | 53 | }; |
IanBenzMaxim | 1:e1c7c1c636af | 54 | |
IanBenzMaxim | 1:e1c7c1c636af | 55 | /// @param I2C_interface A configured I2C interface to use for communication. |
IanBenzMaxim | 1:e1c7c1c636af | 56 | /// @param I2C_address Device bus address in mbed format. |
IanBenzMaxim | 1:e1c7c1c636af | 57 | DS7505(mbed::I2C & I2C_interface, std::uint8_t I2C_address); |
IanBenzMaxim | 1:e1c7c1c636af | 58 | |
IanBenzMaxim | 1:e1c7c1c636af | 59 | /// Set the resolution for temperature conversions. |
IanBenzMaxim | 1:e1c7c1c636af | 60 | /// @param resolution Number of decimal bit from 1 to 4. |
IanBenzMaxim | 1:e1c7c1c636af | 61 | Result set_resolution(std::uint8_t resolution); |
IanBenzMaxim | 1:e1c7c1c636af | 62 | |
IanBenzMaxim | 1:e1c7c1c636af | 63 | /// Reads the current temperature with an exponent of 10^-2. |
IanBenzMaxim | 1:e1c7c1c636af | 64 | /// @note Compatible with Bluetooth characteristic: org.bluetooth.characteristic.temperature. |
IanBenzMaxim | 1:e1c7c1c636af | 65 | Result read_current_temp(std::int16_t & temperature) const; |
IanBenzMaxim | 1:e1c7c1c636af | 66 | |
IanBenzMaxim | 1:e1c7c1c636af | 67 | /// Reads the current temperature as a floating point value. |
IanBenzMaxim | 1:e1c7c1c636af | 68 | Result read_current_temp(double & temperature) const; |
IanBenzMaxim | 1:e1c7c1c636af | 69 | |
IanBenzMaxim | 1:e1c7c1c636af | 70 | /// Reads the current temperature as an integer value. |
IanBenzMaxim | 1:e1c7c1c636af | 71 | Result read_current_temp(std::int8_t & temperature) const; |
IanBenzMaxim | 1:e1c7c1c636af | 72 | |
IanBenzMaxim | 1:e1c7c1c636af | 73 | private: |
IanBenzMaxim | 1:e1c7c1c636af | 74 | /// Bit resolution of temperature conversions. |
IanBenzMaxim | 1:e1c7c1c636af | 75 | enum Config_Resolution |
IanBenzMaxim | 1:e1c7c1c636af | 76 | { |
IanBenzMaxim | 1:e1c7c1c636af | 77 | Config_9b_Res = 0x00, |
IanBenzMaxim | 1:e1c7c1c636af | 78 | Config_10b_Res = 0x20, |
IanBenzMaxim | 1:e1c7c1c636af | 79 | Config_11b_Res = 0x40, |
IanBenzMaxim | 1:e1c7c1c636af | 80 | Config_12b_Res = 0x60 |
IanBenzMaxim | 1:e1c7c1c636af | 81 | }; |
IanBenzMaxim | 1:e1c7c1c636af | 82 | |
IanBenzMaxim | 1:e1c7c1c636af | 83 | /// DS7505 Register addresses. |
IanBenzMaxim | 1:e1c7c1c636af | 84 | enum Register |
IanBenzMaxim | 1:e1c7c1c636af | 85 | { |
IanBenzMaxim | 1:e1c7c1c636af | 86 | Temperature_Reg = 0x00, |
IanBenzMaxim | 1:e1c7c1c636af | 87 | Configuration_Reg = 0x01, |
IanBenzMaxim | 1:e1c7c1c636af | 88 | Thyst_Reg = 0x02, |
IanBenzMaxim | 1:e1c7c1c636af | 89 | Tos_Reg = 0x03 |
IanBenzMaxim | 1:e1c7c1c636af | 90 | }; |
IanBenzMaxim | 1:e1c7c1c636af | 91 | |
IanBenzMaxim | 1:e1c7c1c636af | 92 | /// Represents a DS7505 configuration. |
IanBenzMaxim | 1:e1c7c1c636af | 93 | struct Config |
IanBenzMaxim | 1:e1c7c1c636af | 94 | { |
IanBenzMaxim | 1:e1c7c1c636af | 95 | Config_Resolution resolution; |
IanBenzMaxim | 1:e1c7c1c636af | 96 | bool enable_shutdown_mode; |
IanBenzMaxim | 1:e1c7c1c636af | 97 | |
IanBenzMaxim | 1:e1c7c1c636af | 98 | Config(Config_Resolution resolution, bool enable_shutdown_mode) |
IanBenzMaxim | 1:e1c7c1c636af | 99 | : resolution(resolution), enable_shutdown_mode(enable_shutdown_mode) { } |
IanBenzMaxim | 1:e1c7c1c636af | 100 | }; |
IanBenzMaxim | 1:e1c7c1c636af | 101 | |
IanBenzMaxim | 1:e1c7c1c636af | 102 | /// @note Mark as mutable to allow manipulation by read_temp_sensor(). |
IanBenzMaxim | 1:e1c7c1c636af | 103 | mutable Config m_current_config; |
IanBenzMaxim | 1:e1c7c1c636af | 104 | |
IanBenzMaxim | 1:e1c7c1c636af | 105 | mbed::I2C & m_I2C_interface; |
IanBenzMaxim | 1:e1c7c1c636af | 106 | std::uint8_t m_I2C_address; |
IanBenzMaxim | 1:e1c7c1c636af | 107 | |
IanBenzMaxim | 1:e1c7c1c636af | 108 | /// Returns the maximum time needed in ms for a sample at the specified resolution. |
IanBenzMaxim | 1:e1c7c1c636af | 109 | static std::uint8_t get_measure_delay_ms(Config_Resolution resolution); |
IanBenzMaxim | 1:e1c7c1c636af | 110 | |
IanBenzMaxim | 1:e1c7c1c636af | 111 | /// Reads the current temperature via I2C. |
IanBenzMaxim | 1:e1c7c1c636af | 112 | /// Assumes that the I2C register pointer is already set to the temperature register. |
IanBenzMaxim | 1:e1c7c1c636af | 113 | /// @param sensor_data Output for raw data from DS7505 with upper and lower bytes combined. |
IanBenzMaxim | 1:e1c7c1c636af | 114 | /// @returns True on success. |
IanBenzMaxim | 1:e1c7c1c636af | 115 | bool read_temp_sensor_data(std::uint16_t & sensor_data) const; |
IanBenzMaxim | 1:e1c7c1c636af | 116 | |
IanBenzMaxim | 1:e1c7c1c636af | 117 | /// Reads the current temperature with support for shutdown mode. |
IanBenzMaxim | 1:e1c7c1c636af | 118 | /// @param sensor_data Output for raw data from DS7505 with upper and lower bytes combined. |
IanBenzMaxim | 1:e1c7c1c636af | 119 | /// @returns Success or Hardware_Failure. |
IanBenzMaxim | 1:e1c7c1c636af | 120 | Result read_temp_sensor(std::uint16_t & sensor_data) const; |
IanBenzMaxim | 1:e1c7c1c636af | 121 | |
IanBenzMaxim | 1:e1c7c1c636af | 122 | /// Sets the I2C register pointer for the next operation. |
IanBenzMaxim | 1:e1c7c1c636af | 123 | /// @param pointer_reg Desired register to set. |
IanBenzMaxim | 1:e1c7c1c636af | 124 | /// @returns True on success. |
IanBenzMaxim | 1:e1c7c1c636af | 125 | /// @note Allow marking const since not public. |
IanBenzMaxim | 1:e1c7c1c636af | 126 | bool set_register_pointer(Register pointer_reg) const; |
IanBenzMaxim | 1:e1c7c1c636af | 127 | |
IanBenzMaxim | 1:e1c7c1c636af | 128 | /// Writes to a device register via I2C. |
IanBenzMaxim | 1:e1c7c1c636af | 129 | /// @param write_reg Register to write to. |
IanBenzMaxim | 1:e1c7c1c636af | 130 | /// @param write_val Value to write to the register. |
IanBenzMaxim | 1:e1c7c1c636af | 131 | /// @returns True on success. |
IanBenzMaxim | 1:e1c7c1c636af | 132 | /// @note Allow marking const since not public |
IanBenzMaxim | 1:e1c7c1c636af | 133 | bool write_register(Register write_reg, std::uint8_t write_val) const; |
IanBenzMaxim | 1:e1c7c1c636af | 134 | |
IanBenzMaxim | 1:e1c7c1c636af | 135 | /// Writes the current configuration via I2C. |
IanBenzMaxim | 1:e1c7c1c636af | 136 | /// @returns True on success. |
IanBenzMaxim | 1:e1c7c1c636af | 137 | /// @note Allow marking const since not public |
IanBenzMaxim | 1:e1c7c1c636af | 138 | bool write_current_config() const; |
IanBenzMaxim | 1:e1c7c1c636af | 139 | }; |
IanBenzMaxim | 1:e1c7c1c636af | 140 | |
IanBenzMaxim | 1:e1c7c1c636af | 141 | #endif |