com.mbientlab.metawear.module

Interface Gpio.AnalogInParameterBuilder

Enclosing interface:

Gpio

public static interface Gpio.AnalogInParameterBuilder

Builder to construct parameters for the enhanced analog input read.

Method Summary

Modifier and Type	Method and Description
void	commit() Commit the read parameters to the board
Gpio.AnalogInParameterBuilder	delay(short delay) Sets how long to wait before reading from the pin.
Gpio.AnalogInParameterBuilder	pullDownPin(byte pin) Sets the GPIO pin that will be pulled down before the read.
Gpio.AnalogInParameterBuilder	pullUpPin(byte pin) Sets the GPIO pin that will be pulled up before the read.
Gpio.AnalogInParameterBuilder	silent(boolean silent) Sets silent mode.
Gpio.AnalogInParameterBuilder	virtualPin(byte pin) GPIO pin the returned data identifies as.

Method Detail

pullUpPin

Gpio.AnalogInParameterBuilder pullUpPin(byte pin)

Sets the GPIO pin that will be pulled up before the read. If unused, no pin will be pulled up

Parameters:

pin - Pullup pin

Returns:

Calling object

pullDownPin

Gpio.AnalogInParameterBuilder pullDownPin(byte pin)

Sets the GPIO pin that will be pulled down before the read. If unused, no pin will be pulled down

Parameters:

pin - Pulldown pin

Returns:

Calling object

delay

Gpio.AnalogInParameterBuilder delay(short delay)

Sets how long to wait before reading from the pin. If unused, the read will happen when the command is issued.

Parameters:

delay - Delay time, in microseconds (μs)

Returns:

Calling object

virtualPin

Gpio.AnalogInParameterBuilder virtualPin(byte pin)

GPIO pin the returned data identifies as. If used, the virtual pin value must match the pin used for Gpio.readAnalogIn(byte, AnalogReadMode) and Gpio.readAnalogIn(byte, AnalogReadMode, boolean) when constructing a data route for analog data.

Parameters:

pin - Virtual pin identifying the data

Returns:

Calling object

silent

Gpio.AnalogInParameterBuilder silent(boolean silent)

Sets silent mode. If unused, it will default to false. The silent value must match the silent flag used for Gpio.readAnalogIn(byte, AnalogReadMode, boolean).

Parameters:

silent - True if read should be silent

Returns:

Calling object

commit

void commit()

Commit the read parameters to the board