Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Windows_Logo
Linux_Logo

USB 3.x

GigE

USB 3.x

GigE

Syntax

INT is_DeviceInfo (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)

Description

Using is_DeviceInfo(), you can query information about connected USB 3 and GigE uEye cameras. The resulting information is written to the IS_DEVICE_INFO structure. For this purpose, the cameras need not be opened (see Example 1).

hint_info

If you use the function with a GigE uEye camera, then you can also pass a pointer to a UEYE_ETH_DEVICE_INFO structure (see Example 2).

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.

Input parameters

hCam

nDeviceId | IS_USE_DEVICE_ID
nDeviceId = Device ID of the camera

pParam

Pointer to a function parameter, whose function depends on nCommand.

cbSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Contents of the IS_DEVICE_INFO structure

IS_DEVICE_INFO_HEARTBEAT

infoDevHeartbeat

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

See IS_DEVICE_INFO_HEARTBEAT

IS_DEVICE_INFO_CONTROL

infoDevControl

Camera-related driver data

See IS_DEVICE_INFO_CONTROL

BYTE

reserved[240]

reserved

Contents of the IS_DEVICE_INFO::IS_DEVICE_INFO_HEARTBEAT structure

BYTE

reserved_1[24]

reserved

DWORD

dwRuntimeFirmwareVersion

Firmware version

BYTE

reserved_2[8]

reserved

WORD

wTemperature

Camera temperature in degree Celsius

Bit 15: algebraic sign

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

Bit 10...4: temperature (places before the decimal point)

Bit 3...0: temperature (places after the decimal point)

See the D: Specifications chapter for the ambient conditions for each camera family.

If the value "-127.9 °C" is returned, the camera does not have a temperature sensor.

WORD

wLinkSpeed_Mb

Transfer rate:

IS_USB_HIGH_SPEED = 480

IS_USB_SUPER_SPEED = 4000

BYTE

reserved_3[6]

reserved

WORD

wComportOffset

Comport offset

BYTE

reserved[200]

reserved

Contents of the IS_DEVICE_INFO::IS_DEVICE_INFO_CONTROL structure

DWORD

dwDeviceId

Device ID of the camera

BYTE

reserved[148]

reserved

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: UEYE_ETH_ADAPTER_INFO

UEYE_ETH_DRIVER_INFO

infoDriver

General driver data

See below: UEYE_ETH_DRIVER_INFO

Contents of the UEYE_ETH_DEVICE_INFO::UEYE_ETH_DEVICE_INFO_HEARTBEAT structure

BYTE

abySerialNumber[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 for current camera status:

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

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 the D: Specifications chapter for the ambient conditions for each camera family.

If the value "-127.9 °C" is returned, the camera does not have a temperature sensor.

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 memory

BYTE

reserved_5[84]

reserved

BYTE

reserved_6[64]

reserved

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:

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

BYTE

reserved_1[80]

reserved

BYTE

reserved_2[64]

reserved

Contents of the UEYE_ETH_DEVICE_INFO::UEYE_ETH_ADAPTER_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:

IS_ETH_PCKTFLT_PASSALL: Forward all packets to the operating system.

IS_ETH_PCKTFLT_BLOCKUEGET: Block GigE uEye data packets directed to the operating system (recommended).

IS_ETH_PCKTFLT_BLOCKALL: Block all packets directed to the operating system.

BYTE

reserved_3[38]

reserved

BYTE

reserved_4[64]

reserved

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_INVALID_PARAMETER

One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode.

IS_IO_REQUEST_FAILED

An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match.

IS_SUCCESS

Function executed successfully

Related functions

is_GetCameraList()

Example 1

// The camera has the device ID 1
UINT nDeviceId = 1;
 
IS_DEVICE_INFO deviceInfo;
memset(&deviceInfo, 0, sizeof(IS_DEVICE_INFO));
 
INT nRet = is_DeviceInfo((HIDS)(nDeviceId | IS_USE_DEVICE_ID),
                        IS_DEVICE_INFO_CMD_GET_DEVICE_INFO,
                        (void*)&deviceInfo, sizeof(deviceInfo));
if (nRet == IS_SUCCESS)
{
WORD wTemperature = deviceInfo.infoDevHeartbeat.wTemperature;
}

Example 2

// The camera has the device ID 1001
UINT nDeviceId = 1001;
 
UEYE_ETH_DEVICE_INFO deviceInfo;
memset(&deviceInfo, 0, sizeof(UEYE_ETH_DEVICE_INFO));
 
INT nRet = is_DeviceInfo((HIDS)(nDeviceId | IS_USE_DEVICE_ID),
                              IS_DEVICE_INFO_CMD_GET_DEVICE_INFO,
                              (void*)&deviceInfo, sizeof(deviceInfo));
if (nRet == IS_SUCCESS)
{
WORD wTemperature = deviceInfo.infoDevHeartbeat.wTemperature;
}

© 2022 IDS Imaging Development Systems GmbH