Event Control

Event Features

Events allow you to get notified when the camera has performed something you might find interesting. Events are similar to the asynchronous communication but the difference is the initiator is the device.

For more information, see Using the Event Control Feature.

Once an event is turned on, it has its own XML area where it outputs the event's ID, timestamp, and any applicable event data.

Use EventSelector to choose an event, then use EventNotification to set the event On or Off.

Standard events to choose:

Exposure End - Event is sent every image when exposure end occurs. Event data includes: the event ID, timestamp, and frame ID.

Serial Port Receive - Event is sent every time the serial port receives data. Event data includes: the event ID, timestamp, length, and overflow.

Error - Event is sent every time an error occurs internally in the device. Event data includes: the event ID, timestamp, frame ID, and error code.

In order to verify that events are working, there is a Test Event Generate command that can be executed to allow you to trigger the camera to send a test event out.

Event Test - Event you can trigger to verify events are working properly. This is always enabled. Event data includes: ID and timestamp.

Summary Table

Name Interface Access Visibility Description
Event Selector IEnumeration RW Expert Selects which Event to enable or disable.
Event Notification [Event Selector] IEnumeration RW Expert Enables/Disables the selected event.
Event Exposure End Data ICategory RO Expert Category that contains all the data features related to the Exposure End Event.
Event Error Data ICategory RO Expert Category that contains all the data features related to the Error Event.
Event Serial Port Receive Data ICategory RO Expert Category that contains all the data features related to the Serial Port Receive Event.
Event Test Data ICategory RO Expert Category that contains all the data features related to the Test Event.

Event Control Features


Event Selector

Selects which Event to enable or disable.

Property Value
Name EventSelector
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
Error
ExposureEnd
SerialPortReceive

Event Notification

Enables/Disables the selected event.

Property Value
Name EventNotification [Event Selector]
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
On
Off

Event Exposure End Data

Category that contains all the data features related to the Exposure End Event.

Property Value
Name EventExposureEndData
Interface ICategory
Access RO
Visibility Expert

Event Error Data

Category that contains all the data features related to the Error Event.

Property Value
Name EventErrorData
Interface ICategory
Access RO
Visibility Expert

Event Serial Port Receive Data

Category that contains all the data features related to the Serial Port Receive Event.

Property Value
Name EventSerialPortReceiveData
Interface ICategory
Access RO
Visibility Expert

Event Test Data

Category that contains all the data features related to the Test Event.

Property Value
Name EventTestData
Interface ICategory
Access RO
Visibility Expert