Implementation of 1-Wire with added Alarm Search Functionality
Dependents: Max32630_One_Wire_Interface
Slaves/Switches/DS2413/DS2413.h@142:85b71cfd617e, 2019-08-13 (annotated)
- Committer:
- mfruge
- Date:
- Tue Aug 13 14:42:37 2019 +0000
- Revision:
- 142:85b71cfd617e
- Parent:
- 105:e6ba25711c05
Added functions to ROMCommands to add Alarm Search functionality
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
j3 | 19:6d4c039a2d8e | 1 | /******************************************************************//** |
j3 | 19:6d4c039a2d8e | 2 | * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved. |
j3 | 19:6d4c039a2d8e | 3 | * |
j3 | 19:6d4c039a2d8e | 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
j3 | 19:6d4c039a2d8e | 5 | * copy of this software and associated documentation files (the "Software"), |
j3 | 19:6d4c039a2d8e | 6 | * to deal in the Software without restriction, including without limitation |
j3 | 19:6d4c039a2d8e | 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
j3 | 19:6d4c039a2d8e | 8 | * and/or sell copies of the Software, and to permit persons to whom the |
j3 | 19:6d4c039a2d8e | 9 | * Software is furnished to do so, subject to the following conditions: |
j3 | 19:6d4c039a2d8e | 10 | * |
j3 | 19:6d4c039a2d8e | 11 | * The above copyright notice and this permission notice shall be included |
j3 | 19:6d4c039a2d8e | 12 | * in all copies or substantial portions of the Software. |
j3 | 19:6d4c039a2d8e | 13 | * |
j3 | 19:6d4c039a2d8e | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
j3 | 19:6d4c039a2d8e | 15 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
j3 | 19:6d4c039a2d8e | 16 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
j3 | 19:6d4c039a2d8e | 17 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
j3 | 19:6d4c039a2d8e | 18 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
j3 | 19:6d4c039a2d8e | 19 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
j3 | 19:6d4c039a2d8e | 20 | * OTHER DEALINGS IN THE SOFTWARE. |
j3 | 19:6d4c039a2d8e | 21 | * |
j3 | 19:6d4c039a2d8e | 22 | * Except as contained in this notice, the name of Maxim Integrated |
j3 | 19:6d4c039a2d8e | 23 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
j3 | 19:6d4c039a2d8e | 24 | * Products, Inc. Branding Policy. |
j3 | 19:6d4c039a2d8e | 25 | * |
j3 | 19:6d4c039a2d8e | 26 | * The mere transfer of this software does not imply any licenses |
j3 | 19:6d4c039a2d8e | 27 | * of trade secrets, proprietary technology, copyrights, patents, |
j3 | 19:6d4c039a2d8e | 28 | * trademarks, maskwork rights, or any other form of intellectual |
j3 | 19:6d4c039a2d8e | 29 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
j3 | 19:6d4c039a2d8e | 30 | * ownership rights. |
j3 | 19:6d4c039a2d8e | 31 | **********************************************************************/ |
j3 | 19:6d4c039a2d8e | 32 | |
IanBenzMaxim | 73:2cecc1372acc | 33 | #ifndef OneWire_Switches_DS2413 |
IanBenzMaxim | 73:2cecc1372acc | 34 | #define OneWire_Switches_DS2413 |
j3 | 19:6d4c039a2d8e | 35 | |
IanBenzMaxim | 73:2cecc1372acc | 36 | #include <stdint.h> |
j3 | 104:3f48daed532b | 37 | #include "Slaves/OneWireSlave.h" |
IanBenzMaxim | 73:2cecc1372acc | 38 | |
IanBenzMaxim | 73:2cecc1372acc | 39 | namespace OneWire |
IanBenzMaxim | 73:2cecc1372acc | 40 | { |
j3 | 93:e496a45ce796 | 41 | /** |
j3 | 93:e496a45ce796 | 42 | * @brief DS2413 1-Wire Dual Channel Addressable Switch |
j3 | 93:e496a45ce796 | 43 | * |
j3 | 93:e496a45ce796 | 44 | * @details The DS2413 is a dual-channel programmable I/O 1-Wire® |
j3 | 93:e496a45ce796 | 45 | * chip. The PIO outputs are configured as open-drain and provide up |
j3 | 93:e496a45ce796 | 46 | * to 20mA continuous sink capability and off-state operating voltage |
j3 | 93:e496a45ce796 | 47 | * up to 28V. Control and sensing of the PIO pins is performed with |
j3 | 93:e496a45ce796 | 48 | * a dedicated device-level command protocol. To provide a high level |
j3 | 93:e496a45ce796 | 49 | * of fault tolerance in the end application, the 1-Wire I/O and PIO |
j3 | 93:e496a45ce796 | 50 | * pins are all capable of withstanding continuous application of |
j3 | 93:e496a45ce796 | 51 | * voltages up to 28V max. Communication and operation of the DS2413 |
j3 | 93:e496a45ce796 | 52 | * is performed with the single contact Maxim 1-Wire serial interface. |
j3 | 93:e496a45ce796 | 53 | */ |
IanBenzMaxim | 76:84e6c4994e29 | 54 | class DS2413 : public OneWireSlave |
IanBenzMaxim | 73:2cecc1372acc | 55 | { |
IanBenzMaxim | 76:84e6c4994e29 | 56 | public: |
j3 | 93:e496a45ce796 | 57 | |
j3 | 93:e496a45ce796 | 58 | ///Result of operations |
IanBenzMaxim | 76:84e6c4994e29 | 59 | enum CmdResult |
IanBenzMaxim | 74:23be10c32fa3 | 60 | { |
IanBenzMaxim | 76:84e6c4994e29 | 61 | Success, |
IanBenzMaxim | 76:84e6c4994e29 | 62 | CommsReadError, |
IanBenzMaxim | 76:84e6c4994e29 | 63 | CommsWriteError, |
IanBenzMaxim | 76:84e6c4994e29 | 64 | OpFailure |
IanBenzMaxim | 76:84e6c4994e29 | 65 | }; |
IanBenzMaxim | 74:23be10c32fa3 | 66 | |
IanBenzMaxim | 76:84e6c4994e29 | 67 | /**********************************************************//** |
IanBenzMaxim | 76:84e6c4994e29 | 68 | * @brief DS2413 constructor |
IanBenzMaxim | 76:84e6c4994e29 | 69 | * |
IanBenzMaxim | 76:84e6c4994e29 | 70 | * @details |
IanBenzMaxim | 76:84e6c4994e29 | 71 | * |
IanBenzMaxim | 76:84e6c4994e29 | 72 | * On Entry: |
IanBenzMaxim | 76:84e6c4994e29 | 73 | * @param[in] owm - reference to 1-wire master |
IanBenzMaxim | 76:84e6c4994e29 | 74 | * |
IanBenzMaxim | 76:84e6c4994e29 | 75 | * On Exit: |
IanBenzMaxim | 76:84e6c4994e29 | 76 | * |
IanBenzMaxim | 76:84e6c4994e29 | 77 | * @return |
IanBenzMaxim | 76:84e6c4994e29 | 78 | **************************************************************/ |
IanBenzMaxim | 77:529edb329ee0 | 79 | DS2413(RandomAccessRomIterator &selector); |
IanBenzMaxim | 74:23be10c32fa3 | 80 | |
IanBenzMaxim | 76:84e6c4994e29 | 81 | /**********************************************************//** |
j3 | 94:d2dea35b25ea | 82 | * @brief pioAccessReadChA() |
IanBenzMaxim | 76:84e6c4994e29 | 83 | * |
IanBenzMaxim | 76:84e6c4994e29 | 84 | * @details reads state of pio |
IanBenzMaxim | 76:84e6c4994e29 | 85 | * |
IanBenzMaxim | 76:84e6c4994e29 | 86 | * |
IanBenzMaxim | 76:84e6c4994e29 | 87 | * On Exit: |
IanBenzMaxim | 76:84e6c4994e29 | 88 | * @param[out] val - lsb represents the state of the pio |
IanBenzMaxim | 76:84e6c4994e29 | 89 | * |
IanBenzMaxim | 76:84e6c4994e29 | 90 | * @return CmdResult - result of operation |
IanBenzMaxim | 76:84e6c4994e29 | 91 | **************************************************************/ |
j3 | 94:d2dea35b25ea | 92 | CmdResult pioAccessReadChA(uint8_t & val); |
j3 | 19:6d4c039a2d8e | 93 | |
IanBenzMaxim | 76:84e6c4994e29 | 94 | /**********************************************************//** |
j3 | 94:d2dea35b25ea | 95 | * @brief pioAccessReadChB() |
IanBenzMaxim | 76:84e6c4994e29 | 96 | * |
IanBenzMaxim | 76:84e6c4994e29 | 97 | * @details reads state of pio |
IanBenzMaxim | 76:84e6c4994e29 | 98 | * |
IanBenzMaxim | 76:84e6c4994e29 | 99 | * |
IanBenzMaxim | 76:84e6c4994e29 | 100 | * On Exit: |
IanBenzMaxim | 76:84e6c4994e29 | 101 | * @param[out] val - lsb represents the state of the pio |
IanBenzMaxim | 76:84e6c4994e29 | 102 | * |
IanBenzMaxim | 76:84e6c4994e29 | 103 | * @return CmdResult - result of operation |
IanBenzMaxim | 76:84e6c4994e29 | 104 | **************************************************************/ |
j3 | 94:d2dea35b25ea | 105 | CmdResult pioAccessReadChB(uint8_t & val); |
IanBenzMaxim | 74:23be10c32fa3 | 106 | |
IanBenzMaxim | 76:84e6c4994e29 | 107 | /**********************************************************//** |
j3 | 94:d2dea35b25ea | 108 | * @brief pioAccessWriteChA() |
IanBenzMaxim | 76:84e6c4994e29 | 109 | * |
IanBenzMaxim | 76:84e6c4994e29 | 110 | * @details writes to pio |
IanBenzMaxim | 76:84e6c4994e29 | 111 | * |
IanBenzMaxim | 76:84e6c4994e29 | 112 | * On Entry: |
IanBenzMaxim | 76:84e6c4994e29 | 113 | * @param[in] val - lsb sets state of pio |
IanBenzMaxim | 76:84e6c4994e29 | 114 | * |
IanBenzMaxim | 76:84e6c4994e29 | 115 | * @return CmdResult - result of operation |
IanBenzMaxim | 76:84e6c4994e29 | 116 | **************************************************************/ |
j3 | 94:d2dea35b25ea | 117 | CmdResult pioAccessWriteChA(uint8_t val); |
j3 | 19:6d4c039a2d8e | 118 | |
IanBenzMaxim | 76:84e6c4994e29 | 119 | /**********************************************************//** |
j3 | 94:d2dea35b25ea | 120 | * @brief pioAccessWriteChB() |
IanBenzMaxim | 76:84e6c4994e29 | 121 | * |
IanBenzMaxim | 76:84e6c4994e29 | 122 | * @details writes to pio |
IanBenzMaxim | 76:84e6c4994e29 | 123 | * |
IanBenzMaxim | 76:84e6c4994e29 | 124 | * On Entry: |
IanBenzMaxim | 76:84e6c4994e29 | 125 | * @param[in] val - lsb sets state of pio |
IanBenzMaxim | 76:84e6c4994e29 | 126 | * |
IanBenzMaxim | 76:84e6c4994e29 | 127 | * @return CmdResult - result of operation |
IanBenzMaxim | 76:84e6c4994e29 | 128 | **************************************************************/ |
j3 | 94:d2dea35b25ea | 129 | CmdResult pioAccessWriteChB(uint8_t val); |
IanBenzMaxim | 74:23be10c32fa3 | 130 | |
IanBenzMaxim | 76:84e6c4994e29 | 131 | /**********************************************************//** |
j3 | 94:d2dea35b25ea | 132 | * @brief pioAccessWriteChAB() |
IanBenzMaxim | 76:84e6c4994e29 | 133 | * |
IanBenzMaxim | 76:84e6c4994e29 | 134 | * @details writes to pio |
IanBenzMaxim | 76:84e6c4994e29 | 135 | * |
IanBenzMaxim | 76:84e6c4994e29 | 136 | * On Entry: |
IanBenzMaxim | 76:84e6c4994e29 | 137 | * @param[in] val - Bits 1:0 set PIOB and PIOB respectively |
IanBenzMaxim | 76:84e6c4994e29 | 138 | * |
IanBenzMaxim | 76:84e6c4994e29 | 139 | * @return CmdResult - result of operation |
IanBenzMaxim | 76:84e6c4994e29 | 140 | **************************************************************/ |
j3 | 94:d2dea35b25ea | 141 | CmdResult pioAccessWriteChAB(uint8_t val); |
IanBenzMaxim | 74:23be10c32fa3 | 142 | |
IanBenzMaxim | 76:84e6c4994e29 | 143 | private: |
IanBenzMaxim | 74:23be10c32fa3 | 144 | |
j3 | 94:d2dea35b25ea | 145 | CmdResult pioAccessRead(uint8_t & val); |
IanBenzMaxim | 74:23be10c32fa3 | 146 | |
j3 | 94:d2dea35b25ea | 147 | CmdResult pioAccessWrite(uint8_t val); |
IanBenzMaxim | 76:84e6c4994e29 | 148 | }; |
IanBenzMaxim | 73:2cecc1372acc | 149 | } |
IanBenzMaxim | 73:2cecc1372acc | 150 | |
IanBenzMaxim | 74:23be10c32fa3 | 151 | #endif |