com.dalsemi.onewire.container
Class OneWireContainer04

java.lang.Object
  |
  +--com.dalsemi.onewire.container.OneWireContainer
        |
        +--com.dalsemi.onewire.container.OneWireContainer04
All Implemented Interfaces:
ClockContainer, OneWireSensor

public class OneWireContainer04
extends OneWireContainer
implements ClockContainer

iButton container for iButton family type 04 (hex), DS1994/DS2404.

Version:
0.00, 28 Aug 2000

Field Summary
static int BITMAP_OFFSET
          Offset of BITMAP in array returned from read registers
static int CONTROL_OFFSET
          Offset of control register from read registers
static int COUNTER_ALARM_OFFSET
          Offset of counter-alarm in array returned from read registers
static int COUNTER_OFFSET
          Offset of counter in array returned from read registers
static int INTERVAL_ALARM_OFFSET
          Offset of inverval-counter-alarm in array returned from read registers
static int INTERVAL_OFFSET
          Offset of inverval-counter in array returned from read registers
static int RTC_ALARM_OFFSET
          Offset of real-time-clock-alarm in array returned from read registers
static int RTC_OFFSET
          Offset of real-time-clock in array returned from read registers
static int STATUS_OFFSET
          Offset of status register from read registers
 
Constructor Summary
OneWireContainer04()
          Default constructor
OneWireContainer04(DSPortAdapter sourceAdapter, byte[] newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer04(DSPortAdapter sourceAdapter, long newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
OneWireContainer04(DSPortAdapter sourceAdapter, java.lang.String newAddress)
          Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
 
Method Summary
 boolean canDisableClock()
          Query to see if the clock can be disabled.
 boolean canReadAfterExpire(byte[] state)
          This method checks if the device can be read after a write protected alarm has occured from the provided clock register page retrieved from the 'readClockRegisters()' method.
 java.lang.String getAlternateNames()
          Retrieve the alternate Dallas Semiconductor part numbers or names.
 long getClock(byte[] state)
          This method extracts the Clock Value in milliseconds from the state data retrieved from the 'readDevice()' method.
 long getClockAlarm(byte[] state)
          This method extracts the Clock Alarm Value from the provided state data retrieved from the 'readDevice()' method.
 long getClockResolution()
          Query to get the clock resolution in milliseconds
 long getCycleCounter(byte[] state)
          This method extracts the cycle count Value from the clock register page retrieved from the 'readClockRegisters()' method.
 long getCycleCounterAlarm(byte[] state)
          This method retrieves the cycle count Alarm Value from the DS1994.
 java.lang.String getDescription()
          Retrieve a short description of the function of the iButton type.
 long getIntervalTimer(byte[] state)
          This method extracts the Interval Timer Value in milliseconds from the clock register page retrieved from the 'readClockRegisters()' method.
 long getIntervalTimerAlarm(byte[] state)
          This method extracts the Interval Timer Alarm Value from the provided clock register page retrieved from the 'readClockRegisters()' method.
 java.util.Enumeration getMemoryBanks()
          Return an enumeration of memory banks.
 java.lang.String getName()
          Retrieve the Dallas Semiconductor part number of the iButton as a string.
 boolean hasClockAlarm()
          Query to see if the clock has an alarm feature.
 boolean isAutomaticDelayLong(byte[] state)
          This method checks if the automatic delay for the Inteval Timer and the Cycle counter is either 3.5ms (regular) or 123ms (long).
 boolean isClockAlarmEnabled(byte[] state)
          This method checks if the Clock Alarm is enabled from the provided state data retrieved from the 'readDevice()' method.
 boolean isClockAlarming(byte[] state)
          This method checks if the Real-Time Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isClockRunning(byte[] state)
          This method checks if the device's oscilator is enabled.
 boolean isClockWriteProtected(byte[] state)
          This method checks if the Real-Time clock/Alarm is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isCycleCounterAlarmEnabled(byte[] state)
          This method checks if the Cycle Alarm is enabled from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isCycleCounterAlarming(byte[] state)
          This method checks if the Cycle Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isCycleCounterWriteProtected(byte[] state)
          This method checks if the Cycle Counter and Alarm is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isIntervalTimerAlarmEnabled(byte[] state)
          This method checks if the Interval Timer Alarm is enabled from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isIntervalTimerAlarming(byte[] state)
          This method checks if the Interval Timer Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
 boolean isIntervalTimerAutomatic(byte[] state)
          This method checks if the Interval timer is automatic or manual.
 boolean isIntervalTimerStopped(byte[] state)
          This method checks if the Interval timer is stopped.
 boolean isIntervalTimerWriteProtected(byte[] state)
          This method checks if the Interval Timer and Interval Timer Alarm register is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
 byte[] readDevice()
          This method retrieves the entire clock register page.
 void setAutomaticDelayLong(boolean delayLong, byte[] state)
          This method sets the automatic delay for the Inteval Timer and the Cycle counter is either 123ms (long) or 3.5ms (regular).
 void setClock(long time, byte[] state)
          This method sets the Clock time in the provided state data Use the method 'writeDevice()' with this data to finalize the change to the device.
 void setClockAlarm(long time, byte[] state)
          This method sets the Clock Alarm in the provided state data.
 void setClockAlarmEnable(boolean alarmEnable, byte[] state)
          This method sets the Clock Alarm enable.
 void setClockRunEnable(boolean runEnable, byte[] state)
          This method sets the oscillator enable to the specified value.
 void setCycleCounter(long cycles, byte[] state)
          This method sets Cycle counter in the provided clock register data field.
 void setCycleCounterAlarm(long cycles, byte[] state)
          This method sets the Cycle Count Alarm in the provided clock register data field.
 void setCycleCounterAlarmEnable(boolean alarmEnable, byte[] state)
          This method sets the Cycle counter Alarm enable.
 void setIntervalTimer(long time, byte[] state)
          This method sets the Interval Timer in the provided clock register data field.
 void setIntervalTimerAlarm(long time, byte[] state)
          This method sets the Interval Timer Alarm in the provided clock register data field.
 void setIntervalTimerAlarmEnable(boolean alarmEnable, byte[] state)
          This method sets the Interval Timer Alarm enable.
 void setIntervalTimerAutomatic(boolean autoTimer, byte[] state)
          This method sets the Interval timer in automatic or manual.
 void setIntervalTimerRunState(boolean runState, byte[] state)
          This method sets the Interval timer run/stop mode.
 void setReadAfterExpire(boolean readAfter, byte[] state)
          This method sets the read state of the device after write protected alarm has occured.
 void writeDevice(byte[] state)
          This method write the bytes in the provided clock register page that have been changed by the 'set' methods.
 void writeProtectClock(byte[] state)
          This method sets the write protect options for the Real-Time clock/Alarm in the provided clock register page retrieved from the 'readClockRegisters()' method.
 void writeProtectedCycleCounter(byte[] state)
          This method sets the write protect options for the Cycle Counter and Alarm register in the provided clock register page retrieved from the 'readClockRegisters()' method.
 void writeProtectedIntervalTimer(byte[] state)
          This method sets the write protect options for Interval Timer and Interval Timer Alarm register in the provided clock register page retrieved from the 'readClockRegisters()' method.
 
Methods inherited from class com.dalsemi.onewire.container.OneWireContainer
doSpeed, getAdapter, getAddress, getAddressAsLong, getAddressAsString, getMaxSpeed, isAlarming, isPresent, setSpeed, setupContainer, setupContainer, setupContainer
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BITMAP_OFFSET

public static final int BITMAP_OFFSET
Offset of BITMAP in array returned from read registers

STATUS_OFFSET

public static final int STATUS_OFFSET
Offset of status register from read registers

CONTROL_OFFSET

public static final int CONTROL_OFFSET
Offset of control register from read registers

RTC_OFFSET

public static final int RTC_OFFSET
Offset of real-time-clock in array returned from read registers

INTERVAL_OFFSET

public static final int INTERVAL_OFFSET
Offset of inverval-counter in array returned from read registers

COUNTER_OFFSET

public static final int COUNTER_OFFSET
Offset of counter in array returned from read registers

RTC_ALARM_OFFSET

public static final int RTC_ALARM_OFFSET
Offset of real-time-clock-alarm in array returned from read registers

INTERVAL_ALARM_OFFSET

public static final int INTERVAL_ALARM_OFFSET
Offset of inverval-counter-alarm in array returned from read registers

COUNTER_ALARM_OFFSET

public static final int COUNTER_ALARM_OFFSET
Offset of counter-alarm in array returned from read registers
Constructor Detail

OneWireContainer04

public OneWireContainer04()
Default constructor

OneWireContainer04

public OneWireContainer04(DSPortAdapter sourceAdapter,
                          byte[] newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

OneWireContainer04

public OneWireContainer04(DSPortAdapter sourceAdapter,
                          long newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device

OneWireContainer04

public OneWireContainer04(DSPortAdapter sourceAdapter,
                          java.lang.String newAddress)
Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
Parameters:
sourceAdapter - adapter object required to communicate with this iButton.
newAddress - address of this 1-Wire device
Method Detail

getName

public java.lang.String getName()
Retrieve the Dallas Semiconductor part number of the iButton as a string. For example 'DS1992'.
Overrides:
getName in class OneWireContainer
Returns:
string represetation of the iButton name.

getAlternateNames

public java.lang.String getAlternateNames()
Retrieve the alternate Dallas Semiconductor part numbers or names. A 'family' of MicroLAN devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.
Overrides:
getAlternateNames in class OneWireContainer
Returns:
string represetation of the alternate names.

getDescription

public java.lang.String getDescription()
Retrieve a short description of the function of the iButton type.
Overrides:
getDescription in class OneWireContainer
Returns:
string represetation of the function description.

getMemoryBanks

public java.util.Enumeration getMemoryBanks()
Return an enumeration of memory banks. Look at the MemoryBank, PagedMemoryBank and OTPMemoryBank classes.
Overrides:
getMemoryBanks in class OneWireContainer
Following copied from class: com.dalsemi.onewire.container.OneWireContainer
Returns:
enumeration of memory banks to read and write memory on this iButton or 1-Wire device.

hasClockAlarm

public boolean hasClockAlarm()
Query to see if the clock has an alarm feature.
Specified by:
hasClockAlarm in interface ClockContainer
Returns:
boolean, true if real-time-clock has an alarm

canDisableClock

public boolean canDisableClock()
Query to see if the clock can be disabled. See the methods 'isClockRunning()' and 'setClockRunEnable()'.
Specified by:
canDisableClock in interface ClockContainer
Returns:
boolean, true if the clock can be enabled and disabled.

getClockResolution

public long getClockResolution()
Query to get the clock resolution in milliseconds
Specified by:
getClockResolution in interface ClockContainer
Returns:
long, get the clock resolution in milliseconds.

readDevice

public byte[] readDevice()
                  throws OneWireIOException,
                         OneWireException
This method retrieves the entire clock register page. It reads this page up to 5 times or until a match (except for lsbyte of timers) is the same. Use the byte array return from this method with static utility methods to extract the real-time-clock and other register values. Appended to the clock page data is 4 bytes that represent a bitmap of changed bytes. These bytes are used in the 'writeClockRegisters()' in conjuction with the 'set' methods to only write back the changed clock register bytes. This method will clear any pending alarms.
Specified by:
readDevice in interface OneWireSensor
Returns:
 
Throws:
OneWireIOException -  
OneWireException -  

writeDevice

public void writeDevice(byte[] state)
                 throws OneWireIOException,
                        OneWireException
This method write the bytes in the provided clock register page that have been changed by the 'set' methods. It knows which registers have changed by looking at the bitmap fields appended to the clock register page data. WARNING: If write-protect alarm options have been set then this operation is non-reversable.
Specified by:
writeDevice in interface OneWireSensor
Parameters:
state - - byte array of clock register page contents
Throws:
OneWireIOException -  
OneWireException -  

getClock

public long getClock(byte[] state)
This method extracts the Clock Value in milliseconds from the state data retrieved from the 'readDevice()' method.
Specified by:
getClock in interface ClockContainer
Parameters:
state - - byte array of device state
Returns:
long<\code> time - in milliseconds that have occured since 1970.

getClockAlarm

public long getClockAlarm(byte[] state)
This method extracts the Clock Alarm Value from the provided state data retrieved from the 'readDevice()' method.
Specified by:
getClockAlarm in interface ClockContainer
Parameters:
state - - byte array of device state
Returns:
long<\code> time - in milliseconds that have the clock alarm is set to.

isClockAlarming

public boolean isClockAlarming(byte[] state)
This method checks if the Real-Time Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
Specified by:
isClockAlarming in interface ClockContainer
Parameters:
state - - byte array of clock register page contents

isClockAlarmEnabled

public boolean isClockAlarmEnabled(byte[] state)
This method checks if the Clock Alarm is enabled from the provided state data retrieved from the 'readDevice()' method.
Specified by:
isClockAlarmEnabled in interface ClockContainer
Parameters:
state - - byte array of device state
Returns:
boolean<\code> true if clock alarm is enabled

isClockRunning

public boolean isClockRunning(byte[] state)
This method checks if the device's oscilator is enabled. The clock will not increment if the clock is not enabled. This value is read from the provided state data retrieved from the 'readDevice()' method.
Specified by:
isClockRunning in interface ClockContainer
Parameters:
state - - byte array of device state
Returns:
boolean<\code> true

getIntervalTimer

public long getIntervalTimer(byte[] state)
This method extracts the Interval Timer Value in milliseconds from the clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

getCycleCounter

public long getCycleCounter(byte[] state)
This method extracts the cycle count Value from the clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

getIntervalTimerAlarm

public long getIntervalTimerAlarm(byte[] state)
This method extracts the Interval Timer Alarm Value from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

getCycleCounterAlarm

public long getCycleCounterAlarm(byte[] state)
This method retrieves the cycle count Alarm Value from the DS1994.
Parameters:
state - - byte array of clock register page contents

isIntervalTimerAlarming

public boolean isIntervalTimerAlarming(byte[] state)
This method checks if the Interval Timer Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isCycleCounterAlarming

public boolean isCycleCounterAlarming(byte[] state)
This method checks if the Cycle Alarm flag has been set from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isIntervalTimerAlarmEnabled

public boolean isIntervalTimerAlarmEnabled(byte[] state)
This method checks if the Interval Timer Alarm is enabled from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isCycleCounterAlarmEnabled

public boolean isCycleCounterAlarmEnabled(byte[] state)
This method checks if the Cycle Alarm is enabled from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isClockWriteProtected

public boolean isClockWriteProtected(byte[] state)
This method checks if the Real-Time clock/Alarm is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isIntervalTimerWriteProtected

public boolean isIntervalTimerWriteProtected(byte[] state)
This method checks if the Interval Timer and Interval Timer Alarm register is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isCycleCounterWriteProtected

public boolean isCycleCounterWriteProtected(byte[] state)
This method checks if the Cycle Counter and Alarm is write protected from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

canReadAfterExpire

public boolean canReadAfterExpire(byte[] state)
This method checks if the device can be read after a write protected alarm has occured from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isIntervalTimerAutomatic

public boolean isIntervalTimerAutomatic(byte[] state)
This method checks if the Interval timer is automatic or manual. If it is automatic then the interval counter will increment while the devices I/O line is high after the delay select period has elapsed (either 3.5 or 123 ms, see the isAutomaticDelayLong() method). This value is read from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isIntervalTimerStopped

public boolean isIntervalTimerStopped(byte[] state)
This method checks if the Interval timer is stopped. This only has meaning if the interval timer is in manual mode (not isIntervalTimerAutomatic()). This value is read from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

isAutomaticDelayLong

public boolean isAutomaticDelayLong(byte[] state)
This method checks if the automatic delay for the Inteval Timer and the Cycle counter is either 3.5ms (regular) or 123ms (long). This value is read from the provided clock register page retrieved from the 'readClockRegisters()' method.
Parameters:
state - - byte array of clock register page contents

setClock

public void setClock(long time,
                     byte[] state)
This method sets the Clock time in the provided state data Use the method 'writeDevice()' with this data to finalize the change to the device.
Specified by:
setClock in interface ClockContainer
Parameters:
time - - long<\code> milliseconds the user wants the Clock set to.
state - - byte array of device state

setClockAlarm

public void setClockAlarm(long time,
                          byte[] state)
This method sets the Clock Alarm in the provided state data. Use the method 'writeDevice()' with this data to finalize the change to the device.
Specified by:
setClockAlarm in interface ClockContainer
Parameters:
time - - long<\code> milliseconds the user wants the Clock alarm set to.
state - - byte array of device state

setClockRunEnable

public void setClockRunEnable(boolean runEnable,
                              byte[] state)
This method sets the oscillator enable to the specified value. Use the method 'writeDevice()' with this data to finalize the change to the device.
Specified by:
setClockRunEnable in interface ClockContainer
Parameters:
runEnable - - boolean, true if want the clock oscillator to be enabled.
state - - byte array of device state

setClockAlarmEnable

public void setClockAlarmEnable(boolean alarmEnable,
                                byte[] state)
This method sets the Clock Alarm enable. Use the method 'writeDevice()' with this data to finalize the change to the device.
Specified by:
setClockAlarmEnable in interface ClockContainer
Parameters:
alarmEnable - - boolean, true to enable the clock alarm
state - - byte array of device state

setIntervalTimer

public void setIntervalTimer(long time,
                             byte[] state)
                      throws java.lang.IllegalArgumentException
This method sets the Interval Timer in the provided clock register data field. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
time -  
state - - byte array of clock register page contents
Throws:
java.lang.IllegalArgumentException -  

setCycleCounter

public void setCycleCounter(long cycles,
                            byte[] state)
                     throws java.lang.IllegalArgumentException
This method sets Cycle counter in the provided clock register data field. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
cycles -  
state - - byte array of clock register page contents
Throws:
java.lang.IllegalArgumentException -  

setIntervalTimerAlarm

public void setIntervalTimerAlarm(long time,
                                  byte[] state)
                           throws java.lang.IllegalArgumentException
This method sets the Interval Timer Alarm in the provided clock register data field. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
time -  
state - - byte array of clock register page contents
Throws:
java.lang.IllegalArgumentException -  

setCycleCounterAlarm

public void setCycleCounterAlarm(long cycles,
                                 byte[] state)
                          throws java.lang.IllegalArgumentException
This method sets the Cycle Count Alarm in the provided clock register data field. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
cycles -  
state - - byte array of clock register page contents
Throws:
java.lang.IllegalArgumentException -  

writeProtectClock

public void writeProtectClock(byte[] state)
This method sets the write protect options for the Real-Time clock/Alarm in the provided clock register page retrieved from the 'readClockRegisters()' method. WARNING: after calling 'writeClockRegisters()' after this method will perminatly write protect these registers.
Parameters:
state - - byte array of clock register page contents

writeProtectedIntervalTimer

public void writeProtectedIntervalTimer(byte[] state)
This method sets the write protect options for Interval Timer and Interval Timer Alarm register in the provided clock register page retrieved from the 'readClockRegisters()' method. WARNING: after calling 'writeClockRegisters()' after this method will perminatly write protect these registers.
Parameters:
state - - byte array of clock register page contents

writeProtectedCycleCounter

public void writeProtectedCycleCounter(byte[] state)
This method sets the write protect options for the Cycle Counter and Alarm register in the provided clock register page retrieved from the 'readClockRegisters()' method. WARNING: after calling 'writeClockRegisters()' after this method will perminatly write protect these registers.
Parameters:
state - - byte array of clock register page contents

setReadAfterExpire

public void setReadAfterExpire(boolean readAfter,
                               byte[] state)
This method sets the read state of the device after write protected alarm has occured. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
readAfter - - boolean, true if want to read device after it expires from a write protected alarm event.
state - - byte array of clock register page contents

setIntervalTimerAutomatic

public void setIntervalTimerAutomatic(boolean autoTimer,
                                      byte[] state)
This method sets the Interval timer in automatic or manual. If it is automatic then the interval counter will increment while the devices I/O line is high after the delay select period has elapsed (either 3.5 or 123 ms, see the isAutomaticDelayLong() method). Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
autoTimer - - boolean, true if want the interval timer to operate in automatic mode. The interval timer will then run whenever the IO pin is higth for at least the delay-select time.
state - - byte array of clock register page contents

setIntervalTimerRunState

public void setIntervalTimerRunState(boolean runState,
                                     byte[] state)
This method sets the Interval timer run/stop mode. This only has meaning if the interval timer is in manual mode (not isIntervalTimerAutomatic()). Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
runState - - boolean, true if want the interval timer run. The interval timer must be in manual mode for this to have an effect.
state - - byte array of clock register page contents

setAutomaticDelayLong

public void setAutomaticDelayLong(boolean delayLong,
                                  byte[] state)
This method sets the automatic delay for the Inteval Timer and the Cycle counter is either 123ms (long) or 3.5ms (regular). Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
delayLong - - boolean, true if want the interval timer in automatic mode and cycle counter to increment after 123ms. 'false' if 3.5ms is desired.
state - - byte array of clock register page contents

setIntervalTimerAlarmEnable

public void setIntervalTimerAlarmEnable(boolean alarmEnable,
                                        byte[] state)
This method sets the Interval Timer Alarm enable. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
alarmEnable - - boolean, true if want the interval-timer-alarm enabled.
state - - byte array of clock register page contents

setCycleCounterAlarmEnable

public void setCycleCounterAlarmEnable(boolean alarmEnable,
                                       byte[] state)
This method sets the Cycle counter Alarm enable. Use the method 'writeClockRegisters()' with this data to finalize the change to the device.
Parameters:
alarmEnable - - boolean, true if want the cycle-counter-alarm enabled.
state - - byte array of clock register page contents