All Classes
| Class | Description |
|---|---|
| AbstractDevice | |
| AbstractDeviceFactory |
Base class for all device factories, including custom board-specific provider
implementations (e.g.
|
| AbstractDigitalInputDevice |
Abstract base class for low-level GPIO digital input devices.
|
| AbstractInputDevice<T extends DeviceEvent> | |
| Action | |
| Ads112C04 | |
| Ads112C04.Address |
The ADS112C04 has two address pins: A0 and A1.
|
| Ads112C04.Builder | |
| Ads112C04.BurnoutCurrentSources | |
| Ads112C04.ConfigRegister | |
| Ads112C04.ConversionMode | |
| Ads112C04.CrcConfig | |
| Ads112C04.DataCounter | |
| Ads112C04.DataRate | |
| Ads112C04.GainConfig | |
| Ads112C04.Idac1RoutingConfig | |
| Ads112C04.Idac2RoutingConfig | |
| Ads112C04.IdacCurrent | |
| Ads112C04.OperatingMode | |
| Ads112C04.Pga | |
| Ads112C04.TemperatureSensorMode | |
| Ads112C04.VRef | |
| Ads1x15 |
ADS1115 Datasheet: https://www.ti.com/lit/ds/symlink/ads1115.pdf ADS1015
Datasheet: https://www.ti.com/lit/ds/symlink/ads1015.pdf
|
| Ads1x15.Address |
I2C address configuration
|
| Ads1x15.Ads1015DataRate |
Number of samples per second
|
| Ads1x15.Ads1115DataRate |
Number of samples per second
|
| Ads1x15.ComparatorMode | |
| Ads1x15.ComparatorPolarity | |
| Ads1x15.ComparatorQueue |
Comparator queue configuration
|
| Ads1x15.Mode |
Read mode - continuous or single
|
| Ads1x15.Model | |
| Ads1x15.PgaConfig |
Programmable Gain Amplifier configuration.
|
| ADXL345 |
http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.PDF
|
| ADXL345.OutputDataRateType | |
| AllwinnerSun8iBoardInfoProvider | |
| AllwinnerSun8iBoardInfoProvider.AllwinnerSun8iBoardInfo | |
| AllwinnerSun8iMmapGpio |
See https://github.com/friendlyarm/WiringNP/blob/master/wiringPi/wiringPi.c
|
| AnalogInputDevice |
The AnalogInputDevice base class encapsulates logic for interfacing with
analog devices.
|
| AnalogInputDeviceFactoryInterface | |
| AnalogInputDeviceInterface | |
| AnalogInputEvent |
Represents an input event from an analog device.
|
| AnalogOutputDeviceFactoryInterface | |
| AnalogOutputDeviceInterface | |
| Animation |
The Animation class constructs objects that represent a single Animation.
|
| AnimationInstance | |
| AnimationInstance.KeyFrame | |
| Back | |
| BarometerInterface | |
| BaseNativeDeviceFactory |
Helper class for instantiating different devices via the configured provider.
|
| BeagleBoneBoardInfoProvider | |
| BeagleBoneBoardInfoProvider.BeagleBoneBlackBoardInfo |
Also works on the BeagleBone Green
|
| BH1750 |
BH1750 Luminosity sensor
Datasheet
Python code
|
| BH1750.Mode | |
| BitManipulation | |
| BME280 |
Provides access to the Bosch BMx280 pressure and temperature sensor.
|
| BME280.FilterCoefficient |
IIR Filter coefficient; can be FILTER_OFF, _2, _4, _8, _16.
|
| BME280.HumidityOversampling |
Humidity oversampling multiplier; value can be OVERSAMPLING_1, _2, _4, _8,
_16.
|
| BME280.Model | |
| BME280.OperatingMode |
Operating mode; value can be MODE_SLEEP, _FORCED, or _NORMAL.
|
| BME280.PressureOversampling |
Pressure oversampling multiplier; value can be OVERSAMPLING_1, _2, _4, _8,
_16.
|
| BME280.StandbyDuration |
Inactive duration in standby mode; can be STANDBY_
500_US (0.5 ms)
62_5_MS (62.5 ms)
125_MS (125 ms)
250_MS (250 ms)
500_MS (500 ms)
1_S (1 second)
10_MS (10 ms)
20_MS (20 ms)
|
| BME280.TemperatureOversampling |
Temperature oversampling multiplier; value can be OVERSAMPLING_1, _2, _4, _8,
_16.
|
| BME680 | |
| BME680.Calibration | |
| BME680.Data | |
| BME680.FilterSize |
IIR filter size.
|
| BME680.GasSettings | |
| BME680.HeaterProfile |
Gas heater profile.
|
| BME680.OversamplingMultiplier |
Oversampling multiplier.
|
| BME680.PowerMode |
Power mode.
|
| BME680.SensorSettings | |
| BMP180 |
Bosch BMP180 I2C temperature and pressure sensor
|
| BMP180.BMPMode |
Relationship between sampling mode and conversion delay (in ms) for each
sampling mode Ultra low power: 4.5 ms minimum conversion delay Standard: 7.5
ms High Resolution: 13.5 ms Ultra high Resolution: 25.5 ms
|
| BoardInfo |
Information about the connected SBC.
|
| BoardInfoProvider | |
| BoardPinInfo |
Provide information about the GPIOs that are available on the connected
board.
|
| Bounce | |
| Button |
Provides push button related utility methods.
|
| Buzzer |
Represents a digital buzzer component.
|
| CamJamKitDualMotor |
CamJam EduKit 3 Robot.
|
| ChipBoardInfoProvider | |
| ChipBoardInfoProvider.CHIPBoardInfo | |
| ChipBoardInfoProvider.CHIPProBoardInfo | |
| ChipMmapGpio | |
| Circular | |
| ColourSsdOled | |
| ColourUtil | |
| Crc |
CRC-8 and CRC-16 calculator.
|
| Crc.Params | |
| Cubic | |
| DebouncedDigitalInputDevice |
Represents a generic input device with typical on/off behaviour.
|
| DefaultDeviceFactory | |
| DefaultNativeSerialDevice | |
| DefaultNativeSpiDevice | |
| DeviceAlreadyOpenedException | |
| DeviceBusyException | |
| DeviceEvent |
Abstract class representing an event from a GPIO device.
|
| DeviceEventConsumer<T extends DeviceEvent> | |
| DeviceFactoryHelper |
Helper class for automatically detecting the
native device factory that will be used
for provisioning I/O devices. |
| DeviceFactoryInterface | |
| DeviceInterface |
Fundamental interface for all low-level device types.
|
| DeviceMode |
Valid GPIO modes
|
| DeviceStates | |
| DigitalInputDevice |
Represents a generic digital input device.
|
| DigitalInputDeviceInterface |
Base interface for devices with digital input.
|
| DigitalInputEvent |
Represents an input event from a digital device.
|
| DigitalInputOutputDevice | |
| DigitalMotor | |
| DigitalOutputDevice |
Provides generic digital (on/off) output control with support for active high
and low logic.
|
| DiozeroScheduler | |
| DistanceSensorInterface | |
| DualMotor |
Generic dual bi-directional motor driver
|
| EasingFunction |
See easings.net for examples.
|
| EasingFunctions | |
| Elastic | |
| EpollEvent | |
| EpollNative | |
| EpollNativeCallback | |
| Event | |
| Exponential | |
| FileDescriptorUtil | |
| FloatConsumer |
Represents an operation that accepts a single
float-valued argument
and returns no result. |
| GenericLinuxArmBoardInfo | |
| GP2Y0A21YK |
Sharp GP2Y0A21YK distance sensor.
|
| GpioChip | |
| GpioChipInfo | |
| GpioChipTest | |
| GpioDevice |
Abstract base class for all GPIO related devices.
|
| GpioDeviceFactoryInterface | |
| GpioDeviceInterface | |
| GpioDigitalDeviceInterface | |
| GpioDigitalInputDeviceInterface | |
| GpioDigitalInputOutputDeviceInterface | |
| GpioDigitalOutputDeviceInterface | |
| GpioEventTrigger |
Values for input event triggers - none (no events), rising edge (transition
from off to on), falling (transition from on to off) and both
|
| GpioExpander |
Interface for GPIO expansion boards such as the MCP23xxx family of devices
|
| GpioInputDevice<T extends DeviceEvent> |
Common base class for digital and analog input devices.
|
| GpioLine | |
| GpioLine.Direction | |
| GpioLineEventListener | |
| GpioPullUpDown | |
| HCSR04 |
User's manual:
https://docs.google.com/document/d/1Y-yZnNhMYy7rwhAgyL_pfa39RsB-x2qR4vP8saG73rE/edit#
Product specification:
http://www.micropik.com/PDF/HCSR04.pdf
Provides 2cm - 400cm non-contact measurement function, the ranging accuracy
can reach to 3mm You only need to supply a short 10uS pulse to the trigger
input to start the ranging, and then the module will send out an 8 cycle
burst of ultrasound at 40 kHz and raise its echo.
|
| HCSR04UsingEvents |
Note this version doesn't work as well as the polling-based HCSR04 version.
|
| HCSR04UsingWait |
User's manual:
https://docs.google.com/document/d/1Y-yZnNhMYy7rwhAgyL_pfa39RsB-x2qR4vP8saG73rE/edit#
Product specification:
http://www.micropik.com/PDF/HCSR04.pdf
Provides 2cm - 400cm non-contact measurement function, the ranging accuracy
can reach to 3mm You only need to supply a short 10uS pulse to the trigger
input to start the ranging, and then the module will send out an 8 cycle
burst of ultrasound at 40 kHz and raise its echo.
|
| HD44780Lcd | |
| HD44780Lcd.Characters | |
| HD44780Lcd.LcdConnection | |
| HD44780Lcd.PCF8574LcdConnection | |
| HD44780Lcd.PiFaceCadLcdConnection | |
| Hex | |
| HTS221 |
STMicroelectronics HTS221 "ultra compact sensor for relative humidity and
temperature".
|
| HygrometerInterface | |
| I2CConstants | |
| I2CConstants.AddressSize | |
| I2CDevice |
Utility class for interfacing with to I2C devices.
|
| I2CDevice.Builder |
I2C device builder.
|
| I2CDevice.ProbeMode | |
| I2CDeviceFactoryInterface | |
| I2CDeviceInterface | |
| I2CDeviceInterface.I2CMessage | |
| I2CSMBusInterface |
I2C device interface
Linux
SMBus interface
|
| ImuBase | |
| ImuData | |
| ImuDataFactory | |
| ImuInterface | |
| InvalidModeException | |
| Keypad |
References:
|
| LDR |
Generic Photoresistor /
Light-Dependent-Resistor (LDR).
Wiring: |
| LED |
Provides utility methods for controlling a Light Emitting Diode (LED).
|
| LedBarGraph | |
| LibraryLoader | |
| Linear | |
| LM73 | |
| LM73.Configuration | |
| LM73.Resolution | |
| LocalBoardInfoUtil |
Utility class for accessing information for the local board that the
application is executing on.
|
| LocalSystemInfo |
Utility class for accessing information about the local system.
|
| LPS25H |
STMicroelectronics LPS25H "ultra compact absolute piezoresistive pressure sensor".
|
| LuminositySensorInterface | |
| MCP23008 | |
| MCP23017 | |
| MCP23S17 | |
| MCP23x08 | |
| MCP23x08.MCP23x08BoardPinInfo | |
| MCP23x17 | |
| MCP23x17.MCP23x17BoardPinInfo | |
| MCP23xxx |
Support for both MCP23008 and MCP23017 GPIO expansion boards.
|
| MCP23xxxDigitalInputDevice | |
| MCP23xxxDigitalInputOutputDevice | |
| MCP23xxxDigitalOutputDevice | |
| McpAdc | |
| McpAdc.McpAdcBoardPinInfo | |
| McpAdc.Type |
The MCP3204/3208 devices offer the choice of using the analog input channels
configured as single-ended inputs or pseudo-differential pairs.
|
| McpEeprom |
See the Microchip website.
|
| McpEeprom.Type | |
| MFRC522 | |
| MFRC522.AntennaGain | |
| MFRC522.PiccType | |
| MFRC522.Response | |
| MFRC522.StatusCode | |
| MFRC522.UID | |
| MmapBufferNative | |
| MmapByteBuffer | |
| MmapGpioInterface | |
| MmapIntBuffer | |
| MotionSensor |
A Passive Infra-Red (PIR) motion sensor.
|
| MotorBase | |
| MotorEvent | |
| MotorEventListener | |
| MotorInterface | |
| MqttConstants | |
| MutableByte | |
| NativeDeviceFactoryInterface | |
| NativeGpioDevice | |
| NativeGpioInputDevice | |
| NativeGpioInputOutputDevice | |
| NativeGpioOutputDevice | |
| NativeI2C | |
| NativeI2CDeviceJavaRaf | Deprecated. |
| NativeI2CDeviceSMBus |
JNI wrapper of SMBus interface.
|
| NativeSerialDevice | |
| NativeSpiDevice | |
| OdroidBoardInfoProvider | |
| OdroidBoardInfoProvider.Model | |
| OdroidBoardInfoProvider.OdroidC1BoardInfo | |
| OdroidBoardInfoProvider.OdroidC2BoardInfo | |
| OdroidC2MmapGpio |
See Odroid
wiringPi fork.
|
| OdroidC2SysFsPwmOutputDevice |
Setting up:
1 PWM Channel (GPIO 234; Pin 33):
|
| OrientationEvent | |
| OrientationEvent.OrientationType | |
| OrientationListener | |
| OutputDeviceCollection |
A collection of output devices to simplify setting the same output value for
a number of devices at the same time
|
| OutputDeviceInterface |
Represents a device capable of output (digital or analog).
|
| PCA9685 |
PCA9685 I2C-bus controlled 16-channel 12-bit PWM controller as used in the popular Adafruit PWM add-on board
Datasheet: http://www.nxp.com/documents/data_sheet/PCA9685.pdf
|
| PCA9685.PCA9685BoardPinInfo | |
| PCF8574 | |
| PCF8574.PCF8574BoardPinInfo | |
| PCF8591 |
Analog to Digital Converter.
|
| PCF8591.InputMode | |
| PCF8591.PCF8591BoardPinInfo | |
| PiconZero | |
| PiconZero.InputConfig | |
| PiconZero.OutputConfig | |
| PiconZero.PiconZeroAnalogInputDevice | |
| PiconZero.PiconZeroAnalogOutputDevice | |
| PiconZero.PiconZeroBoardPinInfo | |
| PiconZero.PiconZeroDigitalInputDevice | |
| PiconZero.PiconZeroDigitalOutputDevice | |
| PiconZero.PiconZeroPwmOutputDevice | |
| PiconZeroMotor | |
| PinInfo |
Describe the various attributes of an individual General-Purpose Input/Output
(GPIO) pin.
|
| PollEventListener | |
| PollNative | |
| Potentiometer |
Supports taking readings from a potentiometer.
|
| PropertyUtil | |
| PwmLed |
PWM controlled LED.
|
| PwmLedBarGraph | |
| PwmMotor |
Generic bi-directional motor controlled by separate forward / backward PWM output GPIOs
|
| PwmOutputDevice |
Provide generic
Pulse Width
Modulation (PWM) output control.
|
| PwmOutputDeviceFactoryInterface | |
| PwmOutputDeviceInterface | |
| PwmPinInfo |
Describe the various attributes of an individual General-Purpose Input/Output
(GPIO) pin used for Pulse Width Modulation (PWM) output.
|
| PwmType | |
| Quad | |
| Quart | |
| Quintic | |
| RangeUtil | |
| RaspberryPiBoardInfoProvider |
See
this c
library.
|
| RaspberryPiBoardInfoProvider.PiABPlusBoardInfo | |
| RaspberryPiBoardInfoProvider.PiABRev2BoardInfo | |
| RaspberryPiBoardInfoProvider.PiBRev1BoardInfo | |
| RaspberryPiBoardInfoProvider.PiComputeModuleBoardInfo | |
| RaspberryPiMmapGpio | |
| RgbLed |
Three pin controlled RGB LED.
|
| RgbPwmLed |
Three pin controlled RGB LED.
|
| RuntimeIOException | |
| RyanteckDualMotor |
RTK MCB Robot.
|
| SensorInterface | |
| SerialConstants | |
| 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.
|
| SerialDevice |
Serial device.
|
| SerialDevice.Builder |
Serial device builder.
|
| SerialDevice.DeviceInfo |
Provides descriptive information for a connected serial device.
|
| SerialDeviceFactoryInterface | |
| SerialDeviceInterface | |
| Servo | |
| Servo.Array | |
| Servo.OutputDeviceUnit | |
| Servo.Trim | |
| ServoUtil | |
| SGP30 | |
| SGP30.FeatureSetVersion | |
| SGP30.RawMeasurement | |
| SGP30.SGP30Measurement | |
| Sine | |
| SleepUtil | |
| SmoothedInputDevice |
Represents a generic input device which takes its value from the number of
active events over a specific time period.
|
| SoftwarePwmOutputDevice |
Generate a very poor approximation of a PWM signal - use at your own risk!
All timing is in milliseconds hence it is strongly recommend to use a
frequency of 50Hz to minimise integer rounding errors.
|
| SpiClockMode |
SPI clock mode determines the clock polarity and phase with respect to
data.
|
| SpiConstants | |
| SpiDevice |
Serial Peripheral Interface device
|
| SpiDevice.Builder |
I2C device builder.
|
| SpiDeviceFactoryInterface | |
| SpiDeviceInterface | |
| SSD1306 |
128x64 Dot Matrix OLED/PLED Segment/Common Driver (128 segments and 64 commons).
Segment = column (x), Common = row (y) |
| SSD1331 |
Encapsulates the serial interface to the 16-bit colour (5-6-5 RGB) SSD1331
96x64 OLED display hardware.
|
| SSD1351 |
Encapsulates the serial interface to the 16-bit (5-6-5 RGB) and 18-bit
(6-6-6 RGB) colour SSD1351 128x128 OLED display hardware.
|
| SsdOled | |
| ST7735 | |
| ST77xx | |
| StringUtil | |
| SysFsAnalogInputDevice | |
| SysFsDigitalInputDevice |
Pure Java implementation using
the sysfs
(/sys/class/gpio) kernel module.
|
| SysFsDigitalInputOutputDevice | |
| SysFsDigitalOutputDevice | |
| SysFsGpioUtil | |
| SysFsPwmOutputDevice | |
| SysFsPwmOutputDevice.Polarity | |
| TapEvent | |
| TapEvent.TapAxisType | |
| TapEvent.TapType | |
| TapListener | |
| TB6612FNGDualMotorDriver |
Dual bi-directional motor controlled by a single PWM pin and separate forward / backward GPIO pins
Toshiba TB6612FNG Dual Motor Driver such as this one from Pololu: https://www.pololu.com/product/713
|
| TB6612FNGMotor |
Bi-directional motor controlled by a single PWM pin and separate forward / backward GPIO pins
Toshiba TB6612FNG Dual Motor Driver such as @see this one from Pololu
Turn forward, set pin 1 to HIGH, pin 2 to LOW, and PWM to >0
Turn backward, set pin 1 to LOW, pin 2 to HIGH, PWM to >0
|
| TCS3200 |
This class reads RGB values from a TCS3200 colour sensor.
|
| TCS3200.Filter | |
| TCS3200.Frequency | |
| TemperatureUtil | |
| ThermometerInterface | |
| TinkerBoardBoardInfoProvider | |
| TinkerBoardBoardInfoProvider.TinkerBoardBoardInfo | |
| TinkerBoardMmapGpio | |
| TMP36 |
Support for reading temperature values from a
TMP36 Temperature Sensor by Analog Devices
|
| TSL2561 | |
| TSL2561.TSL2561Package | |
| UnknownBoardInfo |
Attempt to handle generic boards that don't have explicit support within
diozero
|
| UsbInfo | |
| VL6180 |
Datasheet: https://www.st.com/resource/en/datasheet/vl6180.pdf
|
| VoidConsumer |
Represents an operation that accepts a no-valued argument and returns no
result.
|
| W1ThermSensor | |
| W1ThermSensor.Type | |
| WaitableDigitalInputDevice |
Represents a digital input device with distinct waitable states (active / inactive).
|