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/DS1920.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 "DS1920.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 8:5ea891c7d1a1 41 Result<void> DS1920::writeScratchpad(uint_least8_t th, uint_least8_t tl) {
IanBenzMaxim 8:5ea891c7d1a1 42 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 43 if (result) {
IanBenzMaxim 7:9cd16581b578 44 const uint_least8_t sendBlock[] = {0x4E, th, tl};
IanBenzMaxim 7:9cd16581b578 45 result = master->writeBlock(sendBlock);
IanBenzMaxim 7:9cd16581b578 46 }
IanBenzMaxim 7:9cd16581b578 47 return result;
IanBenzMaxim 7:9cd16581b578 48 }
IanBenzMaxim 7:9cd16581b578 49
IanBenzMaxim 8:5ea891c7d1a1 50 Result<DS1920::Scratchpad> DS1920::readScratchpad() const {
IanBenzMaxim 8:5ea891c7d1a1 51 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 52 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 53 return result.error();
IanBenzMaxim 8:5ea891c7d1a1 54 }
IanBenzMaxim 8:5ea891c7d1a1 55 result = master->writeByte(0xBE);
IanBenzMaxim 7:9cd16581b578 56 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 57 return result.error();
IanBenzMaxim 8:5ea891c7d1a1 58 }
IanBenzMaxim 8:5ea891c7d1a1 59 Scratchpad scratchpad;
IanBenzMaxim 8:5ea891c7d1a1 60 result = master->readBlock(scratchpad);
IanBenzMaxim 8:5ea891c7d1a1 61 if (!result) {
IanBenzMaxim 8:5ea891c7d1a1 62 return result.error();
IanBenzMaxim 7:9cd16581b578 63 }
IanBenzMaxim 8:5ea891c7d1a1 64 uint_least8_t receivedCrc;
IanBenzMaxim 8:5ea891c7d1a1 65 MaximInterfaceCore_TRY_VALUE(receivedCrc, master->readByte());
IanBenzMaxim 8:5ea891c7d1a1 66 if (receivedCrc != calculateCrc8(scratchpad)) {
IanBenzMaxim 8:5ea891c7d1a1 67 return CrcError;
IanBenzMaxim 8:5ea891c7d1a1 68 }
IanBenzMaxim 8:5ea891c7d1a1 69 return scratchpad;
IanBenzMaxim 7:9cd16581b578 70 }
IanBenzMaxim 7:9cd16581b578 71
IanBenzMaxim 8:5ea891c7d1a1 72 Result<void> DS1920::copyScratchpad() {
IanBenzMaxim 8:5ea891c7d1a1 73 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 74 if (result) {
IanBenzMaxim 7:9cd16581b578 75 result = master->writeByteSetLevel(0x48, OneWireMaster::StrongLevel);
IanBenzMaxim 8:5ea891c7d1a1 76 if (result) {
IanBenzMaxim 7:9cd16581b578 77 sleep->invoke(10);
IanBenzMaxim 7:9cd16581b578 78 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 79 }
IanBenzMaxim 7:9cd16581b578 80 }
IanBenzMaxim 7:9cd16581b578 81 return result;
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83
IanBenzMaxim 8:5ea891c7d1a1 84 Result<void> DS1920::convertTemperature() {
IanBenzMaxim 8:5ea891c7d1a1 85 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 86 if (result) {
IanBenzMaxim 7:9cd16581b578 87 result = master->writeByteSetLevel(0x44, OneWireMaster::StrongLevel);
IanBenzMaxim 8:5ea891c7d1a1 88 if (result) {
IanBenzMaxim 7:9cd16581b578 89 sleep->invoke(750);
IanBenzMaxim 7:9cd16581b578 90 result = master->setLevel(OneWireMaster::NormalLevel);
IanBenzMaxim 7:9cd16581b578 91 }
IanBenzMaxim 7:9cd16581b578 92 }
IanBenzMaxim 7:9cd16581b578 93 return result;
IanBenzMaxim 7:9cd16581b578 94 }
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 8:5ea891c7d1a1 96 Result<void> DS1920::recallEeprom() {
IanBenzMaxim 8:5ea891c7d1a1 97 Result<void> result = selectRom(*master);
IanBenzMaxim 8:5ea891c7d1a1 98 if (result) {
IanBenzMaxim 7:9cd16581b578 99 result = master->writeByte(0xB8);
IanBenzMaxim 7:9cd16581b578 100 }
IanBenzMaxim 7:9cd16581b578 101 return result;
IanBenzMaxim 7:9cd16581b578 102 }
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 const error_category & DS1920::errorCategory() {
IanBenzMaxim 7:9cd16581b578 105 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 106 public:
IanBenzMaxim 11:3f3bf6bf5e6c 107 virtual const char * name() const { return "MaximInterfaceDevices.DS1920"; }
IanBenzMaxim 7:9cd16581b578 108
IanBenzMaxim 7:9cd16581b578 109 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 110 switch (condition) {
IanBenzMaxim 7:9cd16581b578 111 case CrcError:
IanBenzMaxim 7:9cd16581b578 112 return "CRC Error";
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 7:9cd16581b578 114 case DataError:
IanBenzMaxim 7:9cd16581b578 115 return "Data Error";
IanBenzMaxim 7:9cd16581b578 116 }
IanBenzMaxim 8:5ea891c7d1a1 117 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 118 }
IanBenzMaxim 7:9cd16581b578 119 } instance;
IanBenzMaxim 7:9cd16581b578 120 return instance;
IanBenzMaxim 7:9cd16581b578 121 }
IanBenzMaxim 7:9cd16581b578 122
IanBenzMaxim 8:5ea891c7d1a1 123 Result<int> readTemperature(DS1920 & ds1920) {
IanBenzMaxim 8:5ea891c7d1a1 124 MaximInterfaceCore_TRY(ds1920.convertTemperature());
IanBenzMaxim 8:5ea891c7d1a1 125 DS1920::Scratchpad scratchpad;
IanBenzMaxim 8:5ea891c7d1a1 126 MaximInterfaceCore_TRY_VALUE(scratchpad, ds1920.readScratchpad());
IanBenzMaxim 7:9cd16581b578 127
IanBenzMaxim 7:9cd16581b578 128 unsigned int tempData =
IanBenzMaxim 7:9cd16581b578 129 (static_cast<unsigned int>(scratchpad[1]) << 8) | scratchpad[0];
IanBenzMaxim 7:9cd16581b578 130 const unsigned int signMask = 0xFF00;
IanBenzMaxim 8:5ea891c7d1a1 131 int temperature;
IanBenzMaxim 7:9cd16581b578 132 if ((tempData & signMask) == signMask) {
IanBenzMaxim 7:9cd16581b578 133 temperature = -0x100;
IanBenzMaxim 7:9cd16581b578 134 tempData &= ~signMask;
IanBenzMaxim 7:9cd16581b578 135 } else if ((tempData & signMask) == 0) {
IanBenzMaxim 7:9cd16581b578 136 temperature = 0;
IanBenzMaxim 7:9cd16581b578 137 } else {
IanBenzMaxim 8:5ea891c7d1a1 138 return DS1920::DataError;
IanBenzMaxim 7:9cd16581b578 139 }
IanBenzMaxim 7:9cd16581b578 140 temperature += static_cast<int>(tempData);
IanBenzMaxim 8:5ea891c7d1a1 141 return temperature;
IanBenzMaxim 7:9cd16581b578 142 }
IanBenzMaxim 7:9cd16581b578 143
IanBenzMaxim 7:9cd16581b578 144 } // namespace MaximInterfaceDevices