|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.dalsemi.onewire.adapter.DSPortAdapter
The DSPortAdapter class is the abstract base class for all 1-Wire port adapter objects. An implementation class of this type is therefore independent of the adapter type.
Field Summary | |
static int |
CONDITION_AFTER_BIT
Condition for power state change, after next bit communication |
static int |
CONDITION_AFTER_BYTE
Condition for power state change, after next byte communication |
static int |
CONDITION_NOW
Condition for power state change, immediate |
static int |
DELIVERY_CURRENT_DETECT
Duration used in delivering power to the 1-Wire, current detect |
static int |
DELIVERY_EPROM
Duration used in delivering power to the 1-Wire, 480 us |
static int |
DELIVERY_FOUR_SECONDS
Duration used in delivering power to the 1-Wire, 4 second |
static int |
DELIVERY_HALF_SECOND
Duration used in delivering power to the 1-Wire, 1/2 second |
static int |
DELIVERY_INFINITE
Duration used in delivering power to the 1-Wire, infinite |
static int |
DELIVERY_ONE_SECOND
Duration used in delivering power to the 1-Wire, 1 second |
static int |
DELIVERY_SMART_DONE
Duration used in delivering power to the 1-Wire, smart complete |
static int |
DELIVERY_TWO_SECONDS
Duration used in delivering power to the 1-Wire, 2 seconds |
static char |
LEVEL_BREAK
1-Wire Network level, (strong pulldown to 0Volts, reset 1-Wire) |
static char |
LEVEL_NORMAL
1-Wire Network level, normal (weak 5Volt pullup) |
static char |
LEVEL_POWER_DELIVERY
1-Wire Network level, (strong 5Volt pullup, used for power delivery) |
static char |
LEVEL_PROGRAM
1-Wire Network level, (strong 12Volt pullup, used to program eprom ) |
static int |
RESET_ALARM
1-Wire Network reset result = alarm |
static int |
RESET_NOPRESENCE
1-Wire Network reset result = no presence |
static int |
RESET_PRESENCE
1-Wire Network reset result = presence |
static int |
RESET_SHORT
1-Wire Network reset result = shorted |
static int |
SPEED_FLEX
Speed modes for 1-Wire Network, flexible for long lines |
static int |
SPEED_HYPERDRIVE
Speed modes for 1-Wire Network, hyperdrive |
static int |
SPEED_OVERDRIVE
Speed modes for 1-Wire Network, overdrive |
static int |
SPEED_REGULAR
Speed modes for 1-Wire Network, regular |
Constructor Summary | |
DSPortAdapter()
|
Method Summary | |
abstract boolean |
adapterDetected()
Detect adapter presence on the selected port. |
abstract boolean |
beginExclusive(boolean blocking)
Gets exclusive use of the 1-Wire to communicate with an iButton or 1-Wire Device. |
boolean |
canBreak()
Returns whether adapter can physically support 0 volt 'break' mode. |
boolean |
canDeliverPower()
Returns whether the adapter can physically support strong 5 volt power mode. |
boolean |
canDeliverSmartPower()
Returns whether the adapter can physically support "smart" strong 5 volt power mode. |
boolean |
canFlex()
Returns whether the adapter can physically support flex speed mode. |
boolean |
canHyperdrive()
Returns whether the adapter can physically support hyperdrive mode. |
boolean |
canOverdrive()
Returns whether adapter can physically support overdrive mode. |
boolean |
canProgram()
Returns whether adapter can physically support 12 volt power mode. |
abstract void |
dataBlock(byte[] dataBlock,
int off,
int len)
Sends a block of data and returns the data received in the same array. |
abstract void |
endExclusive()
Relinquishes exclusive control of the 1-Wire Network. |
void |
excludeFamily(byte[] family)
Takes an array of bytes containing family codes to avoid when finding iButtons or 1-Wire devices. |
void |
excludeFamily(int family)
Takes an integer family code to avoid when searching for iButtons. |
abstract boolean |
findFirstDevice()
Returns true if the first iButton or 1-Wire device
is found on the 1-Wire Network. |
abstract boolean |
findNextDevice()
Returns true if the next iButton or 1-Wire device
is found. |
abstract void |
freePort()
Free ownership of the selected port if it is currently owned back to the system. |
java.lang.String |
getAdapterAddress()
Retrieve the address of the adapter if it has one. |
abstract java.lang.String |
getAdapterName()
Retrieve the name of the port adapter as a string. |
java.lang.String |
getAdapterVersion()
Retrieve the version of the adapter. |
abstract void |
getAddress(byte[] address)
Copies the 'current' iButton address being used by the adapter into the array. |
long |
getAddressAsLong()
Get the 'current' iButton address being used by the adapter as a long. |
java.lang.String |
getAddressAsString()
Get the 'current' iButton address being used by the adapter as a String. |
java.util.Enumeration |
getAllDeviceContainers()
Returns an enumeration of OneWireContainer objects corresponding to all of the iButtons or 1-Wire devices found on the 1-Wire Network. |
abstract boolean |
getBit()
Gets a bit from the 1-Wire Network. |
abstract void |
getBlock(byte[] arr,
int len)
Get a block of data from the 1-Wire Network and write it into the provided array. |
abstract void |
getBlock(byte[] arr,
int off,
int len)
Get a block of data from the 1-Wire Network and write it into the provided array. |
abstract byte[] |
getBlock(int len)
Get a block of data from the 1-Wire Network. |
abstract int |
getByte()
Gets a byte from the 1-Wire Network. |
abstract java.lang.String |
getClassVersion()
Retrieve a version string for this class. |
OneWireContainer |
getDeviceContainer()
Constructs an OneWireContainer object using the current iButton address. |
OneWireContainer |
getDeviceContainer(byte[] address)
Constructs an OneWireContainer object using a user supplied iButton address. |
OneWireContainer |
getDeviceContainer(long address)
Constructs an OneWireContainer object using a user supplied iButton address. |
OneWireContainer |
getDeviceContainer(java.lang.String address)
Constructs an OneWireContainer object using a user supplied iButton address. |
OneWireContainer |
getFirstDeviceContainer()
Returns an OneWireContainer object corresponding to the first iButton or 1-Wire device found on the 1-Wire Network. |
OneWireContainer |
getNextDeviceContainer()
Returns an OneWireContainer object corresponding to the next iButton or 1-Wire device found. |
abstract java.lang.String |
getPortName()
Retrieve the name of the selected port as a String . |
abstract java.util.Enumeration |
getPortNames()
Retrieve a list of the platform appropriate port names for this adapter. |
abstract java.lang.String |
getPortTypeDescription()
Retrieve a description of the port required by this port adapter. |
int |
getSpeed()
This method returns the current data transfer speed through a port to a 1-Wire Network. |
boolean |
isAlarming(byte[] address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network and in an alarm state. |
boolean |
isAlarming(long address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network and in an alarm state. |
boolean |
isAlarming(java.lang.String address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network and in an alarm state. |
boolean |
isPresent(byte[] address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network. |
boolean |
isPresent(long address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network. |
boolean |
isPresent(java.lang.String address)
Verifies that the iButton or 1-Wire device specified is present on the 1-Wire Network. |
abstract void |
putBit(boolean bitValue)
Sends a bit to the 1-Wire Network. |
abstract void |
putByte(int byteValue)
Sends a byte to the 1-Wire Network. |
void |
registerOneWireContainerClass(int family,
java.lang.Class OneWireContainerClass)
Register a user provided OneWireContainer class. |
abstract int |
reset()
Sends a Reset to the 1-Wire Network. |
boolean |
select(byte[] address)
Selects the specified iButton or 1-Wire device by broadcasting its address. |
boolean |
select(long address)
Selects the specified iButton or 1-Wire device by broadcasting its address. |
boolean |
select(java.lang.String address)
Selects the specified iButton or 1-Wire device by broadcasting its address. |
abstract boolean |
selectPort(java.lang.String portName)
Specify a platform appropriate port name for this adapter. |
abstract void |
setNoResetSearch()
Set the 1-Wire Network search to not perform a 1-Wire reset before a search. |
void |
setPowerDuration(int timeFactor)
Sets the duration to supply power to the 1-Wire Network. |
void |
setPowerNormal()
Sets the 1-Wire Network voltage to normal level. |
void |
setProgramPulseDuration(int timeFactor)
Sets the duration for providing a program pulse on the 1-Wire Network. |
abstract void |
setSearchAllDevices()
Set the 1-Wire Network search to find all iButtons and 1-Wire devices whether they are in an 'Alarm' state or not and restores the default setting of providing a 1-Wire reset command before each search. |
abstract void |
setSearchOnlyAlarmingDevices()
Set the 1-Wire Network search to find only iButtons and 1-Wire devices that are in an 'Alarm' state that signals a need for attention. |
void |
setSpeed(int speed)
This method takes an int representing the new speed of data transfer on the 1-Wire Network. |
void |
startBreak()
Sets the 1-Wire Network voltage to 0 volts. |
boolean |
startPowerDelivery(int changeCondition)
Sets the 1-Wire Network voltage to supply power to an iButton device. |
boolean |
startProgramPulse(int changeCondition)
Sets the 1-Wire Network voltage to eprom programming level. |
void |
targetAllFamilies()
Removes any selectivity during a search for iButtons or 1-Wire devices by family type. |
void |
targetFamily(byte[] family)
Takes an array of bytes to use for selectively searching for acceptable family codes. |
void |
targetFamily(int family)
Takes an integer to selectively search for this desired family type. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int SPEED_REGULAR
public static final int SPEED_FLEX
public static final int SPEED_OVERDRIVE
public static final int SPEED_HYPERDRIVE
public static final char LEVEL_NORMAL
public static final char LEVEL_POWER_DELIVERY
public static final char LEVEL_BREAK
public static final char LEVEL_PROGRAM
public static final int RESET_NOPRESENCE
public static final int RESET_PRESENCE
public static final int RESET_ALARM
public static final int RESET_SHORT
public static final int CONDITION_NOW
public static final int CONDITION_AFTER_BIT
public static final int CONDITION_AFTER_BYTE
public static final int DELIVERY_HALF_SECOND
public static final int DELIVERY_ONE_SECOND
public static final int DELIVERY_TWO_SECONDS
public static final int DELIVERY_FOUR_SECONDS
public static final int DELIVERY_SMART_DONE
public static final int DELIVERY_INFINITE
public static final int DELIVERY_CURRENT_DETECT
public static final int DELIVERY_EPROM
Constructor Detail |
public DSPortAdapter()
Method Detail |
public abstract java.lang.String getAdapterName()
String
representation of the port adapter.public abstract java.lang.String getPortTypeDescription()
String
description of the port type required.public abstract java.lang.String getClassVersion()
public abstract java.util.Enumeration getPortNames()
OneWireException
exception.String
that contains the port
namespublic void registerOneWireContainerClass(int family, java.lang.Class OneWireContainerClass) throws OneWireException
family
- the code of the family type to associate with this class.OneWireContainerClass
- User provided classOneWireException
- public abstract boolean selectPort(java.lang.String portName) throws OneWireIOException, OneWireException
PortInUseException
will be thrown.portName
- name of the target port, retrieved from
getPortNames()true
if the port was aquired, false
if the port is not available.OneWireIOException
- OneWireException
- public abstract void freePort() throws OneWireException
OneWireException
- public abstract java.lang.String getPortName() throws OneWireException
String
.String
of selected portOneWireException
- public abstract boolean adapterDetected() throws OneWireIOException, OneWireException
true
if the adapter is confirmed to be connected to
the selected port, false
if the adapter is not connected.OneWireIOException
- OneWireException
- public java.lang.String getAdapterVersion() throws OneWireIOException, OneWireException
String
of the adapter version. It will return
"OneWireIOException
- OneWireException
- public java.lang.String getAdapterAddress() throws OneWireIOException, OneWireException
String
of the adapter address. It will return "OneWireIOException
- OneWireException
- public boolean canOverdrive() throws OneWireIOException, OneWireException
true
if this port adapter can do OverDrive,
false
otherwise.OneWireIOException
- OneWireException
- public boolean canHyperdrive() throws OneWireIOException, OneWireException
true
if this port adapter can do HyperDrive,
false
otherwise.OneWireIOException
- OneWireException
- public boolean canFlex() throws OneWireIOException, OneWireException
true
if this port adapter can do flex speed,
false
otherwise.OneWireIOException
- OneWireException
- public boolean canProgram() throws OneWireIOException, OneWireException
true
if this port adapter can do Program voltage,
false
otherwise.OneWireIOException
- OneWireException
- public boolean canDeliverPower() throws OneWireIOException, OneWireException
true
if this port adapter can do strong 5 volt
mode, false
otherwise.OneWireIOException
- OneWireException
- public boolean canDeliverSmartPower() throws OneWireIOException, OneWireException
true
if this port adapter can do "smart" strong
5 volt mode, false
otherwise.OneWireIOException
- OneWireException
- public boolean canBreak() throws OneWireIOException, OneWireException
true
if this port adapter can do break,
false
otherwise.OneWireIOException
- OneWireException
- public java.util.Enumeration getAllDeviceContainers() throws OneWireIOException, OneWireException
Enumeration
of OneWireContainer
objects
found on the 1-Wire Network.OneWireIOException
- OneWireException
- public OneWireContainer getFirstDeviceContainer() throws OneWireIOException, OneWireException
OneWireContainer
object found on the
1-Wire Network, or null if no devices found.OneWireIOException
- OneWireException
- public OneWireContainer getNextDeviceContainer() throws OneWireIOException, OneWireException
OneWireContainer
object found on the
1-Wire Network, or null if no iButtons found.OneWireIOException
- OneWireException
- public abstract boolean findFirstDevice() throws OneWireIOException, OneWireException
true
if the first iButton or 1-Wire device
is found on the 1-Wire Network.
If no devices are found, then false
will be returned.true
if an iButton or 1-Wire device is found.OneWireIOException
- OneWireException
- public abstract boolean findNextDevice() throws OneWireIOException, OneWireException
true
if the next iButton or 1-Wire device
is found. The previous 1-Wire device found is used
as a starting point in the search. If no more devices are found
then false
will be returned.true
if an iButton or 1-Wire device is found.OneWireIOException
- OneWireException
- public abstract void getAddress(byte[] address)
address
- An array to be filled with the current iButton address.public long getAddressAsLong()
long
representation of the iButton addresspublic java.lang.String getAddressAsString()
String
representation of the iButton addresspublic boolean isPresent(byte[] address) throws OneWireIOException, OneWireException
address
- device address to verify is presenttrue
if device is present else
false
.OneWireIOException
- OneWireException
- public boolean isPresent(long address) throws OneWireIOException, OneWireException
address
- device address to verify is presenttrue
if device is present else
false
.OneWireIOException
- OneWireException
- public boolean isPresent(java.lang.String address) throws OneWireIOException, OneWireException
address
- device address to verify is presenttrue
if device is present else
false
.OneWireIOException
- OneWireException
- public boolean isAlarming(byte[] address) throws OneWireIOException, OneWireException
address
- device address to verify is present and alarmingtrue
if device is present and alarming else
false
.OneWireIOException
- OneWireException
- public boolean isAlarming(long address) throws OneWireIOException, OneWireException
address
- device address to verify is present and alarmingtrue
if device is present and alarming else
false
.OneWireIOException
- OneWireException
- public boolean isAlarming(java.lang.String address) throws OneWireIOException, OneWireException
address
- device address to verify is present and alarmingtrue
if device is present and alarming else
false
.OneWireIOException
- OneWireException
- public boolean select(byte[] address) throws OneWireIOException, OneWireException
address
- address of iButton or 1-Wire device to selecttrue
if device address was sent,false
otherwise.OneWireIOException
- OneWireException
- isPresent(byte[] address)
public boolean select(long address) throws OneWireIOException, OneWireException
ibutton
- iButton to selectaddress
- true
if device address was sent,false
otherwise.OneWireIOException
- OneWireException
- isPresent(byte[] address)
public boolean select(java.lang.String address) throws OneWireIOException, OneWireException
ibutton
- iButton to selectaddress
- true
if device address was sent,false
otherwise.OneWireIOException
- OneWireException
- isPresent(byte[] address)
public abstract void setSearchOnlyAlarmingDevices()
public abstract void setNoResetSearch()
public abstract void setSearchAllDevices()
public void targetAllFamilies()
public void targetFamily(int family)
family
- the code of the family type to target for searchespublic void targetFamily(byte[] family)
family
- array of the family types to target for searchespublic void excludeFamily(int family)
family
- the code of the family type NOT to target in searchespublic void excludeFamily(byte[] family)
family
- array of family cods NOT to target for searchespublic abstract boolean beginExclusive(boolean blocking) throws OneWireException
It can be called through the OneWireContainer class by the end application if they want to ensure exclusive use. If it is not called around several methods then it will be called inside each method.
blocking
- true
if want to block waiting
for an excluse access to the adaptertrue
if blocking was false and a
exclusive session with the adapter was aquiredOneWireException
- public abstract void endExclusive()
public abstract void putBit(boolean bitValue) throws OneWireIOException, OneWireException
bitValue
- the bit value to send to the 1-Wire Network.OneWireIOException
- OneWireException
- public abstract boolean getBit() throws OneWireIOException, OneWireException
OneWireIOException
- OneWireException
- public abstract void putByte(int byteValue) throws OneWireIOException, OneWireException
byteValue
- the byte value to send to the 1-Wire Network.OneWireIOException
- OneWireException
- public abstract int getByte() throws OneWireIOException, OneWireException
OneWireIOException
- OneWireException
- public abstract byte[] getBlock(int len) throws OneWireIOException, OneWireException
len
- length of data bytes to receiveOneWireIOException
- OneWireException
- public abstract void getBlock(byte[] arr, int len) throws OneWireIOException, OneWireException
arr
- array in which to write the received byteslen
- length of data bytes to receiveOneWireIOException
- OneWireException
- public abstract void getBlock(byte[] arr, int off, int len) throws OneWireIOException, OneWireException
arr
- array in which to write the received bytesoff
- offset into the array to startlen
- length of data bytes to receiveOneWireIOException
- OneWireException
- public abstract void dataBlock(byte[] dataBlock, int off, int len) throws OneWireIOException, OneWireException
dataBlock
- array of data to transfer to and from the 1-Wire Network.off
- offset into the array of data to startlen
- length of data to send / receive starting at 'off'OneWireIOException
- OneWireException
- public abstract int reset() throws OneWireIOException, OneWireException
OneWireIOException
- OneWireException
- public void setPowerDuration(int timeFactor) throws OneWireIOException, OneWireException
Note: to avoid getting an exception, use the canDeliverPower() and canDeliverSmartPower() method to check it's availability.
timeFactor
- OneWireIOException
- OneWireException
- public boolean startPowerDelivery(int changeCondition) throws OneWireIOException, OneWireException
Note: to avoid getting an exception, use the canDeliverPower() and canDeliverSmartPower() method to check it's availability.
changeCondition
- true
if the voltage change was successful,
false
otherwise.OneWireIOException
- OneWireException
- public void setProgramPulseDuration(int timeFactor) throws OneWireIOException, OneWireException
Note: to avoid getting an exception, use the canDeliverPower() method to check it's availability.
timeFactor
- OneWireIOException
- OneWireException
- public boolean startProgramPulse(int changeCondition) throws OneWireIOException, OneWireException
Note: to avoid getting an exception, use the canProgram() method to check it's availability.
changeCondition
- true
if the voltage change was successful,
false
otherwise.OneWireIOException
- OneWireException
- public void startBreak() throws OneWireIOException, OneWireException
OneWireIOException
- OneWireException
- public void setPowerNormal() throws OneWireIOException, OneWireException
OneWireIOException
- OneWireException
- public void setSpeed(int speed) throws OneWireIOException, OneWireException
speed
- OneWireIOException
- OneWireException
- public int getSpeed()
public OneWireContainer getDeviceContainer(byte[] address)
address
- device address with which to create a new containerOneWireContainer
objectpublic OneWireContainer getDeviceContainer(long address)
address
- device address with which to create a new containerOneWireContainer
objectpublic OneWireContainer getDeviceContainer(java.lang.String address)
address
- device address with which to create a new containerOneWireContainer
objectpublic OneWireContainer getDeviceContainer()
OneWireContainer
object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |