DS2484.h

00001 /**********************************************************************
00002 * Copyright (C) 2016 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 
00034 #ifndef OneWire_Masters_DS2484
00035 #define OneWire_Masters_DS2484
00036 
00037 
00038 #include "Masters/DS248x/DS248x.h"
00039 
00040 
00041 namespace OneWire
00042 {
00043     ///DS2484 I2C to 1-wire Master
00044     class DS2484 : public DS248x
00045     {
00046     public:        
00047         /// 1-Wire port adjustment parameters.
00048         /// @note See datasheet page 13.
00049         enum OwAdjustParam
00050         {
00051             tRSTL = 0,
00052             tRSTL_OD,
00053             tMSP,
00054             tMSP_OD,
00055             tW0L,
00056             tW0L_OD,
00057             tREC0, // OD N/A
00058             RWPU = 8 // OD N/A
00059         };
00060         
00061         /// Construct to use an existing I2C interface.
00062         /// @param i2c_bus Configured I2C communication interface for DS248x.
00063         /// @param adrs I2C bus address of the DS248x in mbed format.
00064         DS2484(mbed::I2C & i2c_bus, uint8_t adrs = 0x30);
00065         
00066         /// Adjust 1-Wire port parameters.
00067         /// @note DS2484 only
00068         /// @param param Parameter to adjust.
00069         /// @param val New parameter value to set. Consult datasheet for value mappings.
00070         OneWireMaster::CmdResult adjustOwPort(OwAdjustParam param, uint8_t val);
00071     };
00072 }
00073 
00074 #endif /* OneWire_Masters_DS2484 */