IpConfigurator Class#

This class provides helper functions to work with IP based camera devices.

Inheritance Hierarchy#

System.Object
  Basler.Pylon.IpConfigurator

Syntax#

C#

public static class IpConfigurator

VB

Public NotInheritable Class IpConfigurator

The IpConfigurator type exposes the following members.

Methods#

	Name	Description
	AnnounceRemoteDevice	Announce that a remote device is going to be used.
	ChangeIpConfiguration(String, IpConfigurationMethod)	Change the IP configuration of a camera device.
	ChangeIpConfiguration(String, IpConfigurationMethod, String, String, String)	Change the IP configuration of a camera device.
	EnumerateAllDevices	Enumerates all available GigE Vision devices.
	IsAutoIpActive	Checks if camera device is working in automatic IP configuration, also known as link-local address.
	IsAutoIpSupported	Checks if camera device supports automatic IP configuration, also known as link-local address.
	IsDhcpActive	Checks if camera device is working in DHCP configuration.
	IsDhcpSupported	Checks if camera device supports DHCP configuration.
	IsPersistentIpActive	Checks if camera device is working in persistent IP configuration, also known as static IP configuration.
	IsPersistentIpSupported	Checks if camera device supports persistent IP configuration, also known as static IP configuration.
	RenounceRemoteDevice	Stop using remote device.

IpConfigurator.AnnounceRemoteDevice Method#

Announce that a remote device is going to be used.

Syntax#

C#

public static ICameraInfo AnnounceRemoteDevice(
    string ipAddress
)

VB

Public Shared Function AnnounceRemoteDevice ( 
    ipAddress As String
) As ICameraInfo

Parameters#

ipAddress

Type: System.String
Address of device in "dot notation".

Return Value#

Type: ICameraInfo
Returns ICameraInfo if the camera device is found.

Remarks#

This is necessary when working with IP-based camera devices that are behind a router.In order to succeed, that camera device must be reachable and a route configured.Most system setups will not need this.If all your camera devices are found using the CameraFinder, you will not need this.The announcement can be reverted using RenounceRemoteDevice().

Please note that devices announced using this function are only remembered temporarily. If you annouce a device and then stop using pylon in your program, the underlying pylon might get disposed and the information about announced devices is lost. It is recommended to hold at least one pylon object from the time this function is called to the time the device is opened.

IpConfigurator.ChangeIpConfiguration Method (String, IpConfigurationMethod)#

Change the IP configuration of a camera device.

Syntax#

C#

public static bool ChangeIpConfiguration(
    string macAddress,
    IpConfigurationMethod method
)

VB

Public Shared Function ChangeIpConfiguration ( 
    macAddress As String,
    method As IpConfigurationMethod
) As Boolean

Parameters#

macAddress

Type: System.String
The MAC address of the camera device.

method

Type: Basler.Pylon.IpConfigurationMethod
The IpConfigurationMethod to be used.

Return Value#

Type: Boolean
Returns true if successful, false otherwise.

Remarks#

This overloaded method is for AutoIP or DHCP. To configure a static IP address, use the other overload.

IpConfigurator.ChangeIpConfiguration Method (String, IpConfigurationMethod, String, String, String)#

Change the IP configuration of a camera device.

Syntax#

C#

public static bool ChangeIpConfiguration(
    string macAddress,
    IpConfigurationMethod method,
    string ipAddress,
    string subnetMask,
    string defaultGateway
)

VB

Public Shared Function ChangeIpConfiguration ( 
    macAddress As String,
    method As IpConfigurationMethod,
    ipAddress As String,
    subnetMask As String,
    defaultGateway As String
) As Boolean

Parameters#

macAddress

Type: System.String
The MAC address of the camera device.

method

Type: Basler.Pylon.IpConfigurationMethod
The IpConfigurationMethod to be used.

ipAddress

Type: System.String
The target IP address of the camera device.

subnetMask

Type: System.String
The target subnet mask of the camera device.

defaultGateway

Type: System.String
The target default gateway of the camera device.

Return Value#

Type: Boolean
Returns true if successful, false otherwise.

Remarks#

This overloaded method is for a static IP address. To configure AutoIP or DHCP, use the other overload.

IpConfigurator.EnumerateAllDevices Method#

Enumerates all available GigE Vision devices.

Syntax#

C#

public static List<ICameraInfo> EnumerateAllDevices()

VB

Public Shared Function EnumerateAllDevices As List(Of ICameraInfo)

Return Value#

Type: List(ICameraInfo)
Returns a list of ICameraInfo objects, one per camera found.

IpConfigurator.IsAutoIpActive Method#

Checks if camera device is working in automatic IP configuration, also known as link-local address.

Syntax#

C#

public static bool IsAutoIpActive(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsAutoIpActive ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if active, false otherwise.

IpConfigurator.IsAutoIpSupported Method#

Checks if camera device supports automatic IP configuration, also known as link-local address.

Syntax#

C#

public static bool IsAutoIpSupported(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsAutoIpSupported ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if supported, false otherwise.

IpConfigurator.IsDhcpActive Method#

Checks if camera device is working in DHCP configuration.

Syntax#

C#

public static bool IsDhcpActive(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsDhcpActive ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if active, false otherwise.

IpConfigurator.IsDhcpSupported Method#

Checks if camera device supports DHCP configuration.

Syntax#

C#

public static bool IsDhcpSupported(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsDhcpSupported ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if supported, false otherwise.

IpConfigurator.IsPersistentIpActive Method#

Checks if camera device is working in persistent IP configuration, also known as static IP configuration.

Syntax#

C#

public static bool IsPersistentIpActive(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsPersistentIpActive ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if active, false otherwise.

IpConfigurator.IsPersistentIpSupported Method#

Checks if camera device supports persistent IP configuration, also known as static IP configuration.

Syntax#

C#

public static bool IsPersistentIpSupported(
    ICameraInfo cameraInfo
)

VB

Public Shared Function IsPersistentIpSupported ( 
    cameraInfo As ICameraInfo
) As Boolean

Parameters#

cameraInfo

Type: Basler.Pylon.ICameraInfo
An ICameraInfo object specifying the camera device.

Return Value#

Type: Boolean
Returns true if supported, false otherwise.

IpConfigurator.RenounceRemoteDevice Method#

Stop using remote device.

Syntax#

C#

public static bool RenounceRemoteDevice(
    string ipAddress
)

VB

Public Shared Function RenounceRemoteDevice ( 
    ipAddress As String
) As Boolean

Parameters#

ipAddress

Type: System.String
Address of device in "dot notation".

Return Value#

Type: Boolean
Returns true if successful, false otherwise.

IpConfigurator.ChangeIpConfiguration Method#

Overload List#

	Name	Description
	ChangeIpConfiguration(String, IpConfigurationMethod)	Change the IP configuration of a camera device.
	ChangeIpConfiguration(String, IpConfigurationMethod, String, String, String)	Change the IP configuration of a camera device.