Overview

A set of configuration settings that a device needs to initialize.

#include <rdmnet/cpp/device.h>

Public Member Functions
	Settings ()=default
	Create an empty, invalid data structure by default.

	Settings (const etcpal::Uuid &new_cid, const rdm::Uid &new_uid)
	Create a device Settings instance by passing the required members explicitly. More...

	Settings (const etcpal::Uuid &new_cid, uint16_t manufacturer_id)
	Create a device Settings instance by passing the required members explicitly. More...

bool	IsValid () const
	Determine whether a device Settings instance contains valid data for RDMnet operation.

Data Fields
etcpal::Uuid	cid
	The device's Component Identifier (CID).

rdm::Uid	uid
	The device's RDM UID. For a dynamic UID, use rdm::Uid::DynamicUidRequest().

std::string	search_domain
	The device's search domain for discovering brokers.

uint8_t *	response_buf {nullptr}
	A data buffer to be used to respond synchronously to RDM commands. More...

std::vector< VirtualEndpointConfig >	virtual_endpoints
	Array of configurations for virtual endpoints that are present on the device at startup.

std::vector< PhysicalEndpointConfig >	physical_endpoints
	Array of configurations for physical endpoints that are present on the device at startup.

std::vector< RdmnetMcastNetintId >	llrp_netints
	(optional) A set of network interfaces to use for the LLRP target associated with this device. More...

Constructor & Destructor Documentation

◆ Settings() [1/2]

rdmnet::Device::Settings::Settings	(	const etcpal::Uuid &	new_cid,
		const rdm::Uid &	new_uid
	)

inline

Create a device Settings instance by passing the required members explicitly.

This version takes the fully-formed RDM UID that the device will use. Optional members can be modified directly in the struct.

◆ Settings() [2/2]

rdmnet::Device::Settings::Settings	(	const etcpal::Uuid &	cid_in,
		uint16_t	manufacturer_id
	)

inline

Create a device Settings instance by passing the required members explicitly.

This version just takes the device's ESTA manufacturer ID and uses it to generate an RDMnet dynamic UID request. Optional members can be modified directly in the struct.

Field Documentation

◆ llrp_netints

std::vector<RdmnetMcastNetintId> rdmnet::Device::Settings::llrp_netints

(optional) A set of network interfaces to use for the LLRP target associated with this device.

If empty, the set passed to rdmnet::Init() will be used, or all network interfaces on the system if that was not provided.

◆ response_buf

uint8_t* rdmnet::Device::Settings::response_buf {nullptr}

A data buffer to be used to respond synchronously to RDM commands.

See Handling RDM Commands for more information.

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

include/rdmnet/cpp/device.h