Diff: Devices/DS2413.hpp

Revision:

0:f77ad7f72d04

Child:

5:a8c83a2e6fa4

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Devices/DS2413.hpp	Mon Nov 06 14:39:18 2017 -0600
@@ -0,0 +1,102 @@
+/*******************************************************************************
+* Copyright (C) 2017 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.
+*******************************************************************************/
+
+#ifndef MaximInterface_DS2413
+#define MaximInterface_DS2413
+
+#include <stdint.h>
+#include <MaximInterface/Links/SelectRom.hpp>
+#include <MaximInterface/Utilities/Export.h>
+
+namespace MaximInterface {
+
+/// DS2413 1-Wire Dual Channel Addressable Switch
+/// @details The DS2413 is a dual-channel programmable I/O 1-Wire®
+/// chip. The PIO outputs are configured as open-drain and provide up
+/// to 20mA continuous sink capability and off-state operating voltage
+/// up to 28V. Control and sensing of the PIO pins is performed with
+/// a dedicated device-level command protocol. To provide a high level
+/// of fault tolerance in the end application, the 1-Wire I/O and PIO
+/// pins are all capable of withstanding continuous application of
+/// voltages up to 28V max. Communication and operation of the DS2413
+/// is performed with the single contact Maxim 1-Wire serial interface.
+class DS2413 {
+public:
+  enum ErrorValue { CommunicationError = 1 };
+
+  struct Status {
+    bool pioAInputState;
+    bool pioAOutputState;
+    bool pioBInputState;
+    bool pioBOutputState;
+  };
+
+  DS2413(OneWireMaster & master, const SelectRom & selectRom)
+      : selectRom(selectRom), master(&master) {}
+
+  void setMaster(OneWireMaster & master) { this->master = &master; }
+  void setSelectRom(const SelectRom & selectRom) {
+    this->selectRom = selectRom;
+  }
+
+  /// Read the input and output logic states for all PIO pins.
+  MaximInterface_EXPORT error_code readStatus(Status & status) const;
+
+  /// Write the output logic states for all PIO pins.
+  MaximInterface_EXPORT error_code writeOutputState(bool pioAState,
+                                                    bool pioBState);
+
+  MaximInterface_EXPORT static const error_category & errorCategory();
+
+private:
+  error_code pioAccessRead(uint_least8_t & val) const;
+  error_code pioAccessWrite(uint_least8_t val);
+
+  SelectRom selectRom;
+  OneWireMaster * master;
+};
+
+/// @{
+/// Write the output logic state for only a single PIO pin.
+MaximInterface_EXPORT error_code writePioAOutputState(DS2413 & ds2413,
+                                                      bool pioAState);
+MaximInterface_EXPORT error_code writePioBOutputState(DS2413 & ds2413,
+                                                      bool pioBState);
+/// @}
+
+inline error_code make_error_code(DS2413::ErrorValue e) {
+  return error_code(e, DS2413::errorCategory());
+}
+
+} // namespace MaximInterface
+
+#endif