OneWire Library for Arduino  version: 1.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
OneWire::DS2484 Class Reference

DS2484 I2C to 1-wire Master. More...

#include <DS2484.h>

Inheritance diagram for OneWire::DS2484:
OneWire::DS248x OneWire::OneWireMaster

Public Types

enum  OwAdjustParam {
  tRSTL = 0, tRSTL_OD, tMSP, tMSP_OD,
  tW0L, tW0L_OD, tREC0, RWPU = 8
}
 
- Public Types inherited from OneWire::DS248x
enum  Register {
  ConfigReg = 0xC3, StatusReg = 0xF0, ReadDataReg = 0xE1, PortConfigReg = 0xB4,
  ChannelSelectReg = 0xD2
}
 Device register pointers. More...
 
- Public Types inherited from OneWire::OneWireMaster
enum  OWSpeed { StandardSpeed = 0x00, OverdriveSpeed = 0x01 }
 Speed of the 1-Wire bus. More...
 
enum  OWLevel { NormalLevel = 0x00, StrongLevel = 0x02 }
 Level of the 1-Wire bus. More...
 
enum  SearchDirection { WriteZero = 0, WriteOne = 1 }
 Search direction for the triplet operation. More...
 
enum  CmdResult {
  Success, CommunicationWriteError, CommunicationReadError, TimeoutError,
  OperationFailure
}
 Result of all 1-Wire commands. More...
 

Public Member Functions

 DS2484 ()
 Default Construct. More...
 
virtual ~DS2484 ()
 Destroys DS2484 object. More...
 
OneWireMaster::CmdResult adjustOwPort (OwAdjustParam param, uint8_t val)
 
- Public Member Functions inherited from OneWire::DS248x
 DS248x ()
 Default Constructor. More...
 
OneWireMaster::CmdResult begin (uint8_t i2cAdrs=0x18)
 
void end ()
 End mbr function. More...
 
OneWireMaster::CmdResult reset (void)
 
OneWireMaster::CmdResult writeConfig (const Config &config, bool verify)
 
Config currentConfig () const
 
OneWireMaster::CmdResult readRegister (Register reg, uint8_t &buf, bool skipSetPointer=false) const
 
virtual OneWireMaster::CmdResult OWInitMaster ()
 
virtual OneWireMaster::CmdResult OWTriplet (SearchDirection &searchDirection, uint8_t &sbr, uint8_t &tsb)
 
virtual OneWireMaster::CmdResult OWReset ()
 
virtual OneWireMaster::CmdResult OWTouchBitSetLevel (uint8_t &sendRecvBit, OWLevel afterLevel)
 
virtual OneWireMaster::CmdResult OWReadByteSetLevel (uint8_t &recvByte, OWLevel afterLevel)
 
virtual OneWireMaster::CmdResult OWWriteByteSetLevel (uint8_t sendByte, OWLevel afterLevel)
 
virtual OneWireMaster::CmdResult OWSetSpeed (OWSpeed newSpeed)
 Set the 1-Wire bus communication speed. More...
 
virtual OneWireMaster::CmdResult OWSetLevel (OWLevel newLevel)
 Set the 1-Wire bus level. More...
 
- Public Member Functions inherited from OneWire::OneWireMaster
virtual ~OneWireMaster ()
 Allow freeing through a base class pointer. More...
 
virtual CmdResult OWWriteBlock (const uint8_t *sendBuf, uint8_t sendLen)
 
virtual CmdResult OWReadBlock (uint8_t *recvBuf, uint8_t recvLen)
 
CmdResult OWWriteBitSetLevel (uint8_t sendBit, OWLevel afterLevel)
 
CmdResult OWReadBitSetLevel (uint8_t &recvBit, OWLevel afterLevel)
 
CmdResult OWWriteBit (uint8_t sendBit)
 
CmdResult OWReadBit (uint8_t &recvBit)
 
CmdResult OWWriteBitPower (uint8_t sendBit)
 
CmdResult OWReadBitPower (uint8_t &recvBit)
 
CmdResult OWWriteByte (uint8_t sendByte)
 
CmdResult OWReadByte (uint8_t &recvByte)
 
CmdResult OWWriteBytePower (uint8_t sendByte)
 
CmdResult OWReadBytePower (uint8_t &recvByte)
 

Static Public Attributes

static const uint8_t I2C_ADRS = 0x18
 

Additional Inherited Members

- Protected Types inherited from OneWire::DS248x
enum  Command {
  DeviceResetCmd = 0xF0, WriteDeviceConfigCmd = 0xD2, AdjustOwPortCmd = 0xC3, ChannelSelectCmd = 0xC3,
  SetReadPointerCmd = 0xE1, OwResetCmd = 0xB4, OwWriteByteCmd = 0xA5, OwReadByteCmd = 0x96,
  OwSingleBitCmd = 0x87, OwTripletCmd = 0x78
}
 
- Protected Member Functions inherited from OneWire::DS248x
OneWireMaster::CmdResult pollBusy (uint8_t *pStatus=NULL)
 
OneWireMaster::CmdResult configureLevel (OWLevel level)
 
OneWireMaster::CmdResult sendCommand (Command cmd) const
 
OneWireMaster::CmdResult sendCommand (Command cmd, uint8_t param) const
 
- Protected Attributes inherited from OneWire::DS248x
uint8_t m_adrs
 
Config m_curConfig
 

Detailed Description

DS2484 I2C to 1-wire Master.

Member Enumeration Documentation

1-Wire port adjustment parameters.

Note
See datasheet page 13.
Enumerator
tRSTL 
tRSTL_OD 
tMSP 
tMSP_OD 
tW0L 
tW0L_OD 
tREC0 
RWPU 

Constructor & Destructor Documentation

DS2484::DS2484 ( )

Default Construct.

virtual OneWire::DS2484::~DS2484 ( )
inlinevirtual

Destroys DS2484 object.

Member Function Documentation

OneWireMaster::CmdResult DS2484::adjustOwPort ( OwAdjustParam  param,
uint8_t  val 
)

Adjust 1-Wire port paramaters.

Note
DS2484 only
Parameters
paramParameter to adjust.
valNew parameter value to set. Consult datasheet for value mappings.

Member Data Documentation

const uint8_t OneWire::DS2484::I2C_ADRS = 0x18
static

The documentation for this class was generated from the following files: