sigrok-java  0.4.0
Java bindings for libsigrok
Public Member Functions | Static Public Attributes | List of all members
org.sigrok.core.classes.ConfigKey Class Reference

Configuration key. More...

+ Inheritance diagram for org.sigrok.core.classes.ConfigKey:

Public Member Functions

DataType data_type ()
 Data type used for this configuration key. More...
 
String identifier ()
 String identifier for this configuration key, suitable for CLI use. More...
 
String description ()
 Description of this configuration key. More...
 
Variant parse_string (String value)
 Parse a string argument into the appropriate type for this key. More...
 
- Public Member Functions inherited from org.sigrok.core.classes.EnumValueConfigKey
int id ()
 The integer constant associated with this value. More...
 
String name ()
 The name associated with this value. More...
 

Static Public Attributes

static final ConfigKey LOGIC_ANALYZER
 The device can act as logic analyzer. More...
 
static final ConfigKey OSCILLOSCOPE
 The device can act as an oscilloscope. More...
 
static final ConfigKey MULTIMETER
 The device can act as a multimeter. More...
 
static final ConfigKey DEMO_DEV
 The device is a demo device. More...
 
static final ConfigKey SOUNDLEVELMETER
 The device can act as a sound level meter. More...
 
static final ConfigKey THERMOMETER
 The device can measure temperature. More...
 
static final ConfigKey HYGROMETER
 The device can measure humidity. More...
 
static final ConfigKey ENERGYMETER
 The device can measure energy consumption. More...
 
static final ConfigKey DEMODULATOR
 The device can act as a signal demodulator. More...
 
static final ConfigKey POWER_SUPPLY
 The device can act as a programmable power supply. More...
 
static final ConfigKey LCRMETER
 The device can act as an LCR meter. More...
 
static final ConfigKey ELECTRONIC_LOAD
 The device can act as an electronic load. More...
 
static final ConfigKey SCALE
 The device can act as a scale. More...
 
static final ConfigKey CONN
 Specification on how to connect to a device. More...
 
static final ConfigKey SERIALCOMM
 Serial communication specification, in the form: More...
 
static final ConfigKey MODBUSADDR
 Modbus slave address specification. More...
 
static final ConfigKey SAMPLERATE
 The device supports setting its samplerate, in Hz. More...
 
static final ConfigKey CAPTURE_RATIO
 The device supports setting a pre/post-trigger capture ratio. More...
 
static final ConfigKey PATTERN_MODE
 The device supports setting a pattern (pattern generator mode). More...
 
static final ConfigKey RLE
 The device supports run-length encoding (RLE). More...
 
static final ConfigKey TRIGGER_SLOPE
 The device supports setting trigger slope. More...
 
static final ConfigKey AVERAGING
 The device supports averaging. More...
 
static final ConfigKey AVG_SAMPLES
 The device supports setting number of samples to be averaged over. More...
 
static final ConfigKey TRIGGER_SOURCE
 Trigger source. More...
 
static final ConfigKey HORIZ_TRIGGERPOS
 Horizontal trigger position. More...
 
static final ConfigKey BUFFERSIZE
 Buffer size. More...
 
static final ConfigKey TIMEBASE
 Time base. More...
 
static final ConfigKey FILTER
 Filter. More...
 
static final ConfigKey VDIV
 Volts/div. More...
 
static final ConfigKey COUPLING
 Coupling. More...
 
static final ConfigKey TRIGGER_MATCH
 Trigger matches. More...
 
static final ConfigKey SAMPLE_INTERVAL
 The device supports setting its sample interval, in ms. More...
 
static final ConfigKey NUM_HDIV
 Number of horizontal divisions, as related to SR_CONF_TIMEBASE. More...
 
static final ConfigKey NUM_VDIV
 Number of vertical divisions, as related to SR_CONF_VDIV. More...
 
static final ConfigKey SPL_WEIGHT_FREQ
 Sound pressure level frequency weighting. More...
 
static final ConfigKey SPL_WEIGHT_TIME
 Sound pressure level time weighting. More...
 
static final ConfigKey SPL_MEASUREMENT_RANGE
 Sound pressure level measurement range. More...
 
static final ConfigKey HOLD_MAX
 Max hold mode. More...
 
static final ConfigKey HOLD_MIN
 Min hold mode. More...
 
static final ConfigKey VOLTAGE_THRESHOLD
 Logic low-high threshold range. More...
 
static final ConfigKey EXTERNAL_CLOCK
 The device supports using an external clock. More...
 
static final ConfigKey SWAP
 The device supports swapping channels. More...
 
static final ConfigKey CENTER_FREQUENCY
 Center frequency. More...
 
static final ConfigKey NUM_LOGIC_CHANNELS
 The device supports setting the number of logic channels. More...
 
static final ConfigKey NUM_ANALOG_CHANNELS
 The device supports setting the number of analog channels. More...
 
static final ConfigKey VOLTAGE
 Current voltage. More...
 
static final ConfigKey VOLTAGE_TARGET
 Maximum target voltage. More...
 
static final ConfigKey CURRENT
 Current current. More...
 
static final ConfigKey CURRENT_LIMIT
 Current limit. More...
 
static final ConfigKey ENABLED
 Enabling/disabling channel. More...
 
static final ConfigKey CHANNEL_CONFIG
 Channel configuration. More...
 
static final ConfigKey OVER_VOLTAGE_PROTECTION_ENABLED
 Over-voltage protection (OVP) feature. More...
 
static final ConfigKey OVER_VOLTAGE_PROTECTION_ACTIVE
 Over-voltage protection (OVP) active. More...
 
static final ConfigKey OVER_VOLTAGE_PROTECTION_THRESHOLD
 Over-voltage protection (OVP) threshold. More...
 
static final ConfigKey OVER_CURRENT_PROTECTION_ENABLED
 Over-current protection (OCP) feature. More...
 
static final ConfigKey OVER_CURRENT_PROTECTION_ACTIVE
 Over-current protection (OCP) active. More...
 
static final ConfigKey OVER_CURRENT_PROTECTION_THRESHOLD
 Over-current protection (OCP) threshold. More...
 
static final ConfigKey CLOCK_EDGE
 Choice of clock edge for external clock ("r" or "f"). More...
 
static final ConfigKey AMPLITUDE
 Amplitude of a source without strictly-defined MQ. More...
 
static final ConfigKey REGULATION
 Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulated. More...
 
static final ConfigKey OVER_TEMPERATURE_PROTECTION
 Over-temperature protection (OTP) More...
 
static final ConfigKey OUTPUT_FREQUENCY
 Output frequency in Hz. More...
 
static final ConfigKey OUTPUT_FREQUENCY_TARGET
 Output frequency target in Hz. More...
 
static final ConfigKey MEASURED_QUANTITY
 Measured quantity. More...
 
static final ConfigKey EQUIV_CIRCUIT_MODEL
 Equivalent circuit model. More...
 
static final ConfigKey OVER_TEMPERATURE_PROTECTION_ACTIVE
 Over-temperature protection (OTP) active. More...
 
static final ConfigKey SESSIONFILE
 Session filename. More...
 
static final ConfigKey CAPTUREFILE
 The device supports specifying a capturefile to inject. More...
 
static final ConfigKey CAPTURE_UNITSIZE
 The device supports specifying the capturefile unit size. More...
 
static final ConfigKey POWER_OFF
 Power off the device. More...
 
static final ConfigKey DATA_SOURCE
 Data source for acquisition. More...
 
static final ConfigKey PROBE_FACTOR
 The device supports setting a probe factor. More...
 
static final ConfigKey LIMIT_MSEC
 The device supports setting a sample time limit (how long the sample acquisition should run, in ms). More...
 
static final ConfigKey LIMIT_SAMPLES
 The device supports setting a sample number limit (how many samples should be acquired). More...
 
static final ConfigKey LIMIT_FRAMES
 The device supports setting a frame limit (how many frames should be acquired). More...
 
static final ConfigKey CONTINUOUS
 The device supports continuous sampling. More...
 
static final ConfigKey DATALOG
 The device has internal storage, into which data is logged. More...
 
static final ConfigKey DEVICE_MODE
 Device mode for multi-function devices. More...
 
static final ConfigKey TEST_MODE
 Self test mode. More...
 

Detailed Description

Configuration key.

Member Function Documentation

DataType org.sigrok.core.classes.ConfigKey.data_type ( )

Data type used for this configuration key.

String org.sigrok.core.classes.ConfigKey.identifier ( )

String identifier for this configuration key, suitable for CLI use.

String org.sigrok.core.classes.ConfigKey.description ( )

Description of this configuration key.

Variant org.sigrok.core.classes.ConfigKey.parse_string ( String  value)

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

Member Data Documentation

final ConfigKey org.sigrok.core.classes.ConfigKey.LOGIC_ANALYZER
static

The device can act as logic analyzer.

final ConfigKey org.sigrok.core.classes.ConfigKey.OSCILLOSCOPE
static

The device can act as an oscilloscope.

final ConfigKey org.sigrok.core.classes.ConfigKey.MULTIMETER
static

The device can act as a multimeter.

final ConfigKey org.sigrok.core.classes.ConfigKey.DEMO_DEV
static

The device is a demo device.

final ConfigKey org.sigrok.core.classes.ConfigKey.SOUNDLEVELMETER
static

The device can act as a sound level meter.

final ConfigKey org.sigrok.core.classes.ConfigKey.THERMOMETER
static

The device can measure temperature.

final ConfigKey org.sigrok.core.classes.ConfigKey.HYGROMETER
static

The device can measure humidity.

final ConfigKey org.sigrok.core.classes.ConfigKey.ENERGYMETER
static

The device can measure energy consumption.

final ConfigKey org.sigrok.core.classes.ConfigKey.DEMODULATOR
static

The device can act as a signal demodulator.

final ConfigKey org.sigrok.core.classes.ConfigKey.POWER_SUPPLY
static

The device can act as a programmable power supply.

final ConfigKey org.sigrok.core.classes.ConfigKey.LCRMETER
static

The device can act as an LCR meter.

final ConfigKey org.sigrok.core.classes.ConfigKey.ELECTRONIC_LOAD
static

The device can act as an electronic load.

final ConfigKey org.sigrok.core.classes.ConfigKey.SCALE
static

The device can act as a scale.

final ConfigKey org.sigrok.core.classes.ConfigKey.CONN
static

Specification on how to connect to a device.

final ConfigKey org.sigrok.core.classes.ConfigKey.SERIALCOMM
static

Serial communication specification, in the form:

final ConfigKey org.sigrok.core.classes.ConfigKey.MODBUSADDR
static

Modbus slave address specification.

final ConfigKey org.sigrok.core.classes.ConfigKey.SAMPLERATE
static

The device supports setting its samplerate, in Hz.

final ConfigKey org.sigrok.core.classes.ConfigKey.CAPTURE_RATIO
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.PATTERN_MODE
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.RLE
static

The device supports run-length encoding (RLE).

final ConfigKey org.sigrok.core.classes.ConfigKey.TRIGGER_SLOPE
static

The device supports setting trigger slope.

final ConfigKey org.sigrok.core.classes.ConfigKey.AVERAGING
static

The device supports averaging.

final ConfigKey org.sigrok.core.classes.ConfigKey.AVG_SAMPLES
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.TRIGGER_SOURCE
static

Trigger source.

final ConfigKey org.sigrok.core.classes.ConfigKey.HORIZ_TRIGGERPOS
static

Horizontal trigger position.

final ConfigKey org.sigrok.core.classes.ConfigKey.BUFFERSIZE
static

Buffer size.

final ConfigKey org.sigrok.core.classes.ConfigKey.TIMEBASE
static

Time base.

final ConfigKey org.sigrok.core.classes.ConfigKey.FILTER
static

Filter.

final ConfigKey org.sigrok.core.classes.ConfigKey.VDIV
static

Volts/div.

final ConfigKey org.sigrok.core.classes.ConfigKey.COUPLING
static

Coupling.

final ConfigKey org.sigrok.core.classes.ConfigKey.TRIGGER_MATCH
static

Trigger matches.

final ConfigKey org.sigrok.core.classes.ConfigKey.SAMPLE_INTERVAL
static

The device supports setting its sample interval, in ms.

final ConfigKey org.sigrok.core.classes.ConfigKey.NUM_HDIV
static

Number of horizontal divisions, as related to SR_CONF_TIMEBASE.

final ConfigKey org.sigrok.core.classes.ConfigKey.NUM_VDIV
static

Number of vertical divisions, as related to SR_CONF_VDIV.

final ConfigKey org.sigrok.core.classes.ConfigKey.SPL_WEIGHT_FREQ
static

Sound pressure level frequency weighting.

final ConfigKey org.sigrok.core.classes.ConfigKey.SPL_WEIGHT_TIME
static

Sound pressure level time weighting.

final ConfigKey org.sigrok.core.classes.ConfigKey.SPL_MEASUREMENT_RANGE
static

Sound pressure level measurement range.

final ConfigKey org.sigrok.core.classes.ConfigKey.HOLD_MAX
static

Max hold mode.

final ConfigKey org.sigrok.core.classes.ConfigKey.HOLD_MIN
static

Min hold mode.

final ConfigKey org.sigrok.core.classes.ConfigKey.VOLTAGE_THRESHOLD
static

Logic low-high threshold range.

final ConfigKey org.sigrok.core.classes.ConfigKey.EXTERNAL_CLOCK
static

The device supports using an external clock.

final ConfigKey org.sigrok.core.classes.ConfigKey.SWAP
static

The device supports swapping channels.

final ConfigKey org.sigrok.core.classes.ConfigKey.CENTER_FREQUENCY
static

Center frequency.

final ConfigKey org.sigrok.core.classes.ConfigKey.NUM_LOGIC_CHANNELS
static

The device supports setting the number of logic channels.

final ConfigKey org.sigrok.core.classes.ConfigKey.NUM_ANALOG_CHANNELS
static

The device supports setting the number of analog channels.

final ConfigKey org.sigrok.core.classes.ConfigKey.VOLTAGE
static

Current voltage.

final ConfigKey org.sigrok.core.classes.ConfigKey.VOLTAGE_TARGET
static

Maximum target voltage.

final ConfigKey org.sigrok.core.classes.ConfigKey.CURRENT
static

Current current.

final ConfigKey org.sigrok.core.classes.ConfigKey.CURRENT_LIMIT
static

Current limit.

final ConfigKey org.sigrok.core.classes.ConfigKey.ENABLED
static

Enabling/disabling channel.

final ConfigKey org.sigrok.core.classes.ConfigKey.CHANNEL_CONFIG
static

Channel configuration.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_ENABLED
static

Over-voltage protection (OVP) feature.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_ACTIVE
static

Over-voltage protection (OVP) active.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_VOLTAGE_PROTECTION_THRESHOLD
static

Over-voltage protection (OVP) threshold.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_ENABLED
static

Over-current protection (OCP) feature.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_ACTIVE
static

Over-current protection (OCP) active.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_CURRENT_PROTECTION_THRESHOLD
static

Over-current protection (OCP) threshold.

final ConfigKey org.sigrok.core.classes.ConfigKey.CLOCK_EDGE
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.AMPLITUDE
static

Amplitude of a source without strictly-defined MQ.

final ConfigKey org.sigrok.core.classes.ConfigKey.REGULATION
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_TEMPERATURE_PROTECTION
static

Over-temperature protection (OTP)

final ConfigKey org.sigrok.core.classes.ConfigKey.OUTPUT_FREQUENCY
static

Output frequency in Hz.

final ConfigKey org.sigrok.core.classes.ConfigKey.OUTPUT_FREQUENCY_TARGET
static

Output frequency target in Hz.

final ConfigKey org.sigrok.core.classes.ConfigKey.MEASURED_QUANTITY
static

Measured quantity.

final ConfigKey org.sigrok.core.classes.ConfigKey.EQUIV_CIRCUIT_MODEL
static

Equivalent circuit model.

final ConfigKey org.sigrok.core.classes.ConfigKey.OVER_TEMPERATURE_PROTECTION_ACTIVE
static

Over-temperature protection (OTP) active.

final ConfigKey org.sigrok.core.classes.ConfigKey.SESSIONFILE
static

Session filename.

final ConfigKey org.sigrok.core.classes.ConfigKey.CAPTUREFILE
static

The device supports specifying a capturefile to inject.

final ConfigKey org.sigrok.core.classes.ConfigKey.CAPTURE_UNITSIZE
static

The device supports specifying the capturefile unit size.

final ConfigKey org.sigrok.core.classes.ConfigKey.POWER_OFF
static

Power off the device.

final ConfigKey org.sigrok.core.classes.ConfigKey.DATA_SOURCE
static

Data source for acquisition.

final ConfigKey org.sigrok.core.classes.ConfigKey.PROBE_FACTOR
static

The device supports setting a probe factor.

final ConfigKey org.sigrok.core.classes.ConfigKey.LIMIT_MSEC
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.LIMIT_SAMPLES
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.LIMIT_FRAMES
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.CONTINUOUS
static

The device supports continuous sampling.

final ConfigKey org.sigrok.core.classes.ConfigKey.DATALOG
static

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

final ConfigKey org.sigrok.core.classes.ConfigKey.DEVICE_MODE
static

Device mode for multi-function devices.

final ConfigKey org.sigrok.core.classes.ConfigKey.TEST_MODE
static

Self test mode.