Port IMAGE - DEFAULT¶

Default port for interaction with GenICam cameras

Stimulation¶

This port has no stimulus capabilities.

Specifics¶

The port supports the setting of some standard properties, such as image size, frame rate, pixel format, etc. For more complex settings, such as triggers, ROI, etc., the camera manufacturer’s software should be used, and the specific settings should be saved in a UserSet, which is loaded when the configuration is started.

Supported Pixel Formats¶

The port supports the following pixel formats:

Mono8, Mono10, Mono12, Mono16
RGB8, RGB10, RGB12, RGB16
BGR8, BGR10, BGR12, BGR16
RGBA8, RGBA10, RGBA12, RGBA16
BGRA8, BGRA10, BGRA12, BGRA16
BayerRG8, BayerRG10, BayerRG12, BayerRG16
BayerGR8, BayerGR10, BayerGR12, BayerGR16
BayerBG8, BayerBG10, BayerBG12, BayerBG16
BayerGB8, BayerGB10, BayerGB12, BayerGB16

The bayer formats are automatically converted to the BGR8 format.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Camera settings
Camera	Camera settings		[ONLINE]	string	The name, model and serial number of the available cameras are listed. The selected camera is identified by its serial number when the port is started.
User set	Camera settings	<manual>	[ONLINE]	string	For advanced camera configurations, it is recommended to set the properties in the camera software, save them in a user set on the camera. You can load the user set when starting the configuration. For simple setups, you can configure basic properties such as resolution and fps manually by selecting “<manual>”.
Pixel format	Camera settings » User set: ‘<manual>’		[ONLINE]	string	A list of the camera’s supported pixel formats filtered by formats that are supported by ecu.test.
Width	Camera settings » User set: ‘<manual>’	640		int	Width of the camera frame.
Height	Camera settings » User set: ‘<manual>’	480		int	Height of the camera frame.
Frame rate	Camera settings » User set: ‘<manual>’	30		int	The desired frame rate for capturing
Live preview		☐		bool	Streams a live preview on the configured network port. The live stream is available under the toolhost’s IP address and the configured port, e.g. for a local tool connection: http://127.0.0.1:<port>
Open preview window	Live preview	☑		bool	Opens a preview window upon loading the configuration. This window displays the current output of the image source as a livestream and will remain open as long as the test configuration is active.
Port	Live preview	‘<auto>’		string	The network port that will be used for live streaming. Every live stream needs an unique port if live streaming is enabled for multiple video sources. If the value is set to <auto> a free network port will be defined by the system.
Show text overlay in video recordings		☐		bool	Adds a text overlay with the format “timestamp package name” in the bottom left corner of video recordings.
Show binary timestamp		☐		bool	The current timestamp of the camera in nanoseconds is stored in a 64 bit unsigned integer and written to the first 64 pixels in the upper left corner of the frame.
Show human-readable timestamp		☐		bool	Adds a human-readable timestamp to the video frames. The position and format can be configured.
Timestamp format	Show human-readable timestamp	‘%Y-%m-%d %H:%M:%S.%f’		string	The format of the timestamp according to Python’s datetime formatting. For example, “%Y-%m-%d %H:%M:%S.%f” would result in a timestamp like “2023-01-31 13:45:30.123456”.
Position X	Show human-readable timestamp	10		int	The X position (in pixels) of the timestamp in the video frame. Measured from the left border.
Position Y	Show human-readable timestamp	10		int	The Y position (in pixels) of the timestamp in the video frame. Measured from the top border.
Font size	Show human-readable timestamp	10		int	The font size (height of letter “A”) of the timestamp text in the video frame in pixels.

Jobs 🛈¶

ExecuteProperty¶

Calls the execute() method on the property.

Parameter

Name	Available if	Default value	Valid values	Type	Description
prop				string	Name of the property. Get all available names with job “ListProperties”.

GetProperty¶

Returns a property’s value.

Parameter

Name	Available if	Default value	Valid values	Type	Description
prop		‘Width’		string	Name of the property. Get all available names with job “ListProperties”.

Return value

Name	Available if	Default value	Valid values	Type	Description
return				object	Returns the current value of the given property.

ListProperties¶

Lists all available properties for device.

Return value

Name	Available if	Default value	Valid values	Type	Description
return				object	List with names of all properties.

SetProperty¶

Sets a property’s value.

Parameter

Name	Available if	Default value	Valid values	Type	Description
prop		‘Width’		string	Name of the property. Get all available names with job “ListProperties”.
value				object	New value for the given property.