Configuration key. More...

Inheritance diagram for sigrok.core.classes.ConfigKey:

Public Member Functions
def	data_type (self)
	Data type used for this configuration key. More...

def	description (self)
	Description of this configuration key. More...

def	parse_string (self, value)
	Parse a string argument into the appropriate type for this key. More...

Public Member Functions inherited from sigrok.core.classes.EnumValueConfigKey
def	id (self)
	The integer constant associated with this value. More...

def	name (self)
	The name associated with this value. More...

Static Public Attributes
tuple	get_by_identifier

	LOGIC_ANALYZER

	OSCILLOSCOPE
	The device can act as an oscilloscope. More...

	MULTIMETER
	The device can act as a multimeter. More...

	DEMO_DEV
	The device is a demo device. More...

	SOUNDLEVELMETER
	The device can act as a sound level meter. More...

	THERMOMETER
	The device can measure temperature. More...

	HYGROMETER
	The device can measure humidity. More...

	ENERGYMETER
	The device can measure energy consumption. More...

	DEMODULATOR
	The device can act as a signal demodulator. More...

	POWER_SUPPLY
	The device can act as a programmable power supply. More...

	LCRMETER
	The device can act as an LCR meter. More...

	ELECTRONIC_LOAD
	The device can act as an electronic load. More...

	SCALE
	The device can act as a scale. More...

	CONN
	Specification on how to connect to a device. More...

	SERIALCOMM
	Serial communication specification, in the form: More...

	MODBUSADDR
	Modbus slave address specification. More...

	SAMPLERATE
	The device supports setting its samplerate, in Hz. More...

	CAPTURE_RATIO
	The device supports setting a pre/post-trigger capture ratio. More...

	PATTERN_MODE
	The device supports setting a pattern (pattern generator mode). More...

	RLE
	The device supports run-length encoding (RLE). More...

	TRIGGER_SLOPE
	The device supports setting trigger slope. More...

	AVERAGING
	The device supports averaging. More...

	AVG_SAMPLES
	The device supports setting number of samples to be averaged over. More...

	TRIGGER_SOURCE
	Trigger source. More...

	HORIZ_TRIGGERPOS
	Horizontal trigger position. More...

	BUFFERSIZE
	Buffer size. More...

	TIMEBASE
	Time base. More...

	FILTER
	Filter. More...

	VDIV
	Volts/div. More...

	COUPLING
	Coupling. More...

	TRIGGER_MATCH
	Trigger matches. More...

	SAMPLE_INTERVAL
	The device supports setting its sample interval, in ms. More...

	NUM_HDIV
	Number of horizontal divisions, as related to SR_CONF_TIMEBASE. More...

	NUM_VDIV
	Number of vertical divisions, as related to SR_CONF_VDIV. More...

	SPL_WEIGHT_FREQ
	Sound pressure level frequency weighting. More...

	SPL_WEIGHT_TIME
	Sound pressure level time weighting. More...

	SPL_MEASUREMENT_RANGE
	Sound pressure level measurement range. More...

	HOLD_MAX
	Max hold mode. More...

	HOLD_MIN
	Min hold mode. More...

	VOLTAGE_THRESHOLD
	Logic low-high threshold range. More...

	EXTERNAL_CLOCK
	The device supports using an external clock. More...

	SWAP
	The device supports swapping channels. More...

	CENTER_FREQUENCY
	Center frequency. More...

	NUM_LOGIC_CHANNELS
	The device supports setting the number of logic channels. More...

	NUM_ANALOG_CHANNELS
	The device supports setting the number of analog channels. More...

	VOLTAGE
	Current voltage. More...

	VOLTAGE_TARGET
	Maximum target voltage. More...

	CURRENT
	Current current. More...

	CURRENT_LIMIT
	Current limit. More...

	ENABLED
	Enabling/disabling channel. More...

	CHANNEL_CONFIG
	Channel configuration. More...

	OVER_VOLTAGE_PROTECTION_ENABLED
	Over-voltage protection (OVP) feature. More...

	OVER_VOLTAGE_PROTECTION_ACTIVE
	Over-voltage protection (OVP) active. More...

	OVER_VOLTAGE_PROTECTION_THRESHOLD
	Over-voltage protection (OVP) threshold. More...

	OVER_CURRENT_PROTECTION_ENABLED
	Over-current protection (OCP) feature. More...

	OVER_CURRENT_PROTECTION_ACTIVE
	Over-current protection (OCP) active. More...

	OVER_CURRENT_PROTECTION_THRESHOLD
	Over-current protection (OCP) threshold. More...

	CLOCK_EDGE
	Choice of clock edge for external clock ("r" or "f"). More...

	AMPLITUDE
	Amplitude of a source without strictly-defined MQ. More...

	REGULATION
	Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulated. More...

	OVER_TEMPERATURE_PROTECTION
	Over-temperature protection (OTP) More...

	OUTPUT_FREQUENCY
	Output frequency in Hz. More...

	OUTPUT_FREQUENCY_TARGET
	Output frequency target in Hz. More...

	MEASURED_QUANTITY
	Measured quantity. More...

	EQUIV_CIRCUIT_MODEL
	Equivalent circuit model. More...

	OVER_TEMPERATURE_PROTECTION_ACTIVE
	Over-temperature protection (OTP) active. More...

	SESSIONFILE
	Session filename. More...

	CAPTUREFILE
	The device supports specifying a capturefile to inject. More...

	CAPTURE_UNITSIZE
	The device supports specifying the capturefile unit size. More...

	POWER_OFF
	Power off the device. More...

	DATA_SOURCE
	Data source for acquisition. More...

	PROBE_FACTOR
	The device supports setting a probe factor. More...

	LIMIT_MSEC
	The device supports setting a sample time limit (how long the sample acquisition should run, in ms). More...

	LIMIT_SAMPLES
	The device supports setting a sample number limit (how many samples should be acquired). More...

	LIMIT_FRAMES
	The device supports setting a frame limit (how many frames should be acquired). More...

	CONTINUOUS
	The device supports continuous sampling. More...

	DATALOG
	The device has internal storage, into which data is logged. More...

	DEVICE_MODE
	Device mode for multi-function devices. More...

	TEST_MODE
	Self test mode. More...

tuple	id

tuple	name

tuple	identifier

Static Public Attributes inherited from sigrok.core.classes.EnumValueConfigKey
tuple	get

Detailed Description

Configuration key.

Member Function Documentation

def sigrok.core.classes.ConfigKey.data_type ( self )

Data type used for this configuration key.

def sigrok.core.classes.ConfigKey.description ( self )

Description of this configuration key.

def sigrok.core.classes.ConfigKey.parse_string	(	self,
		value
	)

Parse a string argument into the appropriate type for this key.

Member Data Documentation

sigrok.core.classes.ConfigKey.OSCILLOSCOPE

static

The device can act as an oscilloscope.

sigrok.core.classes.ConfigKey.MULTIMETER

static

The device can act as a multimeter.

sigrok.core.classes.ConfigKey.DEMO_DEV

static

The device is a demo device.

sigrok.core.classes.ConfigKey.SOUNDLEVELMETER

static

The device can act as a sound level meter.

sigrok.core.classes.ConfigKey.THERMOMETER

static

The device can measure temperature.

sigrok.core.classes.ConfigKey.HYGROMETER

static

The device can measure humidity.

sigrok.core.classes.ConfigKey.ENERGYMETER

static

The device can measure energy consumption.

sigrok.core.classes.ConfigKey.DEMODULATOR

static

The device can act as a signal demodulator.

sigrok.core.classes.ConfigKey.POWER_SUPPLY

static

The device can act as a programmable power supply.

sigrok.core.classes.ConfigKey.LCRMETER

static

The device can act as an LCR meter.

sigrok.core.classes.ConfigKey.ELECTRONIC_LOAD

static

The device can act as an electronic load.

sigrok.core.classes.ConfigKey.SCALE

static

The device can act as a scale.

sigrok.core.classes.ConfigKey.CONN

static

Specification on how to connect to a device.

sigrok.core.classes.ConfigKey.SERIALCOMM

static

Serial communication specification, in the form:

sigrok.core.classes.ConfigKey.MODBUSADDR

static

Modbus slave address specification.

sigrok.core.classes.ConfigKey.SAMPLERATE

static

The device supports setting its samplerate, in Hz.

sigrok.core.classes.ConfigKey.CAPTURE_RATIO

static

The device supports setting a pre/post-trigger capture ratio.

sigrok.core.classes.ConfigKey.PATTERN_MODE

static

The device supports setting a pattern (pattern generator mode).

sigrok.core.classes.ConfigKey.RLE

static

The device supports run-length encoding (RLE).

sigrok.core.classes.ConfigKey.TRIGGER_SLOPE

static

The device supports setting trigger slope.

sigrok.core.classes.ConfigKey.AVERAGING

static

The device supports averaging.

sigrok.core.classes.ConfigKey.AVG_SAMPLES

static

The device supports setting number of samples to be averaged over.

sigrok.core.classes.ConfigKey.TRIGGER_SOURCE

static

Trigger source.

sigrok.core.classes.ConfigKey.HORIZ_TRIGGERPOS

static

Horizontal trigger position.

sigrok.core.classes.ConfigKey.BUFFERSIZE

static

Buffer size.

sigrok.core.classes.ConfigKey.TIMEBASE

static

Time base.

sigrok.core.classes.ConfigKey.FILTER

static

Filter.

sigrok.core.classes.ConfigKey.VDIV

static

Volts/div.

sigrok.core.classes.ConfigKey.COUPLING

static

Coupling.

sigrok.core.classes.ConfigKey.TRIGGER_MATCH

static

Trigger matches.

sigrok.core.classes.ConfigKey.SAMPLE_INTERVAL

static

The device supports setting its sample interval, in ms.

sigrok.core.classes.ConfigKey.NUM_HDIV

static

Number of horizontal divisions, as related to SR_CONF_TIMEBASE.

sigrok.core.classes.ConfigKey.NUM_VDIV

static

Number of vertical divisions, as related to SR_CONF_VDIV.

sigrok.core.classes.ConfigKey.SPL_WEIGHT_FREQ

static

Sound pressure level frequency weighting.

sigrok.core.classes.ConfigKey.SPL_WEIGHT_TIME

static

Sound pressure level time weighting.

sigrok.core.classes.ConfigKey.SPL_MEASUREMENT_RANGE

static

Sound pressure level measurement range.

sigrok.core.classes.ConfigKey.HOLD_MAX

static

Max hold mode.

sigrok.core.classes.ConfigKey.HOLD_MIN

static

Min hold mode.

sigrok.core.classes.ConfigKey.VOLTAGE_THRESHOLD

static

Logic low-high threshold range.

sigrok.core.classes.ConfigKey.EXTERNAL_CLOCK

static

The device supports using an external clock.

sigrok.core.classes.ConfigKey.SWAP

static

The device supports swapping channels.

sigrok.core.classes.ConfigKey.CENTER_FREQUENCY

static

Center frequency.

sigrok.core.classes.ConfigKey.NUM_LOGIC_CHANNELS

static

The device supports setting the number of logic channels.

sigrok.core.classes.ConfigKey.NUM_ANALOG_CHANNELS

static

The device supports setting the number of analog channels.

sigrok.core.classes.ConfigKey.VOLTAGE

static

Current voltage.

sigrok.core.classes.ConfigKey.VOLTAGE_TARGET

static

Maximum target voltage.

sigrok.core.classes.ConfigKey.CURRENT

static

Current current.

sigrok.core.classes.ConfigKey.CURRENT_LIMIT

static

Current limit.

sigrok.core.classes.ConfigKey.ENABLED

static

Enabling/disabling channel.

sigrok.core.classes.ConfigKey.CHANNEL_CONFIG

static

Channel configuration.

sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_ENABLED

static

Over-voltage protection (OVP) feature.

sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_ACTIVE

static

Over-voltage protection (OVP) active.

sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_THRESHOLD

static

Over-voltage protection (OVP) threshold.

sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_ENABLED

static

Over-current protection (OCP) feature.

sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_ACTIVE

static

Over-current protection (OCP) active.

sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_THRESHOLD

static

Over-current protection (OCP) threshold.

sigrok.core.classes.ConfigKey.CLOCK_EDGE

static

Choice of clock edge for external clock ("r" or "f").

sigrok.core.classes.ConfigKey.AMPLITUDE

static

Amplitude of a source without strictly-defined MQ.

sigrok.core.classes.ConfigKey.REGULATION

static

Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulated.

sigrok.core.classes.ConfigKey.OVER_TEMPERATURE_PROTECTION

static

Over-temperature protection (OTP)

sigrok.core.classes.ConfigKey.OUTPUT_FREQUENCY

static

Output frequency in Hz.

sigrok.core.classes.ConfigKey.OUTPUT_FREQUENCY_TARGET

static

Output frequency target in Hz.

sigrok.core.classes.ConfigKey.MEASURED_QUANTITY

static

Measured quantity.

sigrok.core.classes.ConfigKey.EQUIV_CIRCUIT_MODEL

static

Equivalent circuit model.

sigrok.core.classes.ConfigKey.OVER_TEMPERATURE_PROTECTION_ACTIVE

static

Over-temperature protection (OTP) active.

sigrok.core.classes.ConfigKey.SESSIONFILE

static

Session filename.

sigrok.core.classes.ConfigKey.CAPTUREFILE

static

The device supports specifying a capturefile to inject.

sigrok.core.classes.ConfigKey.CAPTURE_UNITSIZE

static

The device supports specifying the capturefile unit size.

sigrok.core.classes.ConfigKey.POWER_OFF

static

Power off the device.

sigrok.core.classes.ConfigKey.DATA_SOURCE

static

Data source for acquisition.

sigrok.core.classes.ConfigKey.PROBE_FACTOR

static

The device supports setting a probe factor.

sigrok.core.classes.ConfigKey.LIMIT_MSEC

static

The device supports setting a sample time limit (how long the sample acquisition should run, in ms).

sigrok.core.classes.ConfigKey.LIMIT_SAMPLES

static

The device supports setting a sample number limit (how many samples should be acquired).

sigrok.core.classes.ConfigKey.LIMIT_FRAMES

static

The device supports setting a frame limit (how many frames should be acquired).

sigrok.core.classes.ConfigKey.CONTINUOUS

static

The device supports continuous sampling.

sigrok.core.classes.ConfigKey.DATALOG

static

The device has internal storage, into which data is logged.

sigrok.core.classes.ConfigKey.DEVICE_MODE

static

Device mode for multi-function devices.

sigrok.core.classes.ConfigKey.TEST_MODE

static

Self test mode.

The documentation for this class was generated from the following file:

sigrok/core/classes.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation