Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers DS2480B.hpp Source File

DS2480B.hpp

00001 /*******************************************************************************
00002 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterfaceDevices_DS2480B_hpp
00034 #define MaximInterfaceDevices_DS2480B_hpp
00035 
00036 #include <MaximInterfaceCore/OneWireMaster.hpp>
00037 #include <MaximInterfaceCore/Sleep.hpp>
00038 #include <MaximInterfaceCore/Uart.hpp>
00039 #include "Config.hpp"
00040 
00041 namespace MaximInterfaceDevices {
00042 
00043 /// Serial to 1-Wire Line Driver
00044 class DS2480B : public Core::OneWireMaster {
00045 public:
00046   enum ErrorValue { HardwareError = 1 };
00047 
00048   DS2480B(Core::Sleep & sleep, Core::Uart & uart)
00049       : sleep(&sleep), uart(&uart) {}
00050 
00051   void setSleep(Core::Sleep & sleep) { this->sleep = &sleep; }
00052 
00053   void setUart(Core::Uart & uart) { this->uart = &uart; }
00054 
00055   MaximInterfaceDevices_EXPORT Core::Result<void> initialize();
00056 
00057   MaximInterfaceDevices_EXPORT virtual Core::Result<void> reset();
00058 
00059   MaximInterfaceDevices_EXPORT virtual Core::Result<bool>
00060   touchBitSetLevel(bool sendBit, Level afterLevel);
00061 
00062   MaximInterfaceDevices_EXPORT virtual Core::Result<void>
00063   writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
00064 
00065   MaximInterfaceDevices_EXPORT virtual Core::Result<uint_least8_t>
00066   readByteSetLevel(Level afterLevel);
00067 
00068   MaximInterfaceDevices_EXPORT virtual Core::Result<void>
00069   setSpeed(Speed newSpeed);
00070 
00071   MaximInterfaceDevices_EXPORT virtual Core::Result<void>
00072   setLevel(Level newLevel);
00073 
00074   MaximInterfaceDevices_EXPORT static const Core::error_category &
00075   errorCategory();
00076 
00077 protected:
00078   MaximInterfaceDevices_EXPORT Core::Result<void>
00079   sendCommand(uint_least8_t command);
00080 
00081 private:
00082   const Core::Sleep * sleep;
00083   Core::Uart * uart;
00084 
00085   Level level;
00086   uint_least8_t mode;
00087   uint_least8_t speed;
00088 };
00089 
00090 } // namespace MaximInterfaceDevices
00091 namespace MaximInterfaceCore {
00092 
00093 template <>
00094 struct is_error_code_enum<MaximInterfaceDevices::DS2480B::ErrorValue>
00095     : true_type {};
00096 
00097 } // namespace MaximInterfaceCore
00098 namespace MaximInterfaceDevices {
00099 
00100 inline Core::error_code make_error_code(DS2480B::ErrorValue e) {
00101   return Core::error_code(e, DS2480B::errorCategory());
00102 }
00103 
00104 } // namespace MaximInterfaceDevices
00105 
00106 #endif