LED

Controls the behavior of the selected camera LED. More...

Enumerations
enum	peak_led_target { PEAK_LED_TARGET_INVALID , PEAK_LED_TARGET_NETWORK , PEAK_LED_TARGET_STATUS }
	peak LED target More...
enum	peak_led_mode {   PEAK_LED_MODE_INVALID , PEAK_LED_MODE_OFF , PEAK_LED_MODE_BLINK_SLOW , PEAK_LED_MODE_BLINK_FAST ,   PEAK_LED_MODE_CAMERA_STATUS , PEAK_LED_MODE_NETWORK_STATUS }
	peak LED mode More...

Functions
peak_access_status	peak_LED_GetAccessStatus (peak_camera_handle hCam)
	Query LED access status.
peak_status	peak_LED_Target_GetList (peak_camera_handle hCam, peak_led_target *targetList, size_t *targetCount)
	Get the list of currently usable LED targets.
peak_status	peak_LED_Mode_GetList (peak_camera_handle hCam, peak_led_target target, peak_led_mode *modeList, size_t *ledModeCount)
	Get the list of currently usable LED modes of the specified LED target.
peak_status	peak_LED_Set (peak_camera_handle hCam, peak_led_target target, peak_led_mode mode)
	Set LED mode for the specified LED target.
peak_status	peak_LED_Get (peak_camera_handle hCam, peak_led_target target, peak_led_mode *mode)
	Get the LED mode for the specified LED target.

Detailed Description

Controls the behavior of the selected camera LED.

Example to use the LED control feature:

if (peak_LED_GetAccessStatus(hCam) == PEAK_ACCESS_READWRITE)
{
  peak_led_target target = PEAK_LED_TARGET_STATUS;
  size_t ledModeCount = 0;
  peak_status status = peak_LED_Mode_GetList(hCam, target, NULL, &ledModeCount);
  if (PEAK_SUCCESS(status) && ledModeCount != 0)
  {
       peak_led_mode* ledModes = (peak_led_mode*)malloc(
           ledModeCount * sizeof(peak_led_mode));
       status = peak_LED_Mode_GetList(hCam, target, ledModes, &ledModeCount);
       if (PEAK_SUCCESS(status))
       {
           // do something with ledModes
       }
       free(ledModes);
  }
}

peak_LED_Set(hCam, PEAK_LED_TARGET_STATUS, PEAK_LED_MODE_BLINK_FAST);
// ...
// reset back to normal camera status
peak_LED_Set(hCam, PEAK_LED_TARGET_STATUS, PEAK_LED_MODE_CAMERA_STATUS);
 
peak_led_mode mode = PEAK_LED_MODE_INVALID;
peak_LED_Get(hCam, PEAK_LED_TARGET_STATUS, &mode);

Enumeration Type Documentation

peak_led_mode

enum peak_led_mode

peak LED mode

Available LED modes.

Note

The default LED mode for target PEAK_LED_TARGET_STATUS is PEAK_LED_MODE_CAMERA_STATUS. The default LED mode for target PEAK_LED_TARGET_NETWORK is PEAK_LED_MODE_NETWORK_STATUS.

Enumerator
PEAK_LED_MODE_INVALID	Invalid LED mode. Use this value for the initialization of variables of type peak_led_mode.
PEAK_LED_MODE_OFF	Turns off LED.
PEAK_LED_MODE_BLINK_SLOW	Turns LED to slow flashing.
PEAK_LED_MODE_BLINK_FAST	Turns LED to fast flashing.
PEAK_LED_MODE_CAMERA_STATUS	Turns status LED to show camera status. Note only usable for selected target PEAK_LED_TARGET_STATUS.
PEAK_LED_MODE_NETWORK_STATUS	Turns network LED to show network status. Note only usable for selected target PEAK_LED_TARGET_NETWORK.

peak_led_target

enum peak_led_target

peak LED target

Available LED target.

Enumerator
PEAK_LED_TARGET_INVALID	Invalid LED target. Use this value for the initialization of variables of type peak_led_target.
PEAK_LED_TARGET_NETWORK	The camera network LED target.
PEAK_LED_TARGET_STATUS	The camera status LED target.

Function Documentation

peak_LED_Get()

peak_status peak_LED_Get	(	peak_camera_handle	hCam,
		peak_led_target	target,
		peak_led_mode *	mode )

Get the LED mode for the specified LED target.

Reads the current LED mode of the specified LED target.

Parameters

[in]	hCam	The camera handle.
[out]	target	The LED target.
[out]	mode	The LED mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED LED property is not available for read access. Check the access status of the LED via peak_LED_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER target is an invalid target or *mode is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_LED_GetAccessStatus()

peak_access_status peak_LED_GetAccessStatus

(

peak_camera_handle

hCam

)

Query LED access status.

Provides the current access status for the LED feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The LED feature is readable and writeable.

PEAK_ACCESS_READONLY The LED feature is readable only.

PEAK_ACCESS_GFA_LOCK The LED feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The LED feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The LED feature is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
• PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
• PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_LED_Mode_GetList()

peak_status peak_LED_Mode_GetList	(	peak_camera_handle	hCam,
		peak_led_target	target,
		peak_led_mode *	modeList,
		size_t *	ledModeCount )

Get the list of currently usable LED modes of the specified LED target.

Queries the list of currently selectable LED modes.

The list of usable LED modes may depend on the LED target, the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	target	The LED target
[out]	modeList	Pointer to a user allocated array buffer to receive the LED mode list. If this parameter is NULL, *ledModeCount will contain the current number of LED modes. The required size of modeList in bytes is ledModeCount x sizeof(peak_led_mode).
[in,out]	ledModeCount	modeList equal NULL: out: minimal number of LED modes modeList must be large enough to hold modeList unequal NULL: in: number of LED modes modeList can hold out: number of LED modes filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL modeList is not NULL and the value of *ledModeCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The LED feature is not supported or the GFA write mode is enabled.

PEAK_STATUS_INVALID_PARAMETER ledModeCount is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_LED_Set()

peak_status peak_LED_Set	(	peak_camera_handle	hCam,
		peak_led_target	target,
		peak_led_mode	mode )

Set LED mode for the specified LED target.

Writes the LED mode for the specified LED target.

Parameters

[in]	hCam	The camera handle.
[out]	target	The LED target.
[out]	mode	The LED mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The LED property is not available for write access. Check the access status of the LED feature via peak_LED_GetAccessStatus.

PEAK_STATUS_OUT_OF_RANGE Mode or target is out of range. Check the range of valid values via peak_LED_Target_GetList and peak_LED_Mode_GetList.

PEAK_STATUS_INVALID_PARAMETER Mode or target is an invalid value. Check peak_led_target and peak_led_mode.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_LED_Target_GetList()

peak_status peak_LED_Target_GetList	(	peak_camera_handle	hCam,
		peak_led_target *	targetList,
		size_t *	targetCount )

Get the list of currently usable LED targets.

Queries the list of currently selectable LED targets.

The list of usable LED targets may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	targetList	Pointer to a user allocated array buffer to receive the LED target list. If this parameter is NULL, targetCount will contain the current number of LED targets. The required size of targetList in bytes is targetCount x sizeof(peak_led_target).
[in,out]	targetCount	targetList equal NULL: out: minimal number of LED targets targetList must be large enough to hold targetList unequal NULL: in: number of LED targets targetList can hold out: number of LED targets filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL targetList is not NULL and the value of *targetCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The LED target is not supported or the GFA write mode is enabled.

PEAK_STATUS_INVALID_PARAMETER targetCount is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9