Maxim Integrated / MaximInterface

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

Diff: MaximInterfaceDevices/DS2480B.hpp

Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
--- a/MaximInterfaceDevices/DS2480B.hpp	Mon Jul 22 11:44:07 2019 -0500
+++ b/MaximInterfaceDevices/DS2480B.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,8 +30,8 @@
 * ownership rights.
 *******************************************************************************/
 
-#ifndef MaximInterfaceDevices_DS2480B
-#define MaximInterfaceDevices_DS2480B
+#ifndef MaximInterfaceDevices_DS2480B_hpp
+#define MaximInterfaceDevices_DS2480B_hpp
 
 #include <MaximInterfaceCore/OneWireMaster.hpp>
 #include <MaximInterfaceCore/Sleep.hpp>
@@ -52,30 +52,30 @@
 
   void setUart(Core::Uart & uart) { this->uart = &uart; }
 
-  MaximInterfaceDevices_EXPORT Core::error_code initialize();
+  MaximInterfaceDevices_EXPORT Core::Result<void> initialize();
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code reset();
+  MaximInterfaceDevices_EXPORT virtual Core::Result<void> reset();
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code
-  touchBitSetLevel(bool & sendRecvBit, Level afterLevel);
+  MaximInterfaceDevices_EXPORT virtual Core::Result<bool>
+  touchBitSetLevel(bool sendBit, Level afterLevel);
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code
+  MaximInterfaceDevices_EXPORT virtual Core::Result<void>
   writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code
-  readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
+  MaximInterfaceDevices_EXPORT virtual Core::Result<uint_least8_t>
+  readByteSetLevel(Level afterLevel);
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code
+  MaximInterfaceDevices_EXPORT virtual Core::Result<void>
   setSpeed(Speed newSpeed);
 
-  MaximInterfaceDevices_EXPORT virtual Core::error_code
+  MaximInterfaceDevices_EXPORT virtual Core::Result<void>
   setLevel(Level newLevel);
 
   MaximInterfaceDevices_EXPORT static const Core::error_category &
   errorCategory();
 
 protected:
-  MaximInterfaceDevices_EXPORT Core::error_code
+  MaximInterfaceDevices_EXPORT Core::Result<void>
   sendCommand(uint_least8_t command);
 
 private:
@@ -87,6 +87,16 @@
   uint_least8_t speed;
 };
 
+} // namespace MaximInterfaceDevices
+namespace MaximInterfaceCore {
+
+template <>
+struct is_error_code_enum<MaximInterfaceDevices::DS2480B::ErrorValue>
+    : true_type {};
+
+} // namespace MaximInterfaceCore
+namespace MaximInterfaceDevices {
+
 inline Core::error_code make_error_code(DS2480B::ErrorValue e) {
   return Core::error_code(e, DS2480B::errorCategory());
 }