IDS peak 2.17.1 / uEye+ firmware 3.70
IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
This chapter contains the descriptions of all supported features from the Event Control category.
Name |
EventControl |
Category |
Root |
Interface |
Category |
Access |
Read |
Unit |
- |
Visibility |
Expert |
Values |
- |
Standard |
SFNC |
Availability uEye+ |
|
Availability uEye |
- |
Events
An event is a message sent from the camera to the host application when a predefined event has occurred. You can use events to synchronize your host application with events on the camera.
|
The supported events depend on the used camera model. |
You define the event you want to monitor via the EventSelector e.g. "ExposureStart".
The following events can be monitored:
Event |
ID |
Description |
|---|---|---|
CriticalError |
0x9011 |
The event will be generated when a critical error is detected. |
Error |
0x9010 |
The event will be generated when an error is detected. |
EventDropped |
0x9012 |
The event will be generated when one or more events are lost. |
ExposureStart |
0x9000 |
The camera started the exposure of a frame (or line in SensorOperationMode "Linescan"). |
ExposureEnd |
0x9001 |
The camera completed the exposure of a frame (or line in SensorOperationMode "Linescan"). |
ExposureTriggerMissed |
0x900C |
The camera missed a trigger to start the exposure. |
FaceDetect |
0x9100 |
The event will be generated when a face is detected, when the face position has changed since the last event, or when the face disappears. This event can only be used if the PixelFormat is set to YUV422_8_UYVY. |
FrameDropped |
0x900B |
The event will be generated when one or more frames are lost. |
FrameStart |
0x9002 |
The camera started the capture of a frame. Only available in SensorOperationMode "Linescan". |
FrameTriggerReady |
0x900E |
The event will be generated when the camera is ready to receive the next frame trigger. |
Line0FallingEdge |
0x9007 |
The event will be generated when a falling edge is detected on the Line 0. |
Line1FallingEdge |
0x9008 |
The event will be generated when a falling edge is detected on the Line 1. |
Line2FallingEdge |
0x9009 |
The event will be generated when a falling edge is detected on the Line 2. |
Line3FallingEdge |
0x900A |
The event will be generated when a falling edge is detected on the Line 3. |
Line4FallingEdge |
0x9018 |
The event will be generated when a falling edge is detected on the Line 4. |
Line5FallingEdge |
0x9019 |
The event will be generated when a falling edge is detected on the Line 5. |
Line6FallingEdge |
0x901A |
The event will be generated when a falling edge is detected on the Line 6. |
Line0RisingEdge |
0x9003 |
The event will be generated when a rising edge is detected on the Line 0. |
Line1RisingEdge |
0x9004 |
The event will be generated when a rising edge is detected on the Line 1. |
Line2RisingEdge |
0x9005 |
The event will be generated when a rising edge is detected on the Line 2. |
Line3RisingEdge |
0x9006 |
The event will be generated when a rising edge is detected on the Line 3. |
Line4RisingEdge |
0x9015 |
The event will be generated when a rising edge is detected on the Line 4. |
Line5RisingEdge |
0x9016 |
The event will be generated when a rising edge is detected on the Line 5. |
Line6RisingEdge |
0x9017 |
The event will be generated when a rising edge is detected on the Line 6. |
LineTriggerMissed |
0x900D |
The camera missed a trigger to start the capture of a line. Only available in SensorOperationMode "Linescan". |
PtpMasterSyncLost |
0x9013 |
The event will be generated when PTP master sync is lost. |
Temperature |
0x900E |
The event will be generated when the temperature deviates by more than 0.5 degrees from the previous value. |
TemperatureCriticalRange |
0x900F |
The event will be generated when the temperature rises above the critical value. |
Test |
0x4FFF |
The test event is a packet with a defined structure. It is generated by executing the TestEventGenerate command. The test event is not included in the EventSelector since the notification of this event is always enabled. |
UarRxtError |
0x901C |
The event will be generated when the UART Rx module has detected an error during reception. |
UartRxPacket |
0x901E |
The event is generated when the UART Rx module has received a packet. |
UartRxStatusChanged |
0x901D |
The event will be generated when UartRxStatus has changed. The transmitted data itself is irrelevant and should be ignored. |
Event identifier
For each event that can be selected via the EventSelector there is an event identifier. The controlling application can refer to this event identifier in order to be informed about the occurrence of an event. The name of this event identifier is composed of the word 'Event' and the value of the EventSelector (e.g. "ExposureStart"): EventExposureStart.
Subcategories
For each event in the Event Control category there is a subcategory in which all data features, that are related to this event are grouped. The name of this subcategory is composed of the event identifier + the word 'Data'.
Event Control contains the following subcategories:
•Event Frame Trigger Ready Data
•Event LineX Falling Edge Data
•Event Exposure Trigger Missed Data
•Event Line Trigger Missed Data
•Event Ptp Master Sync Lost Data
•Event Temperature Critical Range Data
•Event Uart Rx Status Changed Data
Event activation
As soon as you enable the notification for an event (EventNotification = "On") and the event occurs, the event is generated and the data for the event is written to the nodes of the corresponding subcategory. The defined event is active as long as the EventNotification is "On" for this event. If EventNotification = "Off", no event is generated.
If you enable the EventNotification for the ExposureStart event (EventNotification = "On" with the EventSelector = "ExposureStart"), the event identifier (EventExposureStart), the frame ID (EventExposureStartFrameID) and the timestamp (EventExposureStartTimestamp) are written to the Event Exposure Start Data subcategory when an exposure starts.
