You are here: Technical Reference > Transport Layer Control > GigE Vision
FLIR

Blackfly®S

BFS-PGE-23S3

 

GigE Vision

Category that contains the features pertaining to the GigE Vision transport layer of device, including IEEE 1588.

Summary Table

Name Interface Access Visibility Description
Supported Option Selector IEnumeration RW Expert Selects the GEV option to interrogate for existing support.
Supported Option [Supported Option Selector] IBoolean RO Expert Returns if the selected GEV option is supported.
Interface Selector IInteger RW Beginner Selects which logical link to control.
MAC Address [Interface Selector] IInteger Beginner MAC address of the logical link.
Current IP Configuration LLA [Interface Selector] IBoolean RW Beginner Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.
Current IP Configuration DHCP [Interface Selector] IBoolean RW Beginner Controls whether the DHCP IP configuration scheme is activated on the given logical link.
Current IP Configuration Persistent IP [Interface Selector] IBoolean RW Beginner Controls whether the PersistentIP configuration scheme is activated on the given logical link.
Current IP Address [Interface Selector] IInteger RO Beginner Reports the IP address for the given logical link.
Current Subnet Mask [Interface Selector] IInteger RO Beginner Reports the subnet mask of the given logical link.
Current Default Gateway [Interface Selector] IInteger RO Beginner Reports the default gateway IP address to be used on the given logical link.
First URL IStringReg Guru The first choice of URL for the XML device description file.
Second URL IStringReg Guru The second choice of URL to the XML device description file.
Number Of Interfaces IInteger RO Expert Indicates the number of physical network interfaces supported by this device.
Persistent IP Address [Interface Selector] IInteger Beginner Controls the Persistent IP address for this logical link.
Persistent Subnet Mask [Interface Selector] IInteger Beginner Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.
Persistent Default Gateway [Interface Selector] IInteger Beginner Controls the persistent default gateway for this logical link.
Heartbeat Timeout IInteger Guru Indicates the current heartbeat timeout in milliseconds.
Timestamp Tick Frequency IInteger RO Expert Indicates the number of timestamp ticks in 1 second (frequency in Hz).
Pending Acknowledge Enable IBoolean RW Guru Enables the generation of PENDING_ACK.
Heartbeat Disable IBoolean RW Expert Disables the GVCP heartbeat.
Pending Timeout IInteger RO Guru Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds.
IEEE 1588 IBoolean RW Expert Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.
IEEE 1588 Status IEnumeration RO Expert Provides the status of the IEEE 1588 clock.
IEEE 1588 Mode IEnumeration RW Expert Provides the mode of the IEEE 1588 clock.
IEEE 1588 Clock ID IInteger RO Guru IEEE 1588 Clock ID
IEEE 1588 Dataset Latch ICommand WO Expert Latches the current IEEE 1588 dataset
IEEE 1588 Latch Status IEnumeration RO Expert IEEE 1588 Latch Status
IEEE 1588 Latch Parent ID IInteger RO Guru IEEE 1588 Latch Parent ID
IEEE 1588 Latch Offset From Master IInteger RO Guru IEEE 1588 Latch Offset From Master in Nanoseconds
CCP IEnumeration RW Guru Controls the device access privilege of an application.
MCP Host Port IInteger RW Guru The port to which the device must send messages
Message Channel Destination Address IInteger RW Guru Controls the destination IP address of the message channel
Message Channel Transmission Timeout IInteger RO Guru Indicates the transmission timeout of the message channel.
Message Channel Retry Count IInteger RO Guru Indicates the number of retries of the message channel.
Message Channel Source Port IInteger RO Guru Indicates the source port of the message channel.
Stream Channel Selector IInteger Expert Selects the stream channel to control.
SCCFG Unconditional Streaming [Stream Channel Selector] IBoolean RW Guru Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).
Gev SCCFG Extended Chunk Data [Stream Channel Selector] IBoolean RW Guru Enables cameras to use the extended chunk data payload type for this stream channel.
SCP Direction [Stream Channel Selector] IInteger RO Guru Transmit or Receive of the channel
SCP Interface Index [Stream Channel Selector] IInteger RO Guru Index of the logical link to use.
SCP Host Port [Stream Channel Selector] IInteger RW Guru Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.
SCPS Fire Test Packet [Stream Channel Selector] IBoolean RW Guru Sends a test packet.
SCPS Do Not Fragment [Stream Channel Selector] IBoolean RW Guru The state of this feature is copied into the "do not fragment" bit of the IP header of each stream packet.
SCPS Big Endian [Stream Channel Selector] IBoolean RW Guru Endianess of multi-byte pixel data for this stream.
SCPS Packet Size [Stream Channel Selector] IInteger RW Expert Specifies the stream packet size (in bytes) to send on this channel.
Stream Channel Packet Delay [Stream Channel Selector] IInteger RW Expert Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
Stream Channel Destination Address [Stream Channel Selector] IInteger RW Guru Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.
Stream Channel Source Port [Stream Channel Selector] IInteger RO Guru Indicates the source port of the stream channel.

GigE Vision Features


Supported Option Selector

Selects the GEV option to interrogate for existing support.

Property Value
Name GevSupportedOptionSelector
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
UserDefinedName
SerialNumber
HeartbeatDisable
LinkSpeed
CCPApplicationSocket
ManifestTable
TestData
DiscoveryAckDelay
DiscoveryAckDelayWritable
ExtendedStatusCodes
Action
PendingAck
EventData
Event
PacketResend
WriteMem
CommandsConcatenation
IPConfigurationLLA
IPConfigurationDHCP
IPConfigurationPersistentIP
StreamChannelSourceSocket
MessageChannelSourceSocket

Supported Option

Returns if the selected GEV option is supported.

Property Value
Name GevSupportedOption [Supported Option Selector]
Interface IBoolean
Access RO
Visibility Expert

Interface Selector

Selects which logical link to control.

Property Value
Name GevInterfaceSelector
Interface IInteger
Access RW
Unit
Visibility Beginner
Value 0

MAC Address

MAC address of the logical link.

Property Value
Name GevMACAddress [Interface Selector]
Interface IInteger
Access
Unit
Visibility Beginner

Current IP Configuration LLA

Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

Property Value
Name GevCurrentIPConfigurationLLA [Interface Selector]
Interface IBoolean
Access RW
Visibility Beginner

Current IP Configuration DHCP

Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Property Value
Name GevCurrentIPConfigurationDHCP [Interface Selector]
Interface IBoolean
Access RW
Visibility Beginner

Current IP Configuration Persistent IP

Controls whether the PersistentIP configuration scheme is activated on the given logical link.

Property Value
Name GevCurrentIPConfigurationPersistentIP [Interface Selector]
Interface IBoolean
Access RW
Visibility Beginner

Current IP Address

Reports the IP address for the given logical link.

Property Value
Name GevCurrentIPAddress [Interface Selector]
Interface IInteger
Access RO
Unit
Visibility Beginner

Current Subnet Mask

Reports the subnet mask of the given logical link.

Property Value
Name GevCurrentSubnetMask [Interface Selector]
Interface IInteger
Access RO
Unit
Visibility Beginner

Current Default Gateway

Reports the default gateway IP address to be used on the given logical link.

Property Value
Name GevCurrentDefaultGateway [Interface Selector]
Interface IInteger
Access RO
Unit
Visibility Beginner

First URL

The first choice of URL for the XML device description file.

Property Value
Name GevFirstURL
Interface IStringReg
Access
Visibility Guru

Second URL

The second choice of URL to the XML device description file.

Property Value
Name GevSecondURL
Interface IStringReg
Access
Visibility Guru

Number Of Interfaces

Indicates the number of physical network interfaces supported by this device.

Property Value
Name GevNumberOfInterfaces
Interface IInteger
Access RO
Unit
Visibility Expert

Persistent IP Address

Controls the Persistent IP address for this logical link.

Property Value
Name GevPersistentIPAddress [Interface Selector]
Interface IInteger
Access
Unit
Visibility Beginner

Persistent Subnet Mask

Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

Property Value
Name GevPersistentSubnetMask [Interface Selector]
Interface IInteger
Access
Unit
Visibility Beginner

Persistent Default Gateway

Controls the persistent default gateway for this logical link.

Property Value
Name GevPersistentDefaultGateway [Interface Selector]
Interface IInteger
Access
Unit
Visibility Beginner

Heartbeat Timeout

Indicates the current heartbeat timeout in milliseconds.

Property Value
Name GevHeartbeatTimeout
Interface IInteger
Access
Unit
Visibility Guru

Timestamp Tick Frequency

Indicates the number of timestamp ticks in 1 second (frequency in Hz).

Property Value
Name GevTimestampTickFrequency
Interface IInteger
Access RO
Unit
Visibility Expert

Pending Acknowledge Enable

Enables the generation of PENDING_ACK.

Property Value
Name GevGVCPPendingAck
Interface IBoolean
Access RW
Visibility Guru

Heartbeat Disable

Disables the GVCP heartbeat.

Property Value
Name GevGVCPHeartbeatDisable
Interface IBoolean
Access RW
Visibility Expert

Pending Timeout

Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds.

Property Value
Name GevGVCPPendingTimeout
Interface IInteger
Access RO
Unit
Visibility Guru

IEEE 1588

Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.

Property Value
Name GevIEEE1588
Interface IBoolean
Access RW
Visibility Expert

IEEE 1588 Status

Provides the status of the IEEE 1588 clock.

Property Value
Name GevIEEE1588Status
Interface IEnumeration
Access RO
Visibility Expert

Enumeration Values
Initializing
Faulty
Disabled
Listening
PreMaster
Master
Passive
Uncalibrated
Slave

IEEE 1588 Mode

Provides the mode of the IEEE 1588 clock.

Property Value
Name GevIEEE1588Mode
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
Auto
SlaveOnly

IEEE 1588 Clock ID

IEEE 1588 Clock ID

Property Value
Name GevIEEE1588ClockId
Interface IInteger
Access RO
Unit
Visibility Guru

IEEE 1588 Dataset Latch

Latches the current IEEE 1588 dataset

Property Value
Name GevIEEE1588DataSetLatch
Interface ICommand
Access WO
Visibility Expert

IEEE 1588 Latch Status

IEEE 1588 Latch Status

Property Value
Name GevIEEE1588StatusLatched
Interface IEnumeration
Access RO
Visibility Expert

Enumeration Values
Initializing
Faulty
Disabled
Listening
PreMaster
Master
Passive
Uncalibrated
Slave

IEEE 1588 Latch Parent ID

IEEE 1588 Latch Parent ID

Property Value
Name GevIEEE1588ParentClockIdLatched
Interface IInteger
Access RO
Unit
Visibility Guru

IEEE 1588 Latch Offset From Master

IEEE 1588 Latch Offset From Master in Nanoseconds

Property Value
Name GevIEEE1588OffsetFromMasterLatched
Interface IInteger
Access RO
Unit
Visibility Guru

CCP

Controls the device access privilege of an application.

Property Value
Name GevCCP
Interface IEnumeration
Access RW
Visibility Guru

Enumeration Values
OpenAccess
ExclusiveAccess
ControlAccess

MCP Host Port

The port to which the device must send messages

Property Value
Name GevMCPHostPort
Interface IInteger
Access RW
Unit
Visibility Guru

Message Channel Destination Address

Controls the destination IP address of the message channel

Property Value
Name GevMCDA
Interface IInteger
Access RW
Unit
Visibility Guru

Message Channel Transmission Timeout

Indicates the transmission timeout of the message channel.

Property Value
Name GevMCTT
Interface IInteger
Access RO
Unit
Visibility Guru

Message Channel Retry Count

Indicates the number of retries of the message channel.

Property Value
Name GevMCRC
Interface IInteger
Access RO
Unit
Visibility Guru

Message Channel Source Port

Indicates the source port of the message channel.

Property Value
Name GevMCSP
Interface IInteger
Access RO
Unit
Visibility Guru

Stream Channel Selector

Selects the stream channel to control.

Property Value
Name GevStreamChannelSelector
Interface IInteger
Access
Unit
Visibility Expert
Value 0

SCCFG Unconditional Streaming

Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

Property Value
Name GevSCCFGUnconditionalStreaming [Stream Channel Selector]
Interface IBoolean
Access RW
Visibility Guru

Gev SCCFG Extended Chunk Data

Enables cameras to use the extended chunk data payload type for this stream channel.

Property Value
Name GevSCCFGExtendedChunkData [Stream Channel Selector]
Interface IBoolean
Access RW
Visibility Guru

SCP Direction

Transmit or Receive of the channel

Property Value
Name GevSCPDirection [Stream Channel Selector]
Interface IInteger
Access RO
Unit
Visibility Guru

SCP Interface Index

Index of the logical link to use.

Property Value
Name GevSCPInterfaceIndex [Stream Channel Selector]
Interface IInteger
Access RO
Unit
Visibility Guru

SCP Host Port

Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.

Property Value
Name GevSCPHostPort [Stream Channel Selector]
Interface IInteger
Access RW
Unit
Visibility Guru

SCPS Fire Test Packet

Sends a test packet.

Property Value
Name GevSCPSFireTestPacket [Stream Channel Selector]
Interface IBoolean
Access RW
Visibility Guru

SCPS Do Not Fragment

The state of this feature is copied into the "do not fragment" bit of the IP header of each stream packet.

Property Value
Name GevSCPSDoNotFragment [Stream Channel Selector]
Interface IBoolean
Access RW
Visibility Guru

SCPS Big Endian

Endianess of multi-byte pixel data for this stream.

Property Value
Name GevSCPSBigEndian [Stream Channel Selector]
Interface IBoolean
Access RW
Visibility Guru

SCPS Packet Size

Specifies the stream packet size (in bytes) to send on this channel.

Property Value
Name GevSCPSPacketSize [Stream Channel Selector]
Interface IInteger
Access RW
Unit
Visibility Expert

Stream Channel Packet Delay

Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

Property Value
Name GevSCPD [Stream Channel Selector]
Interface IInteger
Access RW
Unit
Visibility Expert

Stream Channel Destination Address

Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

Property Value
Name GevSCDA [Stream Channel Selector]
Interface IInteger
Access RW
Unit
Visibility Guru

Stream Channel Source Port

Indicates the source port of the stream channel.

Property Value
Name GevSCSP [Stream Channel Selector]
Interface IInteger
Access RO
Unit
Visibility Guru

 

12/11/2018
© 2015-2018 FLIR® Integrated Imaging Solutions Inc.
All rights reserved.
Legal
| Contact Support

Blackfly®S BFS-PGE-23S3
Camera Reference

FLIR Camera and API References