IP address configuration for network devices (IPv4), used with property OB_STRUCT_DEVICE_IP_ADDR_CONFIG. More...

#include <ObTypes.h>

Public Attributes
uint16_t	dhcp
	DHCP status.
uint8_t	address [4]
	IP address (IPv4, big endian: 192.168.1.10, address[0] = 192, address[1] = 168, address[2] = 1, address[3] = 10)
uint8_t	mask [4]
	Subnet mask (big endian)
uint8_t	gateway [4]
	Gateway (big endian)

Detailed Description

IP address configuration for network devices (IPv4), used with property OB_STRUCT_DEVICE_IP_ADDR_CONFIG.

Note

Device support:

Femto Mega / Femto Mega I: only this structure is supported.
Gemini 335Le / Gemini 435Le with older firmware: only this structure is supported.
Gemini 335Le / Gemini 435Le with newer firmware: both this structure and OBNetIpConfigV2 are supported; it is recommended to use OBNetIpConfigV2 (property OB_STRUCT_DEVICE_IP_ADDR_CONFIG_V2) instead.

How to choose between OBNetIpConfig and OBNetIpConfigV2: First check whether OB_STRUCT_DEVICE_IP_ADDR_CONFIG_V2 is supported by the device. If yes, use OBNetIpConfigV2; otherwise fall back to this structure. Example:

bool v2Supported = ob_device_is_property_supported(dev, OB_STRUCT_DEVICE_IP_ADDR_CONFIG_V2,
                                                    OB_PERMISSION_READ_WRITE, &error);
if(v2Supported) {
    // Use OBNetIpConfigV2 with OB_STRUCT_DEVICE_IP_ADDR_CONFIG_V2
} else {
    // Use OBNetIpConfig with OB_STRUCT_DEVICE_IP_ADDR_CONFIG
}

Definition at line 1291 of file ObTypes.h.

Member Data Documentation

◆ dhcp

uint16_t OBNetIpConfig::dhcp

DHCP status.

Note: 0: static IP; 1: DHCP

Definition at line 1297 of file ObTypes.h.

◆ address

uint8_t OBNetIpConfig::address[4]

IP address (IPv4, big endian: 192.168.1.10, address[0] = 192, address[1] = 168, address[2] = 1, address[3] = 10)

Definition at line 1302 of file ObTypes.h.

◆ mask

uint8_t OBNetIpConfig::mask[4]

Subnet mask (big endian)

Definition at line 1307 of file ObTypes.h.

◆ gateway

uint8_t OBNetIpConfig::gateway[4]

Gateway (big endian)

Definition at line 1312 of file ObTypes.h.

The documentation for this struct was generated from the following file: