Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_GetEthDeviceInfo

uEye Camera Manual Version 3.80

is_GetEthDeviceInfo

Windows_Logo

Linux_Logo

GigE

GigE

Syntax

INT is_GetEthDeviceInfo (HIDS hDev,
UEYE_ETH_DEVICE_INFO* pDeviceInfo,
UINT uStructSize)

Search

Description

Using is_GetEthDeviceInfo, you can query information about the connected Gigabit Ethernet uEye cameras. The resulting information is written to the UEYE_ETH_DEVICE_INFO structure. For this purpose, the cameras need not be initialized.

Hinweis

The is_GetEthDeviceInfo() function is only supported by cameras of the GigE uEye series.

Input Parameters

hDev

DevID | IS_USE_DEVICE_ID,
DevID = internal device ID of the camera from the UEYE_CAMERA_INFO structure (see also is_GetCameraList())

pDeviceInfo

Pointer to a UEYE_ETH_DEVICE_INFO object

uStructSize

Size of the UEYE_ETH_DEVICE_INFO structure in bytes

 

Achtung

The is_GetEthDeviceInfo() function does not accept a camera handle as the hDev parameter. As stated above, the internal device ID must be used for the call. The advantage is that you can also query information related to Gigabit Ethernet uEye cameras that are currently not initialized.

This information can also be queried using the uEye Camera Manager.

Contents of the UEYE_ETH_DEVICE_INFO Structure

UEYE_ETH_DEVICE_INFO
_HEARTBEAT

infoDevHeartbeat

Camera-related data retrieved from the camera (from the heartbeat telegram)

See below: DEVICE_INFO_HEARTBEAT

UEYE_ETH_DEVICE_INFO
_CONTROL

infoDevControl

Camera-related driver data

See below: DEVICE_INFO_CONTROL

UEYE_ETH_ADAPTER_INFO

infoAdapter

Network-card related driver data

See below: ADAPTER_INFO

UEYE_ETH_DRIVER_INFO

infoDriver

General driver data

See below: DRIVER_INFO

Contents of the UEYE_ETH_DEVICE_INFO::UEYE_ETH_DEVICE_INFO_HEARTBEAT Structure

BYTE

bySerialNumber[12]

Serial number (string)

BYTE

byDeviceType

Type of camera series
(0x80 for Gigabit Ethernet uEye)

BYTE

byCameraID

User-defined camera ID

WORD

wSensorID

Sensor ID

WORD

wSizeImgMem_MB

Image memory size in MB

BYTE

reserved_1[2]

reserved

DWORD

dwVerStarterFirmware

Starter firmware version

DWORD

dwVerRuntimeFirmware

Runtime firmware version

DWORD

dwStatus

Status word

BYTE

reserved_2[4]

reserved

WORD

wTemperature

Camera temperature in degrees Celsius

Bits 15: Algebraic sign

Bits 14...11: filled according to algebraic sign

Bits 10...4: Temperature (places before the decimal point)

Bits 3...0: Temperature (places after the decimal point)

See conversion example.

See the Ambient Conditions chapter for the permissible temperature range.

WORD

wLinkSpeed_Mb

Link bandwidth in Mbits/s

UEYE_ETH_ADDR_MAC

macDevice

MAC address of the camera

BYTE

reserved_3[2]

reserved

UEYE_ETH
_IP_CONFIGURATION

ipcfgPersistentIpCfg

Persistent IP configuration

UEYE_ETH
_IP_CONFIGURATION

ipcfgCurrentIpCfg

Current IP configuration

UEYE_ETH_ADDR_MAC

macPairedHost

MAC address of the connected PC, if any

BYTE

reserved_4[2]

reserved

UEYE_ETH_ADDR_IPV4

ipPairedHostIp

IP address of the connected PC, if any

UEYE_ETH_ADDR_IPV4

ipAutoCfgIpRangeBegin

First IP address of the auto configuration range

UEYE_ETH_ADDR_IPV4

ipAutoCfgIpRangeEnd

Last IP address of the auto configuration range

BYTE

abyUserSpace[8]

The first eight bytes of the user EEPROM

BYTE

reserved_5[84]

reserved

BYTE

reserved_6[64]

reserved

Status Flags in UEYE_ETH_DEVICE_INFO::UEYE_ETH_DEVICE_INFO_HEARTBEAT::dwStatus

IS_ETH_DEVSTATUS_READY_TO_OPERATE

Camera is ready to operate

IS_ETH_DEVSTATUS_TESTING_IP_CURRENT

Camera is testing current IP address

IS_ETH_DEVSTATUS_TESTING_IP_PERSISTENT

Camera is testing persistent IP address

IS_ETH_DEVSTATUS_TESTING_IP_RANGE

Camera is testing auto config IP range

 

 

IS_ETH_DEVSTATUS_INAPPLICABLE_IP_CURRENT

Current IP address already assigned on the network

IS_ETH_DEVSTATUS_INAPPLICABLE_IP_PERSISTENT

Persistent IP address already assigned on the network

IS_ETH_DEVSTATUS_INAPPLICABLE_IP_RANGE

IP addresses of auto config IP range already assigned on the network

 

 

IS_ETH_DEVSTATUS_UNPAIRED

Camera has not been initialized (paired)

IS_ETH_DEVSTATUS_PAIRING_IN_PROGRESS

Camera is being initialized (paired)

IS_ETH_DEVSTATUS_PAIRED

Camera has been initialized (paired)

 

 

IS_ETH_DEVSTATUS_FORCE_100MBPS

Camera configured for 100 Mbits/s

IS_ETH_DEVSTATUS_NO_COMPORT

Camera supports no uEye COM port

 

 

IS_ETH_DEVSTATUS_RECEIVING_FW_STARTER

Camera is receiving starter firmware

IS_ETH_DEVSTATUS_RECEIVING_FW_RUNTIME

Camera is receiving runtime firmware

IS_ETH_DEVSTATUS_INAPPLICABLE_FW_RUNTIME

Runtime firmware cannot be used

IS_ETH_DEVSTATUS_INAPPLICABLE_FW_STARTER

Starter firmware cannot be used

 

 

IS_ETH_DEVSTATUS_REBOOTING_FW_RUNTIME

Camera is rebooting runtime firmware

IS_ETH_DEVSTATUS_REBOOTING_FW_STARTER

Camera is rebooting starter firmware

IS_ETH_DEVSTATUS_REBOOTING_FW_FAILSAFE

Camera is rebooting failsafe firmware

 

 

IS_ETH_DEVSTATUS_RUNTIME_FW_ERR0

Checksum error (error 0) in runtime firmware

Contents of the UEYE_ETH_DEVICE_INFO::UEYE_ETH_DEVICE_INFO_CONTROL Structure

DWORD

dwDeviceID

Internal device ID of the camera

DWORD

dwControlStatus

Status word for driver-based camera management (see below)

BYTE

reserved_1[80]

reserved

BYTE

reserved_2[64]

reserved

Status Flags in UEYE_ETH_DEVICE_INFO::UEYE_ETH_DEVICE_INFO_CONTROL::dwControlStatus

IS_ETH_CTRLSTATUS_AVAILABLE

The camera is available

IS_ETH_CTRLSTATUS_ACCESSIBLE1

Camera has valid IP address and can be accessed over the network

IS_ETH_CTRLSTATUS_ACCESSIBLE2

Camera has no persistent IP address; the auto IP range is valid

IS_ETH_CTRLSTATUS_PERSISTENT_IP_USED

Camera can be accessed over the network by its persistent IP address

IS_ETH_CTRLSTATUS_COMPATIBLE

Camera is compatible with the installed driver

IS_ETH_CTRLSTATUS_ADAPTER_ON_DHCP

DHCP is enabled on the PC network card

IS_ETH_CTRLSTATUS_UNPAIRING_IN_PROGRESS

Camera is being closed on this PC

IS_ETH_CTRLSTATUS_PAIRING_IN_PROGRESS

Camera is being initialized on this PC

IS_ETH_CTRLSTATUS_PAIRED

Camera has been initialized on this PC

IS_ETH_CTRLSTATUS_FW_UPLOAD_STARTER

Starter firmware is being loaded onto the camera

IS_ETH_CTRLSTATUS_FW_UPLOAD_RUNTIME

Runtime firmware is being loaded onto the camera

IS_ETH_CTRLSTATUS_REBOOTING

Camera is rebooting

IS_ETH_CTRLSTATUS_INITIALIZED

Camera has been initialized in the driver

IS_ETH_CTRLSTATUS_TO_BE_DELETED

Camera is being removed from driver management

IS_ETH_CTRLSTATUS_TO_BE_REMOVED

Camera is being removed from driver management

Contents of the UEYE_ETH_DEVICE_INFO::Structure

DWORD

dwAdapterID

Network adapter ID as defined internally in the driver

DWORD

dwDeviceLinkspeed

Possible values:

IS_ETH_LINKSPEED_100MB = 100 Mbits/s IS_ETH_LINKSPEED_1000MB = 1000 Mbits/s

UEYE_ETH_ETHERNET
_CONFIGURATION

ethcfg

Ethernet configuration of the network adapter

BYTE

reserved_2[2]

reserved

BOOL

bIsEnabledDHCP

The adapter is configured for DHCP

UEYE_ETH_AUTOCFG
_IP_SETUP

autoCfgIp

Setting of the IP address auto configuration

BOOL

bIsValidAutoCfgIpRange

The IP auto configuration setting is valid

DWORD

dwCntDevicesKnown

Number of cameras detected at this network adapter

DWORD

dwCntDevicesPaired

Number of cameras initialized using this network adapter

WORD

wPacketFilter

Filter settings for incoming packets (see below)

BYTE

reserved_3[38]

reserved

BYTE

reserved_4[64]

reserved

Value Range of UEYE_ETH_DEVICE_INFO::UEYE_ETH_ADAPTER_INFO::wPacketFilter

IS_ETH_PCKTFLT_PASSALL

Forward all packets to the operating system.

IS_ETH_PCKTFLT_BLOCKUEGET

Block Gigabit Ethernet uEye data packets directed to the operating system (recommended).

IS_ETH_PCKTFLT_BLOCKALL

Block all packets directed to the operating system.

Contents of the UEYE_ETH_DEVICE_INFO::UEYE_ETH_DRIVER_INFO Structure

DWORD

dwMinVerStarterFirmware

Minimum compatible starter firmware version

DWORD

dwMaxVerStarterFirmware

Maximum compatible starter firmware version

BYTE

reserved_1[8]

reserved

BYTE

reserved_2[64]

reserved

Return Values

IS_SUCCESS

Data was read without errors.

IS_INVALID_PARAMETER

The pDeviceInfo parameter is invalid.

IS_BAD_STRUCTURE_SIZE

The structure size you specified is invalid.

IS_NOT_SUPPORTED

hCam was not designated as a device ID or the device ID specified is not supported by the Gigabit Ethernet uEye.

IS_CANT_OPEN_DEVICE

Driver could not be found.

IS_IO_REQUEST_FAILED

Driver communication failed.

Related Functions

is_GetCameraList()

Code Sample

//Create the structure

UEYE_ETH_DEVICE_INFO di;

 

//Create specific camera handle from the internal device ID, see info in the box above

HIDS hDev = (HIDS)(dwDeviceID | IS_USE_DEVICE_ID);

 

//Populate the structure with Gigabit Ethernet uEye information

INT nRet = is_GetEthDeviceInfo( hDev, &di, sizeof(UEYE_ETH_DEVICE_INFO));

 

//Read out and convert camera temperature

DWORD dwTempFahrenheit;

DWORD dwTempCelsius;

dwTempCelsius = (float) di.infoDevHeartbeat.wTemperature / 16

dwTempFahrenheit = ((float) di.infoDevHeartbeat.wTemperature * 0.1125) + 32


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com