Sensor API v2.5.0
Parameters for Illumination

Macros

#define PARAM_REG_PULSE_WIDTH_FLOAT   "reg_pulse_width_float"
 
#define PARAM_AGC_ENABLED   "agc_enabled"
 
#define PARAM_AGC_PULSE_WIDTH_LIMIT   "agc_pulse_width_limit"
 
#define PARAM_AGC_MIN_PULSE_WIDTH_LIMIT   "agc_minimum_pulse_width_limit"
 
#define PARAM_AGC_GAIN   "agc_gain"
 
#define PARAM_AGC_TARGET   "agc_target"
 
#define PARAM_PULSE_CURRENT_MIDDLE   "pulse_current_middle"
 
#define PARAM_PULSE_CURRENT_EDGES   "pulse_current_edges"
 

Detailed Description

Macro Definition Documentation

◆ PARAM_AGC_ENABLED

#define PARAM_AGC_ENABLED   "agc_enabled"

C# name:  SensorParameter.AgcEnabled

Is Automatic Gain Control (AGC) enabled. If enabled, AGC will automatically tune the pulse width based on the signal from the surface(s).

  • Parameter type: int
  • Range : 0,1. Default value is 0 (disabled).

◆ PARAM_AGC_GAIN

#define PARAM_AGC_GAIN   "agc_gain"

C# name:  SensorParameter.AgcGain

Gain for AGC P-controller.

  • Parameter type: float
  • Range : Default value is 1.2F.

◆ PARAM_AGC_MIN_PULSE_WIDTH_LIMIT

#define PARAM_AGC_MIN_PULSE_WIDTH_LIMIT   "agc_minimum_pulse_width_limit"

C# name:  SensorParameter.AgcMinPulseWidthLimit

AGC pulse width minimum limit.

  • Parameter type: int
  • Unit : Microseconds
  • Range : Default value is 1.

◆ PARAM_AGC_PULSE_WIDTH_LIMIT

#define PARAM_AGC_PULSE_WIDTH_LIMIT   "agc_pulse_width_limit"

C# name:  SensorParameter.AgcWiLimit

AGC pulse width upper limit.

  • Parameter type: int
  • Unit : Microseconds
  • Range : Default value is 2000.

◆ PARAM_AGC_TARGET

#define PARAM_AGC_TARGET   "agc_target"

C# name:  SensorParameter.AgcTarget

AGC target intensity (8-bit grayscale).

  • Parameter type: float
  • Range : 0.0F-255.0F. Default value is 80.0f.

◆ PARAM_PULSE_CURRENT_EDGES

#define PARAM_PULSE_CURRENT_EDGES   "pulse_current_edges"

C# name:  SensorParameter.PulseCurrentEdges

Pulse current in the edges of the sensor.

  • Parameter type: float
  • Range : 0.1 - 1.0 ampere

◆ PARAM_PULSE_CURRENT_MIDDLE

#define PARAM_PULSE_CURRENT_MIDDLE   "pulse_current_middle"

C# name:  SensorParameter.PulseCurrentMiddle

Pulse current in the middle section of the sensor.

  • Parameter type: float
  • Range : 0.1 - 1.0 ampere

◆ PARAM_REG_PULSE_WIDTH_FLOAT

#define PARAM_REG_PULSE_WIDTH_FLOAT   "reg_pulse_width_float"

C# name:  SensorParameter.PulseWidthFloat

Illumination pulse width. Replaces PARAM_LED_DURATION.

  • Parameter type: float
  • Unit: Microseconds