System nodes

Lists all the pre-listed nodes of the SpinSystem and InterfaceDevice.

Classes:

`SystemNodes`	Lists all the pre-listed nodes of the `SpinSystem`.
`InterfaceNodes`	Lists all the pre-listed nodes of the `InterfaceDevice`.

class SystemNodes(system)

Bases: object

Lists all the pre-listed nodes of the SpinSystem.

Warning

Do not create a SystemNodes manually, rather get it from system_nodes that is automatically created when the system is instantiated.

Warning

Once the associated system is freed, the nodes are not valid anymore.

Note

Even though the nodes are pre-listed, it is simply a convenience and the same nodes can be gotten by name through NodeMap. Additionally, you must check that the node is actually available, readable etc, even if it’s pre-listed.

Attributes:

`EnumerateGEVInterfaces`	Enables or disables enumeration of GEV Interfaces.
`EnumerateGen2Cameras`	Enables or disables the enumeration of USB3 and GigE based Generation 2 cameras.
`EnumerateUSBInterfaces`	Enables or disables enumeration of USB Interfaces.
`GenTLSFNCVersionMajor`	Major version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
`GenTLSFNCVersionMinor`	Minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
`GenTLSFNCVersionSubMinor`	Sub minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
`GenTLVersionMajor`	Major version number of the GenTL specification the GenTL Producer implementation complies with.
`GenTLVersionMinor`	Minor version number of the GenTL specification the GenTL Producer implementation complies with.
`GevInterfaceDefaultGateway`	Gateway of the selected interface.
`GevInterfaceDefaultIPAddress`	IP address of the first subnet of the selected interface.
`GevInterfaceDefaultSubnetMask`	Subnet mask of the first subnet of the selected interface.
`GevInterfaceMACAddress`	48-bit MAC address of the selected interface.
`GevVersionMajor`	Major version number of the GigE Vision specification the GenTL Producer implementation complies to.
`GevVersionMinor`	Minor version number of the GigE Vision specification the GenTL Producer implementation complies to.
`InterfaceDisplayName`	A user-friendly name of the selected Interface.
`InterfaceID`	GenTL Producer wide unique identifier of the selected interface.
`InterfaceSelector`	Selector for the different GenTL Producer interfaces.
`InterfaceUpdateList`	Updates the internal list of the interfaces.
`TLDisplayName`	User readable name of the GenTL Producer.
`TLFileName`	Filename including extension of the GenTL Producer.
`TLID`	Unique identifier of the GenTL Producer like a GUID.
`TLModelName`	Name of the GenTL Producer to distinguish different kinds of GenTL Producer implementations from one vendor.
`TLPath`	Full path to the GenTL Producer including filename and extension.
`TLType`	Transport layer type of the GenTL Producer implementation.
`TLVendorName`	Name of the GenTL Producer vendor.
`TLVersion`	Vendor specific version string.
`bool_nodes`	bool_nodes: list A list of all the names of the bool nodes.
`command_nodes`	command_nodes: list A list of all the names of the command nodes.
`enum_nodes`	enum_nodes: list A list of all the names of the enum nodes.
`float_nodes`	float_nodes: list A list of all the names of the float nodes.
`int_nodes`	int_nodes: list A list of all the names of the integer nodes.
`register_nodes`	register_nodes: list A list of all the names of the register nodes.
`str_nodes`	str_nodes: list A list of all the names of the string nodes.

EnumerateGEVInterfaces

Enables or disables enumeration of GEV Interfaces.

Property type: SpinBoolNode.
Visibility: default.

EnumerateGen2Cameras

Enables or disables the enumeration of USB3 and GigE based Generation 2 cameras. This includes the CM3, FL3, GS3, and BFLY families.

Property type: SpinBoolNode.
Visibility: default.

EnumerateUSBInterfaces

Enables or disables enumeration of USB Interfaces.

Property type: SpinBoolNode.
Visibility: default.

GenTLSFNCVersionMajor

Major version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Property type: SpinIntNode.
Visibility: default.

GenTLSFNCVersionMinor

Minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Property type: SpinIntNode.
Visibility: default.

GenTLSFNCVersionSubMinor

Sub minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Property type: SpinIntNode.
Visibility: default.

GenTLVersionMajor

Major version number of the GenTL specification the GenTL Producer implementation complies with.

Property type: SpinIntNode.
Visibility: default.

GenTLVersionMinor

Minor version number of the GenTL specification the GenTL Producer implementation complies with.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceDefaultGateway

Gateway of the selected interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceDefaultIPAddress

IP address of the first subnet of the selected interface. Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceDefaultSubnetMask

Subnet mask of the first subnet of the selected interface. Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceMACAddress

48-bit MAC address of the selected interface. Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory.

Property type: SpinIntNode.
Visibility: default.

GevVersionMajor

Major version number of the GigE Vision specification the GenTL Producer implementation complies to.

Property type: SpinIntNode.
Visibility: default.

GevVersionMinor

Minor version number of the GigE Vision specification the GenTL Producer implementation complies to.

Property type: SpinIntNode.
Visibility: default.

InterfaceDisplayName

A user-friendly name of the selected Interface.

Property type: SpinStrNode.
Visibility: default.

InterfaceID

GenTL Producer wide unique identifier of the selected interface.

Property type: SpinStrNode.
Visibility: default.

InterfaceSelector

Selector for the different GenTL Producer interfaces. This interface list only changes on execution of “InterfaceUpdateList”. The selector is 0-based in order to match the index of the C interface.

Property type: SpinIntNode.
Visibility: default.

InterfaceUpdateList

Updates the internal list of the interfaces. This feature is readable even if the execution cannot be performed immediately. The command then returns and the status can be polled. This function interacts with the TLUpdateInterfaceList function of the GenTL producer. It is up to the GenTL consumer to handle access in case both methods are used.

Property type: SpinCommandNode.
Visibility: default.

TLDisplayName

User readable name of the GenTL Producer.

Property type: SpinStrNode.
Visibility: default.

TLFileName

Filename including extension of the GenTL Producer.

Property type: SpinStrNode.
Visibility: default.

TLID

Unique identifier of the GenTL Producer like a GUID.

Property type: SpinStrNode.
Visibility: default.

TLModelName

Name of the GenTL Producer to distinguish different kinds of GenTL Producer implementations from one vendor.

Property type: SpinStrNode.
Visibility: default.

TLPath

Full path to the GenTL Producer including filename and extension.

Property type: SpinStrNode.
Visibility: default.

TLType

Transport layer type of the GenTL Producer implementation.

Property type: SpinEnumDefNode.
Enum entries: TLType_names.
Visibility: default.

TLVendorName

Name of the GenTL Producer vendor.

Property type: SpinStrNode.
Visibility: default.

TLVersion

Vendor specific version string.

Property type: SpinStrNode.
Visibility: default.

bool_nodes: bool_nodes: list A list of all the names of the bool nodes.

command_nodes: command_nodes: list A list of all the names of the command nodes.

enum_nodes: enum_nodes: list A list of all the names of the enum nodes.

float_nodes: float_nodes: list A list of all the names of the float nodes.

int_nodes: int_nodes: list A list of all the names of the integer nodes.

register_nodes: register_nodes: list A list of all the names of the register nodes.

str_nodes: str_nodes: list A list of all the names of the string nodes.

class InterfaceNodes(interface)

Bases: object

Lists all the pre-listed nodes of the InterfaceDevice.

Warning

Do not create a InterfaceNodes manually, rather get it from interface_nodes that is automatically created when the interface is instantiated.

Warning

Once the associated interface is freed, the nodes are not valid anymore.

Note

Even though the nodes are pre-listed, it is simply a convenience and the same nodes can be gotten by name through NodeMap. Additionally, you must check that the node is actually available, readable etc, even if it’s pre-listed.

Attributes:

`ActionCommand`	Issues an Action Command to attached GEV devices on interface.
`DeviceAccessStatus`	Gives the device's access status at the moment of the last execution of "DeviceUpdateList".
`DeviceCount`	Number of compatible devices detected on current interface.
`DeviceID`	Interface wide unique identifier of the selected device.
`DeviceModelName`	Name of the device model.
`DeviceSelector`	Selector for the different devices on this interface.
`DeviceSerialNumber`	Serial number of the selected remote device.
`DeviceUnlock`	Unlocks devices for internal use.
`DeviceUpdateList`	Updates the internal device list.
`DeviceVendorName`	Name of the device vendor.
`FilterDriverStatus`	Reports whether FLIR Light Weight Filter Driver is enabled, disabled, or not installed.
`GevActionDeviceKey`	Key to authorize the action for the device.
`GevActionGroupKey`	Provides the key that the device will use to validate the action on reception of the action protocol message.
`GevActionGroupMask`	Provides the mask that the device will use to validate the action on reception of the action protocol message.
`GevActionTime`	Provides the time in nanoseconds when the action is to be executed.
`GevDeviceAutoForceIP`	Automatically forces the selected remote device to an IP Address on the same subnet as the GVCP interface.
`GevDeviceForceGateway`	Static gateway IP address to set for the GVCP interface of the selected remote device.
`GevDeviceForceIP`	Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the selected remote device using ForceIP command.
`GevDeviceForceIPAddress`	Static IP address to set for the GVCP interface of the selected remote device.
`GevDeviceForceSubnetMask`	Static subnet mask to set for GVCP interface of the selected remote device.
`GevDeviceGateway`	Current gateway IP address of the GVCP interface of the selected remote device.
`GevDeviceIPAddress`	Current IP address of the GVCP interface of the selected remote device.
`GevDeviceMACAddress`	48-bit MAC address of the GVCP interface of the selected remote device.
`GevDeviceSubnetMask`	Current subnet mask of the GVCP interface of the selected remote device.
`GevInterfaceGateway`	IP address of the selected gateway entry of this interface.
`GevInterfaceGatewaySelector`	Selector for the different gateway entries for this interface.
`GevInterfaceMACAddress`	48-bit MAC address of this interface.
`GevInterfaceMTU`	Maximum transmission unit of this interface.
`GevInterfaceReceiveLinkSpeed`	Receive link speed of this interface in bits per second.
`GevInterfaceSubnetIPAddress`	IP address of the selected subnet of this interface.
`GevInterfaceSubnetMask`	Subnet mask of the selected subnet of this interface.
`GevInterfaceSubnetSelector`	Selector for the subnet of this interface.
`GevInterfaceTransmitLinkSpeed`	Transmit link speed of this interface in bits per second.
`HostAdapterDriverVersion`	Driver version of the interface's host adapter.
`HostAdapterName`	User readable name of the interface's host adapter.
`HostAdapterVendor`	User readable name of the host adapter's vendor.
`IncompatibleDeviceCount`	Number of incompatible devices detected on current interface.
`IncompatibleDeviceID`	Interface wide unique identifier of the selected incompatible device.
`IncompatibleDeviceModelName`	Name of the incompatible device model.
`IncompatibleDeviceSelector`	Selector for the devices that are not compatible with Spinnaker on this interface.
`IncompatibleDeviceVendorName`	Name of the incompatible device vendor.
`IncompatibleGevDeviceIPAddress`	Current IP address of the GVCP interface of the selected remote incompatible device.
`IncompatibleGevDeviceMACAddress`	48-bit MAC address of the GVCP interface of the selected remote incompatible device.
`IncompatibleGevDeviceSubnetMask`	Current subnet mask of the GVCP interface of the selected remote incompatible device.
`InterfaceDisplayName`	User readable name of the selected interface.
`InterfaceID`	Transport layer Producer wide unique identifier of the selected interface.
`InterfaceType`	Transport layer type of the interface.
`POEStatus`	Reports and controls the interface's power over Ethernet status.
`bool_nodes`	bool_nodes: list A list of all the names of the bool nodes.
`command_nodes`	command_nodes: list A list of all the names of the command nodes.
`enum_nodes`	enum_nodes: list A list of all the names of the enum nodes.
`float_nodes`	float_nodes: list A list of all the names of the float nodes.
`int_nodes`	int_nodes: list A list of all the names of the integer nodes.
`register_nodes`	register_nodes: list A list of all the names of the register nodes.
`str_nodes`	str_nodes: list A list of all the names of the string nodes.

ActionCommand

Issues an Action Command to attached GEV devices on interface.

Property type: SpinCommandNode.
Visibility: default.

DeviceAccessStatus

Gives the device’s access status at the moment of the last execution of “DeviceUpdateList”. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinEnumDefNode.
Enum entries: DeviceAccessStatus_names.
Visibility: default.

DeviceCount

Number of compatible devices detected on current interface.

Property type: SpinIntNode.
Visibility: default.

DeviceID

Interface wide unique identifier of the selected device. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

DeviceModelName

Name of the device model. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

DeviceSelector

Selector for the different devices on this interface. This value only changes on execution of “DeviceUpdateList”. The selector is 0-based in order to match the index of the C interface.

Property type: SpinIntNode.
Visibility: default.

DeviceSerialNumber

Serial number of the selected remote device.

Property type: SpinStrNode.
Visibility: default.

DeviceUnlock

Unlocks devices for internal use.

Property type: SpinStrNode.
Visibility: default.

DeviceUpdateList

Updates the internal device list.

Property type: SpinCommandNode.
Visibility: default.

DeviceVendorName

Name of the device vendor. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

FilterDriverStatus

Reports whether FLIR Light Weight Filter Driver is enabled, disabled, or not installed.

Property type: SpinEnumDefNode.
Enum entries: FilterDriverStatus_names.
Visibility: default.

GevActionDeviceKey

Key to authorize the action for the device.

Property type: SpinIntNode.
Visibility: default.

GevActionGroupKey

Provides the key that the device will use to validate the action on reception of the action protocol message.

Property type: SpinIntNode.
Visibility: default.

GevActionGroupMask

Provides the mask that the device will use to validate the action on reception of the action protocol message.

Property type: SpinIntNode.
Visibility: default.

GevActionTime

Provides the time in nanoseconds when the action is to be executed.

Property type: SpinIntNode.
Visibility: default.

GevDeviceAutoForceIP

Automatically forces the selected remote device to an IP Address on the same subnet as the GVCP interface.

Property type: SpinCommandNode.
Visibility: default.

GevDeviceForceGateway

Static gateway IP address to set for the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceForceIP

Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the selected remote device using ForceIP command.

Property type: SpinCommandNode.
Visibility: default.

GevDeviceForceIPAddress

Static IP address to set for the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceForceSubnetMask

Static subnet mask to set for GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceGateway

Current gateway IP address of the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceIPAddress

Current IP address of the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceMACAddress

48-bit MAC address of the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevDeviceSubnetMask

Current subnet mask of the GVCP interface of the selected remote device.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceGateway

IP address of the selected gateway entry of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceGatewaySelector

Selector for the different gateway entries for this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceMACAddress

48-bit MAC address of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceMTU

Maximum transmission unit of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceReceiveLinkSpeed

Receive link speed of this interface in bits per second.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceSubnetIPAddress

IP address of the selected subnet of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceSubnetMask

Subnet mask of the selected subnet of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceSubnetSelector

Selector for the subnet of this interface.

Property type: SpinIntNode.
Visibility: default.

GevInterfaceTransmitLinkSpeed

Transmit link speed of this interface in bits per second.

Property type: SpinIntNode.
Visibility: default.

HostAdapterDriverVersion

Driver version of the interface’s host adapter.

Property type: SpinStrNode.
Visibility: default.

HostAdapterName

User readable name of the interface’s host adapter.

Property type: SpinStrNode.
Visibility: default.

HostAdapterVendor

User readable name of the host adapter’s vendor.

Property type: SpinStrNode.
Visibility: default.

IncompatibleDeviceCount

Number of incompatible devices detected on current interface.

Property type: SpinIntNode.
Visibility: default.

IncompatibleDeviceID

Interface wide unique identifier of the selected incompatible device. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

IncompatibleDeviceModelName

Name of the incompatible device model. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

IncompatibleDeviceSelector

Selector for the devices that are not compatible with Spinnaker on this interface. This value only changes on execution of “DeviceUpdateList”. The selector is 0-based in order to match the index of the C interface.

Property type: SpinIntNode.
Visibility: default.

IncompatibleDeviceVendorName

Name of the incompatible device vendor. This value only changes on execution of “DeviceUpdateList”.

Property type: SpinStrNode.
Visibility: default.

IncompatibleGevDeviceIPAddress

Current IP address of the GVCP interface of the selected remote incompatible device.

Property type: SpinIntNode.
Visibility: default.

IncompatibleGevDeviceMACAddress

48-bit MAC address of the GVCP interface of the selected remote incompatible device.

Property type: SpinIntNode.
Visibility: default.

IncompatibleGevDeviceSubnetMask

Current subnet mask of the GVCP interface of the selected remote incompatible device.

Property type: SpinIntNode.
Visibility: default.

InterfaceDisplayName

User readable name of the selected interface.

Property type: SpinStrNode.
Visibility: default.

InterfaceID

Transport layer Producer wide unique identifier of the selected interface.

Property type: SpinStrNode.
Visibility: default.

InterfaceType

Transport layer type of the interface.

Property type: SpinEnumDefNode.
Enum entries: InterfaceType_names.
Visibility: default.

POEStatus

Reports and controls the interface’s power over Ethernet status.

Property type: SpinEnumDefNode.
Enum entries: POEStatus_names.
Visibility: default.

bool_nodes: bool_nodes: list A list of all the names of the bool nodes.

command_nodes: command_nodes: list A list of all the names of the command nodes.

enum_nodes: enum_nodes: list A list of all the names of the enum nodes.

float_nodes: float_nodes: list A list of all the names of the float nodes.

int_nodes: int_nodes: list A list of all the names of the integer nodes.

register_nodes: register_nodes: list A list of all the names of the register nodes.

str_nodes: str_nodes: list A list of all the names of the string nodes.