1-Wire API for .NET Version 4.00
|
Inherits com::dalsemi::onewire::container::OneWireContainer, com::dalsemi::onewire::container::TemperatureContainer, and com::dalsemi::onewire::container::ClockContainer.
Public Member Functions | |
OneWireContainer21 () | |
Creates a new OneWireContainer for communication with a DS1921 Thermocron iButton. | |
OneWireContainer21 (DSPortAdapter sourceAdapter, byte[] newAddress) | |
Creates a new OneWireContainer for communication with a DS1921 Thermocron iButton. | |
OneWireContainer21 (DSPortAdapter sourceAdapter, long newAddress) | |
Creates a new OneWireContainer for communication with a DS1921 Thermocron iButton. | |
OneWireContainer21 (DSPortAdapter sourceAdapter, String newAddress) | |
Creates a new OneWireContainer for communication with a DS1921 Thermocron iButton. | |
void | setupContainer (DSPortAdapter sourceAdapter, byte[] newAddress) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device. | |
void | setupContainer (DSPortAdapter sourceAdapter, long newAddress) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device. | |
void | setupContainer (DSPortAdapter sourceAdapter, java.lang.String newAddress) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device. | |
Enumeration | getMemoryBanks () |
Gets an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank. | |
int | getMaxSpeed () |
Returns the maximum speed this iButton device can communicate at. | |
String | getName () |
Gets the Maxim Integrated Products part number of the iButton or 1-Wire Device as a java.lang.String . | |
String | getAlternateNames () |
Retrieves the alternate Maxim Integrated Products part numbers or names. | |
String | getDescription () |
Gets a short description of the function of this iButton or 1-Wire Device type. | |
synchronized void | setSpeedCheck (boolean doSpeedCheck) |
Directs the container to avoid the calls to doSpeed() in methods that communicate with the Thermocron. | |
double | getPhysicalRangeLowTemperature () |
This method returns the low temperature of the thermochron's physical temperature range. | |
double | getPhysicalRangeHighTemperature () |
This method returns the high temperature of the thermochron's physical temperature range. | |
double | getOperatingRangeLowTemperature () |
This method returns the low temperature of the thermochron's operating temperature range. | |
double | getOperatingRangeHighTemperature () |
This method returns the high temperature of the thermochron's operating temperature range. | |
double | getTemperatureResolution () |
Retrieves the resolution with which the thermochron takes temperatures in degrees Celsius. | |
double | getHistogramLowTemperature () |
Retrieves the lowest temperature of the first histogram bin in degrees Celsius. | |
double | getHistogramBinWidth () |
This method returns the width of a histogram bin in degrees Celsius. | |
double | decodeTemperature (byte tempByte) |
Converts a temperature from the DS1921 byte encoded format to degrees Celsius. | |
byte | encodeTemperature (double temperature) |
Converts a temperature in degrees Celsius to a byte formatted for the DS1921. | |
void | writeByte (int memAddr, byte source) throws OneWireIOException, OneWireException |
Writes a byte of data into the DS1921's memory. | |
byte | readByte (int memAddr) throws OneWireIOException, OneWireException |
Reads a single byte from the DS1921. | |
boolean | getFlag (int register, byte bitMask) throws OneWireIOException, OneWireException |
boolean | getFlag (int register, byte bitMask, byte[] state) |
void | setFlag (int register, byte bitMask, boolean flagValue) throws OneWireIOException, OneWireException |
void | setFlag (int register, byte bitMask, boolean flagValue, byte[] state) |
void | enableMission (int sampleRate) throws OneWireIOException, OneWireException |
void | disableMission () throws OneWireIOException, OneWireException |
Ends this DS1921's running mission. | |
void | setMissionStartDelay (int missionStartDelay, byte[] state) |
void | clearMemory () throws OneWireIOException, OneWireException |
Calendar | getAlarmTime (byte[] state) |
void | setClockAlarm (int hours, int minutes, int seconds, int day, int alarmFrequency, byte[] state) |
Set the DS1921's alarm clock. | |
int | getSampleRate (byte[] state) |
Returns the rate at which the DS1921 takes temperature samples. | |
int | getMissionSamplesCounter (byte[] state) |
Determines the number of samples taken on this mission. | |
int | getDeviceSamplesCounter (byte[] state) |
Calendar | getMissionTimeStamp (byte[] state) |
Returns the date and time that the last mission was started. | |
long | getFirstLogOffset (byte[] state) |
synchronized byte[] | getTemperatureLog (byte[] state) throws OneWireIOException, OneWireException |
int[] | getTemperatureHistogram () throws OneWireIOException, OneWireException |
boolean | getAlarmStatus (byte alarmBit, byte[] state) |
Returns true if the specified alarm has been triggered. | |
byte[] | getAlarmHistory (byte alarmBit) throws OneWireIOException, OneWireException |
byte[] | readDevice () throws OneWireIOException, OneWireException |
Retrieves the 1-Wire device sensor state. | |
void | writeDevice (byte[] state) throws OneWireIOException, OneWireException |
Writes the 1-Wire device sensor state that have been changed by 'set' methods. | |
boolean | hasTemperatureAlarms () |
Checks to see if this temperature measuring device has high/low trip alarms. | |
boolean | hasSelectableTemperatureResolution () |
Checks to see if this device has selectable temperature resolution. | |
double[] | getTemperatureResolutions () |
Get an array of available temperature resolutions in Celsius. | |
double | getTemperatureAlarmResolution () |
Gets the temperature alarm resolution in Celsius. | |
double | getMaxTemperature () |
Gets the maximum temperature in Celsius. | |
double | getMinTemperature () |
Gets the minimum temperature in Celsius. | |
void | doTemperatureConvert (byte[] state) throws OneWireIOException, OneWireException |
Performs a temperature conversion. | |
double | getTemperature (byte[] state) |
Gets the temperature value in Celsius from the state data retrieved from the readDevice() method. | |
double | getTemperatureAlarm (int alarmType, byte[] state) |
Gets the specified temperature alarm value in Celsius from the state data retrieved from the readDevice() method. | |
double | getTemperatureResolution (byte[] state) |
Gets the current temperature resolution in Celsius from the state data retrieved from the readDevice() method. | |
void | setTemperatureAlarm (int alarmType, double alarmValue, byte[] state) |
Sets the temperature alarm value in Celsius in the provided state data. | |
void | setTemperatureResolution (double resolution, byte[] state) throws OneWireException |
Sets the current temperature resolution in Celsius in the provided state data. | |
boolean | hasClockAlarm () |
Checks to see if the clock has an alarm feature. | |
boolean | canDisableClock () |
Checks to see if the clock can be disabled. | |
long | getClockResolution () |
Gets the clock resolution in milliseconds. | |
long | getClock (byte[] state) |
Extracts the Real-Time clock value in milliseconds. | |
long | getClockAlarm (byte[] state) |
Extracts the clock alarm value for the Real-Time clock. | |
boolean | isClockAlarming (byte[] state) |
Checks if the clock alarm flag has been set. | |
boolean | isClockAlarmEnabled (byte[] state) |
Checks if the clock alarm is enabled. | |
boolean | isClockRunning (byte[] state) |
Checks if the device's oscillator is enabled. | |
void | setClock (long time, byte[] state) |
Sets the Real-Time clock. | |
void | setClockAlarm (long time, byte[] state) throws OneWireException |
Sets the clock alarm. | |
void | setClockRunEnable (boolean runEnable, byte[] state) |
Enables or disables the oscillator, turning the clock 'on' and 'off'. | |
void | setClockAlarmEnable (boolean alarmEnable, byte[] state) |
Enables or disables the clock alarm. | |
Static Public Attributes | |
static final int | STATUS_REGISTER = 0x214 |
Address of the status register. | |
static final int | CONTROL_REGISTER = 0x20E |
Address of the control register. | |
static final byte | ONCE_PER_SECOND = ( byte ) 0x1F |
Alarm frequency setting for the setClockAlarm() method. | |
static final byte | ONCE_PER_MINUTE = ( byte ) 0x17 |
Alarm frequency setting for the setClockAlarm() method. | |
static final byte | ONCE_PER_HOUR = ( byte ) 0x13 |
Alarm frequency setting for the setClockAlarm() method. | |
static final byte | ONCE_PER_DAY = ( byte ) 0x11 |
Alarm frequency setting for the setClockAlarm() method. | |
static final byte | ONCE_PER_WEEK = ( byte ) 0x10 |
Alarm frequency setting for the setClockAlarm() method. | |
static final byte | TEMPERATURE_LOW_ALARM = 4 |
Low temperature alarm value for the methods getAlarmStatus() , getAlarmHistory() , and setTemperatureAlarm() . | |
static final byte | TEMPERATURE_HIGH_ALARM = 2 |
High temperature alarm value for the methods getAlarmStatus() , getAlarmHistory() , and setTemperatureAlarm() . | |
static final byte | TIMER_ALARM = 1 |
Clock alarm value for the methods getAlarmStatus() and isClockAlarming() . | |
static final byte | TIMER_ALARM_SEARCH_FLAG = 1 |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if a timer alarm has occurred. | |
static final byte | TEMP_HIGH_SEARCH_FLAG = 2 |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if the temperature has reached the high temperature threshold. | |
static final byte | TEMP_LOW_SEARCH_FLAG = 4 |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if the temperature has reached the low temperature threshold. | |
static final byte | ROLLOVER_ENABLE_FLAG = 8 |
CONTROL REGISTER FLAG: When enabled, the device will begin overwriting the earlier temperature measurements when the temperature log memory becomes full. | |
static final byte | MISSION_ENABLE_FLAG = 16 |
CONTROL REGISTER FLAG: When DISABLED, the mission will start as soon as the sample rate is written. | |
static final byte | MEMORY_CLEAR_ENABLE_FLAG = 64 |
CONTROL REGISTER FLAG: Must be enabled to allow a clear memory function. | |
static final byte | OSCILLATOR_ENABLE_FLAG = ( byte ) 128 |
CONTROL REGISTER FLAG: When DISABLED, the real time clock will start working. | |
static final byte | TIMER_ALARM_FLAG = 1 |
STATUS REGISTER FLAG: Will read back true when a clock alarm has occurred. | |
static final byte | TEMPERATURE_HIGH_FLAG = 2 |
STATUS REGISTER FLAG: Will read back true when the temperature during a mission reaches or exceeds the temperature high threshold. | |
static final byte | TEMPERATURE_LOW_FLAG = 4 |
STATUS REGISTER FLAG: Will read back true when a temperature equal to or below the low temperature threshold was detected on a mission. | |
static final byte | SAMPLE_IN_PROGRESS_FLAG = 16 |
STATUS REGISTER FLAG: Will read back true when a mission temperature conversion is in progress. | |
static final byte | MISSION_IN_PROGRESS_FLAG = 32 |
STATUS REGISTER FLAG: Will read back true when a mission is in progress. | |
static final byte | MEMORY_CLEARED_FLAG = 64 |
STATUS REGISTER FLAG: Will read back true if the memory has been cleared. | |
static final byte | TEMP_CORE_BUSY_FLAG = ( byte ) 128 |
STATUS REGISTER FLAG: Will read back true if a temperature conversion of any kind is in progress. |
1-Wire® container for a Thermochron iButton, DS1921. This container encapsulates the functionality of the 1-Wire family type 21 (hex).
The memory can be accessed through the objects that are returned from the getMemoryBanks method.
The following is a list of the MemoryBank instances that are returned:
The code below starts a mission with the following characteristics:
This code also ensures that the Thermocron's clock is set to run, and that the clock alarm is enabled.
// "ID" is a byte array of size 8 with an address of a part we
// have already found with family code 12 hex
// "access" is a DSPortAdapter
OneWireContainer21 ds1921 = (OneWireContainer21) access.getDeviceContainer(ID);
ds1921.setupContainer(access,ID);
// ds1921 previously setup as a OneWireContainer21
ds1921.clearMemory();
// read the current state of the device
byte[] state = ds1921.readDevice();
// enable rollover
ds1921.setFlag(ds1921.CONTROL_REGISTER, ds1921.ROLLOVER_ENABLE_FLAG, true, state);
// set the high temperature alarm to 28 C
ds1921.setTemperatureAlarm(ds1921.ALARM_HIGH, 28.0, state);
// set the low temperature alarm to 23 C
ds1921.setTemperatureAlarm(ds1921.ALARM_LOW, 23.0, state);
// set the clock alarm to occur weekly, Mondays at 12:30:45 pm
ds1921.setClockAlarm(12, 30, 45, 2, ds1921.ONCE_PER_WEEK, state);
// set the real time clock to the system's current clock
ds1921.setClock(System.currentTimeMillis(), state);
// set the mission to start in 2 minutes
ds1921.setMissionStartDelay(2,state);
// make sure the clock is set to run
ds1921.setClockRunEnable(true, state);
// make sure the clock alarm is enabled
ds1921.setClockAlarmEnable(true, state);
// write all that information out
ds1921.writeDevice(state);
// now enable the mission with a sample rate of 1 minute
ds1921.enableMission(1);
The following code processes the temperature log:
byte[] state = ds1921.readDevice(); byte[] log = ds1921.getTemperatureLog(state); Calendar time_stamp = ds1921.getMissionTimeStamp(state); long time = time_stamp.getTime().getTime() + ds1921.getFirstLogOffset(state); int sample_rate = ds1921.getSampleRate(state);
System.out.println("TEMPERATURE LOG");
for (int i=0;i < log.length;i++) { System.out.println("- Temperature recorded at : "+(new Date(time))); System.out.println("- was : "+ds1921.decodeTemperature(log[i])+" C"); time += sample_rate * 60 * 1000; }
The following code processes the alarm histories:
byte[] high_history = ds1921.getAlarmHistory(ds1921.TEMPERATURE_HIGH_ALARM); byte[] low_history = ds1921.getAlarmHistory(ds1921.TEMPERATURE_LOW_ALARM); int sample_rate = ds1921.getSampleRate(state); int start_offset, violation_count; System.out.println("ALARM HISTORY"); if (low_history.length==0) { System.out.println("- No violations against the low temperature alarm."); System.out.println("-"); } for (int i=0;i < low_history.length/4; i++) { start_offset = (low_history [i * 4] & 0x0ff) | ((low_history [i * 4 + 1] << 8) & 0x0ff00) | ((low_history [i * 4 + 2] << 16) & 0x0ff0000); violation_count = 0x0ff & low_history[i*4+3]; System.out.println("- Low alarm started at : "+(start_offset * sample_rate)); System.out.println("- : Lasted "+(violation_count * sample_rate)+" minutes"); } if (high_history.length==0) { System.out.println("- No violations against the high temperature alarm."); System.out.println("-"); } for (int i=0;i < high_history.length/4; i++) { start_offset = (high_history [i * 4] & 0x0ff) | ((high_history [i * 4 + 1] << 8) & 0x0ff00) | ((high_history [i * 4 + 2] << 16) & 0x0ff0000); violation_count = 0x0ff & high_history[i*4+3]; System.out.println("- High alarm started at : "+(start_offset * sample_rate)); System.out.println("- : Lasted "+(violation_count * sample_rate)+" minutes"); }
The following code processes the temperature histogram:
double resolution = ds1921.getTemperatureResolution(); double histBinWidth = ds1921.getHistogramBinWidth(); double start = ds1921.getHistogramLowTemperature(); System.out.println("TEMPERATURE HISTOGRAM"); for (int i=0;i < histogram.length;i++) { System.out.println("- Histogram entry : " + histogram [i] + " at temperature " + start + " to " + ( start + (histBinWidth - resolution)) + " C"); start += histBinWidth; }
Also see the usage examples in the TemperatureContainer and ClockContainer interfaces.
For examples regarding memory operations,
http://pdfserv.maxim-ic.com/arpdf/DS1921L-F5X.pdf
Also visit http://www.ibutton.com/ibuttons/thermochron.html for links to more sources on the DS1921 Thermocron.
Creates a new OneWireContainer
for communication with a DS1921 Thermocron iButton.
Note that the method setupContainer(DSPortAdapter,byte[])
must be called to set the correct DSPortAdapter
device address.
OneWireContainer21 | ( | DSPortAdapter | sourceAdapter, |
byte[] | newAddress | ||
) |
Creates a new OneWireContainer
for communication with a DS1921 Thermocron iButton.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this DS1921 |
OneWireContainer21 | ( | DSPortAdapter | sourceAdapter, |
long | newAddress | ||
) |
Creates a new OneWireContainer
for communication with a DS1921 Thermocron iButton.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this DS1921 |
OneWireContainer21 | ( | DSPortAdapter | sourceAdapter, |
String | newAddress | ||
) |
Creates a new OneWireContainer
for communication with a DS1921 Thermocron iButton.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this DS1921 |
boolean canDisableClock | ( | ) |
Checks to see if the clock can be disabled.
Implements ClockContainer.
void clearMemory | ( | ) | throws OneWireIOException, OneWireException |
Clears the memory of any previous mission. The memory must be cleared before setting up a new mission. If a mission is in progress a OneWireIOException
is thrown.
The Clear Memory command clears the Thermocron's memory at address 220h and higher. It also clears the sample rate, mission start delay, mission time stamp, and mission samples counter.
Note that this method actually communicates with the DS1921 Thermocron. No call to writeDevice(byte[])
is necessary to finalize this activity.
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. In the case of the DS1921 Thermocron, this could also be due to a currently running mission. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
double decodeTemperature | ( | byte | tempByte | ) |
Converts a temperature from the DS1921 byte
encoded format to degrees Celsius.
The raw temperature readings are unsigned byte
values, representing a 2.0 degree accuracy.
tempByte | raw DS1921 temperature reading |
void disableMission | ( | ) | throws OneWireIOException, OneWireException |
Ends this DS1921's running mission.
Note that this method actually communicates with the DS1921 Thermocron. No additional call to writeDevice(byte[])
is required.
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
void doTemperatureConvert | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Performs a temperature conversion.
Use the state
information to calculate the conversion time.
state | byte array with device state information |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. In the case of the DS1921 Thermocron, this could also be due to a currently running mission. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
Implements TemperatureContainer.
void enableMission | ( | int | sampleRate | ) | throws OneWireIOException, OneWireException |
Begins this DS1921's mission. If a mission is already in progress, this will throw a OneWireIOException
. The mission will wait the number of minutes specified by the mission start delay (use setMissionStartDelay()
) before beginning.
Note that this method actually communicates with the DS1921 Thermocron. No call to writeDevice()
is required to finalize mission enabling. However, some flags (such as the mission start delay) may need to be set with a call to writeDevice()
before the mission is enabled. See the usage section above for an example of starting a mission.
sampleRate | the number of minutes to wait in between temperature samples (valid values are 1 to 255) |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. In the case of the DS1921 Thermocron, this could also be due to a currently running mission. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
byte encodeTemperature | ( | double | temperature | ) |
Converts a temperature in degrees Celsius to a byte
formatted for the DS1921.
temperature | the temperature (Celsius) to convert |
byte [] getAlarmHistory | ( | byte | alarmBit | ) | throws OneWireIOException, OneWireException |
Returns an array containing the alarm log. The DS1921 contains two separate alarm logs. One for the high temperature alarm and one for the low temperature alarm. Each log can store up to 12 log entries and each log entry will record up to 255 consecutive alarm violations.
The returned array is not altered from its representation on the DS1921 Thermocron. It is therefore up to the caller to interpret the data. The number of logs in this alarm history is equal to the array length divided by 4, since each entry is 4 bytes. The first three bytes are the number of samples into the mission that the alarm occurred. The fourth byte is the number of consecutive samples that violated the alarm. To extract the starting offset and number of violations from the array:
byte[] data = ds1921.getAlarmHistory(OneWireContainer21.TEMPERATURE_HIGH_ALARM); int start_offset; int violation_count; . . . for (int i=0;i < data.length/4; i++) { start_offset = (data [i * 4] & 0x0ff) | ((data [i * 4 + 1] << 8) & 0x0ff00) | ((data [i * 4 + 2] << 16) & 0x0ff0000); violation_count = 0x0ff & data[i*4+3];
. . .
// note: you may find it useful to multiply start_offset // by getSampleRate() in order to get the number of // minutes into the mission that the violation occurred // on. You can do the same with violation_count // to determine how long the violation lasted. }
Acceptable values for the alarmBit
parameter are:
TEMPERATURE_LOW_ALARM
TEMPERATURE_HIGH_ALARM
alarmBit | the alarm log to get |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
boolean getAlarmStatus | ( | byte | alarmBit, |
byte[] | state | ||
) |
Returns true
if the specified alarm has been triggered.
Valid values for the alarmBit
parameter are:
TEMPERATURE_LOW_ALARM TEMPERATURE_HIGH_ALARM TIMER_ALARM
alarmBit | the alarm to check |
state | current state of the device returned from readDevice() |
Calendar getAlarmTime | ( | byte[] | state | ) |
Gets the clock alarm time settings. The alarm settings used by the Thermocron are Hour, Minute, Second, and Day of Week. Note that not all values in the returned java.util.Calendar
object are valid. Only four values in the Calendar
should be used. The field names for these values are:
Calendar.DAY_OF_MONTH
Calendar.HOUR_OF_DAY
Calendar.MINUTE
Calendar.SECOND
The hour is reported in 24-hour format. Use the method getClockAlarm(byte[])
to find out the next time an alarm event will occur.
state | current state of the device returned from readDevice() |
String getAlternateNames | ( | ) |
Retrieves the alternate Maxim Integrated Products 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".
Reimplemented from OneWireContainer.
long getClock | ( | byte[] | state | ) |
Extracts the Real-Time clock value in milliseconds.
state | current state of the device returned from readDevice() |
Implements ClockContainer.
long getClockAlarm | ( | byte[] | state | ) |
Extracts the clock alarm value for the Real-Time clock.
In the case of the DS1921 Thermocron, this is the time that the next periodic alarm event will occur.
state | current state of the device returned from readDevice() |
Implements ClockContainer.
long getClockResolution | ( | ) |
Gets the clock resolution in milliseconds.
Implements ClockContainer.
String getDescription | ( | ) |
Gets a short description of the function of this iButton or 1-Wire Device type.
Reimplemented from OneWireContainer.
int getDeviceSamplesCounter | ( | byte[] | state | ) |
Determines the total number of samples taken by this Thermocron. This includes samples taken in past missions. It also includes 'forced' readings. A 'forced' reading refers to a reading taken when the Thermocron does not have a running mission and is instructed to read the current temperature.
The DS1921 Thermocron is tested to last for 1 million temperature readings.
state | current state of the device returned from readDevice() |
long getFirstLogOffset | ( | byte[] | state | ) |
Helps determine the times for values in a temperature log. If rollover is enabled, temperature log entries will over-write previous entries once more than 2048 logs are written. The returned value can be added to the underlying millisecond value of getMissionTimeStamp()
to determine the time that the 'first' log entry actually occurred.
//ds1921 is a OneWireContainer21
byte[] state = ds1921.readDevice();
Calendar c = ds1921.getMissionTimeStamp(state);
//find the time for the first log entry
long first_entry = c.getTime().getTime();
first_entry += ds1921.getFirstLogOffset(state);
. . .
Be cautious of Java's Daylight Savings Time offsets when using this function--if you use the Date
or Calendar
class to print this out, Java may try to automatically format the java.lang.String
to handle Daylight Savings Time, resulting in offset by 1 hour problems.
state | current state of the device returned from readDevice() |
getTemperatureLog()
boolean getFlag | ( | int | register, |
byte | bitMask | ||
) | throws OneWireIOException, OneWireException |
Gets the status of the specified flag from the specified register. This method actually communicates with the Thermocron. To improve performance if you intend to make multiple calls to this method, first call readDevice()
and use the getFlag(int, byte, byte[])
method instead.
The DS1921 Thermocron has two sets of flags. One set belongs to the control register. When reading from the control register, valid values for bitMask
are:
TIMER_ALARM_SEARCH_FLAG
TEMP_HIGH_SEARCH_FLAG
TEMP_LOW_SEARCH_FLAG
ROLLOVER_ENABLE_FLAG
MISSION_ENABLE_FLAG
MEMORY_CLEAR_ENABLE_FLAG
OSCILLATOR_ENABLE_FLAG
When reading from the status register, valid values for bitMask
are:
TIMER_ALARM_FLAG
TEMPERATURE_HIGH_FLAG
TEMPERATURE_LOW_FLAG
SAMPLE_IN_PROGRESS_FLAG
MISSION_IN_PROGRESS_FLAG
MEMORY_CLEARED_FLAG
TEMP_CORE_BUSY_FLAG
register | address of register containing the flag (valid values are CONTROL_REGISTER and STATUS_REGISTER ) |
bitMask | the flag to read (see above for available options) |
true
signifies a "1" and false
signifies a "0"OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
boolean getFlag | ( | int | register, |
byte | bitMask, | ||
byte[] | state | ||
) |
Gets the status of the specified flag from the specified register. This method is the preferred manner of reading the control and status flags.
For more information on valid values for the bitMask
parameter, see the getFlag(int,byte) method.
register | address of register containing the flag (valid values are CONTROL_REGISTER and STATUS_REGISTER ) |
bitMask | the flag to read (see getFlag(int,byte) for available options) |
state | current state of the device returned from readDevice() |
true
signifies a "1" and false
signifies a "0"double getHistogramBinWidth | ( | ) |
This method returns the width of a histogram bin in degrees Celsius.
double getHistogramLowTemperature | ( | ) |
Retrieves the lowest temperature of the first histogram bin in degrees Celsius.
int getMaxSpeed | ( | ) |
Returns the maximum speed this iButton device can communicate at.
Reimplemented from OneWireContainer.
double getMaxTemperature | ( | ) |
Gets the maximum temperature in Celsius.
Implements TemperatureContainer.
Enumeration getMemoryBanks | ( | ) |
Gets an enumeration of memory bank instances that implement one or more of the following interfaces: MemoryBank, PagedMemoryBank, and OTPMemoryBank.
Enumeration
of memory banks Reimplemented from OneWireContainer.
double getMinTemperature | ( | ) |
Gets the minimum temperature in Celsius.
Implements TemperatureContainer.
int getMissionSamplesCounter | ( | byte[] | state | ) |
Determines the number of samples taken on this mission.
Only the last 2048 samples appear in the Thermocron's log, though all readings from the current mission are logged in the histogram.
state | current state of the device returned from readDevice() |
Calendar getMissionTimeStamp | ( | byte[] | state | ) |
Returns the date and time that the last mission was started.
The values in the java.util.Calendar
object are fully specified. In other words, the year, month, date, hour, minute, and second are all valid in the returned object.
state | current state of the device returned from readDevice() |
String getName | ( | ) |
Gets the Maxim Integrated Products part number of the iButton or 1-Wire Device as a java.lang.String
.
For example "DS1992".
Reimplemented from OneWireContainer.
double getOperatingRangeHighTemperature | ( | ) |
This method returns the high temperature of the thermochron's operating temperature range.
The operating range is the range of temperatures for which the thermochron can function properly.
The following is a list of operating ranges in degrees Celsius:
DS1921L-F50 = operating range -40 to +85. DS1921L-F51 = operating range -10 to +85. DS1921L-F52 = operating range -20 to +85. DS1921L-F53 = operating range -30 to +85.
DS1921H = operating range -40 to +85 DS1921Z = operating range -40 to +85
double getOperatingRangeLowTemperature | ( | ) |
This method returns the low temperature of the thermochron's operating temperature range.
The operating range is the range of temperatures for which the thermochron can function properly.
The following is a list of operating ranges in degrees Celsius:
DS1921L-F50 = operating range -40 to +85. DS1921L-F51 = operating range -10 to +85. DS1921L-F52 = operating range -20 to +85. DS1921L-F53 = operating range -30 to +85.
DS1921H = operating range -40 to +85 DS1921Z = operating range -40 to +85
double getPhysicalRangeHighTemperature | ( | ) |
This method returns the high temperature of the thermochron's physical temperature range.
The physical range is the range of temperatures that the thermochron can record.
The following is a list of physical ranges in degrees Celsius:
DS1921L-F5X = physical range -40 to +85
DS1921H = physical range 15 to 46
DS1921Z = physical range -5 to 26
double getPhysicalRangeLowTemperature | ( | ) |
This method returns the low temperature of the thermochron's physical temperature range.
The physical range is the range of temperatures that the thermochron can record.
The following is a list of physical ranges in degrees Celsius:
DS1921L-F5X = physical range -40 to +85
DS1921H = physical range 15 to 46
DS1921Z = physical range -5 to 26
int getSampleRate | ( | byte[] | state | ) |
Returns the rate at which the DS1921 takes temperature samples.
This rate is set when the mission is enabled (in the method enableMission(int)
.
state | current state of the device returned from readDevice() |
double getTemperature | ( | byte[] | state | ) |
Gets the temperature value in Celsius from the state
data retrieved from the readDevice()
method.
state | byte array with device state information |
doTemperatureConvert()
Implements TemperatureContainer.
double getTemperatureAlarm | ( | int | alarmType, |
byte[] | state | ||
) |
Gets the specified temperature alarm value in Celsius from the state
data retrieved from the readDevice()
method.
alarmType | valid value: ALARM_HIGH or ALARM_LOW |
state | byte array with device state information |
Implements TemperatureContainer.
double getTemperatureAlarmResolution | ( | ) |
Gets the temperature alarm resolution in Celsius.
Implements TemperatureContainer.
int [] getTemperatureHistogram | ( | ) | throws OneWireIOException, OneWireException |
Returns an array of at most 64 counter bins holding the DS1921 histogram data (63 bins for the DS1921L-F5X and 64 bins for the DS1921H or DS1921Z). For the temperature histogram, the DS1921 provides bins that each consist of a 16-bit, non rolling-over binary counter that is incremented each time a temperature value acquired during a mission falls into the range of the bin. The bin to be updated is determined by cutting off the two least significant bits of the binary temperature value. For example, on a DS1921L-F5X, bin 0 will hold the counter for temperatures ranging from -40 to -38.5 (Celsius) and lower. Bin 1 is associated with the range of -38 to 36.5 and so on. The last bin, in this case bin 62, holds temperature values of 84 degrees and higher. Please see the respective DS1921H or DS1921Z datasheets for their bin arrangements. The temperature histogram can be read while a mission is still in progress.
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
synchronized byte [] getTemperatureLog | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Returns the log of temperature measurements. Each byte
in the returned array is an independent sample. Use the method decodeTemperature(byte)
to get the double value of the encoded temperature. See the DS1921 datasheet for more on the data's encoding scheme. The array's length equals the number of measurements taken thus far. The temperature log can be read while a mission is still in progress.
Note that although this method takes the device state as a parameter, this method still must communicate directly with the Thermocron to read the log.
state | current state of the device returned from readDevice() |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
double getTemperatureResolution | ( | byte[] | state | ) |
Gets the current temperature resolution in Celsius from the state
data retrieved from the readDevice()
method.
state | byte array with device state information |
Implements TemperatureContainer.
double getTemperatureResolution | ( | ) |
Retrieves the resolution with which the thermochron takes temperatures in degrees Celsius.
double [] getTemperatureResolutions | ( | ) |
Get an array of available temperature resolutions in Celsius.
Implements TemperatureContainer.
boolean hasClockAlarm | ( | ) |
Checks to see if the clock has an alarm feature.
Implements ClockContainer.
boolean hasSelectableTemperatureResolution | ( | ) |
Checks to see if this device has selectable temperature resolution.
true
if this TemperatureContainer
has selectable temperature resolutionImplements TemperatureContainer.
boolean hasTemperatureAlarms | ( | ) |
Checks to see if this temperature measuring device has high/low trip alarms.
true
if this TemperatureContainer
has high/low trip alarmsImplements TemperatureContainer.
boolean isClockAlarmEnabled | ( | byte[] | state | ) |
Checks if the clock alarm is enabled.
state | current state of the device returned from readDevice() |
Implements ClockContainer.
boolean isClockAlarming | ( | byte[] | state | ) |
Checks if the clock alarm flag has been set.
This will occur when the value of the Real-Time clock equals the value of the clock alarm.
state | current state of the device returned from readDevice() |
Implements ClockContainer.
boolean isClockRunning | ( | byte[] | state | ) |
Checks if the device's oscillator is enabled.
The clock will not increment if the clock oscillator is not enabled.
state | current state of the device returned from readDevice() |
Implements ClockContainer.
byte readByte | ( | int | memAddr | ) | throws OneWireIOException, OneWireException |
Reads a single byte from the DS1921.
Note that the preferred manner of reading from the DS1921 Thermocron is through the readDevice()
method or through the MemoryBank
objects returned in the getMemoryBanks()
method.
memAddr | the address to read from (in the range of 0x200-0x21F) |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
byte [] readDevice | ( | ) | throws OneWireIOException, OneWireException |
Retrieves the 1-Wire device sensor state.
This state is returned as a byte array. Pass this byte array to the 'get' and 'set' methods. If the device state needs to be changed then call the 'writeDevice' to finalize the changes.
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
Implements OneWireSensor.
void setClock | ( | long | time, |
byte[] | state | ||
) |
Sets the Real-Time clock.
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
.
time | new value for the Real-Time clock, in milliseconds since January 1, 1970 |
state | current state of the device returned from readDevice() |
Implements ClockContainer.
void setClockAlarm | ( | long | time, |
byte[] | state | ||
) | throws OneWireException |
Sets the clock alarm.
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
. Also note that not all clock devices have alarms. Check to see if this device has alarms first by calling the hasClockAlarm()
method.
time | - new value for the Real-Time clock alarm, in milliseconds since January 1, 1970 |
state | current state of the device returned from readDevice() |
OneWireException | if this device does not have clock alarms |
Implements ClockContainer.
void setClockAlarm | ( | int | hours, |
int | minutes, | ||
int | seconds, | ||
int | day, | ||
int | alarmFrequency, | ||
byte[] | state | ||
) |
Set the DS1921's alarm clock.
Some of the parameters might be unimportant depending on the alarm frequency setting. For instance, if the alarm frequency setting is ONCE_PER_MINUTE
, then the hour
argument is irrelevant.
Valid values for alarmFrequency
are:
ONCE_PER_SECOND
ONCE_PER_MINUTE
ONCE_PER_HOUR
ONCE_PER_DAY
ONCE_PER_WEEK
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
.
hours | the hour of the day (0-23) |
minutes | the minute setting (0-59) |
seconds | the second setting (0-59) |
day | the day of the week (1-7, 1==Sunday) |
alarmFrequency | frequency that the alarm should occur at |
state | current state of the device returned from readDevice() |
void setClockAlarmEnable | ( | boolean | alarmEnable, |
byte[] | state | ||
) |
Enables or disables the clock alarm.
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
. Also note that not all clock devices have alarms. Check to see if this device has alarms first by calling the hasClockAlarm()
method.
alarmEnable | true to enable the clock alarm |
state | current state of the device returned from readDevice() |
Implements ClockContainer.
void setClockRunEnable | ( | boolean | runEnable, |
byte[] | state | ||
) |
Enables or disables the oscillator, turning the clock 'on' and 'off'.
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
. Also note that not all clock devices can disable their oscillators. Check to see if this device can disable its oscillator first by calling the canDisableClock()
method.
runEnable | true to enable the clock oscillator |
state | current state of the device returned from readDevice() |
Implements ClockContainer.
void setFlag | ( | int | register, |
byte | bitMask, | ||
boolean | flagValue | ||
) | throws OneWireIOException, OneWireException |
Sets the status of the specified flag in the specified register. If a mission is in progress a OneWireIOException
will be thrown (one cannot write to the registers while a mission is commencing). This method actually communicates with the DS1921 Thermocron. To improve performance if you intend to make multiple calls to this method, first call readDevice()
and use the setFlag(int,byte,boolean,byte[])
method instead.
For more information on valid values for the bitMask
parameter, see the getFlag(int,byte) method.
register | address of register containing the flag (valid values are CONTROL_REGISTER and STATUS_REGISTER ) |
bitMask | the flag to read (see getFlag(int,byte) for available options) |
flagValue | new value for the flag (true is logic "1") |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. In the case of the DS1921 Thermocron, this could also be due to a currently running mission. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
void setFlag | ( | int | register, |
byte | bitMask, | ||
boolean | flagValue, | ||
byte[] | state | ||
) |
Sets the status of the specified flag in the specified register. If a mission is in progress a OneWireIOException
will be thrown (one cannot write to the registers while a mission is commencing). This method is the preferred manner of setting the DS1921 status and control flags. The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
.
For more information on valid values for the bitMask
parameter, see the getFlag(int,byte) method.
register | address of register containing the flag (valid values are CONTROL_REGISTER and STATUS_REGISTER ) |
bitMask | the flag to read (see getFlag(int,byte) for available options) |
flagValue | new value for the flag (true is logic "1") |
state | current state of the device returned from readDevice() |
void setMissionStartDelay | ( | int | missionStartDelay, |
byte[] | state | ||
) |
Sets the time to wait before starting the mission. The DS1921 will sleep missionStartDelay
minutes after the mission is enabled with enableMission(int)
, then begin taking samples. Only the least significant 16 bits of missionStartDelay
are relevant.
The method writeDevice()
must be called to finalize changes to the device. Note that multiple 'set' methods can be called before one call to writeDevice()
.
missionStartDelay | the time in minutes to delay the first sample |
state | current state of the device returned from readDevice() |
synchronized void setSpeedCheck | ( | boolean | doSpeedCheck | ) |
Directs the container to avoid the calls to doSpeed() in methods that communicate with the Thermocron.
To ensure that all parts can talk to the 1-Wire bus at their desired speed, each method contains a call to doSpeed()
. However, this is an expensive operation. If a user manages the bus speed in an application, call this method with doSpeedCheck
as false
. The default behavior is to call doSpeed()
.
doSpeedCheck | true for doSpeed() to be called before every 1-Wire bus access, false to skip this expensive call |
void setTemperatureAlarm | ( | int | alarmType, |
double | alarmValue, | ||
byte[] | state | ||
) |
Sets the temperature alarm value in Celsius in the provided state
data.
Use the method writeDevice()
with this data to finalize the change to the device.
alarmType | valid value: ALARM_HIGH or ALARM_LOW |
alarmValue | alarm trip value in Celsius |
state | byte array with device state information |
Implements TemperatureContainer.
void setTemperatureResolution | ( | double | resolution, |
byte[] | state | ||
) | throws OneWireException |
Sets the current temperature resolution in Celsius in the provided state
data.
Use the method writeDevice()
with this data to finalize the change to the device.
resolution | temperature resolution in Celsius |
state | byte array with device state information |
OneWireException | if the device does not support selectable temperature resolution |
Implements TemperatureContainer.
void setupContainer | ( | DSPortAdapter | sourceAdapter, |
long | newAddress | ||
) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this 1-Wire device |
Reimplemented from OneWireContainer.
void setupContainer | ( | DSPortAdapter | sourceAdapter, |
java.lang.String | newAddress | ||
) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this 1-Wire device |
void setupContainer | ( | DSPortAdapter | sourceAdapter, |
byte[] | newAddress | ||
) |
Provides this container with the adapter object used to access this device and the address of the iButton or 1-Wire device.
sourceAdapter | adapter object required to communicate with this iButton |
newAddress | address of this 1-Wire device |
Reimplemented from OneWireContainer.
void writeByte | ( | int | memAddr, |
byte | source | ||
) | throws OneWireIOException, OneWireException |
Writes a byte of data into the DS1921's memory.
Note that writing to the register page while a mission is in progress ends that mission. Also note that the preferred way to write a page is through the MemoryBank
objects returned from the getMemoryBanks()
method.
memAddr | the address for writing (in the range of 0x200-0x21F) |
source | the data byte to write |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
void writeDevice | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Writes the 1-Wire device sensor state that have been changed by 'set' methods.
Only the state registers that changed are updated. This is done by referencing a field information appended to the state data.
state | 1-Wire device sensor state |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'. |
OneWireException | on a communication or setup error with the 1-Wire adapter |
Implements OneWireSensor.
final int CONTROL_REGISTER = 0x20E [static] |
Address of the control register.
Used with the getFlag
and setFlag
methods to set and check flags indicating the Thermochron's status.
final byte MEMORY_CLEAR_ENABLE_FLAG = 64 [static] |
CONTROL REGISTER FLAG: Must be enabled to allow a clear memory function.
Must be set immediately before the command is issued.
final byte MEMORY_CLEARED_FLAG = 64 [static] |
STATUS REGISTER FLAG: Will read back true if the memory has been cleared.
final byte MISSION_ENABLE_FLAG = 16 [static] |
CONTROL REGISTER FLAG: When DISABLED, the mission will start as soon as the sample rate is written.
final byte MISSION_IN_PROGRESS_FLAG = 32 [static] |
STATUS REGISTER FLAG: Will read back true when a mission is in progress.
final byte ONCE_PER_DAY = ( byte ) 0x11 [static] |
Alarm frequency setting for the setClockAlarm()
method.
If the DS1921 Thermocron alarm is enabled and is not alarming, it will alarm the next time the Real-Time Clock's 'second', 'minute', and 'hour' values are equal to the Alarm Clock's 'second', 'minute', and 'hour' values.
final byte ONCE_PER_HOUR = ( byte ) 0x13 [static] |
Alarm frequency setting for the setClockAlarm()
method.
If the DS1921 Thermocron alarm is enabled and is not alarming, it will alarm the next time the Real-Time Clock's 'second' and 'minute' values are equal to the Alarm Clock's 'second' and 'minute' values.
final byte ONCE_PER_MINUTE = ( byte ) 0x17 [static] |
Alarm frequency setting for the setClockAlarm()
method.
If the DS1921 Thermocron alarm is enabled and is not alarming, it will alarm the next time the Real-Time Clock's 'second' value is equal to the Alarm Clock's 'second' value.
final byte ONCE_PER_SECOND = ( byte ) 0x1F [static] |
Alarm frequency setting for the setClockAlarm()
method.
If the DS1921 Thermocron alarm is enabled and is not alarming, it will alarm on the next Real-Time Clock second.
final byte ONCE_PER_WEEK = ( byte ) 0x10 [static] |
Alarm frequency setting for the setClockAlarm()
method.
If the DS1921 Thermocron alarm is enabled and is not alarming, it will alarm the next time the Real-Time Clock's 'second', 'minute', 'hour', and 'day of week' values are equal to the Alarm Clock's 'second', 'minute', 'hour', and 'day of week' values
final byte OSCILLATOR_ENABLE_FLAG = ( byte ) 128 [static] |
CONTROL REGISTER FLAG: When DISABLED, the real time clock will start working.
Must be disabled for normal operation.
final byte ROLLOVER_ENABLE_FLAG = 8 [static] |
CONTROL REGISTER FLAG: When enabled, the device will begin overwriting the earlier temperature measurements when the temperature log memory becomes full.
final byte SAMPLE_IN_PROGRESS_FLAG = 16 [static] |
STATUS REGISTER FLAG: Will read back true when a mission temperature conversion is in progress.
final int STATUS_REGISTER = 0x214 [static] |
Address of the status register.
Used with the getFlag
and setFlag
methods to set and check flags indicating the Thermochron's status.
final byte TEMP_CORE_BUSY_FLAG = ( byte ) 128 [static] |
STATUS REGISTER FLAG: Will read back true if a temperature conversion of any kind is in progress.
final byte TEMP_HIGH_SEARCH_FLAG = 2 [static] |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if the temperature has reached the high temperature threshold.
final byte TEMP_LOW_SEARCH_FLAG = 4 [static] |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if the temperature has reached the low temperature threshold.
final byte TEMPERATURE_HIGH_ALARM = 2 [static] |
High temperature alarm value for the methods getAlarmStatus()
, getAlarmHistory()
, and setTemperatureAlarm()
.
final byte TEMPERATURE_HIGH_FLAG = 2 [static] |
STATUS REGISTER FLAG: Will read back true when the temperature during a mission reaches or exceeds the temperature high threshold.
final byte TEMPERATURE_LOW_ALARM = 4 [static] |
Low temperature alarm value for the methods getAlarmStatus()
, getAlarmHistory()
, and setTemperatureAlarm()
.
final byte TEMPERATURE_LOW_FLAG = 4 [static] |
STATUS REGISTER FLAG: Will read back true when a temperature equal to or below the low temperature threshold was detected on a mission.
final byte TIMER_ALARM = 1 [static] |
Clock alarm value for the methods getAlarmStatus()
and isClockAlarming()
.
final byte TIMER_ALARM_FLAG = 1 [static] |
STATUS REGISTER FLAG: Will read back true when a clock alarm has occurred.
final byte TIMER_ALARM_SEARCH_FLAG = 1 [static] |
CONTROL REGISTER FLAG: When enabled, the device will respond to conditional search command if a timer alarm has occurred.