Device configuration parameter definitions and API functions. More...

Collaboration diagram for Configuration:

Functions
argus_mode_t	Argus_GetDefaultMeasurementMode (argus_module_version_t module)
	Gets the default measurement mode for a specified module type.

status_t	Argus_SetMeasurementMode (argus_hnd_t *hnd, argus_mode_t mode)
	Sets the measurement mode to a specified device.

status_t	Argus_ResetMeasurementMode (argus_hnd_t *hnd)
	Resets the measurement mode to a specified device.

status_t	Argus_GetMeasurementMode (argus_hnd_t hnd, argus_mode_t mode)
	Gets the measurement mode from a specified device.

status_t	Argus_SetConfigurationFrameTime (argus_hnd_t *hnd, uint32_t value)
	Sets the frame time to a specified device.

status_t	Argus_GetConfigurationFrameTime (argus_hnd_t hnd, uint32_t value)
	Gets the frame time from a specified device.

status_t	Argus_SetConfigurationSmartPowerSaveEnabled (argus_hnd_t *hnd, bool value)
	Sets the smart power save enabled flag to a specified device.

status_t	Argus_GetConfigurationSmartPowerSaveEnabled (argus_hnd_t hnd, bool value)
	Gets the smart power save enabled flag from a specified device.

status_t	Argus_SetConfigurationDFMMode (argus_hnd_t *hnd, argus_dfm_mode_t value)
	Sets the Dual Frequency Mode (DFM) to a specified device.

status_t	Argus_GetConfigurationDFMMode (argus_hnd_t hnd, argus_dfm_mode_t value)
	Gets the Dual Frequency Mode (DFM) from a specified device.

status_t	Argus_SetConfigurationShotNoiseMonitorMode (argus_hnd_t *hnd, argus_snm_mode_t value)
	Sets the Shot Noise Monitor (SNM) mode to a specified device.

status_t	Argus_GetConfigurationShotNoiseMonitorMode (argus_hnd_t hnd, argus_snm_mode_t value)
	Gets the Shot Noise Monitor (SNM) mode from a specified device.

status_t	Argus_SetConfigurationCrosstalkMonitorMode (argus_hnd_t *hnd, bool value)
	Sets the Crosstalk Monitor (XTM) mode to a specified device.

status_t	Argus_GetConfigurationCrosstalkMonitorMode (argus_hnd_t hnd, bool value)
	Gets the Crosstalk Monitor (XTM) mode from a specified device.

status_t	Argus_SetConfigurationDynamicAdaption (argus_hnd_t hnd, argus_cfg_dca_t const value)
	Sets the full DCA module configuration to a specified device.

status_t	Argus_GetConfigurationDynamicAdaption (argus_hnd_t hnd, argus_cfg_dca_t value)
	Gets the # from a specified device.

status_t	Argus_SetConfigurationNoiseDetectors (argus_hnd_t hnd, argus_cfg_nd_t const value)
	Sets the Noise Detectors feature configuration to a specified device.

status_t	Argus_GetConfigurationNoiseDetectors (argus_hnd_t hnd, argus_cfg_nd_t value)
	Gets the Noise Detectors feature configuration from a specified device.

status_t	Argus_SetConfigurationPixelBinning (argus_hnd_t hnd, argus_cfg_pba_t const value)
	Sets the pixel binning configuration parameters to a specified device.

status_t	Argus_GetConfigurationPixelBinning (argus_hnd_t hnd, argus_cfg_pba_t value)
	Gets the pixel binning configuration parameters from a specified device.

status_t	Argus_SetConfigurationCrosstalkMonitor (argus_hnd_t hnd, argus_cfg_xtm_t const value)
	Sets the crosstalk monitor (XTM) configuration parameters to a specified device.

status_t	Argus_GetConfigurationCrosstalkMonitor (argus_hnd_t hnd, argus_cfg_xtm_t value)
	Gets the crosstalk monitor (XTM) configuration parameters from a specified device.

status_t	Argus_GetConfigurationUnambiguousRange (argus_hnd_t hnd, uint32_t range_mm)
	Gets the current unambiguous range in mm.

Detailed Description

Device configuration parameter definitions and API functions.

This module takes care of keeping the device configuration up to date. Therefore, the configuration is managed in a local data structure. Requested changes to the device configuration are validated and endorsed within the module.

Configuration API

Function Documentation

◆ Argus_GetConfigurationCrosstalkMonitor()

status_t Argus_GetConfigurationCrosstalkMonitor	(	argus_hnd_t *	hnd,
		argus_cfg_xtm_t *	value )

Gets the crosstalk monitor (XTM) configuration parameters from a specified device.

See also: Argus_GetConfigurationCrosstalkMonitorMode for the simpler version of the function to only change the crosstalk monitor mode.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current crosstalk monitor configuration parameters.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationCrosstalkMonitorMode()

status_t Argus_GetConfigurationCrosstalkMonitorMode	(	argus_hnd_t *	hnd,
		bool *	value )

Gets the Crosstalk Monitor (XTM) mode from a specified device.

See also: Argus_GetConfigurationCrosstalkMonitor for the full configuration of the crosstalk monitor.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current XTM mode value (true: enabled; false: disabled).

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationDFMMode()

status_t Argus_GetConfigurationDFMMode	(	argus_hnd_t *	hnd,
		argus_dfm_mode_t *	value )

Gets the Dual Frequency Mode (DFM) from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current DFM mode value.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationDynamicAdaption()

status_t Argus_GetConfigurationDynamicAdaption	(	argus_hnd_t *	hnd,
		argus_cfg_dca_t *	value )

Gets the # from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current DCA configuration set value.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationFrameTime()

status_t Argus_GetConfigurationFrameTime	(	argus_hnd_t *	hnd,
		uint32_t *	value )

Gets the frame time from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current frame time in microseconds.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationNoiseDetectors()

status_t Argus_GetConfigurationNoiseDetectors	(	argus_hnd_t *	hnd,
		argus_cfg_nd_t *	value )

Gets the Noise Detectors feature configuration from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current ND configuration set value.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationPixelBinning()

status_t Argus_GetConfigurationPixelBinning	(	argus_hnd_t *	hnd,
		argus_cfg_pba_t *	value )

Gets the pixel binning configuration parameters from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current pixel binning configuration parameters.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationShotNoiseMonitorMode()

status_t Argus_GetConfigurationShotNoiseMonitorMode	(	argus_hnd_t *	hnd,
		argus_snm_mode_t *	value )

Gets the Shot Noise Monitor (SNM) mode from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current SNM mode value.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationSmartPowerSaveEnabled()

status_t Argus_GetConfigurationSmartPowerSaveEnabled	(	argus_hnd_t *	hnd,
		bool *	value )

Gets the smart power save enabled flag from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The current smart power save enabled flag.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetConfigurationUnambiguousRange()

status_t Argus_GetConfigurationUnambiguousRange	(	argus_hnd_t *	hnd,
		uint32_t *	range_mm )

Gets the current unambiguous range in mm.

Parameters

hnd	The API handle; contains all internal states and data.
range_mm	The returned range in mm.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_GetDefaultMeasurementMode()

argus_mode_t Argus_GetDefaultMeasurementMode ( argus_module_version_t module )

Gets the default measurement mode for a specified module type.

Parameters

module The specified module type.

Returns: Returns the default measurement mode for the specified module type.

◆ Argus_GetMeasurementMode()

status_t Argus_GetMeasurementMode	(	argus_hnd_t *	hnd,
		argus_mode_t *	mode )

Gets the measurement mode from a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
mode	The current measurement mode.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_ResetMeasurementMode()

status_t Argus_ResetMeasurementMode ( argus_hnd_t * hnd )

Resets the measurement mode to a specified device.

This generates a new default configuration and calibration for the current measurement mode and applies it to the device.

Warning: The function overwrites all made changes to the configuration or calibration parameters with the default values. So this function must be called before any other changes to the configuration or calibration parameters are made!

Parameters

hnd	The API handle; contains all internal states and data.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationCrosstalkMonitor()

status_t Argus_SetConfigurationCrosstalkMonitor	(	argus_hnd_t *	hnd,
		argus_cfg_xtm_t const *	value )

Sets the crosstalk monitor (XTM) configuration parameters to a specified device.

See also: Argus_SetConfigurationCrosstalkMonitorMode for the simpler version of the function to only change the crosstalk monitor mode.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new crosstalk monitor configuration parameters.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationCrosstalkMonitorMode()

status_t Argus_SetConfigurationCrosstalkMonitorMode	(	argus_hnd_t *	hnd,
		bool	value )

Sets the Crosstalk Monitor (XTM) mode to a specified device.

See also: Argus_SetConfigurationCrosstalkMonitor for the full configuration of the crosstalk monitor.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new XTM mode value (true: enabled; false: disabled).

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationDFMMode()

status_t Argus_SetConfigurationDFMMode	(	argus_hnd_t *	hnd,
		argus_dfm_mode_t	value )

Sets the Dual Frequency Mode (DFM) to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new DFM mode value.

Returns: Returns the status (STATUS_OK on success).

Examples: 03_high_speed_example.c, and 06_low_power_example.c.

◆ Argus_SetConfigurationDynamicAdaption()

status_t Argus_SetConfigurationDynamicAdaption	(	argus_hnd_t *	hnd,
		argus_cfg_dca_t const *	value )

Sets the full DCA module configuration to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new DCA configuration set.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationFrameTime()

status_t Argus_SetConfigurationFrameTime	(	argus_hnd_t *	hnd,
		uint32_t	value )

Sets the frame time to a specified device.

The frame time determines the measurement rate of the device. Usually, this controller the periodicity of measurements to be triggered via the timer based measurement mode that can be started via the Argus_StartMeasurementTimer function. But also the behavior of the Argus_TriggerMeasurement function is influenced by the frame rate parameter.

The frame time parameter handles the maximum frame rate by limiting the trigger of a new measurement frame to the specified value. On the other hand, the accuracy of measurement results it also influenced since the frame time specifies the maximum integration depth (i.e. exposure time) along with the laser safety limitations. This means, the measurement speed can be increased by decreasing the frame time parameter and the accuracy can be improved by increasing the frame time parameter.

Note the additional factor will limit the maximum frame rate on the one hand and the accuracy on the other hand:

High CPU load (or slow CPU in general) will lead to delays due to long data evaluation task (Argus_EvaluateData) or long user application code. Reduce CPU load or increase CPU power to increase maximum frame rate.
The dual frequency mode (DFM, see Argus_SetConfigurationDFMMode) will additionally limit the maximum frame rate to approximately 100 frames per second. Disable the DFM to increase maximum frame rates.
The smart power save (SPS, see Argus_SetConfigurationSmartPowerSaveEnabled) mode will decrease the maximum possible frame rate slightly. Disable it to increase the maximum frame rate.
The dynamic configuration adaption with its specific power saving ratio parameter (see Argus_SetConfigurationDynamicAdaption) will limit the maximum integration depth along with the laser safety limitations. Increase the power saving ratio to increase accuracy. Note that laser safety limitations might already limit the maximum integration depth such that the power saving ratio is ineffective.

Parameters

hnd	The API handle; contains all internal states and data.
value	The measurement frame time in microseconds.

Returns: Returns the status (STATUS_OK on success).

Examples: 01_simple_example.c, 01_simple_example_with_hal_self_test.c, 02_advanced_example.c, 02_advanced_example_with_hal_self_test.c, 03_high_speed_example.c, 04_multi_device_example.c, 05_simple_example_debug.c, and 06_low_power_example.c.

◆ Argus_SetConfigurationNoiseDetectors()

status_t Argus_SetConfigurationNoiseDetectors	(	argus_hnd_t *	hnd,
		argus_cfg_nd_t const *	value )

Sets the Noise Detectors feature configuration to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new ND configuration set.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationPixelBinning()

status_t Argus_SetConfigurationPixelBinning	(	argus_hnd_t *	hnd,
		argus_cfg_pba_t const *	value )

Sets the pixel binning configuration parameters to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new pixel binning configuration parameters.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationShotNoiseMonitorMode()

status_t Argus_SetConfigurationShotNoiseMonitorMode	(	argus_hnd_t *	hnd,
		argus_snm_mode_t	value )

Sets the Shot Noise Monitor (SNM) mode to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new SNM mode value.

Returns: Returns the status (STATUS_OK on success).

◆ Argus_SetConfigurationSmartPowerSaveEnabled()

status_t Argus_SetConfigurationSmartPowerSaveEnabled	(	argus_hnd_t *	hnd,
		bool	value )

Sets the smart power save enabled flag to a specified device.

Parameters

hnd	The API handle; contains all internal states and data.
value	The new smart power save enabled flag.

Returns: Returns the status (STATUS_OK on success).

Examples: 03_high_speed_example.c.

◆ Argus_SetMeasurementMode()

status_t Argus_SetMeasurementMode	(	argus_hnd_t *	hnd,
		argus_mode_t	mode )

Sets the measurement mode to a specified device.

This generates a new default configuration and calibration for the specified measurement mode and applies it to the device.

See argus_mode_t for a list of all available measurement modes.

Warning: The function overwrites all made changes to the configuration or calibration parameters with the default values. So this function must be called before any other changes to the configuration or calibration parameters are made!

Parameters

hnd	The API handle; contains all internal states and data.
mode	The new measurement mode.

Returns: Returns the status (STATUS_OK on success).

Functions

Detailed Description

Function Documentation

◆ Argus_GetConfigurationCrosstalkMonitor()

◆ Argus_GetConfigurationCrosstalkMonitorMode()

◆ Argus_GetConfigurationDFMMode()

◆ Argus_GetConfigurationDynamicAdaption()

◆ Argus_GetConfigurationFrameTime()

◆ Argus_GetConfigurationNoiseDetectors()

◆ Argus_GetConfigurationPixelBinning()

◆ Argus_GetConfigurationShotNoiseMonitorMode()

◆ Argus_GetConfigurationSmartPowerSaveEnabled()

◆ Argus_GetConfigurationUnambiguousRange()

◆ Argus_GetDefaultMeasurementMode()

◆ Argus_GetMeasurementMode()

◆ Argus_ResetMeasurementMode()

◆ Argus_SetConfigurationCrosstalkMonitor()

◆ Argus_SetConfigurationCrosstalkMonitorMode()

◆ Argus_SetConfigurationDFMMode()

◆ Argus_SetConfigurationDynamicAdaption()

◆ Argus_SetConfigurationFrameTime()

◆ Argus_SetConfigurationNoiseDetectors()

◆ Argus_SetConfigurationPixelBinning()

◆ Argus_SetConfigurationShotNoiseMonitorMode()

◆ Argus_SetConfigurationSmartPowerSaveEnabled()

◆ Argus_SetMeasurementMode()