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@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 7:9cd16581b578 2 * Copyright (C) 2017 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 7:9cd16581b578 37 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 7:9cd16581b578 39 using namespace Core;
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 const uint_least8_t DS18B20::nineBitResolution;
IanBenzMaxim 7:9cd16581b578 42 const uint_least8_t DS18B20::tenBitResolution;
IanBenzMaxim 7:9cd16581b578 43 const uint_least8_t DS18B20::elevenBitResolution;
IanBenzMaxim 7:9cd16581b578 44 const uint_least8_t DS18B20::twelveBitResolution;
IanBenzMaxim 7:9cd16581b578 45
IanBenzMaxim 7:9cd16581b578 46 error_code DS18B20::initialize() {
IanBenzMaxim 7:9cd16581b578 47 Scratchpad::array scratchpad;
IanBenzMaxim 7:9cd16581b578 48 return readScratchpad(scratchpad);
IanBenzMaxim 7:9cd16581b578 49 }
IanBenzMaxim 7:9cd16581b578 50
IanBenzMaxim 7:9cd16581b578 51 error_code DS18B20::writeScratchpad(uint_least8_t th, uint_least8_t tl,
IanBenzMaxim 7:9cd16581b578 52 uint_least8_t res) {
IanBenzMaxim 7:9cd16581b578 53 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 54 if (!result) {
IanBenzMaxim 7:9cd16581b578 55 const uint_least8_t sendBlock[] = {0x4E, th, tl, res};
IanBenzMaxim 7:9cd16581b578 56 result = master->writeBlock(sendBlock);
IanBenzMaxim 7:9cd16581b578 57 if (!result) {
IanBenzMaxim 7:9cd16581b578 58 resolution = res;
IanBenzMaxim 7:9cd16581b578 59 }
IanBenzMaxim 7:9cd16581b578 60 }
IanBenzMaxim 7:9cd16581b578 61 return result;
IanBenzMaxim 7:9cd16581b578 62 }
IanBenzMaxim 7:9cd16581b578 63
IanBenzMaxim 7:9cd16581b578 64 error_code DS18B20::readScratchpad(Scratchpad::span scratchpad) {
IanBenzMaxim 7:9cd16581b578 65 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 66 if (result) {
IanBenzMaxim 7:9cd16581b578 67 return result;
IanBenzMaxim 7:9cd16581b578 68 }
IanBenzMaxim 7:9cd16581b578 69 result = master->writeByte(0xBE);
IanBenzMaxim 7:9cd16581b578 70 if (result) {
IanBenzMaxim 7:9cd16581b578 71 return result;
IanBenzMaxim 7:9cd16581b578 72 }
IanBenzMaxim 7:9cd16581b578 73 result = master->readBlock(scratchpad);
IanBenzMaxim 7:9cd16581b578 74 if (result) {
IanBenzMaxim 7:9cd16581b578 75 return result;
IanBenzMaxim 7:9cd16581b578 76 }
IanBenzMaxim 7:9cd16581b578 77 uint_least8_t receivedCrc;
IanBenzMaxim 7:9cd16581b578 78 result = master->readByte(receivedCrc);
IanBenzMaxim 7:9cd16581b578 79 if (result) {
IanBenzMaxim 7:9cd16581b578 80 return result;
IanBenzMaxim 7:9cd16581b578 81 }
IanBenzMaxim 7:9cd16581b578 82 if (receivedCrc == calculateCrc8(scratchpad)) {
IanBenzMaxim 7:9cd16581b578 83 resolution = scratchpad[4];
IanBenzMaxim 7:9cd16581b578 84 } else {
IanBenzMaxim 7:9cd16581b578 85 result = make_error_code(CrcError);
IanBenzMaxim 7:9cd16581b578 86 }
IanBenzMaxim 7:9cd16581b578 87 return result;
IanBenzMaxim 7:9cd16581b578 88 }
IanBenzMaxim 7:9cd16581b578 89
IanBenzMaxim 7:9cd16581b578 90 error_code DS18B20::readPowerSupply(bool & localPower) {
IanBenzMaxim 7:9cd16581b578 91 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 92 if (result) {
IanBenzMaxim 7:9cd16581b578 93 return result;
IanBenzMaxim 7:9cd16581b578 94 }
IanBenzMaxim 7:9cd16581b578 95 result = master->writeByte(0xB4);
IanBenzMaxim 7:9cd16581b578 96 if (result) {
IanBenzMaxim 7:9cd16581b578 97 return result;
IanBenzMaxim 7:9cd16581b578 98 }
IanBenzMaxim 7:9cd16581b578 99 result = master->touchBit(localPower);
IanBenzMaxim 7:9cd16581b578 100 return result;
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 error_code DS18B20::copyScratchpad() {
IanBenzMaxim 7:9cd16581b578 104 const uint_least8_t copyScratchpadCmd = 0x48;
IanBenzMaxim 7:9cd16581b578 105
IanBenzMaxim 7:9cd16581b578 106 bool hasLocalPower;
IanBenzMaxim 7:9cd16581b578 107 error_code result = readPowerSupply(hasLocalPower);
IanBenzMaxim 7:9cd16581b578 108 if (result) {
IanBenzMaxim 7:9cd16581b578 109 return result;
IanBenzMaxim 7:9cd16581b578 110 }
IanBenzMaxim 7:9cd16581b578 111 result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 112 if (result) {
IanBenzMaxim 7:9cd16581b578 113 return result;
IanBenzMaxim 7:9cd16581b578 114 }
IanBenzMaxim 7:9cd16581b578 115 if (hasLocalPower) {
IanBenzMaxim 7:9cd16581b578 116 result = master->writeByte(copyScratchpadCmd);
IanBenzMaxim 7:9cd16581b578 117 bool recvbit = 0;
IanBenzMaxim 7:9cd16581b578 118 while (!recvbit && !result) {
IanBenzMaxim 7:9cd16581b578 119 result = master->touchBit(recvbit);
IanBenzMaxim 7:9cd16581b578 120 }
IanBenzMaxim 7:9cd16581b578 121 } else {
IanBenzMaxim 7:9cd16581b578 122 result = master->writeByteSetLevel(copyScratchpadCmd,
IanBenzMaxim 7:9cd16581b578 123 OneWireMaster::StrongLevel);
IanBenzMaxim 7:9cd16581b578 124 if (!result) {
IanBenzMaxim 7:9cd16581b578 125 sleep->invoke(10);
IanBenzMaxim 7:9cd16581b578 126 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 127 }
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129 return result;
IanBenzMaxim 7:9cd16581b578 130 }
IanBenzMaxim 7:9cd16581b578 131
IanBenzMaxim 7:9cd16581b578 132 error_code DS18B20::convertTemperature() {
IanBenzMaxim 7:9cd16581b578 133 const uint_least8_t convertTemperatureCmd = 0x44;
IanBenzMaxim 7:9cd16581b578 134
IanBenzMaxim 7:9cd16581b578 135 bool hasLocalPower;
IanBenzMaxim 7:9cd16581b578 136 error_code result = readPowerSupply(hasLocalPower);
IanBenzMaxim 7:9cd16581b578 137 if (result) {
IanBenzMaxim 7:9cd16581b578 138 return result;
IanBenzMaxim 7:9cd16581b578 139 }
IanBenzMaxim 7:9cd16581b578 140 result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 141 if (result) {
IanBenzMaxim 7:9cd16581b578 142 return result;
IanBenzMaxim 7:9cd16581b578 143 }
IanBenzMaxim 7:9cd16581b578 144 if (hasLocalPower) {
IanBenzMaxim 7:9cd16581b578 145 result = master->writeByte(convertTemperatureCmd);
IanBenzMaxim 7:9cd16581b578 146 bool recvbit = 0;
IanBenzMaxim 7:9cd16581b578 147 while (!result && !recvbit) {
IanBenzMaxim 7:9cd16581b578 148 result = master->touchBit(recvbit);
IanBenzMaxim 7:9cd16581b578 149 }
IanBenzMaxim 7:9cd16581b578 150 } else {
IanBenzMaxim 7:9cd16581b578 151 result = master->writeByteSetLevel(convertTemperatureCmd,
IanBenzMaxim 7:9cd16581b578 152 OneWireMaster::StrongLevel);
IanBenzMaxim 7:9cd16581b578 153 if (!result) {
IanBenzMaxim 7:9cd16581b578 154 int sleepTime;
IanBenzMaxim 7:9cd16581b578 155 switch (resolution) {
IanBenzMaxim 7:9cd16581b578 156 case nineBitResolution:
IanBenzMaxim 7:9cd16581b578 157 sleepTime = 94;
IanBenzMaxim 7:9cd16581b578 158 break;
IanBenzMaxim 7:9cd16581b578 159
IanBenzMaxim 7:9cd16581b578 160 case tenBitResolution:
IanBenzMaxim 7:9cd16581b578 161 sleepTime = 188;
IanBenzMaxim 7:9cd16581b578 162 break;
IanBenzMaxim 7:9cd16581b578 163
IanBenzMaxim 7:9cd16581b578 164 case elevenBitResolution:
IanBenzMaxim 7:9cd16581b578 165 sleepTime = 375;
IanBenzMaxim 7:9cd16581b578 166 break;
IanBenzMaxim 7:9cd16581b578 167
IanBenzMaxim 7:9cd16581b578 168 case twelveBitResolution:
IanBenzMaxim 7:9cd16581b578 169 default:
IanBenzMaxim 7:9cd16581b578 170 sleepTime = 750;
IanBenzMaxim 7:9cd16581b578 171 break;
IanBenzMaxim 7:9cd16581b578 172 }
IanBenzMaxim 7:9cd16581b578 173 sleep->invoke(sleepTime);
IanBenzMaxim 7:9cd16581b578 174 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 175 }
IanBenzMaxim 7:9cd16581b578 176 }
IanBenzMaxim 7:9cd16581b578 177 return result;
IanBenzMaxim 7:9cd16581b578 178 }
IanBenzMaxim 7:9cd16581b578 179
IanBenzMaxim 7:9cd16581b578 180 error_code DS18B20::recallEeprom() {
IanBenzMaxim 7:9cd16581b578 181 error_code result = selectRom(*master);
IanBenzMaxim 7:9cd16581b578 182 if (!result) {
IanBenzMaxim 7:9cd16581b578 183 result = master->writeByte(0xB8);
IanBenzMaxim 7:9cd16581b578 184 }
IanBenzMaxim 7:9cd16581b578 185 return result;
IanBenzMaxim 7:9cd16581b578 186 }
IanBenzMaxim 7:9cd16581b578 187
IanBenzMaxim 7:9cd16581b578 188 const error_category & DS18B20::errorCategory() {
IanBenzMaxim 7:9cd16581b578 189 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 190 public:
IanBenzMaxim 7:9cd16581b578 191 virtual const char * name() const { return "DS18B20"; }
IanBenzMaxim 7:9cd16581b578 192
IanBenzMaxim 7:9cd16581b578 193 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 194 switch (condition) {
IanBenzMaxim 7:9cd16581b578 195 case CrcError:
IanBenzMaxim 7:9cd16581b578 196 return "CRC Error";
IanBenzMaxim 7:9cd16581b578 197
IanBenzMaxim 7:9cd16581b578 198 case DataError:
IanBenzMaxim 7:9cd16581b578 199 return "Data Error";
IanBenzMaxim 7:9cd16581b578 200
IanBenzMaxim 7:9cd16581b578 201 default:
IanBenzMaxim 7:9cd16581b578 202 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 203 }
IanBenzMaxim 7:9cd16581b578 204 }
IanBenzMaxim 7:9cd16581b578 205 } instance;
IanBenzMaxim 7:9cd16581b578 206 return instance;
IanBenzMaxim 7:9cd16581b578 207 }
IanBenzMaxim 7:9cd16581b578 208
IanBenzMaxim 7:9cd16581b578 209 error_code readTemperature(DS18B20 & ds18b20, int & temperature) {
IanBenzMaxim 7:9cd16581b578 210 error_code result = ds18b20.convertTemperature();
IanBenzMaxim 7:9cd16581b578 211 if (result) {
IanBenzMaxim 7:9cd16581b578 212 return result;
IanBenzMaxim 7:9cd16581b578 213 }
IanBenzMaxim 7:9cd16581b578 214 DS18B20::Scratchpad::array scratchpad;
IanBenzMaxim 7:9cd16581b578 215 result = ds18b20.readScratchpad(scratchpad);
IanBenzMaxim 7:9cd16581b578 216 if (result) {
IanBenzMaxim 7:9cd16581b578 217 return result;
IanBenzMaxim 7:9cd16581b578 218 }
IanBenzMaxim 7:9cd16581b578 219
IanBenzMaxim 7:9cd16581b578 220 const unsigned int tempData =
IanBenzMaxim 7:9cd16581b578 221 (static_cast<unsigned int>(scratchpad[1]) << 8) | scratchpad[0];
IanBenzMaxim 7:9cd16581b578 222 const unsigned int signMask = 0xF800;
IanBenzMaxim 7:9cd16581b578 223 if ((tempData & signMask) == signMask) {
IanBenzMaxim 7:9cd16581b578 224 temperature = -0x800;
IanBenzMaxim 7:9cd16581b578 225 } else if ((tempData & signMask) == 0) {
IanBenzMaxim 7:9cd16581b578 226 temperature = 0;
IanBenzMaxim 7:9cd16581b578 227 } else {
IanBenzMaxim 7:9cd16581b578 228 return make_error_code(DS18B20::DataError);
IanBenzMaxim 7:9cd16581b578 229 }
IanBenzMaxim 7:9cd16581b578 230 unsigned int precisionMask;
IanBenzMaxim 7:9cd16581b578 231 switch (scratchpad[4]) {
IanBenzMaxim 7:9cd16581b578 232 case DS18B20::nineBitResolution:
IanBenzMaxim 7:9cd16581b578 233 default:
IanBenzMaxim 7:9cd16581b578 234 precisionMask = 0x7;
IanBenzMaxim 7:9cd16581b578 235 break;
IanBenzMaxim 7:9cd16581b578 236
IanBenzMaxim 7:9cd16581b578 237 case DS18B20::tenBitResolution:
IanBenzMaxim 7:9cd16581b578 238 precisionMask = 0x3;
IanBenzMaxim 7:9cd16581b578 239 break;
IanBenzMaxim 7:9cd16581b578 240
IanBenzMaxim 7:9cd16581b578 241 case DS18B20::elevenBitResolution:
IanBenzMaxim 7:9cd16581b578 242 precisionMask = 0x1;
IanBenzMaxim 7:9cd16581b578 243 break;
IanBenzMaxim 7:9cd16581b578 244
IanBenzMaxim 7:9cd16581b578 245 case DS18B20::twelveBitResolution:
IanBenzMaxim 7:9cd16581b578 246 precisionMask = 0x0;
IanBenzMaxim 7:9cd16581b578 247 break;
IanBenzMaxim 7:9cd16581b578 248 }
IanBenzMaxim 7:9cd16581b578 249 temperature += static_cast<int>(tempData & ~(signMask | precisionMask));
IanBenzMaxim 7:9cd16581b578 250 return error_code();
IanBenzMaxim 7:9cd16581b578 251 }
IanBenzMaxim 7:9cd16581b578 252
IanBenzMaxim 7:9cd16581b578 253 } // namespace MaximInterfaceDevices