OneWireLibrary++: LOW_devDS2406 class Reference

DESCRIPTION | CONDITIONAL SEARCH SELECT CODE -----------------+---------+--------------+-------------+--------- | |CHANNEL SELECT|SOURCE SELECT|POLARITY | +------+-------+------+------+--------- CONDITION | CHANNEL | CSS4 | CSS3 | CSS2 | CSS1 | CSS0 =================+=========+======+=======+======+======+========= RESERVED | | Don't care | 0 | 0 | 0/1 -----------------+---------+------+-------+------+------+--------- Unconditional |neither | 0 | 0 | At least one| 0 | | | | must be 1 | -----------------+---------+------+-------+------+------+--------- Activity Latch=0 | A | 0 | 1 | 0 | 1 | 0 -----------------+---------+------+-------+------+------+--------- Activity Latch=1 | A | 0 | 1 | 0 | 1 | 1 -----------------+---------+------+-------+------+------+--------- Channel FF = 0 | A | 0 | 1 | 1 | 0 | 0 (transistor on) | | | | | | -----------------+---------+------+-------+------+------+--------- Channel FF = 1 | A | 0 | 1 | 1 | 0 | 1 (transistor off) | | | | | | -----------------+---------+------+-------+------+------+--------- PIO Low | A | 0 | 1 | 1 | 1 | 0 -----------------+---------+------+-------+------+------+--------- PIO High | A | 0 | 1 | 1 | 1 | 1 -----------------+---------+------+-------+------+------+--------- Activity Latch=0 | B | 1 | 0 | 0 | 1 | 0 -----------------+---------+------+-------+------+------+--------- Activity Latch=1 | B | 1 | 0 | 0 | 1 | 1 -----------------+---------+------+-------+------+------+--------- Channel FF = 0 | B | 1 | 0 | 1 | 0 | 0 (transistor on) | | | | | | -----------------+---------+------+-------+------+------+--------- Channel FF = 1 | B | 1 | 0 | 1 | 0 | 1 (transistor off) | | | | | | -----------------+---------+------+-------+------+------+--------- PIO Low | B | 1 | 0 | 1 | 1 | 0 -----------------+---------+------+-------+------+------+--------- PIO High | B | 1 | 0 | 1 | 1 | 1 -----------------+---------+------+-------+------+------+--------- Activity Latch=0 | A or B | 1 | 1 | 0 | 1 | 0 -----------------+---------+------+-------+------+------+--------- Activity Latch=1 | A or B | 1 | 1 | 0 | 1 | 1 -----------------+---------+------+-------+------+------+--------- Channel FF = 0 | A or B | 1 | 1 | 1 | 0 | 0 (transistor on) | | | | | | -----------------+---------+------+-------+------+------+--------- Channel FF = 1 | A or B | 1 | 1 | 1 | 0 | 1 (transistor off) | | | | | | -----------------+---------+------+-------+------+------+--------- PIO Low | A or B | 1 | 1 | 1 | 1 | 0 -----------------+---------+------+-------+------+------+--------- PIO High | A or B | 1 | 1 | 1 | 1 | 1 -----------------+---------+------+-------+------+------+---------


Public Types
typedef std::vector< LOW_devDS2406 * >	devDS2406PtrVec_t
	Vector type of class device pointers.
typedef LOW_devDS2406::statusRegister_t	statusRegister_t
	DS2406 internal status register as defined by Dallas.
enum	chanSelect_t { noneSelect = 0, chanASelect = 1, chanBSelect = 2, chanBothSelect = 3 }
	Type for PIO channel selection. More...
enum	sourceSelect_t { latchSelect = 1, flipFlopSelect = 2, curStatusSelect = 3 }
	Type for search source selection. More...
enum	pioTransistor_t { pioTransistorOn = 0, pioTransistorOff = 1 }
	Type for PIO transistor states. More...
enum	activePolarity_t { activeLow = 0, activeHigh = 1 }
	Type for activity polarity selection. More...
typedef std::vector< LOW_device * >	devPtrVec_t
	Vector type of class device pointers.
typedef std::map< LOW_deviceID, LOW_device * >	deviceMap_t
	Map type of devices with LOW_deviceID as key.
Public Member Functions
	class_DERIVE_FROM_EXCEPTION (devDS2406_error,LOW_exception)
	Exception base class for all exceptions thrown by LOW_devDS2406.
	LOW_devDS2406 (LOW_netSegment &inSegment, const LOW_deviceID &inDevID)
	Real constructor corresponding to static pseudo constructor new_Instance().
virtual	~LOW_devDS2406 ()
	Destructor.
virtual const LOW_deviceIDRaw::devFamCode_t	getFamilyCode () const
	Get the device's family code.
virtual const std::string	getFamilyName () const
	Get the device's family name.
virtual bool	getIsExternalPowered () const
	Get wether the device is externally powered.
virtual bool	getHasPioB () const
	Get wether the second PIO channel is present.
virtual void	getSearchCondition (LOW_devDS2406::statusRegister_t *outStatusRegister) const
	Get the current search condition.
virtual void	setSearchCondition (const chanSelect_t inChanSelect, const sourceSelect_t inSourceSelect, const activePolarity_t inPolaritySelect, const pioTransistor_t inPioATrans, const pioTransistor_t inPioBTrans) const
	Set the search condition and status of the PIO transistors.
virtual void	cmd_ReadMemory (const uint8_t inStartAddr, byteVec_t &outBytes) const
	Read from EPROM memory.
virtual void	cmd_ReadStatus (const uint8_t inStartAddr, byteVec_t &outBytes) const
	Read from status memory.
virtual void	cmd_WriteStatus (const uint8_t inStartAddr, const byteVec_t &inWriteBytes) const
	Write to status memory.
virtual LOW_deviceID	getID () const
	Get the device's ROM ID.
virtual LOW_netSegment &	getNetSegment () const
	Get the network segment the device is on.
virtual bool	verifyDevice (const bool inOnlyAlarm=false, const bool inDoReset=true) const
	Shortcut method to verify the presence of the device on it's network segment.
Static Public Attributes
const LOW_deviceIDRaw::devFamCode_t	familyCode = 0x12
	Family code of this specific device.
const std::string	familyName = "DS2406"
	Family name of this specific device.
const owCommand_t	ReadMemory_COMMAND = 0xf0
	1-Wire command byte constant
const owCommand_t	ExtendedReadMemory_COMMAND = 0xa5
	1-Wire command byte constant
const owCommand_t	WriteMemory_COMMAND = 0x0f
	1-Wire command byte constant
const owCommand_t	WriteStatus_COMMAND = 0x55
	1-Wire command byte constant
const owCommand_t	ReadStatus_COMMAND = 0xaa
	1-Wire command byte constant
const owCommand_t	ChannelAccess_COMMAND = 0xf5
	1-Wire command byte constant
const LOW_deviceIDRaw::devFamCode_t	anyDev_famCode = 0x00
	Pseudo family code for selecting any/all device types.
const LOW_deviceIDRaw::devFamCode_t	unknownDev_famCode = 0xff
	Pseudo family code for unknown device types.
const owCommand_t	MatchROM_COMMAND = 0x55
	1-Wire command byte constant
const owCommand_t	ReadROM_COMMAND = 0x33
	1-Wire command byte constant
const owCommand_t	SkipROM_COMMAND = 0xcc
	1-Wire command byte constant
const owCommand_t	SearchROM_COMMAND = 0xf0
	1-Wire command byte constant
const owCommand_t	SearchAlarmROM_COMMAND = 0xec
	1-Wire command byte constant
Protected Member Functions
virtual void	readMemUniversal (const uint16_t inStartAddr, byteVec_t &outBytes, const uint16_t inMaxLen, const owCommand_t inCommand) const
	Universal, internal data reading.
virtual LOW_link &	getLink () const
	Get the link the device is on.
virtual void	cmd_MatchROM () const
	Shortcut for issuing a matchROM command for a device.
Static Protected Member Functions
LOW_device *	new_Instance (LOW_netSegment &inNetSegment, const LOW_deviceID &inDevID)
	Static pseudo constructor for registering with LOW_deviceFactory.
Protected Attributes
bool	isExternalPowered
	External supply indicator.
bool	hasPioB
	Wether the second PIO channel is present.
const LOW_deviceID	ID
	1-Wire ROM ID of the device
LOW_netSegment &	netSegment
	Network segment where the device is located.
Static Private Member Functions
int	initialize ()
	Static inizializer to register the class with LOW_deviceFactory.
Static Private Attributes
int	initHelper = initialize()
	Needed for dirty little C++ hack to force static initialization on application start.
Friends
class	cmd_ChannelAccess
	required for accessing the device's lock
class	linkLock
	Needed to grant access to the protected getLink() method.

LOW_devDS2406 Class Reference

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Member Functions

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation