Functions

  acquisition_mode_from_string (string)
  acquisition_mode_to_string (value)
  auto_from_string (string)
  auto_to_string (value)
  debug_check (category, level)
  debug_enable (category_selection)
  debug_shutdown ()
  disable_interface (interface_id)
  dom_implementation_add_document_type (qualified_name, document_type)
  dom_implementation_cleanup ()
  dom_implementation_create_document (namespace_uri, qualified_name)
  enable_interface (interface_id)
  gc_error_quark ()
  get_device_address (index)
  get_device_id (index)
  get_device_model (index)
  get_device_physical_id (index)
  get_device_protocol (index)
  get_device_serial_nbr (index)
  get_device_vendor (index)
  get_fake_camera_genicam_xml (size)
  get_interface_id (index)
  get_n_devices ()
  get_n_interfaces ()
  make_thread_high_priority (nice_level)
  make_thread_realtime (priority)
  open_device (device_id)
  set_fake_camera_genicam_filename (filename)
  shutdown ()
  update_device_list ()

Details

Aravis.acquisition_mode_from_string(string)
Parameters:string (str) –
Return type:Aravis.AcquisitionMode
Aravis.acquisition_mode_to_string(value)
Parameters:value (Aravis.AcquisitionMode) –
Return type:str
Aravis.auto_from_string(string)
Parameters:string (str) –
Return type:Aravis.Auto
Aravis.auto_to_string(value)
Parameters:value (Aravis.Auto) –
Return type:str
Aravis.debug_check(category, level)
Parameters:
Return type:

bool

Aravis.debug_enable(category_selection)
Parameters:category_selection (str) – debug category configuration string

Configures the debug output using a configuration string consisting of a comma separated list of debug categories or category/debug level pair. This function overwrites the configuration done by ARV_DEBUG environment variable. For example, enabling debug level 3 of the gvcp category and default debug level of category genicam is done using:

arv_debug_enable ("gvcp:3,genicam");

Aravis.debug_shutdown()
Aravis.disable_interface(interface_id)
Parameters:interface_id (str) – name of the interface

Disable an interface by name. By default, all interfaces are enabled, except ‘Fake’.

Aravis.dom_implementation_add_document_type(qualified_name, document_type)
Parameters:
Aravis.dom_implementation_cleanup()
Aravis.dom_implementation_create_document(namespace_uri, qualified_name)
Parameters:
  • namespace_uri (str) – namespace URI
  • qualified_name (str) – qualified name
Returns:

a new Aravis.DomDocument, None on error:

Return type:

Aravis.DomDocument

Create a new DOM document. Currently, only qualified_name is used.

Aravis.enable_interface(interface_id)
Parameters:interface_id (str) – name of the interface

Enable an interface by name. By default, all interfaces are enabled, except ‘Fake’.

Aravis.gc_error_quark()
Return type:int
Aravis.get_device_address(index)
Parameters:index (int) – device index
Returns:The address of the device corresponding to index as a string.
Return type:str

The index of a device may change after a call to Aravis.update_device_list().

New in version 0.6.0.

Aravis.get_device_id(index)
Parameters:index (int) – device index
Returns:a unique device id
Return type:str

Queries the unique device id corresponding to index. Prior to this call the Aravis.update_device_list() function must be called.

New in version 0.2.0.

Aravis.get_device_model(index)
Parameters:index (int) – device index
Returns:the device model, None on error
Return type:str

Queries the device model.

Prior to this call the Aravis.update_device_list() function must be called.

New in version 0.6.0.

Aravis.get_device_physical_id(index)
Parameters:index (int) – device index
Returns:a physical device id
Return type:str

Queries the physical device id corresponding to index such as the MAC address for Ethernet based devices, bus id for PCI, USB or Firewire based devices.

Prior to this call the Aravis.update_device_list() function must be called.

New in version 0.2.0.

Aravis.get_device_protocol(index)
Parameters:index (int) – device index
Returns:The device protocol as a string.
Return type:str

The index of a device may change after a call to Aravis.update_device_list().

New in version 0.6.0.

Aravis.get_device_serial_nbr(index)
Parameters:index (int) – device index
Returns:the device serial, None on error
Return type:str

Queries the device serial.

Prior to this call the Aravis.update_device_list() function must be called.

New in version 0.6.0.

Aravis.get_device_vendor(index)
Parameters:index (int) – device index
Returns:the device vendor, None on error
Return type:str

Queries the device vendor.

Prior to this call the Aravis.update_device_list() function must be called.

New in version 0.6.0.

Aravis.get_fake_camera_genicam_xml(size)
Parameters:size (int) –
Return type:str
Aravis.get_interface_id(index)
Parameters:index (int) – interface index
Returns:The interfae identifier string.
Return type:str

Retrieves the interface identifier. Possible values are ‘Fake’, ‘USB3Vision’ and ‘GigEVision’.

Aravis.get_n_devices()
Returns:The number of currently online devices.
Return type:int

Retrieves the number of currently online devices. This value is valid until the next call to Aravis.update_device_list().

Aravis.get_n_interfaces()
Returns:The number of available interfaces.
Return type:int

Gets the number of available interfaces, including the disabled ones.

Aravis.make_thread_high_priority(nice_level)
Parameters:nice_level (int) – new nice level
Returns:True on success.

Try to set current thread nice level to high priority, using rtkit.

Return type:bool

New in version 0.4.0.

Aravis.make_thread_realtime(priority)
Parameters:priority (int) – realtime priority
Returns:True on success.

Try to make current thread realtime. It first try to use sched_setscheduler, and if it fails, use rtkit.

Return type:bool

New in version 0.4.0.

Aravis.open_device(device_id)
Parameters:device_id (str or None) – a device identifier string
Returns:A new Aravis.Device instance.
Return type:Aravis.Device

Open a device corresponding to the given identifier. A None string makes this function return the first available device.

New in version 0.2.0.

Aravis.set_fake_camera_genicam_filename(filename)
Parameters:filename (str) –
Aravis.shutdown()

Frees a number of ressources allocated by Aravis that would be otherwise reported as memory leak by tools like Valgrind. The call to this function is optional if you don’t intend to check for memmory leaks.

Aravis.update_device_list()

Updates the list of currently online devices.