Inherited by OneWireContainer41.
This class should be implemented for each Humidity type 1-Wire device.
The HumidityContainer methods can be organized into the following categories:
Gets humidity reading from a HumidityContainer instance 'hc
':
double lastHumidity;
// get the current resolution and other settings of the device (done only once)
byte[] state = hc.readDevice();
// loop to read the humidity
do
{
// perform a humidity conversion
hc.doHumidityConvert(state);
// read the result of the conversion
state = hc.readDevice();
// extract the result out of state
lastHumidity = hc.getHumidity(state);
...
}
while (!done);
Public Member Functions | |
boolean | isRelative () |
Checks to see if humidity value given is a 'relative' humidity value. | |
boolean | hasHumidityAlarms () |
Checks to see if this Humidity measuring device has high/low trip alarms. | |
boolean | hasSelectableHumidityResolution () |
Checks to see if this device has selectable Humidity resolution. | |
double[] | getHumidityResolutions () |
Get an array of available Humidity resolutions in percent humidity (0 to 100). | |
double | getHumidityAlarmResolution () throws OneWireException |
Gets the Humidity alarm resolution in percent. | |
void | doHumidityConvert (byte[] state) throws OneWireIOException, OneWireException |
Performs a Humidity conversion. | |
double | getHumidity (byte[] state) |
Gets the humidity expressed as a percent value (0.0 to 100.0) of humidity. | |
double | getHumidityResolution (byte[] state) |
Gets the current Humidity resolution in percent from the state data retrieved from the readDevice() method. | |
double | getHumidityAlarm (int alarmType, byte[] state) throws OneWireException |
Gets the specified Humidity alarm value in percent from the state data retrieved from the readDevice() method. | |
void | setHumidityAlarm (int alarmType, double alarmValue, byte[] state) throws OneWireException |
Sets the Humidity alarm value in percent in the provided state data. | |
void | setHumidityResolution (double resolution, byte[] state) throws OneWireException |
Sets the current Humidity resolution in percent in the provided state data. | |
Static Public Attributes | |
static final int | ALARM_HIGH = 1 |
high temperature alarm | |
static final int | ALARM_LOW = 0 |
low temperature alarm |
boolean isRelative | ( | ) |
Checks to see if humidity value given is a 'relative' humidity value.
true
if this HumidityContainer
provides a relative humidity readingImplemented in OneWireContainer41.
boolean hasHumidityAlarms | ( | ) |
Checks to see if this Humidity measuring device has high/low trip alarms.
true
if this HumidityContainer
has high/low trip alarmsImplemented in OneWireContainer41.
boolean hasSelectableHumidityResolution | ( | ) |
Checks to see if this device has selectable Humidity resolution.
true
if this HumidityContainer
has selectable Humidity resolutionImplemented in OneWireContainer41.
double [] getHumidityResolutions | ( | ) |
Get an array of available Humidity resolutions in percent humidity (0 to 100).
Implemented in OneWireContainer41.
double getHumidityAlarmResolution | ( | ) | throws OneWireException |
Gets the Humidity alarm resolution in percent.
OneWireException | Device does not support Humidity alarms |
Implemented in OneWireContainer41.
void doHumidityConvert | ( | byte[] | state | ) | throws OneWireIOException, OneWireException |
Performs a Humidity conversion.
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'. | |
OneWireException | on a communication or setup error with the 1-Wire adapter |
Implemented in OneWireContainer41.
double getHumidity | ( | byte[] | state | ) |
Gets the humidity expressed as a percent value (0.0 to 100.0) of humidity.
state | byte array with device state information |
Implemented in OneWireContainer41.
double getHumidityResolution | ( | byte[] | state | ) |
Gets the current Humidity resolution in percent from the state
data retrieved from the readDevice()
method.
state | byte array with device state information |
Implemented in OneWireContainer41.
double getHumidityAlarm | ( | int | alarmType, | |
byte[] | state | |||
) | throws OneWireException |
Gets the specified Humidity alarm value in percent from the state
data retrieved from the readDevice()
method.
alarmType | valid value: ALARM_HIGH or ALARM_LOW | |
state | byte array with device state information |
OneWireException | Device does not support Humidity alarms |
Implemented in OneWireContainer41.
void setHumidityAlarm | ( | int | alarmType, | |
double | alarmValue, | |||
byte[] | state | |||
) | throws OneWireException |
Sets the Humidity alarm value in percent 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 percent | |
state | byte array with device state information |
OneWireException | Device does not support Humidity alarms |
Implemented in OneWireContainer41.
void setHumidityResolution | ( | double | resolution, | |
byte[] | state | |||
) | throws OneWireException |
Sets the current Humidity resolution in percent in the provided state
data.
Use the method writeDevice()
with this data to finalize the change to the device.
resolution | Humidity resolution in percent | |
state | byte array with device state information |
OneWireException | Device does not support selectable Humidity resolution |
Implemented in OneWireContainer41.