Aleksandrs Gumenuks / MaximInterface_Extended

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed_DS28EC20_GPIO

Devices/DS1920.cpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Initial commit.

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