DOC Skip to main content

Camera IP Configuration Function Description

Update on 2025-12-09 02:42:25

ON THIS PAGE

1. First-Time Use

When using the camera for the first time after receiving it, ensure the host and camera are on the same subnet for successful communication:

  1. IP Address: 192.168.1.xx
    a. Configure the host and camera to be on the same subnet. The camera’s default IP is 192.168.1.10.
    b. Ensure there is no IP conflict between the host and the camera.
  2. Subnet Mask (MASK):
    • For local networks, the recommended subnet mask is 255.255.255.0.
  3. Default Gateway: 192.168.1.xx
    a. It is recommended to set the gateway within the same subnet as the IP or leave it unconfigured.
    b. Ensure the gateway does not conflict with the host or camera IP.
    c. Do not set it to 0.0.0.0.

image.png

 

2. Persistent IP Configuration

The camera supports manual configuration of Persistent IP, Subnet Mask, and Default Gateway through Orbbec Viewer or Orbbec SDK, ensuring stable operation in complex network environments. Persistent IP settings are retained after power-off.

2.1 Method 1: Using Orbbec Viewer

  1. Launch Orbbec Viewer and locate the IP Configuration option.

image.png

  1. The configured parameters will take effect after the camera reconnects

image.png

2.2 Method 2: Using Orbbec SDK

    // Create a context object for managing and querying device lists
    ob::Context ctx;
    
    // Query the device list in current context
    auto deviceList = ctx.queryDeviceList();
    
    // Check if the device list is empty or has no devices

    if(!deviceList || deviceList->getCount() < 1) {
        // If no device found, output message and exit
        std::cout << "No device found! Please connect a supported device and retry this program." << std::endl;
        return;
    }
    
    // Get the first device from the device list
    auto device = deviceList->getDevice(0);
    
    // Check if device was successfully obtained
    if(!device) {
        // If failed to get device, output error message and exit
        std::cerr << "Failed to get the device." << std::endl;
        return;
    }
    
    // Define network IP configuration parameters
    OBNetIpConfig ipConfig = {
        0,                     // dhcp off
        { 192, 168, 1, 26 },   // address
        { 255, 255, 255, 0 },  // mask
        { 192, 168, 1, 254 }   // gateway
    };
    
    // Configure the device's IP address settings  
    device->setStructuredData(OB_STRUCT_DEVICE_IP_ADDR_CONFIG, (const uint8_t *)(&ipConfig), sizeof(ipConfig));

 

3. DHCP Configuration

The camera supports enabling DHCP functionality through either Orbbec Viewer or Orbbec SDK, allowing for dynamic IP address assignment. This is particularly suitable for scenarios requiring flexible deployment or temporary debugging. When switching from DHCP to Persistent IP mode, the camera automatically loads the last configured: Persistent IP addressSubnet Mask (MASK) and Default Gateway

3.1 Method 1: Using Orbbec Viewer

  1. Launch Orbbec Viewer.
  2. Locate and activate the DHCP switch in the network configuration interface.

image.png

 

3.2 Method 2: Using Orbbec SDK

 // Create a context object for device management and querying
    ob::Context ctx;
        
    // Query device list in current context
    auto deviceList = ctx.queryDeviceList();
        
    // Check if device list is empty or contains no devices
    if(!deviceList || deviceList->getCount() < 1) {
        // If no devices found, output message and exit
        std::cout << "No device found! Please connect a supported device and retry this program." << std::endl;
        return;
    }
        
    // Get first device from device list
    auto device = deviceList->getDevice(0);
        
    // Verify successful device acquisition
    OBNetIpConfig ipConfig = { 0 };
    uint32_t ipConfigSize = 0;
    device->getStructuredData(OB_STRUCT_DEVICE_IP_ADDR_CONFIG, (uint8_t*)&ipConfig, &ipConfigSize);
    if(ipConfigSize != sizeof(OBNetIpConfig)) {
        std::cerr << "Failed to get the device ip config." << std::endl;
        return;
    }
    // Enable DHCP for automatic IP configuration
    ipConfig.dhcp = 1; 
        
    // Configure device IP address settings
    device->setStructuredData(OB_STRUCT_DEVICE_IP_ADDR_CONFIG, (const uint8_t *)(&ipConfig), sizeof(ipConfig));

 

3.3 DHCP Failure Management

  1. DHCP Request Process:
    • The device broadcasts DHCP requests with a default timeout period of 45 seconds
  2. Fallback Mechanism:
    • If no response is received from the DHCP server within the timeout period
    • OR if the DHCP assignment fails
    • The device will automatically revert to the last configured Persistent IP

 

4. Special Function Description

4.1 Cross-Subnet Device Discovery Function

This camera supports the cross-subnet device discovery function. When the camera and the host are on different subnets, users can still scan and obtain device information through the OrbbecViewer tool or Orbbec SDK.

Under the cross-subnet device discovery function, only device discovery is supported, and direct data communication is not possible. To establish normal communication, the camera and the host must be adjusted to the same subnet.

4.2 Method 1: Using Orbbec Viewer

Hover the mouse over the target device in the device list to obtain the current device information.

image.png 

4.3 Method 2: Using Orbbec SDK

Refer to the Orbbec SDK sample in the following link:

https://www.orbbec.com/developers/orbbec-sdk/

 

5. Temporary IP Address

When the camera cannot be connected due to an unknown or misconfigured IP address, the Temporary IP Address (Force IP) can be used to forcibly assign a new IP address and quickly restore communication. This function is suitable for debugging, device recovery, or cross-network environment adaptation.

Note:

  • The Temporary IP is only for short-term debugging. After the camera reboots, it will revert to the original Persistent IP or DHCP configuration.
  • To permanently retain the assigned IP, manually switch to Persistent IP mode and save the settings.

Prerequisites:

  1. The camera’s MAC address must be known (usually printed on the device label or original packaging).
  2. The camera and the host must be directly connected via Ethernet or be on the same local network (avoiding router or firewall interference).

ON THIS PAGE

Add

  • Name:

  • Link Address:

Cancel

Add

  • Name:

  • Link Address:

Cancel
Questions or
Feedback?

Feedback

  • Your feedback matters! Share your thoughts on this page, report errors, or let us know how we can improve to better support your needs. If applicable, please include the specific sentence or section to help us identify and address the issue.