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
- Committer:
- IanBenzMaxim
- Date:
- 2020-05-29
- Revision:
- 12:7eb41621ba22
- Parent:
- 11:3f3bf6bf5e6c
File content as of revision 12:7eb41621ba22:
/******************************************************************************* * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Except as contained in this notice, the name of Maxim Integrated * Products, Inc. shall not be used except as stated in the Maxim Integrated * Products, Inc. Branding Policy. * * The mere transfer of this software does not imply any licenses * of trade secrets, proprietary technology, copyrights, patents, * trademarks, maskwork rights, or any other form of intellectual * property whatsoever. Maxim Integrated Products, Inc. retains all * ownership rights. *******************************************************************************/ #include <MaximInterfaceCore/Error.hpp> #include <MaximInterfaceCore/OneWireMaster.hpp> #include "DS18B20.hpp" #define TRY MaximInterfaceCore_TRY #define TRY_VALUE MaximInterfaceCore_TRY_VALUE namespace MaximInterfaceDevices { using namespace Core; const uint_least8_t DS18B20::nineBitResolution; const uint_least8_t DS18B20::tenBitResolution; const uint_least8_t DS18B20::elevenBitResolution; const uint_least8_t DS18B20::twelveBitResolution; Result<void> DS18B20::initialize() const { TRY(readScratchpad()); return none; } Result<void> DS18B20::writeScratchpad(uint_least8_t th, uint_least8_t tl, uint_least8_t res) { Result<void> result = selectRom(*master); if (result) { const uint_least8_t sendBlock[] = {0x4E, th, tl, res}; result = master->writeBlock(sendBlock); if (result) { resolution = res; } } return result; } Result<DS18B20::Scratchpad> DS18B20::readScratchpad() const { Result<void> result = selectRom(*master); if (!result) { return result.error(); } result = master->writeByte(0xBE); if (!result) { return result.error(); } Scratchpad scratchpad; result = master->readBlock(scratchpad); if (!result) { return result.error(); } uint_least8_t receivedCrc; TRY_VALUE(receivedCrc, master->readByte()); if (receivedCrc != calculateCrc8(scratchpad)) { return CrcError; } resolution = scratchpad[4]; return scratchpad; } Result<bool> DS18B20::readPowerSupply() const { Result<void> result = selectRom(*master); if (!result) { return result.error(); } result = master->writeByte(0xB4); if (!result) { return result.error(); } return master->readBit(); } Result<void> DS18B20::copyScratchpad() { const uint_least8_t copyScratchpadCmd = 0x48; bool hasLocalPower; TRY_VALUE(hasLocalPower, readPowerSupply()); Result<void> result = selectRom(*master); if (!result) { return result; } if (hasLocalPower) { result = master->writeByte(copyScratchpadCmd); if (result) { bool recvBit; do { TRY_VALUE(recvBit, master->readBit()); } while (!recvBit); } } else { result = master->writeByteSetLevel(copyScratchpadCmd, OneWireMaster::StrongLevel); if (result) { sleep->invoke(10); result = master->setLevel(OneWireMaster::NormalLevel); } } return result; } Result<void> DS18B20::convertTemperature() { const uint_least8_t convertTemperatureCmd = 0x44; bool hasLocalPower; TRY_VALUE(hasLocalPower, readPowerSupply()); Result<void> result = selectRom(*master); if (!result) { return result; } if (hasLocalPower) { result = master->writeByte(convertTemperatureCmd); if (result) { bool recvBit; do { TRY_VALUE(recvBit, master->readBit()); } while (!recvBit); } } else { result = master->writeByteSetLevel(convertTemperatureCmd, OneWireMaster::StrongLevel); if (result) { int sleepTime; switch (resolution) { case nineBitResolution: sleepTime = 94; break; case tenBitResolution: sleepTime = 188; break; case elevenBitResolution: sleepTime = 375; break; case twelveBitResolution: default: sleepTime = 750; break; } sleep->invoke(sleepTime); result = master->setLevel(OneWireMaster::NormalLevel); } } return result; } Result<void> DS18B20::recallEeprom() { Result<void> result = selectRom(*master); if (result) { result = master->writeByte(0xB8); } return result; } const error_category & DS18B20::errorCategory() { static class : public error_category { public: virtual const char * name() const { return "MaximInterfaceDevices.DS18B20"; } virtual std::string message(int condition) const { switch (condition) { case CrcError: return "CRC Error"; case DataError: return "Data Error"; } return defaultErrorMessage(condition); } } instance; return instance; } Result<int> readTemperature(DS18B20 & ds18b20) { TRY(ds18b20.convertTemperature()); DS18B20::Scratchpad scratchpad; TRY_VALUE(scratchpad, ds18b20.readScratchpad()); const unsigned int tempData = (static_cast<unsigned int>(scratchpad[1]) << 8) | scratchpad[0]; const unsigned int signMask = 0xF800; int temperature; if ((tempData & signMask) == signMask) { temperature = -0x800; } else if ((tempData & signMask) == 0) { temperature = 0; } else { return DS18B20::DataError; } unsigned int precisionMask; switch (scratchpad[4]) { case DS18B20::nineBitResolution: default: precisionMask = 0x7; break; case DS18B20::tenBitResolution: precisionMask = 0x3; break; case DS18B20::elevenBitResolution: precisionMask = 0x1; break; case DS18B20::twelveBitResolution: precisionMask = 0x0; break; } temperature += static_cast<int>(tempData & ~(signMask | precisionMask)); return temperature; } } // namespace MaximInterfaceDevices