Device datapoint reference¶

Devices provide configurable items, sensor items and/or actuator items. Configurable items can be given values in the peripheral .ini files. Sensor and actuator items are operated on through the peripheral interface and can be either read out (sensors), or written to (actuators).

For configuration items only the device-specific items are shown.

AD533x (parts `ad5337`, `ad5338`, `ad5339`)¶

AD5337/AD5338/AD5339 8-/10-/12-bit dual DAC

Configurable items¶

key	type	default	unit	description
ref_voltage	float	2.048	V	Reference voltage

Sensor items¶

key	type	unit	description
powerdown_a	bool		Powerdown state of DAC channel A
powerdown_b	bool		Powerdown state of DAC channel B
voltage_a	float	V	Output voltage channel A
voltage_b	float	V	Output voltage channel B

Actuator items¶

key	type	default	unit	description
powerdown_a	bool	True		Power down DAC channel A
powerdown_b	bool	True		Power down DAC channel B
voltage_a	float	0.0	V	Set output voltage channel A
voltage_b	float	0.0	V	Set output voltage channel B

AD799x (parts `ad7991`, `ad7995`, `ad7999`)¶

AD7991/AD7995/AD7999 12-/10-/8-bit 4- or 3-chan ADC

Configurable items¶

key	type	default	unit	description
in3_is_ref	bool	True		If true, will use IN3 as reference voltage; otherwise VDD
ref_voltage	float	2.048	V	Reference voltage

Sensor items¶

key	type	unit	description
voltage_0	float	V	Voltage measured on Vin0
voltage_1	float	V	Voltage measured on Vin1
voltage_2	float	V	Voltage measured on Vin2
voltage_3	float	V	Voltage measured on Vin3 (if not used as Vref)

BME280 (part `bme280`)¶

Bosch BME280 humidity/pressure/temperature sensor

Sensor items¶

key	type	unit	description
humidity	float	%RH	Humidity
pressure	float	hPa	Pressure
temperature	float	degC	Temperature

Display (part `display`)¶

Display module connected to the SPIDR4

DS125BR800 (part `ds125br800`)¶

12.5-Gbps 8-channel repeater with input equalization

Configurable items¶

key	type	default	unit	description
datafile	string			Data-file to load, in addressable data format; automatically reloaded when overwritten

Sensor items¶

key	type	default	unit	description
chans_sig_detect	int			Bit per channel, whether or not a channel is detected

Actuator items¶

key	type	default	unit	description
chans_powerdown	int	255		Bit per channel, when set channel is powered down

Firefly (part `firefly`)¶

Electrical to optical transmitter

Configurable items¶

key	type	default	unit	description
tx_invert	int	0		Bitmask of channels to invert 11..0

Sensor items¶

key	type	unit	description
laser_fault	int		Laser fault status
temp	int	degC	Internal temperature
temp_alarm	bool		Temperature alarm
tx_enabled	int		Transmit channel enabled status (12 bits)
vcc	float	V	Module voltage
vcc_alarm	bool		VCC alarm

Actuator items¶

key	type	default	unit	description
tx_disable	int	4095		Transmit disable bits for 12 channels, also disables laser

INA2xx (parts `ina219`, `ina220`)¶

INA219/220 current/power monitor

Configurable items¶

key	type	default	unit	description
gain	int	1		PGA gain as x/N, either 1, /2, /4 or /8 (shunt v range = 40, 80, 160 and 320 mV)
max_a	float	5.0	A	Maximum expected current: too high will cause loss or resolution, too low can cause overflow
overs	int	128		Oversampling
shunt_r	float	10.0	mOhm	Shunt resistor value in milli-Ohm

Sensor items¶

key	type	unit	description
bus_v	float	V	Bus voltage
current	float	A	Current
power	float	W	Power
shunt_v	float	mV	Voltage over the shunt

LTC2495 (part `ltc2495`)¶

Flexible driver for the LTC2495 16-bit 8-/16-chan Delta-Sigma ADC. It allows detailed configuration of the device, and assignment of custom names to channels

MCP3x21 (parts `mcp3021`, `mcp3221`)¶

MCP3021/3221 single-channel 10-/12-bit ADC

Configurable items¶

key	type	default	unit	description
ref_volt	float	3.3	V	Reference voltage (see ref_voltage)
ref_voltage	float	3.3	V	Reference voltage

Sensor items¶

key	type	default	unit	description
volt	float		V	Voltage measured (see voltage)
voltage	float		V	Voltage measured

MPL3115A2 (part `mpl3115a2`)¶

MPL3115A2 precision altimeter

Sensor items¶

key	type	default	unit	description
pressure	float		hPa	Pressure
temperature	float		degC	Temperature

MS5637 (part `ms5637`)¶

MS5637 pressure sensor

Configurable items¶

key	type	default	unit	description
ovs	int	1024		Oversampling (256, 512, 1024, 2048, 4096 or 8192)

Sensor items¶

key	type	default	unit	description
pressure	float		hPa	Pressure
temperature	float		degC	Temperature

PCA9548 (part `pca9548`)¶

PCA9548A 8-channel I2C-bus switch with reset

Configurable items¶

key	type	default	unit	description
reset_pin	int			Reset pin

Actuator items¶

key	type	default	unit	description
select	int			Which mux to select (0..7, or -1 to disable all)

SFPPlus (part `sfp+`)¶

Generic SFP+ (SFF-8472 compatible) driver

Sensor items¶

key	type	unit	description
rx_power	float	mW	Received power
temperature	float	degC	Module temperature
tx_bias	float	A	Transmission bias
tx_power	float	mW	Transmitted power

Actuator items¶

key	type	default	unit	description
tx_disable	bool	True		Transmission disable

SHT3x (part `sht3x`)¶

Sensirion humidity and temperature sensor

Sensor items¶

key	type	default	unit	description
humidity	float		%RH	Humidity
temperature	float		degC	Temperature

SI534x (parts `si5344`, `si5346`)¶

SI534x clock generator

Configurable items¶

key	type	default	unit	description
cfgfile	string	si5344clock.csv		Configuration file, exported by clock-builder (no header)

Sensor items¶

key	type	description
los	int	Loss of signal for channels 0..3, where each bit is a channel number
losxaxb	bool	There is a problem locking to the XAXB input signal.
oof	int	Out of frequency for channels 0..3, where each bit is a channel number
sysincal	bool	The device is calibrating.
xaxb_err	bool	There is no signal at the XAXB pins.

SI7021 (part `si7021`)¶

Silicon Labs Si7021 temperature/humidity sensor

Sensor items¶

key	type	default	unit	description
humidity	float		%RH	Humidity
temperature	float		degC	Temperature

System (part `system`)¶

System device provided board information

Sensor items¶

key	type	default	unit	description
fan_pwm	int			PWM control code
fan_speed	int		rpm	Fan rotation speed

TCA9534 (part `tca9534`)¶

TCA9534A 8-bit I/O expander

Configurable items¶

key	type	default	unit	description
direction_out	int	0		I/O direction 8 bits: output=1, input=0
output	int	0		8-bit output port

Sensor items¶

key	type	description
direction_out	int	I/O direction 8 bits: output=1, input=0
input	int	8-bit input port
output	int	8-bit output port

Actuator items¶

key	type	description
direction_out	int	I/O direction 8 bits: output=1, input=0
out_0	int	Output pin 0
out_1	int	Output pin 1
out_2	int	Output pin 2
out_3	int	Output pin 3
out_4	int	Output pin 4
out_5	int	Output pin 5
out_6	int	Output pin 6
out_7	int	Output pin 7
output	int	8-bit output port

TMP102 (part `tmp102`)¶

TMP102 temperature sensor

Configurable items¶

key	type	default	unit	description
alert_off	float	75.0	degC	Temperature below which the alert condition turns off (default=75)
alert_on	float	80.0	degC	Temperature above which the alert condition turns on (default=80)

Sensor items¶

key	type	default	unit	description
alert	bool			Over-temperature condition detected
temperature	float		degC	Last converted temperature

TMP117 (part `tmp117`)¶

TMP117 temperature sensor

Configurable items¶

key	type	default	unit	description
alert_off	float	75.0	degC	Temperature below which the alert condition turns off (default=75)
alert_on	float	80.0	degC	Temperature above which the alert condition turns on (default=80)

Sensor items¶

key	type	default	unit	description
alert	bool			Over-temperature condition detected
temperature	float		degC	Last converted temperature

XADC (part `xadc`)¶

Provides various sensor readings from the Xilinx XADC block

Sensor items¶

key	type	unit	description
temperature	float	degC	Temperature
vcc_bram	float	mV	BRAM Vcc
vcc_int	float	mV	INT Vcc

Device datapoint reference¶

AD533x (parts ad5337, ad5338, ad5339)¶

Configurable items¶

Sensor items¶

Actuator items¶

AD799x (parts ad7991, ad7995, ad7999)¶

Configurable items¶

Sensor items¶

BME280 (part bme280)¶

Sensor items¶

Display (part display)¶

DS125BR800 (part ds125br800)¶

Configurable items¶

Sensor items¶

Actuator items¶

Firefly (part firefly)¶

Configurable items¶

Sensor items¶

Actuator items¶

INA2xx (parts ina219, ina220)¶

Configurable items¶

Sensor items¶

LTC2495 (part ltc2495)¶

MCP3x21 (parts mcp3021, mcp3221)¶

Configurable items¶

Sensor items¶

MPL3115A2 (part mpl3115a2)¶

Sensor items¶

MS5637 (part ms5637)¶

Configurable items¶

Sensor items¶

PCA9548 (part pca9548)¶

Configurable items¶

Actuator items¶

SFPPlus (part sfp+)¶

Sensor items¶

Actuator items¶

SHT3x (part sht3x)¶

Sensor items¶

SI534x (parts si5344, si5346)¶

Configurable items¶

Sensor items¶

SI7021 (part si7021)¶

Sensor items¶

System (part system)¶

Sensor items¶

TCA9534 (part tca9534)¶

Configurable items¶

Sensor items¶

Actuator items¶

TMP102 (part tmp102)¶

Configurable items¶

Sensor items¶

TMP117 (part tmp117)¶

Configurable items¶

Sensor items¶

XADC (part xadc)¶

Sensor items¶

AD533x (parts `ad5337`, `ad5338`, `ad5339`)¶

AD799x (parts `ad7991`, `ad7995`, `ad7999`)¶

BME280 (part `bme280`)¶

Display (part `display`)¶

DS125BR800 (part `ds125br800`)¶

Firefly (part `firefly`)¶

INA2xx (parts `ina219`, `ina220`)¶

LTC2495 (part `ltc2495`)¶

MCP3x21 (parts `mcp3021`, `mcp3221`)¶

MPL3115A2 (part `mpl3115a2`)¶

MS5637 (part `ms5637`)¶

PCA9548 (part `pca9548`)¶

SFPPlus (part `sfp+`)¶

SHT3x (part `sht3x`)¶

SI534x (parts `si5344`, `si5346`)¶

SI7021 (part `si7021`)¶

System (part `system`)¶

TCA9534 (part `tca9534`)¶

TMP102 (part `tmp102`)¶

TMP117 (part `tmp117`)¶

XADC (part `xadc`)¶