Module com.pi4j

Package com.pi4j.io.serial

Interface SerialConfig

All Superinterfaces:

Config<SerialConfig>, DeviceConfig<SerialConfig>, IOConfig<SerialConfig>

public interface SerialConfig
extends DeviceConfig<SerialConfig>, IOConfig<SerialConfig>

SerialConfig interface.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BAUD_KEY	Constant BAUD_KEY="baud"
static final String	DATA_BITS_KEY	Constant DATA_BITS_KEY="data-bits"
static final String	FLOW_CONTROL_KEY	Constant FLOW_CONTROL_KEY="flow-control"
static final String	PARITY_KEY	Constant PARITY_KEY="parity"
static final String	STOP_BITS_KEY	Constant STOP_BITS_KEY="stop-bits"

Fields inherited from interface com.pi4j.config.Config

DESCRIPTION_KEY, ID_KEY, NAME_KEY

Fields inherited from interface com.pi4j.config.DeviceConfig

DEVICE_KEY

Fields inherited from interface com.pi4j.io.IOConfig

PLATFORM_KEY, PROVIDER_KEY

Method Summary

Modifier and Type	Method	Description
Integer	baud()	baud.
DataBits	dataBits()	dataBits.
FlowControl	flowControl()	flowControl.
default Integer	getBaud()	getBaud.
default DataBits	getDataBits()	getDataBits.
default FlowControl	getFlowControl()	getFlowControl.
default Parity	getParity()	getParity.
default StopBits	getStopBits()	getStopBits.
Parity	parity()	parity.
StopBits	stopBits()	stopBits.

Methods inherited from interface com.pi4j.config.Config

description, getDescription, getId, getName, id, name, properties, validate

Methods inherited from interface com.pi4j.config.DeviceConfig

device, getDevice

Methods inherited from interface com.pi4j.io.IOConfig

getPlatform, getProvider, platform, provider

Field Details

BAUD_KEY

static final String BAUD_KEY

Constant BAUD_KEY="baud"

See Also:

• Constant Field Values

STOP_BITS_KEY

static final String STOP_BITS_KEY

Constant STOP_BITS_KEY="stop-bits"

See Also:

• Constant Field Values

DATA_BITS_KEY

static final String DATA_BITS_KEY

Constant DATA_BITS_KEY="data-bits"

See Also:

• Constant Field Values

PARITY_KEY

static final String PARITY_KEY

Constant PARITY_KEY="parity"

See Also:

• Constant Field Values

FLOW_CONTROL_KEY

static final String FLOW_CONTROL_KEY

Constant FLOW_CONTROL_KEY="flow-control"

See Also:

• Constant Field Values

Method Details

baud

Integer baud()

baud.

Returns:

a Integer object.

getBaud

default Integer getBaud()

getBaud.

Returns:

a Integer object.

stopBits

StopBits stopBits()

stopBits.

Returns:

a StopBits object.

getStopBits

default StopBits getStopBits()

getStopBits.

Returns:

a StopBits object.

dataBits

DataBits dataBits()

dataBits.

Returns:

a DataBits object.

getDataBits

default DataBits getDataBits()

getDataBits.

Returns:

a DataBits object.

parity

Parity parity()

parity.

Returns:

a Parity object.

getParity

default Parity getParity()

getParity.

Returns:

a Parity object.

flowControl

FlowControl flowControl()

flowControl.

Returns:

a FlowControl object.

getFlowControl

default FlowControl getFlowControl()

getFlowControl.

Returns:

a FlowControl object.