Aravis.Interface

Subclasses:

Aravis.FakeInterface, Aravis.GvInterface, Aravis.UvInterface

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	get_device_address (index)
	get_device_id (index)
	get_device_manufacturer_info (index)
	get_device_model (index)
	get_device_physical_id (index)
	get_device_protocol (index)
	get_device_serial_nbr (index)
	get_device_vendor (index)
	get_n_devices ()
	open_device (device_id)
	update_device_list ()

Virtual Methods

Inherited:

GObject.Object (7)

do_open_device (device_id)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.Object	r

Class Details

class Aravis.Interface(**kwargs)

Bases:

GObject.Object

Abstract:

Yes

Structure:

Aravis.InterfaceClass

Aravis.Interface is an abstract base class for camera discovery. It maintains a list of the available devices and helps to instantiate the corresponding Aravis.Device objects. If the user already knows the device id of the device, he should not worry about this class and just use Aravis.Camera.new() or Aravis.open_device().

get_device_address(index)

Parameters:

index (int) – device index

Returns:

the device address

Return type:

str

queries the device address (IP address in the case of an ethernet camera). Useful for constructing manual connections to devices using arv_gv_device_new

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

New in version 0.2.0.

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.Interface.update_device_list() function must be called.

New in version 0.2.0.

get_device_manufacturer_info(index)

Parameters:

index (int) – device index

Returns:

the device manufacturer info, None on error

Return type:

str

Queries the device manufacturer info.

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

New in version 0.8.20.

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.Interface.update_device_list() function must be called.

New in version 0.6.0.

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.Interface.update_device_list() function must be called.

New in version 0.2.0.

get_device_protocol(index)

Parameters:

index (int) – device index

Returns:

the device protocol as a string, None on error

Return type:

str

Queries the device protocol. Possible values are ‘USB3Vision’, ‘GigEVision’ and ‘Fake’.

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

New in version 0.6.0.

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.Interface.update_device_list() function must be called.

New in version 0.6.0.

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.Interface.update_device_list() function must be called.

New in version 0.6.0.

get_n_devices()

Returns:

the number of available devices

Return type:

int

Queries the number of available devices on this interface. Prior to this call the arv_interface_update_device_list function must be called. The list content will not change until the next call of the update function.

New in version 0.2.0.

open_device(device_id)

Parameters:

device_id (str or None) – device unique id

Raises:

GLib.Error

Returns:

a new Aravis.Device

Return type:

Aravis.Device

Creates a new Aravis.Device object corresponding to the given device id string. The first available device is returned if device_id is None.

New in version 0.2.0.

update_device_list()

Updates the internal list of available devices. This may change the connection between a list index and a device ID.

New in version 0.2.0.

do_open_device(device_id) virtual

Parameters:

device_id (str or None) – device unique id

Returns:

a new Aravis.Device

Return type:

Aravis.Device

Creates a new Aravis.Device object corresponding to the given device id string. The first available device is returned if device_id is None.

New in version 0.2.0.