IDS Software Suite 4.96.1

Syntax

INT is_IpConfig (INT iID, UEYE_ETH_ADDR_MAC mac, UINT nCommand, void* pParam, UINT cbSizeOfParam)

Description

is_IpConfig() allows configuring the IP settings of GigE uEye cameras and the associated GigE network adapters (see IDS Camera Manager).

1.If a persistent IP address is configured for a GigE camera, it will be used (if free).

2.If no persistent IP address is configured for a GigE camera, the IP address is obtained via DHCP (if DHCP is enabled and a DHCP server is available).

3.If no persistent IP address is configured for a GigE camera and DHCP is not possible, an IP address is obtained from the IP address range for automatic IP configuration.

Assigning a persistent IP address to GigE uEye cameras

If you set a persistent IP address, the address is permanently stored in camera memory. The persistent IP address is retained even after the camera is disconnected from the power supply. When connecting the camera to a different PC, make sure the persistent IP address is valid on that PC, as well. If you set the persistent IP address to 0.0.0.0, the camera is configured for automatic assignment of the IP address (see below).

Configuring automatic IP assignment by the network adapter

You can also configure connected GigE uEye cameras to automatically obtain the IP address from the network adapter (see above). To use this feature, you need to define a suitable IP address range for the network adapter. When pairing a GigE uEye camera with the IP address 0.0.0.0, the uEye driver automatically assigns a free IP address to the camera.

Obtaining the IP address from a DHCP server

In order to use the DHCP functionality, the camera must be operated with firmware version 4.95 or higher. For a camera with a firmware version lower than 4.95, the starter firmware must be updated first, e.g. in IDS Camera Manager via the "Starter Firmware Upload" button.

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

Contents of the IPCONFIG_CAPABILITY_FLAGS enumeration

Contents of the UEYE_ETH_ADDR_MAC structure

Contents of the UEYE_ETH_IP_CONFIGURATION structure

Contents of the UEYE_ETH_AUTOCFG_IP_SETUP Structure

Return values

Example

void example_is_IpConfig()
{
INT nRet = IS_SUCCESS;
INT iDeviceID = -1;
UEYE_ETH_ADDR_MAC devicemac = { 0, 0, 0, 0, 0, 0 };
 
if (I_know_the_device_id)
{
  /* Note that the device id may have changed after reconnection of the device. */
  iDeviceID = my_device_id;
}
else if (I_know_the_device_mac)
{
  memcpy(devicemac, my_device_mac, sizeof(UEYE_ETH_ADDR_MAC));
}
else if (I_know_the_device_serno)
{
  /* is_IpConfiguration currently supports device id or device mac for identification of
    * the device of interest.
    * In this case that I know some identifying detail other than device id or device mac,
    * I have to acquire the device list and look up the device of interest.
    * If found I use it's device id for addressing.
    */
 
  /* first query the number of cameras. */
  int nCams = 0;
  nRet = is_GetNumberOfCameras(&nCams);
  if (nRet != IS_SUCCESS)
  {
    /* error handling here. */
  }
 
  /* get the camera list */
  UEYE_CAMERA_LIST* pCamList = 0;
  if (nCams >= 1)
  {
    /* allocate memory for the camera count + the camera info's */
    pCamList = (UEYE_CAMERA_LIST*) new char[sizeof(DWORD) +
                (nCams * sizeof(UEYE_CAMERA_INFO))];
    pCamList->dwCount = nCams;
 
    /* query the camera list */
    nRet = is_GetCameraList(pCamList);
    if (nRet != IS_SUCCESS)
    {
      /* error handling here */
    }
  }
 
  /* scan the camera list for the device with the matching identifier. */
  if (pCamList != 0)
  {
    int i = 0;
    for (i = 0; i < (int)pCamList->dwCount; i++)
    {
      /* test for the identifier to match
        * Note: Here the serial number is used for identification. I could also
        * use the camera id or any other field of the UEYE_CAMERA_INFO datatype.
        */
      if (memcmp(pCamList->uci[i].SerNo, my_serial_number, sizeof(my_serial_number)) == 0)
      {
        /* found the camera with the matching identifier */
 
        /* copy device id */
        iDeviceID = pCamList->uci[i].dwDeviceID;
        /* stop searching */
        break;
      }
    }
  }
 
  /* cleanup */
  delete [] pCamList;
}
 
/* query ip config caps */
UINT uCaps = 0;
nRet = is_IpConfig(iDeviceID, devicemac, IPCONFIG_CMD_QUERY_CAPABILITIES,
                    &uCaps, sizeof(UINT));
if (nRet != IS_SUCCESS)
{
  /* error handling here. */
}
 
/* test for persistent ip feature to be supported */
if ((uCaps & IPCONFIG_CAP_PERSISTENT_IP_SUPPORTED) == IPCONFIG_CAP_PERSISTENT_IP_SUPPORTED)
{
  UEYE_ETH_IP_CONFIGURATION ipcfg;
 
  /* query the persistent ip setting of the device */
  memset(&ipcfg, 0, sizeof(UEYE_ETH_IP_CONFIGURATION));
  nRet = is_IpConfig(iDeviceID, devicemac, IPCONFIG_CMD_GET_PERSISTENT_IP,
                      &ipcfg, sizeof(UEYE_ETH_IP_CONFIGURATION));
  if (nRet != IS_SUCCESS)
  {
    /* error handling here. */
  }
 
  /* set the persistent ip of the device to 192.168.10.2/24 */
  memset(&ipcfg, 0, sizeof(UEYE_ETH_IP_CONFIGURATION));
  /* note: provide the addresses in hex format (little-endian) */
  ipcfg.ipAddress.dwAddr = 0x020aa8c0;
  ipcfg.ipSubnetmask.dwAddr = 0x00ffffff;
  nRet = is_IpConfig(iDeviceID, devicemac, IPCONFIG_CMD_SET_PERSISTENT_IP,
                      &ipcfg, sizeof(UEYE_ETH_IP_CONFIGURATION));
  if (nRet != IS_SUCCESS)
  {
    /* error handling here. */
  }
}
 
/* test for ip auto configuration feature to be supported */
if ((uCaps & IPCONFIG_CAP_AUTOCONFIG_IP_SUPPORTED) == IPCONFIG_CAP_AUTOCONFIG_IP_SUPPORTED)
{
  UEYE_ETH_AUTOCFG_IP_SETUP ipautocfg;
 
  /* query the ip auto configuration setting for the device */
  memset(&ipautocfg, 0, sizeof(UEYE_ETH_AUTOCFG_IP_SETUP));
  /* note: use IPCONFIG_CMD_GET_AUTOCONFIG_IP_BYDEVICE here as it takes device identifiers.
    * alternatively IPCONFIG_CMD_GET_AUTOCONFIG_IP can be used with a network adapter
    * identifier, i.e. adapter id or adapter mac.
    */
  nRet = is_IpConfig(iDeviceID, devicemac, IPCONFIG_CMD_GET_AUTOCONFIG_IP_BYDEVICE,
                      &ipautocfg, sizeof(UEYE_ETH_AUTOCFG_IP_SETUP));
  if (nRet != IS_SUCCESS)
  {
    /* error handling here. */
  }
 
  /* set the ip auto configuration range for the device to (192.168.10.15,192.168.10.35) */
  memset(&ipautocfg, 0, sizeof(UEYE_ETH_AUTOCFG_IP_SETUP));
  /* note: provide the addresses in hex format (little-endian) */
  ipautocfg.ipAutoCfgIpRangeBegin.dwAddr = 0x0f0aa8c0;
  ipautocfg.ipAutoCfgIpRangeEnd.dwAddr = 0x230aa8c0;
  /* note: use IPCONFIG_CMD_SET_AUTOCONFIG_IP_BYDEVICE here as it takes device identifiers.
    * alternatively IPCONFIG_CMD_SET_AUTOCONFIG_IP can be used with a network adapter
    * identifier, i.e. adapter id or adapter mac.
    */
  nRet = is_IpConfig(iDeviceID, devicemac, IPCONFIG_CMD_SET_AUTOCONFIG_IP_BYDEVICE,
                      &ipcfg, sizeof(UEYE_ETH_AUTOCFG_IP_SETUP));
  if (nRet != IS_SUCCESS)
  {
    /* error handling here. */
  }
}
}