Package com.reduxrobotics.sensors.canandcolor

Interface DigoutPinConfig

All Known Implementing Classes:

DataSource, DigoutPinConfig.RawConfigValue

public sealed interface DigoutPinConfig
permits DataSource, DigoutPinConfig.RawConfigValue

Interface that holds the output configuration for a physical digital output pin (digout)

Digout pins can be set into one of three modes:

• disabled (via kDisabled)
• outputting high or low depending on the values of digout slots that combine to form a boolean expression (via kDigoutLogicActiveLow and kDigoutLogicActiveHigh -- for more information, see DigoutChannel)
• a duty cycle/PWM output of values from either the color or proximity sensor via DataSource (only works on digout 2)

See DigoutChannel.configureOutputPin(DigoutPinConfig) for example usage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	DigoutPinConfig.RawConfigValue	Represents a raw config value.

Field Summary

Fields

Modifier and Type	Field	Description
static final DigoutPinConfig	kDigoutLogicActiveHigh	Sets the digout GPIO pin to use the associated digout channel's value, with 3.3v as true and 0v as false.
static final DigoutPinConfig	kDigoutLogicActiveLow	Sets the digout GPIO pin to use the associated digout channel's value, with 0v as true and 3.3v as false.
static final DigoutPinConfig	kDisabled	Disables all output on this digout GPIO pin.

Method Summary

Modifier and Type	Method	Description
boolean	equals(DigoutPinConfig other)	Returns if two configurations are equivalent.
static DigoutPinConfig	fromSettingData(long value)	Unserializes the digout config from setting data to an object.
long	toOutputSettingData()	Serializes the digout config into a value writeable to device settings.

Field Details

kDisabled

static final DigoutPinConfig kDisabled

Disables all output on this digout GPIO pin.

kDigoutLogicActiveHigh

static final DigoutPinConfig kDigoutLogicActiveHigh

Sets the digout GPIO pin to use the associated digout channel's value, with 3.3v as true and 0v as false.

kDigoutLogicActiveLow

static final DigoutPinConfig kDigoutLogicActiveLow

Sets the digout GPIO pin to use the associated digout channel's value, with 0v as true and 3.3v as false.

Method Details

toOutputSettingData

long toOutputSettingData()

Serializes the digout config into a value writeable to device settings.

Returns:

48-bit long

equals

boolean equals(DigoutPinConfig other)

Returns if two configurations are equivalent.

Parameters:

other - other config

Returns:

true if equal

fromSettingData

static DigoutPinConfig fromSettingData(long value)

Unserializes the digout config from setting data to an object.

Parameters:

value - setting data

Returns:

config object