DS2480B.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 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 MaximInterface_DS2480B
00034 #define MaximInterface_DS2480B
00035 
00036 #include <MaximInterface/Links/OneWireMaster.hpp>
00037 #include <MaximInterface/Links/Sleep.hpp>
00038 #include <MaximInterface/Links/Uart.hpp>
00039 #include <MaximInterface/Utilities/Export.h>
00040 
00041 namespace MaximInterface {
00042 
00043 /// Serial to 1-Wire Line Driver
00044 class DS2480B : public OneWireMaster {
00045 public:
00046   enum ErrorValue { HardwareError = 1 };
00047 
00048   DS2480B(Sleep & sleep, Uart & uart) : sleep(&sleep), uart(&uart) {}
00049 
00050   void setSleep(Sleep & sleep) { this->sleep = &sleep; }
00051   void setUart(Uart & uart) { this->uart = &uart; }
00052 
00053   MaximInterface_EXPORT error_code initialize();
00054 
00055   MaximInterface_EXPORT virtual error_code reset();
00056   
00057   MaximInterface_EXPORT virtual error_code touchBitSetLevel(bool & sendRecvBit,
00058                                                             Level afterLevel);
00059   
00060   MaximInterface_EXPORT virtual error_code
00061   writeByteSetLevel(uint_least8_t sendByte, Level afterLevel);
00062   
00063   MaximInterface_EXPORT virtual error_code
00064   readByteSetLevel(uint_least8_t & recvByte, Level afterLevel);
00065   
00066   MaximInterface_EXPORT virtual error_code setSpeed(Speed newSpeed);
00067   
00068   MaximInterface_EXPORT virtual error_code setLevel(Level newLevel);
00069 
00070   MaximInterface_EXPORT static const error_category & errorCategory();
00071 
00072 protected:
00073   MaximInterface_EXPORT error_code sendCommand(uint_least8_t command);
00074 
00075 private:
00076   const Sleep * sleep;
00077   Uart * uart;
00078 
00079   Level level;
00080   uint_least8_t mode;
00081   uint_least8_t speed;
00082 };
00083 
00084 inline error_code make_error_code(DS2480B::ErrorValue e) {
00085   return error_code(e, DS2480B::errorCategory());
00086 }
00087 
00088 } // namespace MaximInterface
00089 
00090 #endif