com.mbientlab.metawear.api.controller

Interface Temperature.SamplingConfigBuilder

Enclosing interface:

Temperature

public static interface Temperature.SamplingConfigBuilder

Builder for creating a configuration for temperature sampling

Author:

Eric Tsai

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Write the configuration settings to the MetaWear board and starts the sampling
Temperature.SamplingConfigBuilder	withSampingPeriod(int period) Deprecated. As of v1.6, use withSamplingPeriod(int) as this method's name was mispelled
Temperature.SamplingConfigBuilder	withSamplingPeriod(int period) Set the temperature sampling period
Temperature.SamplingConfigBuilder	withSilentMode() Enables silent mode, which internally is notified of the events but will not trigger the callback functions
Temperature.SamplingConfigBuilder	withTemperatureBoundary(float lower, float upper) Set the temperature boundaries.
Temperature.SamplingConfigBuilder	withTemperatureDelta(float delta) Set the temperature delta.

Method Detail

withSilentMode

Temperature.SamplingConfigBuilder withSilentMode()

Enables silent mode, which internally is notified of the events but will not trigger the callback functions

Returns:

Calling object

withSampingPeriod

@Deprecated
Temperature.SamplingConfigBuilder withSampingPeriod(int period)

Deprecated. As of v1.6, use withSamplingPeriod(int) as this method's name was mispelled

Set the temperature sampling period

Parameters:

period - How often to sample the temperature, in ms

Returns:

Calling object

withSamplingPeriod

Temperature.SamplingConfigBuilder withSamplingPeriod(int period)

Set the temperature sampling period

Parameters:

period - How often to sample the temperature, in ms

Returns:

Calling object

withTemperatureDelta

Temperature.SamplingConfigBuilder withTemperatureDelta(float delta)

Set the temperature delta. A temperature change exceeding the delta will trigger a call to Temperature.Callbacks.temperatureDeltaExceeded(float, float)

Parameters:

delta - Change in temperature, in Celsius, to detect

Returns:

Calling object

withTemperatureBoundary

Temperature.SamplingConfigBuilder withTemperatureBoundary(float lower,
                                                        float upper)

Set the temperature boundaries. If the temperate lays outside the boundary, trigger a call to Temperature.Callbacks.boundaryCrossed(float, float)

Parameters:

lower - Lower boundary value, in Celsius

upper - Upper boundary value, in Celsius

Returns:

Calling object

commit

void commit()

Write the configuration settings to the MetaWear board and starts the sampling