Package com.diozero.api

Core APIs for interfacing with devices.

Interface Summary

Interface	Description
DeviceInterface
DigitalInputDeviceInterface	Base interface for devices with digital input.
I2CConstants
I2CDeviceInterface	Inter-Integrated Circuit (I2C) Interface
I2CSMBusInterface	I2C device interface Linux SMBus interface
OutputDeviceInterface	Represents a device capable of output (digital or analog).
SerialConstants
SerialDeviceInterface	Serial Port Interface
SpiConstants
SpiDeviceInterface	Serial Peripheral Interface (SPI)

Class Summary

Class	Description
AbstractDigitalInputDevice	Abstract base class for low-level GPIO digital input devices.
AnalogInputDevice	The AnalogInputDevice base class encapsulates logic for interfacing with analog devices.
AnalogInputDevice.Builder
AnalogInputEvent	Represents an input event from an analog device.
AnalogOutputDevice	Analog output device.
AnalogOutputDevice.Builder
DebouncedDigitalInputDevice	Digital input device with debounce logic.
DeviceEvent	Abstract class representing an event from a GPIO device.
DigitalInputDevice	Represents a generic digital input device.
DigitalInputDevice.Builder	Digital input device builder.
DigitalInputEvent	Represents an input event from a digital device.
DigitalInputOutputDevice	A digital device whose Mode can be initialised to and changed to DIGITAL_INPUT and DIGITAL_OUTPUT.
DigitalOutputDevice	Provides generic digital (on/off) output control with support for active high and low logic.
DigitalOutputDevice.Builder
Event
GpioDevice	Abstract base class for all GPIO related devices.
GpioInputDevice<T extends DeviceEvent>	Common base class for digital and analog input devices.
I2CDevice	Utility class for interfacing with to I2C devices.
I2CDevice.Builder	I2C device builder.
I2CDeviceInterface.I2CMessage
OutputDeviceCollection	A collection of output devices to simplify setting the same output value for a number of devices at the same time
PinInfo	Describe the various attributes of an individual General-Purpose Input/Output (GPIO) pin.
PwmOutputDevice	Provide generic Pulse Width Modulation (PWM) output control.
PwmPinInfo	Describe the various attributes of an individual General-Purpose Input/Output (GPIO) pin used for Pulse Width Modulation (PWM) output.
SerialDevice	Serial device.
SerialDevice.Builder	Serial device builder.
SerialDevice.DeviceInfo	Provides descriptive information for a connected serial device.
SmoothedInputDevice	Represents a generic input device which takes its value from the number of active events over a specific time period.
SmoothedInputDevice.Builder	Smoothed input device builder.
SpiDevice	Serial Peripheral Interface device
SpiDevice.Builder	I2C device builder.

Enum Summary

Enum	Description
DeviceMode	Valid GPIO modes
GpioEventTrigger	Values for input event triggers - none (no events), rising edge (transition from off to on), falling (transition from on to off) and both
GpioPullUpDown
I2CConstants.AddressSize
I2CDevice.ProbeMode
PwmType
SerialConstants.DataBits	The number of data bits to use per word.
SerialConstants.Parity	Specifies how error detection is carried out.
SerialConstants.ReadMode	Specifies read mode: whether non-blocking, semi-blocking, blocking; also whether blocks with or without timeout.
SerialConstants.StopBits	The number of stop bits.
SpiClockMode	SPI clock mode determines the clock polarity and phase with respect to data.

Exception Summary

Exception	Description
DeviceAlreadyOpenedException
DeviceBusyException
InvalidModeException
NoSuchDeviceException
RuntimeInterruptedException
RuntimeIOException