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