Public Member Functions | |
OneWireContainer10 () | |
Creates an empty OneWireContainer10 . | |
OneWireContainer10 (DSPortAdapter sourceAdapter, byte[] newAddress) | |
Creates a OneWireContainer10 with the provided adapter object and the address of this One-Wire device. | |
OneWireContainer10 (DSPortAdapter sourceAdapter, long newAddress) | |
Creates a OneWireContainer10 with the provided adapter object and the address of this One-Wire device. | |
OneWireContainer10 (DSPortAdapter sourceAdapter, String newAddress) | |
Creates a OneWireContainer10 with the provided adapter object and the address of this One-Wire device. | |
String | getName () |
Retrieves the Maxim Integrated Products part number of this OneWireContainer10 as a String . | |
String | getAlternateNames () |
Retrieves the alternate Maxim Integrated Products part numbers or names. | |
String | getDescription () |
Retrieves a short description of the function of this OneWireContainer10 type. | |
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 () |
Gets 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 on state information. | |
double | getTemperature (byte[] state) throws OneWireIOException |
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) |
Sets the current temperature resolution in Celsius in the provided state data. | |
byte[] | readDevice () throws OneWireIOException, OneWireException |
Retrieves this OneWireContainer10 state information. | |
void | writeDevice (byte[] state) throws OneWireIOException, OneWireException |
Writes to this OneWireContainer10 state information that have been changed by 'set ' methods. | |
Static Public Member Functions | |
static double | convertToFahrenheit (double celsiusTemperature) |
Converts a temperature reading from Celsius to Fahrenheit. | |
static double | convertToCelsius (double fahrenheitTemperature) |
Converts a temperature reading from Fahrenheit to Celsius. | |
Static Public Attributes | |
static final double | RESOLUTION_NORMAL = 0.5 |
default temperature resolution for this OneWireContainer10 device. | |
static final double | RESOLUTION_MAXIMUM = 0.1 |
maximum temperature resolution for this OneWireContainer10 device. |
Creates an empty OneWireContainer10
.
Must call setupContainer()
before using this new container.
This is one of the methods to construct a OneWireContainer10
. The others are through creating a OneWireContainer10
with parameters.
OneWireContainer10 | ( | DSPortAdapter | sourceAdapter, | |
byte[] | newAddress | |||
) |
Creates a OneWireContainer10
with the provided adapter object and the address of this One-Wire device.
This is one of the methods to construct a OneWireContainer10
. The others are through creating a OneWireContainer10
with different parameters types.
sourceAdapter | adapter object required to communicate with this One-Wire device | |
newAddress | address of this One-Wire device |
OneWireContainer10 | ( | DSPortAdapter | sourceAdapter, | |
long | newAddress | |||
) |
Creates a OneWireContainer10
with the provided adapter object and the address of this One-Wire device.
This is one of the methods to construct a OneWireContainer10
. The others are through creating a OneWireContainer10
with different parameters types.
sourceAdapter | adapter object required to communicate with this One-Wire device | |
newAddress | address of this One-Wire device |
OneWireContainer10(DSPortAdapter,byte[])
OneWireContainer10 | ( | DSPortAdapter | sourceAdapter, | |
String | newAddress | |||
) |
Creates a OneWireContainer10
with the provided adapter object and the address of this One-Wire device.
This is one of the methods to construct a OneWireContainer10
. The others are through creating a OneWireContainer10
with different parameters types.
sourceAdapter | adapter object required to communicate with this One-Wire device | |
newAddress | address of this One-Wire device |
OneWireContainer10(DSPortAdapter,byte[])
String getName | ( | ) |
Retrieves the Maxim Integrated Products part number of this OneWireContainer10
as a String
.
For example 'DS1920'.
OneWireContainer10
name Reimplemented from OneWireContainer.
String getAlternateNames | ( | ) |
Retrieves the alternate Maxim Integrated Products part numbers or names.
A 'family' of 1-Wire Network devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.
OneWireContainer10
alternate names Reimplemented from OneWireContainer.
String getDescription | ( | ) |
Retrieves a short description of the function of this OneWireContainer10
type.
OneWireContainer10
functional description Reimplemented from OneWireContainer.
boolean hasTemperatureAlarms | ( | ) |
Checks to see if this temperature measuring device has high/low trip alarms.
true
if this OneWireContainer10
has high/low trip alarmsImplements TemperatureContainer.
boolean hasSelectableTemperatureResolution | ( | ) |
Checks to see if this device has selectable temperature resolution.
true
if this OneWireContainer10
has selectable temperature resolutionImplements TemperatureContainer.
double [] getTemperatureResolutions | ( | ) |
Gets an array of available temperature resolutions in Celsius.
OneWireContainer10
. The minimum resolution is returned as the first element and maximum resolution as the last element.Implements TemperatureContainer.
double getTemperatureAlarmResolution | ( | ) |
Gets the temperature alarm resolution in Celsius.
OneWireContainer10
Implements TemperatureContainer.
double getMaxTemperature | ( | ) |
Gets the maximum temperature in Celsius.
OneWireContainer10
Implements TemperatureContainer.
double getMinTemperature | ( | ) |
Gets the minimum temperature in Celsius.
OneWireContainer10
Implements TemperatureContainer.
void doTemperatureConvert | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Performs a temperature conversion on state
information.
state | byte array with device state information |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from this OneWireContainer10 . 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 TemperatureContainer.
double getTemperature | ( | byte[] | state | ) | throws OneWireIOException |
Gets the temperature value in Celsius from the state
data retrieved from the readDevice()
method.
state | byte array with device state information for this OneWireContainer10 |
doTemperatureConvert()
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from this OneWireContainer10 . 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'. |
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 |
OneWireContainer10
Implements TemperatureContainer.
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 |
OneWireContainer10
Implements TemperatureContainer.
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 | |||
) |
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. Valid values are RESOLUTION_NORMAL and RESOLUTION_MAXIMUM . | |
state | byte array with device state information |
Implements TemperatureContainer.
byte [] readDevice | ( | ) | throws OneWireIOException, OneWireException |
Retrieves this OneWireContainer10
state information.
The state information 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.
OneWireContainer10
state information. Device state looks like this: 0 : temperature LSB 1 : temperature MSB 2 : trip high 3 : trip low 4 : reserved (put the resolution here, 0 for normal, 1 for max) 5 : reserved 6 : count remain 7 : count per degree Celsius 8 : an 8 bit CRC over the previous 8 bytes of data
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from this OneWireContainer10 . 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 writeDevice | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Writes to this OneWireContainer10
state
information 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 | byte array with device state information |
OneWireIOException | on a 1-Wire communication error such as reading an incorrect CRC from this OneWireContainer10 . 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.
static double convertToFahrenheit | ( | double | celsiusTemperature | ) | [static] |
Converts a temperature reading from Celsius to Fahrenheit.
celsiusTemperature | temperature value in Celsius |
static double convertToCelsius | ( | double | fahrenheitTemperature | ) | [static] |
Converts a temperature reading from Fahrenheit to Celsius.
fahrenheitTemperature | temperature value in Fahrenheit |
final double RESOLUTION_MAXIMUM = 0.1 [static] |
maximum temperature resolution for this OneWireContainer10
device.
Use RESOLUTION_MAXIMUM
in setResolution()
if higher resolution is desired.