Diff: MaximInterfaceDevices/DS2431.hpp

Revision:

8:5ea891c7d1a1

Parent:

7:9cd16581b578

--- a/MaximInterfaceDevices/DS2431.hpp	Mon Jul 22 11:44:07 2019 -0500
+++ b/MaximInterfaceDevices/DS2431.hpp	Mon Sep 16 11:13:37 2019 -0500
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+* 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"),
@@ -30,9 +30,10 @@
 * ownership rights.
 *******************************************************************************/
 
-#ifndef MaximInterfaceDevices_DS2431
-#define MaximInterfaceDevices_DS2431
+#ifndef MaximInterfaceDevices_DS2431_hpp
+#define MaximInterfaceDevices_DS2431_hpp
 
+#include <utility>
 #include <MaximInterfaceCore/array_span.hpp>
 #include <MaximInterfaceCore/SelectRom.hpp>
 #include <MaximInterfaceCore/Sleep.hpp>
@@ -57,7 +58,6 @@
   enum ErrorValue { CrcError = 1, OperationFailure };
 
   typedef Core::array_span<uint_least8_t, 8> Scratchpad;
-  typedef uint_least8_t Address;
 
   DS2431(Core::Sleep & sleep, Core::OneWireMaster & master,
          const Core::SelectRom & selectRom)
@@ -74,29 +74,29 @@
   /// @brief Reads block of data from EEPROM memory.
   /// @param[in] beginAddress EEPROM memory address to start reading from.
   /// @param[out] data EEPROM data read from the device.
-  MaximInterfaceDevices_EXPORT Core::error_code
-  readMemory(Address beginAddress, Core::span<uint_least8_t> data) const;
+  MaximInterfaceDevices_EXPORT Core::Result<void>
+  readMemory(uint_least8_t beginAddress, Core::span<uint_least8_t> data) const;
 
   /// @brief Writes 8 bytes to the scratchpad.
   /// @param[in] targetAddress
   /// EEPROM memory address that this data will be copied to.
   /// Must be on row boundary.
   /// @param[in] data Data to write to scratchpad.
-  MaximInterfaceDevices_EXPORT Core::error_code
-  writeScratchpad(Address targetAddress, Scratchpad::const_span data);
+  MaximInterfaceDevices_EXPORT Core::Result<void>
+  writeScratchpad(uint_least8_t targetAddress, Scratchpad::const_span data);
 
   /// @brief Reads contents of scratchpad.
-  /// @param[out] data Data read from scratchpad.
-  /// @param[out] esByte E/S byte read before scratchpad data.
-  MaximInterfaceDevices_EXPORT Core::error_code
-  readScratchpad(Scratchpad::span data, uint_least8_t & esByte);
+  /// @returns E/S byte and scratchpad data.
+  MaximInterfaceDevices_EXPORT
+      Core::Result<std::pair<uint_least8_t, Scratchpad::array> >
+      readScratchpad() const;
 
   /// @brief Copies contents of scratchpad to EEPROM.
   /// @param[in] targetAddress EEPROM memory address that scratchpad
   /// will be copied to. Must be on row boundary.
   /// @param[in] esByte E/S byte from preceding Read Scratchpad command.
-  MaximInterfaceDevices_EXPORT Core::error_code
-  copyScratchpad(Address targetAddress, uint_least8_t esByte);
+  MaximInterfaceDevices_EXPORT Core::Result<void>
+  copyScratchpad(uint_least8_t targetAddress, uint_least8_t esByte);
 
   MaximInterfaceDevices_EXPORT static const Core::error_category &
   errorCategory();
@@ -113,10 +113,20 @@
 /// @param device Device to write.
 /// @param[in] targetAddress EEPROM memory address to start writing at.
 /// @param[in] data Data to write to EEPROM.
-MaximInterfaceDevices_EXPORT Core::error_code
-writeMemory(DS2431 & device, DS2431::Address targetAddress,
+MaximInterfaceDevices_EXPORT Core::Result<void>
+writeMemory(DS2431 & device, uint_least8_t targetAddress,
             DS2431::Scratchpad::const_span data);
 
+} // namespace MaximInterfaceDevices
+namespace MaximInterfaceCore {
+
+template <>
+struct is_error_code_enum<MaximInterfaceDevices::DS2431::ErrorValue>
+    : true_type {};
+
+} // namespace MaximInterfaceCore
+namespace MaximInterfaceDevices {
+
 inline Core::error_code make_error_code(DS2431::ErrorValue e) {
   return Core::error_code(e, DS2431::errorCategory());
 }