public class OneWireContainer27 extends OneWireContainer24 implements ClockContainer
1-Wire container for Real-Time Clock with Interrupt, DS2417. The DS2417 is similar to the DS2415 with the addition of a hardware interrupt pin. This container encapsulates the functionality of the iButton family type 27 (hex)
The clock methods can be organized into the following categories. Note that methods
that are implemented for the ClockContainer
interface are marked with (*):
ClockContainer
for clock specific operations.
ClockContainer
Modifier and Type | Field and Description |
---|---|
static byte |
INTERRUPT_INTERVAL_1
Passed to setInterruptInterval to set the interrupt interval to 1 second.
|
static byte |
INTERRUPT_INTERVAL_131072
Passed to setInterruptInterval to set the interrupt interval to 131072 seconds.
|
static byte |
INTERRUPT_INTERVAL_2048
Passed to setInterruptInterval to set the interrupt interval to 2048 seconds.
|
static byte |
INTERRUPT_INTERVAL_32
Passed to setInterruptInterval to set the interrupt interval to 32 seconds.
|
static byte |
INTERRUPT_INTERVAL_4
Passed to setInterruptInterval to set the interrupt interval to 4 seconds.
|
static byte |
INTERRUPT_INTERVAL_4096
Passed to setInterruptInterval to set the interrupt interval to 1 seconds.
|
static byte |
INTERRUPT_INTERVAL_64
Passed to setInterruptInterval to set the interrupt interval to 64 seconds.
|
static byte |
INTERRUPT_INTERVAL_65536
Passed to setInterruptInterval to set the interrupt interval to 65536 seconds.
|
Constructor and Description |
---|
OneWireContainer27()
Create an empty container that is not complete until after a call
to
setupContainer . |
OneWireContainer27(DSPortAdapter sourceAdapter,
byte[] newAddress)
Create a container with the provided adapter instance
and the address of the iButton or 1-Wire device.
|
OneWireContainer27(DSPortAdapter sourceAdapter,
long newAddress)
Create a container with the provided adapter instance
and the address of the iButton or 1-Wire device.
|
OneWireContainer27(DSPortAdapter sourceAdapter,
java.lang.String newAddress)
Create a container with the provided adapter instance
and the address of the iButton or 1-Wire device.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlternateNames()
Get the alternate Maxim Integrated Products part numbers or names.
|
java.lang.String |
getDescription()
Get a short description of the function of this iButton
or 1-Wire Device type.
|
long |
getInterruptInterval(byte[] state)
Returns the interval, in seconds, that the device will interrupt on.
|
java.lang.String |
getName()
Get the Maxim Integrated Products part number of the iButton
or 1-Wire Device as a string.
|
boolean |
isInterruptEnabled(byte[] state)
Checks to see if interrupt mode is turned on.
|
void |
setInterruptEnable(boolean iEnable,
byte[] state)
Enables or disables hardware interrupting.
|
void |
setInterruptInterval(byte intervalValue,
byte[] state)
Sets the interval at which interrupting will occur.
|
canDisableClock, getClock, getClockAlarm, getClockResolution, hasClockAlarm, isClockAlarmEnabled, isClockAlarming, isClockRunning, readDevice, setClock, setClockAlarm, setClockAlarmEnable, setClockRunEnable, writeDevice
doSpeed, equals, getAdapter, getAddress, getAddressAsLong, getAddressAsString, getMaxSpeed, getMemoryBanks, hashCode, isAlarming, isPresent, setSpeed, setupContainer, setupContainer, setupContainer, toString
canDisableClock, getClock, getClockAlarm, getClockResolution, hasClockAlarm, isClockAlarmEnabled, isClockAlarming, isClockRunning, setClock, setClockAlarm, setClockAlarmEnable, setClockRunEnable
readDevice, writeDevice
public static final byte INTERRUPT_INTERVAL_1
public static final byte INTERRUPT_INTERVAL_4
public static final byte INTERRUPT_INTERVAL_32
public static final byte INTERRUPT_INTERVAL_64
public static final byte INTERRUPT_INTERVAL_2048
public static final byte INTERRUPT_INTERVAL_4096
public static final byte INTERRUPT_INTERVAL_65536
public static final byte INTERRUPT_INTERVAL_131072
public OneWireContainer27()
setupContainer
. This is one of the methods to construct a container. The others are through creating a OneWireContainer with parameters.
super.setupContainer()
public OneWireContainer27(DSPortAdapter sourceAdapter, byte[] newAddress)
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter
- adapter instance used to communicate with
this iButtonnewAddress
- Address
of this 1-Wire deviceOneWireContainer27
,
utils.Address
public OneWireContainer27(DSPortAdapter sourceAdapter, long newAddress)
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter
- adapter instance used to communicate with
this 1-Wire devicenewAddress
- Address
of this 1-Wire deviceOneWireContainer27
,
utils.Address
public OneWireContainer27(DSPortAdapter sourceAdapter, java.lang.String newAddress)
This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.
sourceAdapter
- adapter instance used to communicate with
this 1-Wire devicenewAddress
- Address
of this 1-Wire deviceOneWireContainer27
,
utils.Address
public java.lang.String getName()
getName
in class OneWireContainer24
public java.lang.String getAlternateNames()
getAlternateNames
in class OneWireContainer24
public java.lang.String getDescription()
getDescription
in class OneWireContainer24
public long getInterruptInterval(byte[] state)
state
- current state of the device returned from readDevice()
OneWireSensor.writeDevice(byte[])
,
OneWireContainer24.getClock(byte[])
public boolean isInterruptEnabled(byte[] state)
state
- current state of the device returned from readDevice()
OneWireSensor.readDevice()
,
OneWireContainer24.canDisableClock()
,
OneWireContainer24.setClockRunEnable(boolean,byte[])
public void setInterruptInterval(byte intervalValue, byte[] state)
writeDevice(byte[])
must be called to finalize
changes to the device. Note that multiple 'set' methods can
be called before one call to writeDevice(byte[])
.intervalValue
- One of the following variables should be passed, representing
different time intervals to interrupt at:
INTERRUPT_INTERVAL_1
1 second
INTERRUPT_INTERVAL_4
4 seconds
INTERRUPT_INTERVAL_32
32 seconds
INTERRUPT_INTERVAL_32
64 seconds
INTERRUPT_INTERVAL_64
2048 seconds
INTERRUPT_INTERVAL_2048
4096 seconds
INTERRUPT_INTERVAL_4096
65536 seconds
INTERRUPT_INTERVAL_131072
131072 secondsstate
- current state of the device returned from readDevice()
OneWireSensor.writeDevice(byte[])
,
OneWireContainer24.getClock(byte[])
public void setInterruptEnable(boolean iEnable, byte[] state)
runEnable
- true to enable interval interrupts.state
- current state of the device returned from readDevice()
OneWireSensor.writeDevice(byte[])
,
OneWireContainer24.canDisableClock()
,
OneWireContainer24.isClockRunning(byte[])
Copyright © 1999-2012 Maxim Integrated Products. All Rights Reserved.