Exposes RealSense ethernet configuration functionality for C compilers. More...

#include "rs_types.h"

Typedefs
typedef enum rs2_eth_link_priority	rs2_eth_link_priority
	Ethernet link priority options. More...

typedef uint8_t	rs2_ip_address[4]
	IP address structure for IPv4 addresses. More...

Enumerations
enum	rs2_eth_link_priority { RS2_LINK_PRIORITY_USB_ONLY = 0, RS2_LINK_PRIORITY_ETH_ONLY = 1, RS2_LINK_PRIORITY_ETH_FIRST = 2, RS2_LINK_PRIORITY_USB_FIRST = 3, RS2_LINK_PRIORITY_DYNAMIC_BIT = 0x10, RS2_LINK_PRIORITY_DYNAMIC_ETH_FIRST = RS2_LINK_PRIORITY_ETH_FIRST \| RS2_LINK_PRIORITY_DYNAMIC_BIT, RS2_LINK_PRIORITY_DYNAMIC_USB_FIRST = RS2_LINK_PRIORITY_USB_FIRST \| RS2_LINK_PRIORITY_DYNAMIC_BIT, RS2_LINK_PRIORITY_COUNT }
	Ethernet link priority options. More...

Functions
const char *	rs2_eth_link_priority_to_string (rs2_eth_link_priority priority)

int	rs2_supports_eth_config (const rs2_device device, rs2_error *error)

unsigned int	rs2_get_link_speed (const rs2_device device, rs2_error *error)

rs2_eth_link_priority	rs2_get_link_priority (const rs2_device device, rs2_error *error)

void	rs2_set_link_priority (const rs2_device device, rs2_eth_link_priority priority, rs2_error *error)

unsigned int	rs2_get_link_timeout (const rs2_device device, rs2_error *error)

void	rs2_set_link_timeout (const rs2_device device, unsigned int timeout, rs2_error *error)

unsigned int	rs2_get_dds_domain (const rs2_device device, rs2_error *error)

void	rs2_set_dds_domain (const rs2_device device, unsigned int domain, rs2_error *error)

void	rs2_get_ip_address (const rs2_device device, rs2_ip_address configured_ip, rs2_ip_address actual_ip, rs2_error *error)

void	rs2_set_ip_address (const rs2_device device, const rs2_ip_address ip, rs2_error *error)

void	rs2_get_netmask (const rs2_device device, rs2_ip_address configured_netmask, rs2_ip_address actual_netmask, rs2_error *error)

void	rs2_set_netmask (const rs2_device device, const rs2_ip_address netmask, rs2_error *error)

void	rs2_get_gateway (const rs2_device device, rs2_ip_address configured_gateway, rs2_ip_address actual_gateway, rs2_error *error)

void	rs2_set_gateway (const rs2_device device, const rs2_ip_address gateway, rs2_error *error)

void	rs2_get_dhcp_config (const rs2_device device, int enabled, unsigned int timeout, rs2_error *error)

void	rs2_set_dhcp_config (const rs2_device device, int enabled, unsigned int timeout, rs2_error *error)

unsigned int	rs2_get_mtu (const rs2_device device, rs2_error *error)

void	rs2_set_mtu (const rs2_device device, unsigned int mtu, rs2_error *error)

unsigned int	rs2_get_transmission_delay (const rs2_device device, rs2_error *error)

void	rs2_set_transmission_delay (const rs2_device device, unsigned int delay, rs2_error *error)

unsigned int	rs2_get_udp_ttl (const rs2_device device, rs2_error *error)

void	rs2_set_udp_ttl (const rs2_device device, unsigned int ttl, rs2_error *error)

void	rs2_restore_default_eth_config (const rs2_device device, rs2_error *error)

Detailed Description

Exposes RealSense ethernet configuration functionality for C compilers.

Typedef Documentation

◆ rs2_eth_link_priority

typedef enum rs2_eth_link_priority rs2_eth_link_priority

Ethernet link priority options.

◆ rs2_ip_address

typedef uint8_t rs2_ip_address[4]

IP address structure for IPv4 addresses.

Enumeration Type Documentation

◆ rs2_eth_link_priority

enum rs2_eth_link_priority

Ethernet link priority options.

Enumerator
RS2_LINK_PRIORITY_USB_ONLY	Use USB connection only
RS2_LINK_PRIORITY_ETH_ONLY	Use Ethernet connection only
RS2_LINK_PRIORITY_ETH_FIRST	Prefer Ethernet, fallback to USB
RS2_LINK_PRIORITY_USB_FIRST	Prefer USB, fallback to Ethernet
RS2_LINK_PRIORITY_DYNAMIC_BIT	Dynamic switching bit flag
RS2_LINK_PRIORITY_DYNAMIC_ETH_FIRST	Dynamic Ethernet-first priority
RS2_LINK_PRIORITY_DYNAMIC_USB_FIRST	Dynamic USB-first priority
RS2_LINK_PRIORITY_COUNT	Number of enumeration values. Not a valid input: intended to be used in for-loops.

Function Documentation

◆ rs2_eth_link_priority_to_string()

const char* rs2_eth_link_priority_to_string ( rs2_eth_link_priority priority )

◆ rs2_get_dds_domain()

unsigned int rs2_get_dds_domain	(	const rs2_device *	device,
		rs2_error **	error
	)

Get current DDS domain id (0-232) used when connected through Ethernet

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current DDS domain id used when connected through Ethernet

◆ rs2_get_dhcp_config()

void rs2_get_dhcp_config	(	const rs2_device *	device,
		int *	enabled,
		unsigned int *	timeout,
		rs2_error **	error
	)

Get DHCP configuration

Parameters

[in]	device	RealSense device
[out]	enabled	DHCP enabled flag (0=off, non-zero=on)
[out]	timeout	DHCP timeout threshold in seconds (0-255)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_get_gateway()

void rs2_get_gateway	(	const rs2_device *	device,
		rs2_ip_address	configured_gateway,
		rs2_ip_address	actual_gateway,
		rs2_error **	error
	)

Get gateway address

Parameters

[in]	device	RealSense device
[out]	configured_gateway	Configured gateway address to populate
[out]	actual_gateway	Actual gateway address to populate. Might be different from configured_gateway if DHCP is enabled
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_get_ip_address()

void rs2_get_ip_address	(	const rs2_device *	device,
		rs2_ip_address	configured_ip,
		rs2_ip_address	actual_ip,
		rs2_error **	error
	)

Get IP address

Parameters

[in]	device	RealSense device
[out]	configured_ip	Configured IP address to populate
[out]	actual_ip	Actual IP address to populate. Might be different from configured_ip if DHCP is enabled
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_get_link_priority()

rs2_eth_link_priority rs2_get_link_priority	(	const rs2_device *	device,
		rs2_error **	error
	)

Get link priority

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current link priority setting

◆ rs2_get_link_speed()

unsigned int rs2_get_link_speed	(	const rs2_device *	device,
		rs2_error **	error
	)

Get Ethernet link speed

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current Ethernet link speed Mbps. 0 if link is not available.

◆ rs2_get_link_timeout()

unsigned int rs2_get_link_timeout	(	const rs2_device *	device,
		rs2_error **	error
	)

Get timeout in milliseconds before falling back to other connection type

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current link timeout in milliseconds

◆ rs2_get_mtu()

unsigned int rs2_get_mtu	(	const rs2_device *	device,
		rs2_error **	error
	)

Get MTU (Maximum Transmission Unit)

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current MTU in bytes

◆ rs2_get_netmask()

void rs2_get_netmask	(	const rs2_device *	device,
		rs2_ip_address	configured_netmask,
		rs2_ip_address	actual_netmask,
		rs2_error **	error
	)

Get network mask

Parameters

[in]	device	RealSense device
[out]	configured_netmask	Configured network mask to populate
[out]	actual_netmask	Actual network mask to populate. Might be different from configured_netmask if DHCP is enabled
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_get_transmission_delay()

unsigned int rs2_get_transmission_delay	(	const rs2_device *	device,
		rs2_error **	error
	)

Get transmission delay

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current transmission delay in microseconds

◆ rs2_get_udp_ttl()

unsigned int rs2_get_udp_ttl	(	const rs2_device *	device,
		rs2_error **	error
	)

Get UDP packet "time to live" (TTL)

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Current UDP TTL value

◆ rs2_restore_default_eth_config()

void rs2_restore_default_eth_config	(	const rs2_device *	device,
		rs2_error **	error
	)

Restores configuration to factory settings

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Non-zero if device supports ethernet configuration, zero otherwise

◆ rs2_set_dds_domain()

void rs2_set_dds_domain	(	const rs2_device *	device,
		unsigned int	domain,
		rs2_error **	error
	)

Set DDS domain id to use when connected through Ethernet

Parameters

[in]	device	RealSense device
[in]	domain	DDS domain id to use (0-232)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_dhcp_config()

void rs2_set_dhcp_config	(	const rs2_device *	device,
		int	enabled,
		unsigned int	timeout,
		rs2_error **	error
	)

Set DHCP configuration

Parameters

[in]	device	RealSense device
[in]	enabled	DHCP enabled flag (0=off, non-zero=on)
[in]	timeout	DHCP timeout threshold in seconds (0-255)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_gateway()

void rs2_set_gateway	(	const rs2_device *	device,
		const rs2_ip_address	gateway,
		rs2_error **	error
	)

Set gateway address

Parameters

[in]	device	RealSense device
[in]	gateway	Gateway address to set
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_ip_address()

void rs2_set_ip_address	(	const rs2_device *	device,
		const rs2_ip_address	ip,
		rs2_error **	error
	)

Set IP address

Parameters

[in]	device	RealSense device
[in]	ip	IP address to set
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_link_priority()

void rs2_set_link_priority	(	const rs2_device *	device,
		rs2_eth_link_priority	priority,
		rs2_error **	error
	)

Set link priority

Parameters

[in]	device	RealSense device
[in]	priority	Link priority to set
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_link_timeout()

void rs2_set_link_timeout	(	const rs2_device *	device,
		unsigned int	timeout,
		rs2_error **	error
	)

Set timeout in milliseconds before falling back to other connection type

Parameters

[in]	device	RealSense device
[in]	timeout	Link timeout to set in milliseconds
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_mtu()

void rs2_set_mtu	(	const rs2_device *	device,
		unsigned int	mtu,
		rs2_error **	error
	)

Set MTU (Maximum Transmission Unit)

Parameters

[in]	device	RealSense device
[in]	mtu	MTU in bytes (500-9000, in 500 byte steps)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_netmask()

void rs2_set_netmask	(	const rs2_device *	device,
		const rs2_ip_address	netmask,
		rs2_error **	error
	)

Set network mask

Parameters

[in]	device	RealSense device
[in]	netmask	Network mask to set
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_transmission_delay()

void rs2_set_transmission_delay	(	const rs2_device *	device,
		unsigned int	delay,
		rs2_error **	error
	)

Set transmission delay

Parameters

[in]	device	RealSense device
[in]	delay	Transmission delay in microseconds (0-144, in 3us steps)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_set_udp_ttl()

void rs2_set_udp_ttl	(	const rs2_device *	device,
		unsigned int	ttl,
		rs2_error **	error
	)

Set UDP packet "time to live" (TTL)

Parameters

[in]	device	RealSense device
[in]	ttl	UDP TTL value (1-255)
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

◆ rs2_supports_eth_config()

int rs2_supports_eth_config	(	const rs2_device *	device,
		rs2_error **	error
	)

Check if device supports ethernet configuration

Parameters

[in]	device	RealSense device
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: Non-zero if device supports ethernet configuration, zero otherwise

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ rs2_eth_link_priority

◆ rs2_ip_address

Enumeration Type Documentation

◆ rs2_eth_link_priority

Function Documentation

◆ rs2_eth_link_priority_to_string()

◆ rs2_get_dds_domain()

◆ rs2_get_dhcp_config()

◆ rs2_get_gateway()

◆ rs2_get_ip_address()

◆ rs2_get_link_priority()

◆ rs2_get_link_speed()

◆ rs2_get_link_timeout()

◆ rs2_get_mtu()

◆ rs2_get_netmask()

◆ rs2_get_transmission_delay()

◆ rs2_get_udp_ttl()

◆ rs2_restore_default_eth_config()

◆ rs2_set_dds_domain()

◆ rs2_set_dhcp_config()

◆ rs2_set_gateway()

◆ rs2_set_ip_address()

◆ rs2_set_link_priority()

◆ rs2_set_link_timeout()

◆ rs2_set_mtu()

◆ rs2_set_netmask()

◆ rs2_set_transmission_delay()

◆ rs2_set_udp_ttl()

◆ rs2_supports_eth_config()