Superseded by MaximInterface.

Diff: OneWire_Masters/DS2480B/ds2480b.h

Revision:

3:644fc630f958

Child:

5:ce108eeb878d

diff -r 02d228c25fd4 -r 644fc630f958 OneWire_Masters/DS2480B/ds2480b.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OneWire_Masters/DS2480B/ds2480b.h	Sun Jan 31 22:42:01 2016 +0000
@@ -0,0 +1,150 @@
+/******************************************************************//**
+* @file ds2480b.h
+*
+* @author Justin Jordan
+*
+* @version 0.0.0
+*
+* Started: 31JAN16
+*
+* Updated: 
+*
+* @brief Header file for DS2480B Async Serial to 1-wire master
+***********************************************************************
+* Copyright (C) 2016 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"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+**********************************************************************/
+
+
+#ifndef DS2480B_H
+#define DS2480B_H
+
+
+#include "mbed.h"
+#include "OneWireInterface.h"
+
+
+class Ds2480b: public OneWireInterface
+{
+    public:
+    
+    /**********************************************************//**
+    * @brief Ds2480b constructor
+    * 
+    * @details allows user to use existing Serial object
+    *
+    * On Entry:
+    *     @param[in] p_serial - pointer to existing serial object
+    *
+    * On Exit:
+    *    @return 
+    **************************************************************/
+    Ds2480b(Serial *p_serial);
+    
+    
+    /**********************************************************//**
+    * @brief Ds2480b constructor
+    * 
+    * @details Object instantiates a new serial object with no 
+    *          public access
+    *
+    * On Entry:
+    *     @param[in] tx - tx pin of uart to be used
+    *     @param[in] rx - rx pin of uart to be used
+    *     @param[in] baud - baudrate for uart
+    *
+    * On Exit:
+    *    @return 
+    **************************************************************/
+    Ds2480b(PinName tx, PinName rx, uint32_t baud);
+    
+    
+    /**********************************************************//**
+    * @brief Ds2480b destructor 
+    * 
+    * @details deletes serial object if owner 
+    *
+    * On Entry:
+    *
+    * On Exit:
+    *    @return 
+    **************************************************************/
+    ~Ds2480b();
+    
+    
+    /***** OW API ****************************************************/
+    virtual bool OWReset();
+    
+    virtual void OWWriteBit(uint8_t sendbit);
+    
+    virtual uint8_t OWReadBit();
+    
+    virtual uint8_t OWTouchBit(uint8_t sendbit);
+
+    virtual bool OWWriteByte(uint8_t sendbyte);
+
+    virtual uint8_t OWReadByte(void);
+
+    virtual uint8_t OWTouchByte(uint8_t sendbyte);
+
+    virtual void OWBlock(uint8_t *tran_buf, uint8_t tran_len);
+
+    virtual bool OWFirst(void);
+
+    virtual bool OWNext(void);
+
+    virtual bool OWVerify(void);
+
+    virtual void OWTargetSetup(uint8_t family_code);
+
+    virtual void OWFamilySkipSetup(void);
+    
+    virtual bool OWSearch(void);
+
+    virtual uint8_t OWSpeed(uint8_t new_speed);
+
+    virtual uint8_t OWLevel(uint8_t new_level);
+
+    virtual bool OWWriteBytePower(uint8_t sendbyte);
+
+    virtual bool OWReadBitPower(uint8_t applyPowerResponse);
+
+    virtual uint8_t OWCalc_crc8(uint8_t data);
+
+    virtual void OWgetROMnumber(uint8_t *p_rom_buff);
+    
+    private:
+    
+    Serial *_p_serial;
+    bool _serial_owner;
+};
+
+#endif /*DS2480B_H*/
+