Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS1920.hpp@10:de4b8812877d, 2020-01-06 (annotated)

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
7:471901a04573 
Fixed inappropriate include path.

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 #ifndef MaximInterface_DS1920
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_DS1920
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <MaximInterface/Links/SelectRom.hpp>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/Sleep.hpp>
IanBenzMaxim 6:a8c83a2e6fa4 38 #include <MaximInterface/Utilities/array_span.hpp>
IanBenzMaxim 0:f77ad7f72d04 39 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 42
IanBenzMaxim 7:471901a04573 43 /// @brief DS1920 1-Wire Temperature iButton
IanBenzMaxim 0:f77ad7f72d04 44 /// @details The iButton® temperature logger (DS1920) provides
IanBenzMaxim 0:f77ad7f72d04 45 /// direct-to-digital 9-bit temperature readings over a range of
IanBenzMaxim 0:f77ad7f72d04 46 /// -55°C to +100°C in 0.5° increments. The iButton communicates with
IanBenzMaxim 0:f77ad7f72d04 47 /// a processor using the 1-Wire® protocol through a hardware port
IanBenzMaxim 0:f77ad7f72d04 48 /// interface. The port interface provides both the physical link and
IanBenzMaxim 0:f77ad7f72d04 49 /// handles the communication protocols that enable the processor to
IanBenzMaxim 0:f77ad7f72d04 50 /// access iButton resources with simple commands. Two bytes of
IanBenzMaxim 0:f77ad7f72d04 51 /// EEPROM can be used either to set alarm triggers or for storing
IanBenzMaxim 0:f77ad7f72d04 52 /// user data.
IanBenzMaxim 0:f77ad7f72d04 53 class DS1920 {
IanBenzMaxim 0:f77ad7f72d04 54 public:
IanBenzMaxim 0:f77ad7f72d04 55 enum ErrorValue { CrcError = 1, DataError };
IanBenzMaxim 0:f77ad7f72d04 56
IanBenzMaxim 0:f77ad7f72d04 57 /// Holds the contents of the device scratchpad.
IanBenzMaxim 6:a8c83a2e6fa4 58 typedef array_span<uint_least8_t, 8> Scratchpad;
IanBenzMaxim 0:f77ad7f72d04 59
IanBenzMaxim 6:a8c83a2e6fa4 60 DS1920(Sleep & sleep, OneWireMaster & master, const SelectRom & selectRom)
IanBenzMaxim 0:f77ad7f72d04 61 : selectRom(selectRom), master(&master), sleep(&sleep) {}
IanBenzMaxim 0:f77ad7f72d04 62
IanBenzMaxim 6:a8c83a2e6fa4 63 void setSleep(Sleep & sleep) { this->sleep = &sleep; }
IanBenzMaxim 6:a8c83a2e6fa4 64
IanBenzMaxim 0:f77ad7f72d04 65 void setMaster(OneWireMaster & master) { this->master = &master; }
IanBenzMaxim 6:a8c83a2e6fa4 66
IanBenzMaxim 0:f77ad7f72d04 67 void setSelectRom(const SelectRom & selectRom) {
IanBenzMaxim 0:f77ad7f72d04 68 this->selectRom = selectRom;
IanBenzMaxim 0:f77ad7f72d04 69 }
IanBenzMaxim 0:f77ad7f72d04 70
IanBenzMaxim 7:471901a04573 71 /// @brief Write Scratchpad Command
IanBenzMaxim 0:f77ad7f72d04 72 /// @details If the result of a temperature measurement is higher
IanBenzMaxim 0:f77ad7f72d04 73 /// than TH or lower than TL, an alarm flag inside the device is
IanBenzMaxim 0:f77ad7f72d04 74 /// set. This flag is updated with every temperature measurement.
IanBenzMaxim 0:f77ad7f72d04 75 /// As long as the alarm flag is set, the DS1920 will respond to
IanBenzMaxim 0:f77ad7f72d04 76 /// the alarm search command.
IanBenzMaxim 0:f77ad7f72d04 77 /// @param[in] th 8-bit upper temperature threshold, MSB indicates sign.
IanBenzMaxim 0:f77ad7f72d04 78 /// @param[in] tl 8-bit lower temperature threshold, MSB indicates sign.
IanBenzMaxim 0:f77ad7f72d04 79 MaximInterface_EXPORT error_code writeScratchpad(uint_least8_t th,
IanBenzMaxim 0:f77ad7f72d04 80 uint_least8_t tl);
IanBenzMaxim 0:f77ad7f72d04 81
IanBenzMaxim 7:471901a04573 82 /// @brief Read Scratchpad Command
IanBenzMaxim 0:f77ad7f72d04 83 /// @param[out] scratchpad Contents of scratchpad.
IanBenzMaxim 6:a8c83a2e6fa4 84 MaximInterface_EXPORT error_code readScratchpad(Scratchpad::span scratchpad);
IanBenzMaxim 0:f77ad7f72d04 85
IanBenzMaxim 7:471901a04573 86 /// @brief Copy Scratchpad Command
IanBenzMaxim 0:f77ad7f72d04 87 /// @details This command copies from the scratchpad into the
IanBenzMaxim 0:f77ad7f72d04 88 /// EEPROM of the DS1920, storing the temperature trigger bytes
IanBenzMaxim 0:f77ad7f72d04 89 /// in nonvolatile memory.
IanBenzMaxim 0:f77ad7f72d04 90 MaximInterface_EXPORT error_code copyScratchpad();
IanBenzMaxim 0:f77ad7f72d04 91
IanBenzMaxim 7:471901a04573 92 /// @brief Convert Temperature Command
IanBenzMaxim 0:f77ad7f72d04 93 /// @details This command begins a temperature conversion.
IanBenzMaxim 0:f77ad7f72d04 94 MaximInterface_EXPORT error_code convertTemperature();
IanBenzMaxim 0:f77ad7f72d04 95
IanBenzMaxim 7:471901a04573 96 /// @brief Recall Command
IanBenzMaxim 0:f77ad7f72d04 97 /// @details This command recalls the temperature trigger values
IanBenzMaxim 0:f77ad7f72d04 98 /// stored in EEPROM to the scratchpad.
IanBenzMaxim 0:f77ad7f72d04 99 MaximInterface_EXPORT error_code recallEeprom();
IanBenzMaxim 0:f77ad7f72d04 100
IanBenzMaxim 0:f77ad7f72d04 101 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 102
IanBenzMaxim 0:f77ad7f72d04 103 private:
IanBenzMaxim 0:f77ad7f72d04 104 SelectRom selectRom;
IanBenzMaxim 0:f77ad7f72d04 105 OneWireMaster * master;
IanBenzMaxim 0:f77ad7f72d04 106 const Sleep * sleep;
IanBenzMaxim 0:f77ad7f72d04 107 };
IanBenzMaxim 0:f77ad7f72d04 108
IanBenzMaxim 7:471901a04573 109 /// @brief Reads the current temperature as an integer value.
IanBenzMaxim 7:471901a04573 110 /// @param ds1920 Device to read.
IanBenzMaxim 6:a8c83a2e6fa4 111 /// @param[out] temperature Temperature in degrees Celsius multiplied by 2.
IanBenzMaxim 0:f77ad7f72d04 112 MaximInterface_EXPORT error_code readTemperature(DS1920 & ds1920,
IanBenzMaxim 0:f77ad7f72d04 113 int & temperature);
IanBenzMaxim 0:f77ad7f72d04 114
IanBenzMaxim 0:f77ad7f72d04 115 inline error_code make_error_code(DS1920::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 116 return error_code(e, DS1920::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 117 }
IanBenzMaxim 0:f77ad7f72d04 118
IanBenzMaxim 0:f77ad7f72d04 119 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 120
IanBenzMaxim 0:f77ad7f72d04 121 #endif