Aravis.GvDevice¶

Subclasses:: None

Methods¶

Inherited:: Aravis.Device (33), GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (interface_address, device_address)
	`auto_packet_size` ()
	`get_current_ip` ()
	`get_device_address` ()
	`get_interface_address` ()
	`get_ip_configuration_mode` ()
	`get_packet_size` ()
	`get_persistent_ip` ()
	`get_stream_options` ()
	`get_timestamp_tick_frequency` ()
	`is_controller` ()
	`leave_control` ()
	`set_ip_configuration_mode` (mode)
	`set_packet_size` (packet_size)
	`set_packet_size_adjustment` (adjustment)
	`set_persistent_ip` (ip, mask, gateway)
	`set_persistent_ip_from_string` (ip, mask, gateway)
	`set_stream_options` (options)
	`take_control` ()

Virtual Methods¶

Inherited:: Aravis.Device (7), GObject.Object (7), Gio.Initable (1)

Properties¶

Name	Type	Flags	Short Description
`device-address`	`Gio.InetAddress`	w/co	The device address
`interface-address`	`Gio.InetAddress`	w/co	The address of the interface connected to the device
`packet-size-adjustment`	`Aravis.GvPacketSizeAdjustment`	r/w/c	Packet size adjustment option

Signals¶

Inherited:: Aravis.Device (1), GObject.Object (1)

Fields¶

Inherited:: Aravis.Device (1), GObject.Object (1)

Class Details¶

class Aravis.GvDevice(**kwargs)¶

Bases:: Aravis.Device
Abstract:: No
Structure:: Aravis.GvDeviceClass

classmethod new(interface_address, device_address)¶

Parameters:

interface_address (Gio.InetAddress) – address of the interface connected to the device
device_address (Gio.InetAddress) – device address

Raises:

GLib.Error

Returns:

a newly created Aravis.Device using GigE protocol

Return type:

Aravis.Device

New in version 0.8.0.

auto_packet_size()¶

Raises:: GLib.Error
Returns:: The automatic packet size, in bytes, or the current one if GevSCPSFireTestPacket is not supported.
Return type:: int

Automatically determine the biggest packet size that can be used data streaming, and set ArvGevSCPSPacketSize value accordingly. This function relies on the GevSCPSFireTestPacket feature.

New in version 0.6.0.

get_current_ip()¶

Raises:

GLib.Error

Returns:

True on success

ip:: a IP address placeholder
mask:: a netmask placeholder
gateway:: a gateway IP address placeholder

Return type:

(bool, ip: Gio.InetAddress, mask: Gio.InetAddressMask, gateway: Gio.InetAddress)

Get the current IP address setting of device.

New in version 0.8.22.

get_device_address()¶

Returns:: the device IP address.
Return type:: Gio.SocketAddress

New in version 0.2.0.

get_interface_address()¶

Returns:: the device host interface IP address.
Return type:: Gio.SocketAddress

New in version 0.2.0.

get_ip_configuration_mode()¶

Raises:: GLib.Error
Returns:: IP address configuration mode
Return type:: Aravis.GvIpConfigurationMode

Get the IP address configuration mode.

New in version 0.8.22.

get_packet_size()¶

Raises:: GLib.Error
Return type:: int

get_persistent_ip()¶

Raises:

GLib.Error

Returns:

True on success

ip:: a IP address placeholder
mask:: a netmask placeholder
gateway:: a gateway IP address placeholder

Return type:

(bool, ip: Gio.InetAddress, mask: Gio.InetAddressMask, gateway: Gio.InetAddress)

Get the persistent IP address setting of device.

New in version 0.8.22.

get_stream_options()¶

Returns:: options for stream creation
Return type:: Aravis.GvStreamOption

New in version 0.6.0.

get_timestamp_tick_frequency()¶

Raises:: GLib.Error
Return type:: int

is_controller()¶

Returns:: value indicating whether the Aravis.GvDevice has control access to the camera
Return type:: bool

New in version 0.8.0.

leave_control()¶

Raises:: GLib.Error
Returns:: whether the control was successfully relinquished
Return type:: bool

New in version 0.8.3.

set_ip_configuration_mode(mode)¶

Parameters:: mode (Aravis.GvIpConfigurationMode) – IP address configuration mode
Raises:: GLib.Error
Returns:: True on success
Return type:: bool

Sets the IP address configuration mode. Available modes are Aravis.GvIpConfigurationMode.DHCP, Aravis.GvIpConfigurationMode.PERSISTENT_IP, Aravis.GvIpConfigurationMode.LLA

New in version 0.8.22.

set_packet_size(packet_size)¶

Parameters:: packet_size (int) –
Raises:: GLib.Error

set_packet_size_adjustment(adjustment)¶

Parameters:: adjustment (Aravis.GvPacketSizeAdjustment) – a Aravis.GvPacketSizeAdjustment option

Sets the option for the packet size adjustment happening at stream object creation. See Aravis.GvDevice.auto_packet_size() for a description of the packet adjustment feature. The default behaviour is ARV_GV_PACKET_SIZE_ADJUSTEMENT_ON_FAILURE_ONCE, which means the packet size is adjusted if the current packet size check fails, and only the first time Aravis.Device.create_stream() is successfully called during self instance life.

New in version 0.8.3.

set_persistent_ip(ip, mask, gateway)¶

Parameters:

ip (Gio.InetAddress or None) – IPv4 address
mask (Gio.InetAddressMask or None) – Netmask
gateway (Gio.InetAddress or None) – Gateway IPv4 address

Raises:

GLib.Error

Returns:

True on success

Return type:

bool

Sets the persistent IP address to device. Also disable DHCP then enable persistent IP mode.

New in version 0.8.22.

set_persistent_ip_from_string(ip, mask, gateway)¶

Parameters:

ip (str or None) – IPv4 address in string format
mask (str or None) – netmask in string format
gateway (str or None) – Gateway IPv4 address in string format

Raises:

GLib.Error

Returns:

True on success

Return type:

bool

Sets the persistent IP address to device.

New in version 0.8.22.

set_stream_options(options)¶

Parameters:: options (Aravis.GvStreamOption) – options for stream creation

Sets the option used during stream creation. It must be called before Aravis.Device.create_stream().

New in version 0.6.0.

take_control()¶

Raises:: GLib.Error
Returns:: whether the control was successfully acquired
Return type:: bool

New in version 0.8.3.

Property Details¶

Aravis.GvDevice.props.device_address¶

Name:: device-address
Type:: Gio.InetAddress
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The device address

Aravis.GvDevice.props.interface_address¶

Name:: interface-address
Type:: Gio.InetAddress
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The address of the interface connected to the device

Aravis.GvDevice.props.packet_size_adjustment¶

Name:: packet-size-adjustment
Type:: Aravis.GvPacketSizeAdjustment
Default Value:: Aravis.GvPacketSizeAdjustment.ON_FAILURE_ONCE
Flags:: READABLE, WRITABLE, CONSTRUCT

Packet size adjustment option