com.mbientlab.metawear.module

Interface Gpio

All Superinterfaces:

MetaWearBoard.Module

public interface Gpio
extends MetaWearBoard.Module

Interacts with the general purpose I/O pins

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Gpio.AnalogInParameterBuilder Builder to construct parameters for the enhanced analog input read.
static class	Gpio.AnalogReadMode Read modes for analog input
static class	Gpio.PinChangeType Pin change types
static class	Gpio.PullMode Input pin configuration types
static interface	Gpio.SourceSelector Selector for available Gpio data sources

Method Summary

Modifier and Type	Method and Description
void	clearDigitalOut(byte pin) Clears the digital output state of a pin
Gpio.AnalogInParameterBuilder	initiateAnalogInRead(byte pin, Gpio.AnalogReadMode mode) Enhanced version of the readAnalogIn functions that combines analog reads with pullup/pulldown commands in one function.
void	readAnalogIn(byte pin, Gpio.AnalogReadMode mode) Read the analog input voltage
void	readAnalogIn(byte pin, Gpio.AnalogReadMode mode, boolean silent) Read the analog input voltage
void	readDigitalIn(byte pin) Read the digital input state
void	readDigitalIn(byte pin, boolean silent) Read the digital input state
Gpio.SourceSelector	routeData() Initiates the creation of a route for gpio data
void	setDigitalOut(byte pin) Sets the digital output state of a pin
void	setPinChangeType(byte pin, Gpio.PinChangeType type) Sets change type to monitor
void	setPinPullMode(byte pin, Gpio.PullMode mode) Sets pull mode on a pin
void	startPinChangeDetection(byte pin) Starts pin change detection
void	stopPinChangeDetection(byte pin) Stops pin change detection

Method Detail

readAnalogIn

void readAnalogIn(byte pin,
                  Gpio.AnalogReadMode mode)

Read the analog input voltage

Parameters:

pin - GPIO pin to read

mode - Analog read mode

readAnalogIn

void readAnalogIn(byte pin,
                  Gpio.AnalogReadMode mode,
                  boolean silent)

Read the analog input voltage

Parameters:

pin - GPIO pin to read

mode - Analog read mode

initiateAnalogInRead

Gpio.AnalogInParameterBuilder initiateAnalogInRead(byte pin,
                                                   Gpio.AnalogReadMode mode)

Enhanced version of the readAnalogIn functions that combines analog reads with pullup/pulldown commands in one function. This function is only available on boards running firmware v1.2.2 or later.

Parameters:

pin - GPIO pin to read

mode - Analog read mode

Returns:

Builder to assign desired parameters

setPinPullMode

void setPinPullMode(byte pin,
                    Gpio.PullMode mode)

Sets pull mode on a pin

Parameters:

pin - GPIO pin to configure

mode - New pull mode

readDigitalIn

void readDigitalIn(byte pin)

Read the digital input state

Parameters:

pin - GPIO pin to read

readDigitalIn

void readDigitalIn(byte pin,
                   boolean silent)

Read the digital input state

Parameters:

pin - GPIO pin to read

silent - True if read should be silent

setDigitalOut

void setDigitalOut(byte pin)

Sets the digital output state of a pin

Parameters:

pin - GPIO pin to set

clearDigitalOut

void clearDigitalOut(byte pin)

Clears the digital output state of a pin

Parameters:

pin - GPIO pin to clear

setPinChangeType

void setPinChangeType(byte pin,
                      Gpio.PinChangeType type)

Sets change type to monitor

Parameters:

pin - GPIO pin to configure

type - Change type to monitor

startPinChangeDetection

void startPinChangeDetection(byte pin)

Starts pin change detection

Parameters:

pin - GPIO pin to monitor

stopPinChangeDetection

void stopPinChangeDetection(byte pin)

Stops pin change detection

Parameters:

pin - GPIO pin to stop monitoring

routeData

Gpio.SourceSelector routeData()

Initiates the creation of a route for gpio data

Returns:

Selection of available data sources