Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS18B20.cpp@8:211d1b8f730c, 2019-04-03 (annotated)

Committer:
reARMnimator
Date:
Wed Apr 03 12:33:10 2019 +0000
Revision:
8:211d1b8f730c
Parent:
6:a8c83a2e6fa4 
Merge with version 1.7;

Who changed what in which revision?

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