Inherits com::dalsemi::onewire::container::OneWireContainer, and com::dalsemi::onewire::container::TemperatureContainer.

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.

Detailed Description

1-Wire container for temperature iButton which measures temperatures from -55 °C to +100 °C , DS1920 or DS18S20. This container encapsulates the functionality of the iButton family type 10 (hex)

Features

Measures temperatures from -55 °C to +100 °C in typically 0.2 seconds
Zero standby power
0.5 °C resolution, digital temperature reading in two�s complement
Increased resolution through interpolation in internal counters
8-bit device-generated CRC for data integrity
Special command set allows user to skip ROM section and do temperature measurements simultaneously for all devices on the bus
2 bytes of EEPROM to be used either as alarm triggers or user memory
Alarm search directly indicates which device senses alarming temperatures

Usage

See the usage example in TemperatureContainer for temperature specific operations.

DataSheet

http://pdfserv.maxim-ic.com/arpdf/DS1920.pdf http://pdfserv.maxim-ic.com/arpdf/DS18S20.pdf

See also:: com.dalsemi.onewire.container.TemperatureContainer

Version:: 1.00, 1 Sep 2000

Author:: DS,JK Converted to use TemperatureContainer interface 9-1-2000 KLA

Constructor & Destructor Documentation

OneWireContainer10 ( )

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.

See also:: OneWireContainer10(DSPortAdapter,byte[]); OneWireContainer10(DSPortAdapter,long); OneWireContainer10(DSPortAdapter,String)

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.

Parameters:

sourceAdapter	adapter object required to communicate with this One-Wire device
newAddress	address of this One-Wire device

See also:: com.dalsemi.onewire.utils.Address; OneWireContainer10(); OneWireContainer10(DSPortAdapter,long); OneWireContainer10(DSPortAdapter,String)

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.

Parameters:

sourceAdapter	adapter object required to communicate with this One-Wire device
newAddress	address of this One-Wire device

See also:: com.dalsemi.onewire.utils.Address; OneWireContainer10(); OneWireContainer10(DSPortAdapter,byte[]); OneWireContainer10(DSPortAdapter,String)

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.

Parameters:

sourceAdapter	adapter object required to communicate with this One-Wire device
newAddress	address of this One-Wire device

See also:: com.dalsemi.onewire.utils.Address; OneWireContainer10(); OneWireContainer10(DSPortAdapter,byte[]); OneWireContainer10(DSPortAdapter,long)

Member Function Documentation

static double convertToCelsius ( double fahrenheitTemperature ) [static]

Converts a temperature reading from Fahrenheit to Celsius.

Parameters:

fahrenheitTemperature temperature value in Fahrenheit

Returns:: the Celsius conversion of the supplied temperature

Deprecated:: Replace with call to com.dalsemi.onewire.utils.Convert.toCelsius()

See also:: com.dalsemi.onewire.utils.Convert.toCelsius(double)

static double convertToFahrenheit ( double celsiusTemperature ) [static]

Converts a temperature reading from Celsius to Fahrenheit.

Parameters:

celsiusTemperature temperature value in Celsius

Returns:: the Fahrenheit conversion of the supplied temperature

Deprecated:: Replace with call to com.dalsemi.onewire.utils.Convert.toFahrenheit()

See also:: com.dalsemi.onewire.utils.Convert.toFahrenheit(double)

void doTemperatureConvert ( byte[] state ) throws OneWireIOException, OneWireException

Performs a temperature conversion on state information.

Parameters:

state byte array with device state information

Exceptions:

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

See also:: getTemperature

Implements TemperatureContainer.

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'.

Returns:: this OneWireContainer10 alternate names

Reimplemented from OneWireContainer.

String getDescription ( )

Retrieves a short description of the function of this OneWireContainer10 type.

Returns:: OneWireContainer10 functional description

Reimplemented from OneWireContainer.

double getMaxTemperature ( )

Gets the maximum temperature in Celsius.

Returns:: maximum temperature in Celsius for this OneWireContainer10

See also:: getMinTemperature

Implements TemperatureContainer.

double getMinTemperature ( )

Gets the minimum temperature in Celsius.

Returns:: minimum temperature in Celsius for this OneWireContainer10

See also:: getMaxTemperature

Implements TemperatureContainer.

String getName ( )

Retrieves the Maxim Integrated Products part number of this OneWireContainer10 as a String.

For example 'DS1920'.

Returns:: this OneWireContainer10 name

Reimplemented from OneWireContainer.

double getTemperature ( byte[] state ) throws OneWireIOException

Gets the temperature value in Celsius from the state data retrieved from the readDevice() method.

Parameters:

state byte array with device state information for this OneWireContainer10

Returns:: temperature in Celsius from the last doTemperatureConvert()

Exceptions:

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'.

See also:: 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.

Parameters:

alarmType	valid value: `ALARM_HIGH` or `ALARM_LOW`
state	byte array with device state information

Returns:: temperature alarm trip values in Celsius for this OneWireContainer10

See also:: hasTemperatureAlarms; setTemperatureAlarm

Implements TemperatureContainer.

double getTemperatureAlarmResolution ( )

Gets the temperature alarm resolution in Celsius.

Returns:: temperature alarm resolution in Celsius for this OneWireContainer10

See also:: hasTemperatureAlarms; getTemperatureAlarm; setTemperatureAlarm

Implements TemperatureContainer.

double getTemperatureResolution ( byte[] state )

Gets the current temperature resolution in Celsius from the state data retrieved from the readDevice() method.

Parameters:

state byte array with device state information

Returns:: temperature resolution in Celsius for this OneWireContainer10

See also:: hasSelectableTemperatureResolution; getTemperatureResolutions; setTemperatureResolution

Implements TemperatureContainer.

double [] getTemperatureResolutions ( )

Gets an array of available temperature resolutions in Celsius.

Returns:: byte array of available temperature resolutions in Celsius for this OneWireContainer10. The minimum resolution is returned as the first element and maximum resolution as the last element.

See also:: hasSelectableTemperatureResolution; getTemperatureResolution; setTemperatureResolution

Implements TemperatureContainer.

boolean hasSelectableTemperatureResolution ( )

Checks to see if this device has selectable temperature resolution.

Returns:: true if this OneWireContainer10 has selectable temperature resolution

See also:: getTemperatureResolution; getTemperatureResolutions; setTemperatureResolution

Implements TemperatureContainer.

boolean hasTemperatureAlarms ( )

Checks to see if this temperature measuring device has high/low trip alarms.

Returns:: true if this OneWireContainer10 has high/low trip alarms

See also:: getTemperatureAlarm; setTemperatureAlarm

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.

Returns:

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

Exceptions:

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

See also:: writeDevice

Implements OneWireSensor.

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.

Parameters:

alarmType	valid value: `ALARM_HIGH` or `ALARM_LOW`
alarmValue	alarm trip value in Celsius
state	byte array with device state information

See also:: hasTemperatureAlarms; getTemperatureAlarm

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.

Parameters:

resolution	temperature resolution in Celsius. Valid values are `RESOLUTION_NORMAL` and `RESOLUTION_MAXIMUM`.
state	byte array with device state information

See also:: RESOLUTION_NORMAL; RESOLUTION_MAXIMUM; hasSelectableTemperatureResolution; getTemperatureResolution; getTemperatureResolutions

Implements TemperatureContainer.

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.

Parameters:

state byte array with device state information

Exceptions:

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

See also:: readDevice

Implements OneWireSensor.

Member Data Documentation

final double RESOLUTION_MAXIMUM = 0.1 [static]

maximum temperature resolution for this OneWireContainer10 device.

Use RESOLUTION_MAXIMUM in setResolution() if higher resolution is desired.

The documentation for this class was generated from the following file:

OneWireContainer10.java

OneWireContainer10 Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Features

Usage

DataSheet

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation