nz_ow2482.h

Go to the documentation of this file.

#ifndef NZ_OW2482_H
#define NZ_OW2482_H

#if defined(NZ_OW2482_ENABLED)


//Default address is 0x30. This is the case if both AD0 and AD1 pins of the DS2482
//are tied to 0V. By connecting AD0, AD1, or both AD0 and AD1 to Vcc, the address
//could also be 0x31, 0x32 or 0x33
#define DS2482_ADDRESS_00   0x30    //DS2482 address if AD0=0V and AD1=0V
#define DS2482_ADDRESS_01   0x31    //DS2482 address if AD0=Vcc and AD1=0V
#define DS2482_ADDRESS_10   0x32    //DS2482 address if AD0=0V and AD1=Vcc
#define DS2482_ADDRESS_11   0x33    //DS2482 address if AD0=Vcc and AD1=Vcc

#define DS2482_COMMAND_RESET        0xF0    //Device Reset command
#define DS2482_COMMAND_WR_CONF      0xD2    //Write Configuration command
#define DS2482_COMMAND_SET_RD_PTR   0xE1    //Set Read Pointer command
#define DS2482_COMMAND_1W_RESET     0xB4    //1-Wire Reset command
#define DS2482_COMMAND_1W_WR_BYTE   0xA5    //1-Wire Write Byte command
#define DS2482_COMMAND_1W_RD_BYTE   0x96    //1-Wire Read Byte command
#define DS2482_COMMAND_1W_SINGLE_BIT 0x87   //1-Wire Single Bit command
#define DS2482_COMMAND_1W_TRIPLET   0x78    //1-Wire Triplet command

#define DS2482_CONFIG_APU           0x01    //Active Pullup enabled
#define DS2482_CONFIG_PPM           0x02    //Presence-Pulse Masking enabled
#define DS2482_CONFIG_SPU           0x04    //Strong Pullup enabled
#define DS2482_CONFIG_1WS           0x08    //1-Wire Speed High Speed enabled

#define DS2482_STATUS_1WB           0x01    //1-Wire Busy
#define DS2482_STATUS_PPD           0x02    //Presence-Pulse Detect
#define DS2482_STATUS_SD            0x04    //Short Detected
#define DS2482_STATUS_LL            0x08    //Logic Level
#define DS2482_STATUS_RST           0x10    //Device Reset
#define DS2482_STATUS_SBR           0x20    //Single Bit Result
#define DS2482_STATUS_TSB           0x40    //Triplet Second Bit
#define DS2482_STATUS_DIR           0x80    //Branch Direction Taken

#define DS2482_TIMEOUT              100     //100ms

typedef struct DS2482_INFO_
//typedef struct __attribute__((__packed__)) DS2482_INFO_
//typedef struct __attribute__((aligned(2), packed)) DS2482_INFO_
{
    void*   pI2CInfo;   //Pointer to I2C_INFO structure of I2C bus used for this DS2482
    WORD    timeout;
    BYTE    sm;
    BYTE    i2cAdr;     //The I2C address of this DS2482. Use a DS2482_ADDRESS_xx define
    BYTE    status;     //The status of the last transmission, 0=Success, 0xff=Busy, else error code
    BYTE    readByte;   //Byte read from DS2482
    BYTE    param;      //Parameter used for passing data between states

    //Required for search
    BYTE    adr64[8];
    BYTE    lastDiscrepancy;
    BYTE    lastFamilyDiscrepancy;
    BYTE    idBitNumber;
    BYTE    lastZero;
    BYTE    romByteNnumber;
    BYTE    romByteMask;

    BYTE    crc8;

    union {
        struct
        {
            unsigned char lastDevice        : 1;
            unsigned char searchResult      : 1;
            unsigned char idBit             : 1;
            unsigned char cmpIdBit          : 1;
            unsigned char searchDirection   : 1;
        } flags;
        BYTE flagsVal;
    };

    //The DS2482 status register
    union {
        struct
        {
            unsigned int OWB    : 1;    //1-Wire Busy
            unsigned int PPD    : 1;    //Presence-Pulse Detect
            unsigned int SD     : 1;    //Short Detected
            unsigned int LL     : 1;    //Logic Level
            unsigned int RST    : 1;    //Device Reset
            unsigned int SBR    : 1;    //Single Bit Result
            unsigned int TSB    : 1;    //Triplet Second Bit
            unsigned int DIR    : 1;    //Branch Direction Taken
        } statusReg;
        BYTE statusRegVal;
    };

    union {
        struct
        {
            unsigned int APU        : 1;    //Active Pullup = Bit 0 of Configuration Register
            unsigned int PPM        : 1;    //Presence-Pulse Masking = Bit 1 of Configuration Register
            unsigned int SPU        : 1;    //Strong Pullup = Bit 2 of Configuration Register
            unsigned int OWS        : 1;    //1-Wire Speed  = Bit 3 of Configuration Register
            unsigned int fill       : 4;    //Fill
        } configReg;
        BYTE configRegVal;
    };
} DS2482_INFO;



BYTE ds2482_init(DS2482_INFO* pObj, BYTE i2cBus, BYTE i2cAdr);


void ds2482_task(DS2482_INFO* pObj);


#define ds2482_isBusy(pObj) ((pObj)->sm!=0)

#define ds2482_getStatus(pObj) ((pObj)->status)

BYTE ds2482_getStatusWait(DS2482_INFO* pObj);


#define ds2482_resetStatus(pObj) ((pObj)->status = 0)

#define ds2482_getStatusReg(pObj) ((pObj)->statusRegVal)

#define ds2482_getStatusRegPPD(pObj) ((pObj)->statusReg.PPD)

#define ds2482_getStatusRegSD(pObj) ((pObj)->statusReg.SD)


BOOL ds2482_reset(DS2482_INFO* pObj);


BOOL ds2482_writeConfig(DS2482_INFO* pObj, BYTE config);


BYTE owReset(DS2482_INFO* pObj);

BYTE owResetWATE(DS2482_INFO* pObj);


BYTE owReadWriteBit(DS2482_INFO* pObj, BOOL bVal);

#define owGetBit(pObj) ((pObj)->statusReg.SBR)


#define owGetByte(pObj) ((pObj)->readByte)


BYTE owReadByte(DS2482_INFO* pObj);

BYTE owReadByteWATE(DS2482_INFO* pObj);


BYTE owWriteByte(DS2482_INFO* pObj, BYTE val);


BYTE owWriteByteWATE(DS2482_INFO* pObj, BYTE val);


BYTE owWriteBytePower(DS2482_INFO* pObj, BYTE val);


BYTE owWriteBytePowerWATE(DS2482_INFO* pObj, BYTE val);


BYTE owSpeed(DS2482_INFO* pObj, BOOL speed);


BYTE owLevel(DS2482_INFO* pObj, BOOL level);


void owSearchReset(DS2482_INFO* pObj);


BOOL owSearch(DS2482_INFO* pObj);


BYTE* owSearchWATE(DS2482_INFO* pObj);


#define owGetAdr64(pObj) (pObj->flags.searchResult?pObj->adr64:0)


BYTE owSelect(DS2482_INFO* pObj, BYTE* adr64);


BYTE owSelectWATE(DS2482_INFO* pObj, BYTE* adr64);

#endif  //#if defined(NZ_OW2482_ENABLED)
#endif  //#ifndef NZ_OW2482_H