Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceDevices/DS18B20.cpp@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
11:3f3bf6bf5e6c 
Updated to version 2.2.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 7:9cd16581b578 33 #include <MaximInterfaceCore/Error.hpp>
IanBenzMaxim 7:9cd16581b578 34 #include <MaximInterfaceCore/OneWireMaster.hpp>
IanBenzMaxim 7:9cd16581b578 35 #include "DS18B20.hpp"
IanBenzMaxim 7:9cd16581b578 36
IanBenzMaxim 8:5ea891c7d1a1 37 #define TRY MaximInterfaceCore_TRY
IanBenzMaxim 8:5ea891c7d1a1 38 #define TRY_VALUE MaximInterfaceCore_TRY_VALUE
IanBenzMaxim 8:5ea891c7d1a1 39
IanBenzMaxim 7:9cd16581b578 40 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 41
IanBenzMaxim 7:9cd16581b578 42 using namespace Core;
IanBenzMaxim 7:9cd16581b578 43
IanBenzMaxim 7:9cd16581b578 44 const uint_least8_t DS18B20::nineBitResolution;
IanBenzMaxim 7:9cd16581b578 45 const uint_least8_t DS18B20::tenBitResolution;
IanBenzMaxim 7:9cd16581b578 46 const uint_least8_t DS18B20::elevenBitResolution;
IanBenzMaxim 7:9cd16581b578 47 const uint_least8_t DS18B20::twelveBitResolution;
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 8:5ea891c7d1a1 49 Result<void> DS18B20::initialize() const {
IanBenzMaxim 8:5ea891c7d1a1 50 TRY(readScratchpad());
IanBenzMaxim 8:5ea891c7d1a1 51 return none;
IanBenzMaxim 7:9cd16581b578 52 }
IanBenzMaxim 7:9cd16581b578 53
IanBenzMaxim 8:5ea891c7d1a1 54 Result<void> DS18B20::writeScratchpad(uint_least8_t th, uint_least8_t tl,
IanBenzMaxim 8:5ea891c7d1a1 55 uint_least8_t res) {
IanBenzMaxim 8:5ea891c7d1a1 56 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 57 if (result) {
IanBenzMaxim 7:9cd16581b578 58 const uint_least8_t sendBlock[] = {0x4E, th, tl, res};
IanBenzMaxim 7:9cd16581b578 59 result = master->writeBlock(sendBlock);
IanBenzMaxim 8:5ea891c7d1a1 60 if (result) {
IanBenzMaxim 7:9cd16581b578 61 resolution = res;
IanBenzMaxim 7:9cd16581b578 62 }
IanBenzMaxim 7:9cd16581b578 63 }
IanBenzMaxim 7:9cd16581b578 64 return result;
IanBenzMaxim 7:9cd16581b578 65 }
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 8:5ea891c7d1a1 67 Result<DS18B20::Scratchpad> DS18B20::readScratchpad() const {
IanBenzMaxim 8:5ea891c7d1a1 68 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 69 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 70 return result.error();
IanBenzMaxim 7:9cd16581b578 71 }
IanBenzMaxim 7:9cd16581b578 72 result = master->writeByte(0xBE);
IanBenzMaxim 8:5ea891c7d1a1 73 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 74 return result.error();
IanBenzMaxim 7:9cd16581b578 75 }
IanBenzMaxim 8:5ea891c7d1a1 76 Scratchpad scratchpad;
IanBenzMaxim 7:9cd16581b578 77 result = master->readBlock(scratchpad);
IanBenzMaxim 8:5ea891c7d1a1 78 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 79 return result.error();
IanBenzMaxim 7:9cd16581b578 80 }
IanBenzMaxim 7:9cd16581b578 81 uint_least8_t receivedCrc;
IanBenzMaxim 8:5ea891c7d1a1 82 TRY_VALUE(receivedCrc, master->readByte());
IanBenzMaxim 8:5ea891c7d1a1 83 if (receivedCrc != calculateCrc8(scratchpad)) {
IanBenzMaxim 8:5ea891c7d1a1 84 return CrcError;
IanBenzMaxim 7:9cd16581b578 85 }
IanBenzMaxim 8:5ea891c7d1a1 86 resolution = scratchpad[4];
IanBenzMaxim 8:5ea891c7d1a1 87 return scratchpad;
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 8:5ea891c7d1a1 90 Result<bool> DS18B20::readPowerSupply() const {
IanBenzMaxim 8:5ea891c7d1a1 91 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 92 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 93 return result.error();
IanBenzMaxim 7:9cd16581b578 94 }
IanBenzMaxim 7:9cd16581b578 95 result = master->writeByte(0xB4);
IanBenzMaxim 8:5ea891c7d1a1 96 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 97 return result.error();
IanBenzMaxim 7:9cd16581b578 98 }
IanBenzMaxim 8:5ea891c7d1a1 99 return master->readBit();
IanBenzMaxim 7:9cd16581b578 100 }
IanBenzMaxim 7:9cd16581b578 101
IanBenzMaxim 8:5ea891c7d1a1 102 Result<void> DS18B20::copyScratchpad() {
IanBenzMaxim 7:9cd16581b578 103 const uint_least8_t copyScratchpadCmd = 0x48;
IanBenzMaxim 7:9cd16581b578 104
IanBenzMaxim 7:9cd16581b578 105 bool hasLocalPower;
IanBenzMaxim 8:5ea891c7d1a1 106 TRY_VALUE(hasLocalPower, readPowerSupply());
IanBenzMaxim 8:5ea891c7d1a1 107 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 108 if (!result) {
IanBenzMaxim 7:9cd16581b578 109 return result;
IanBenzMaxim 7:9cd16581b578 110 }
IanBenzMaxim 7:9cd16581b578 111 if (hasLocalPower) {
IanBenzMaxim 7:9cd16581b578 112 result = master->writeByte(copyScratchpadCmd);
IanBenzMaxim 8:5ea891c7d1a1 113 if (result) {
IanBenzMaxim 8:5ea891c7d1a1 114 bool recvBit;
IanBenzMaxim 8:5ea891c7d1a1 115 do {
IanBenzMaxim 8:5ea891c7d1a1 116 TRY_VALUE(recvBit, master->readBit());
IanBenzMaxim 8:5ea891c7d1a1 117 } while (!recvBit);
IanBenzMaxim 7:9cd16581b578 118 }
IanBenzMaxim 7:9cd16581b578 119 } else {
IanBenzMaxim 7:9cd16581b578 120 result = master->writeByteSetLevel(copyScratchpadCmd,
IanBenzMaxim 7:9cd16581b578 121 OneWireMaster::StrongLevel);
IanBenzMaxim 8:5ea891c7d1a1 122 if (result) {
IanBenzMaxim 7:9cd16581b578 123 sleep->invoke(10);
IanBenzMaxim 7:9cd16581b578 124 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 125 }
IanBenzMaxim 7:9cd16581b578 126 }
IanBenzMaxim 7:9cd16581b578 127 return result;
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 8:5ea891c7d1a1 130 Result<void> DS18B20::convertTemperature() {
IanBenzMaxim 7:9cd16581b578 131 const uint_least8_t convertTemperatureCmd = 0x44;
IanBenzMaxim 7:9cd16581b578 132
IanBenzMaxim 7:9cd16581b578 133 bool hasLocalPower;
IanBenzMaxim 8:5ea891c7d1a1 134 TRY_VALUE(hasLocalPower, readPowerSupply());
IanBenzMaxim 8:5ea891c7d1a1 135 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 136 if (!result) {
IanBenzMaxim 7:9cd16581b578 137 return result;
IanBenzMaxim 7:9cd16581b578 138 }
IanBenzMaxim 7:9cd16581b578 139 if (hasLocalPower) {
IanBenzMaxim 7:9cd16581b578 140 result = master->writeByte(convertTemperatureCmd);
IanBenzMaxim 8:5ea891c7d1a1 141 if (result) {
IanBenzMaxim 8:5ea891c7d1a1 142 bool recvBit;
IanBenzMaxim 8:5ea891c7d1a1 143 do {
IanBenzMaxim 8:5ea891c7d1a1 144 TRY_VALUE(recvBit, master->readBit());
IanBenzMaxim 8:5ea891c7d1a1 145 } while (!recvBit);
IanBenzMaxim 7:9cd16581b578 146 }
IanBenzMaxim 7:9cd16581b578 147 } else {
IanBenzMaxim 7:9cd16581b578 148 result = master->writeByteSetLevel(convertTemperatureCmd,
IanBenzMaxim 7:9cd16581b578 149 OneWireMaster::StrongLevel);
IanBenzMaxim 8:5ea891c7d1a1 150 if (result) {
IanBenzMaxim 7:9cd16581b578 151 int sleepTime;
IanBenzMaxim 7:9cd16581b578 152 switch (resolution) {
IanBenzMaxim 7:9cd16581b578 153 case nineBitResolution:
IanBenzMaxim 7:9cd16581b578 154 sleepTime = 94;
IanBenzMaxim 7:9cd16581b578 155 break;
IanBenzMaxim 7:9cd16581b578 156
IanBenzMaxim 7:9cd16581b578 157 case tenBitResolution:
IanBenzMaxim 7:9cd16581b578 158 sleepTime = 188;
IanBenzMaxim 7:9cd16581b578 159 break;
IanBenzMaxim 7:9cd16581b578 160
IanBenzMaxim 7:9cd16581b578 161 case elevenBitResolution:
IanBenzMaxim 7:9cd16581b578 162 sleepTime = 375;
IanBenzMaxim 7:9cd16581b578 163 break;
IanBenzMaxim 7:9cd16581b578 164
IanBenzMaxim 7:9cd16581b578 165 case twelveBitResolution:
IanBenzMaxim 7:9cd16581b578 166 default:
IanBenzMaxim 7:9cd16581b578 167 sleepTime = 750;
IanBenzMaxim 7:9cd16581b578 168 break;
IanBenzMaxim 7:9cd16581b578 169 }
IanBenzMaxim 7:9cd16581b578 170 sleep->invoke(sleepTime);
IanBenzMaxim 7:9cd16581b578 171 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 172 }
IanBenzMaxim 7:9cd16581b578 173 }
IanBenzMaxim 7:9cd16581b578 174 return result;
IanBenzMaxim 7:9cd16581b578 175 }
IanBenzMaxim 7:9cd16581b578 176
IanBenzMaxim 8:5ea891c7d1a1 177 Result<void> DS18B20::recallEeprom() {
IanBenzMaxim 8:5ea891c7d1a1 178 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 179 if (result) {
IanBenzMaxim 7:9cd16581b578 180 result = master->writeByte(0xB8);
IanBenzMaxim 7:9cd16581b578 181 }
IanBenzMaxim 7:9cd16581b578 182 return result;
IanBenzMaxim 7:9cd16581b578 183 }
IanBenzMaxim 7:9cd16581b578 184
IanBenzMaxim 7:9cd16581b578 185 const error_category & DS18B20::errorCategory() {
IanBenzMaxim 7:9cd16581b578 186 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 187 public:
IanBenzMaxim 11:3f3bf6bf5e6c 188 virtual const char * name() const {
IanBenzMaxim 11:3f3bf6bf5e6c 189 return "MaximInterfaceDevices.DS18B20";
IanBenzMaxim 11:3f3bf6bf5e6c 190 }
IanBenzMaxim 7:9cd16581b578 191
IanBenzMaxim 7:9cd16581b578 192 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 193 switch (condition) {
IanBenzMaxim 7:9cd16581b578 194 case CrcError:
IanBenzMaxim 7:9cd16581b578 195 return "CRC Error";
IanBenzMaxim 7:9cd16581b578 196
IanBenzMaxim 7:9cd16581b578 197 case DataError:
IanBenzMaxim 7:9cd16581b578 198 return "Data Error";
IanBenzMaxim 7:9cd16581b578 199 }
IanBenzMaxim 8:5ea891c7d1a1 200 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 201 }
IanBenzMaxim 7:9cd16581b578 202 } instance;
IanBenzMaxim 7:9cd16581b578 203 return instance;
IanBenzMaxim 7:9cd16581b578 204 }
IanBenzMaxim 7:9cd16581b578 205
IanBenzMaxim 8:5ea891c7d1a1 206 Result<int> readTemperature(DS18B20 & ds18b20) {
IanBenzMaxim 8:5ea891c7d1a1 207 TRY(ds18b20.convertTemperature());
IanBenzMaxim 8:5ea891c7d1a1 208 DS18B20::Scratchpad scratchpad;
IanBenzMaxim 8:5ea891c7d1a1 209 TRY_VALUE(scratchpad, ds18b20.readScratchpad());
IanBenzMaxim 7:9cd16581b578 210
IanBenzMaxim 7:9cd16581b578 211 const unsigned int tempData =
IanBenzMaxim 7:9cd16581b578 212 (static_cast<unsigned int>(scratchpad[1]) << 8) | scratchpad[0];
IanBenzMaxim 7:9cd16581b578 213 const unsigned int signMask = 0xF800;
IanBenzMaxim 8:5ea891c7d1a1 214 int temperature;
IanBenzMaxim 7:9cd16581b578 215 if ((tempData & signMask) == signMask) {
IanBenzMaxim 7:9cd16581b578 216 temperature = -0x800;
IanBenzMaxim 7:9cd16581b578 217 } else if ((tempData & signMask) == 0) {
IanBenzMaxim 7:9cd16581b578 218 temperature = 0;
IanBenzMaxim 7:9cd16581b578 219 } else {
IanBenzMaxim 8:5ea891c7d1a1 220 return DS18B20::DataError;
IanBenzMaxim 7:9cd16581b578 221 }
IanBenzMaxim 7:9cd16581b578 222 unsigned int precisionMask;
IanBenzMaxim 7:9cd16581b578 223 switch (scratchpad[4]) {
IanBenzMaxim 7:9cd16581b578 224 case DS18B20::nineBitResolution:
IanBenzMaxim 7:9cd16581b578 225 default:
IanBenzMaxim 7:9cd16581b578 226 precisionMask = 0x7;
IanBenzMaxim 7:9cd16581b578 227 break;
IanBenzMaxim 7:9cd16581b578 228
IanBenzMaxim 7:9cd16581b578 229 case DS18B20::tenBitResolution:
IanBenzMaxim 7:9cd16581b578 230 precisionMask = 0x3;
IanBenzMaxim 7:9cd16581b578 231 break;
IanBenzMaxim 7:9cd16581b578 232
IanBenzMaxim 7:9cd16581b578 233 case DS18B20::elevenBitResolution:
IanBenzMaxim 7:9cd16581b578 234 precisionMask = 0x1;
IanBenzMaxim 7:9cd16581b578 235 break;
IanBenzMaxim 7:9cd16581b578 236
IanBenzMaxim 7:9cd16581b578 237 case DS18B20::twelveBitResolution:
IanBenzMaxim 7:9cd16581b578 238 precisionMask = 0x0;
IanBenzMaxim 7:9cd16581b578 239 break;
IanBenzMaxim 7:9cd16581b578 240 }
IanBenzMaxim 7:9cd16581b578 241 temperature += static_cast<int>(tempData & ~(signMask | precisionMask));
IanBenzMaxim 8:5ea891c7d1a1 242 return temperature;
IanBenzMaxim 7:9cd16581b578 243 }
IanBenzMaxim 7:9cd16581b578 244
IanBenzMaxim 7:9cd16581b578 245 } // namespace MaximInterfaceDevices