Type and helper functions for the Unique ID (UID) used in the RDM family of protocols. More...

Data Structures
struct	RdmUid

Macros
#define	RDM_UID_EQUAL(uidptr1, uidptr2) ((uidptr1)->manu == (uidptr2)->manu && (uidptr1)->id == (uidptr2)->id)
	Determine if two UIDs are equal. More...

#define	RDM_INIT_STATIC_UID(uidptr, manu_val, id_val)

#define	RDMNET_INIT_DYNAMIC_UID_REQUEST(uidptr, manu_val)

#define	RDMNET_INIT_DEVICE_MANU_BROADCAST(uidptr, manu_val)
	Initialize an RDMnet Device Manufacturer Broadcast UID with a Manufacturer ID. More...

#define	RDM_UID_IS_BROADCAST(uidptr) ((uidptr)->manu == kRdmBroadcastUid.manu && (uidptr)->id == kRdmBroadcastUid.id)
	Determine whether a UID is the E1.20 value BROADCAST_ALL_DEVICES_ID. More...

#define	RDMNET_UID_IS_CONTROLLER_BROADCAST(uidptr) ((uidptr)->manu == kRdmnetControllerBroadcastUid.manu && (uidptr)->id == kRdmnetControllerBroadcastUid.id)
	Determine whether a UID is the E1.33 value RPT_ALL_CONTROLLERS. More...

#define	RDMNET_UID_IS_DEVICE_BROADCAST(uidptr) ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (uidptr)->id == kRdmnetDeviceBroadcastUid.id)
	Determine whether a UID is the E1.33 value RPT_ALL_DEVICES. More...

#define	RDMNET_UID_IS_DEVICE_MANU_BROADCAST(uidptr) ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (((uidptr)->id & 0xffffu) == 0xffffu))
	Determine whether a UID is one of the E1.33 values defined by RPT_ALL_MID_DEVICES. More...

#define	RDMNET_DEVICE_BROADCAST_MANU_MATCHES(uidptr, manu_val) (RDMNET_DEVICE_BROADCAST_MANU_ID(uidptr) == manu_val)
	Determine whether an RDMnet Device Manufacturer Broadcast UID matches a specific ESTA Manufacturer ID. More...

#define	RDMNET_DEVICE_BROADCAST_MANU_ID(uidptr) ((uint16_t)((uidptr)->id >> 16))
	Get the ESTA Manufacturer ID from an RDMnet Device Manufacturer Broadcast UID. More...

#define	RDM_UID_IS_NULL(uidptr) ((uidptr)->manu == 0 && (uidptr)->id == 0)
	Determine if a UID is null. More...

#define	RDMNET_UID_IS_DYNAMIC_UID_REQUEST(uidptr) ((((uidptr)->manu & 0x8000u) != 0) && (uidptr)->id == 0u)
	Determine whether a UID is a Dynamic UID Request as defined in ANSI E1.33. More...

#define	RDMNET_UID_IS_DYNAMIC(uidptr)
	Determine whether a UID is a Dynamic UID as defined in ANSI E1.33. More...

#define	RDMNET_UID_IS_STATIC(uidptr) (!RDM_UID_IS_NULL(uidptr) && ((uidptr)->manu & 0x8000u) == 0)
	Determine whether a UID is a Static UID as defined in ANSI E1.33. More...

#define	RDM_GET_MANUFACTURER_ID(uidptr) ((uidptr)->manu & 0x7fffu)
	Get the ESTA Manufacturer ID from a UID. More...

#define	RDM_GET_DEVICE_ID(uidptr) ((uidptr)->id)
	Get the Device ID from a UID. More...

#define	RDM_UID_STRING_BYTES 14

Typedefs
typedef struct RdmUid	RdmUid

Functions
int	rdm_uid_compare (const RdmUid a, const RdmUid b)
	Compare two UIDs. More...

bool	rdm_uid_to_string (const RdmUid uid, char buf)
	Create a string representation of a UID. More...

bool	rdm_string_to_uid (const char str, RdmUid uid)
	Create a UID from a string representation. More...

Variables
const RdmUid	kRdmBroadcastUid

const RdmUid	kRdmnetControllerBroadcastUid

const RdmUid	kRdmnetDeviceBroadcastUid

Detailed Description

Type and helper functions for the Unique ID (UID) used in the RDM family of protocols.

#include "rdm/uid.h"

uid.h

A type and helper functions for the Unique ID (UID) used in the RDM family of protocols.

RDM-based protocols use an identifier called a UID to identify an entity that generates or consumes RDM messages.

The top bit of the UID is reserved for indicating broadcast values, or indicating Dynamic UIDs in ANSI E1.33.

The next 15 bits is the ESTA Manufacturer ID; each manufacturer of RDM equipment has a unique Manufacturer ID registered with ESTA. The MSB of the UID is reserved for indicating broadcast values, or indicating Dynamic UIDs in ANSI E1.33.

The remaining 32 bits is the Device ID. The Device ID is unique within a given scope; in the case of a Static UID, it is unique across all products made by the manufacturer indicated by the ESTA Manufacturer ID. In the case of a Dynamic UID, it is unique within its current E1.33 Scope.

Macro Definition Documentation

◆ RDM_GET_DEVICE_ID

#define RDM_GET_DEVICE_ID ( uidptr ) ((uidptr)->id)

Get the Device ID from a UID.

Parameters

uidptr Pointer to RdmUid from which to get the Device ID.

Returns: Device ID.

◆ RDM_GET_MANUFACTURER_ID

#define RDM_GET_MANUFACTURER_ID ( uidptr ) ((uidptr)->manu & 0x7fffu)

Get the ESTA Manufacturer ID from a UID.

Parameters

uidptr Pointer to RdmUid from which to get the ESTA Manufacturer ID.

Returns: ESTA Manufacturer ID.

◆ RDM_INIT_STATIC_UID

#define RDM_INIT_STATIC_UID	(	uidptr,
		manu_val,
		id_val
	)

Value:

  do                                                  \
  {                                                   \
    (uidptr)->manu = (manu_val);                      \
    (uidptr)->id = (id_val);                          \
  } while (0)

Initialize a Static UID with a Manufacturer ID and Device ID.

Parameters

uidptr	Pointer to RdmUid to initialize.
manu_val	ESTA Manufacturer ID.
id_val	Device ID.

◆ RDM_UID_EQUAL

#define RDM_UID_EQUAL	(	uidptr1,
		uidptr2
	)	((uidptr1)->manu == (uidptr2)->manu && (uidptr1)->id == (uidptr2)->id)

Determine if two UIDs are equal.

Parameters

uidptr1	Pointer to first RdmUid.
uidptr2	Pointer to second RdmUid.

Returns: true (UIDs are equal) or false (UIDs are not equal).

◆ RDM_UID_IS_BROADCAST

#define RDM_UID_IS_BROADCAST ( uidptr ) ((uidptr)->manu == kRdmBroadcastUid.manu && (uidptr)->id == kRdmBroadcastUid.id)

Determine whether a UID is the E1.20 value BROADCAST_ALL_DEVICES_ID.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (uidptr is equal to BROADCAST_ALL_DEVICES_ID) or false (uidptr is not equal to BROADCAST_ALL_DEVICES_ID).

◆ RDM_UID_IS_NULL

#define RDM_UID_IS_NULL ( uidptr ) ((uidptr)->manu == 0 && (uidptr)->id == 0)

Determine if a UID is null.

A UID is said to be 'null' when it is made up of all 0's.

Parameters

uidptr Pointer to UID to null-check.

Returns: true (UID is null) or false (UID is not null).

◆ RDM_UID_STRING_BYTES

#define RDM_UID_STRING_BYTES 14

The maximum number of bytes for a buffer that can hold a UID string representation.

◆ RDMNET_DEVICE_BROADCAST_MANU_ID

#define RDMNET_DEVICE_BROADCAST_MANU_ID ( uidptr ) ((uint16_t)((uidptr)->id >> 16))

Get the ESTA Manufacturer ID from an RDMnet Device Manufacturer Broadcast UID.

Use RDMNET_UID_IS_DEVICE_MANU_BROADCAST() first to determine whether this UID is an RDMnet Device Manufacturer Broadcast.

Parameters

uidptr Pointer to RdmUid from which to get the Broadcast Manufacturer ID.

Returns: ESTA Manufacturer ID.

◆ RDMNET_DEVICE_BROADCAST_MANU_MATCHES

#define RDMNET_DEVICE_BROADCAST_MANU_MATCHES	(	uidptr,
		manu_val
	)	(RDMNET_DEVICE_BROADCAST_MANU_ID(uidptr) == manu_val)

Determine whether an RDMnet Device Manufacturer Broadcast UID matches a specific ESTA Manufacturer ID.

Use RDMNET_UID_IS_DEVICE_MANU_BROADCAST() first to determine whether this UID is an RDMnet Device Manufacturer Broadcast.

Parameters

uidptr	Pointer to RdmUid to check.
manu_val	ESTA Manufacturer ID to check against the Broadcast UID.

Returns: true (RDMnet Device Manufacturer Broadcast matches this Manufacturer ID) or false (RDMnet Device Manufacturer Broadcast does not match this Manufacturer ID).

◆ RDMNET_INIT_DEVICE_MANU_BROADCAST

#define RDMNET_INIT_DEVICE_MANU_BROADCAST	(	uidptr,
		manu_val
	)

Value:

  do                                                                              \
  {                                                                               \
    (uidptr)->manu = kRdmnetDeviceBroadcastUid.manu;                              \
    (uidptr)->id = (kRdmnetDeviceBroadcastUid.id & ((manu_val << 16) | 0xffffu)); \
  } while (0)

Initialize an RDMnet Device Manufacturer Broadcast UID with a Manufacturer ID.

Parameters

uidptr	Pointer to RdmUid to initialize.
manu_val	ESTA Manufacturer ID.

◆ RDMNET_INIT_DYNAMIC_UID_REQUEST

#define RDMNET_INIT_DYNAMIC_UID_REQUEST	(	uidptr,
		manu_val
	)

Value:

  do                                                      \
  {                                                       \
    (uidptr)->manu = (0x8000u | (manu_val));              \
    (uidptr)->id = 0;                                     \
  } while (0)

Initialize an RDMnet Dynamic UID Request with a Manufacturer ID.

Parameters

uidptr	Pointer to RdmUid to initialize.
manu_val	ESTA Manufacturer ID.

◆ RDMNET_UID_IS_CONTROLLER_BROADCAST

#define RDMNET_UID_IS_CONTROLLER_BROADCAST ( uidptr ) ((uidptr)->manu == kRdmnetControllerBroadcastUid.manu && (uidptr)->id == kRdmnetControllerBroadcastUid.id)

Determine whether a UID is the E1.33 value RPT_ALL_CONTROLLERS.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (uidptr is equal to RPT_ALL_CONTROLLERS) or false (uidptr is not equal to RPT_ALL_CONTROLLERS).

◆ RDMNET_UID_IS_DEVICE_BROADCAST

#define RDMNET_UID_IS_DEVICE_BROADCAST ( uidptr ) ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (uidptr)->id == kRdmnetDeviceBroadcastUid.id)

Determine whether a UID is the E1.33 value RPT_ALL_DEVICES.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (uidptr is equal to RPT_ALL_DEVICES) or false (uidptr is not equal to RPT_ALL_DEVICES).

◆ RDMNET_UID_IS_DEVICE_MANU_BROADCAST

#define RDMNET_UID_IS_DEVICE_MANU_BROADCAST ( uidptr ) ((uidptr)->manu == kRdmnetDeviceBroadcastUid.manu && (((uidptr)->id & 0xffffu) == 0xffffu))

Determine whether a UID is one of the E1.33 values defined by RPT_ALL_MID_DEVICES.

RDMnet Device Manufacturer Broadcasts are directed to all Devices with a specific ESTA Manufacturer ID. If this check returns true, use RDMNET_DEVICE_BROADCAST_MANU_ID() to determine which Manufacturer ID this broadcast is directed to, or RDMNET_DEVICE_BROADCAST_MANU_MATCHES() to determine whether it matches a specific Manufacturer ID.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (uidptr is one of the values defined by RPT_ALL_MID_DEVICES) or false (uidptr is not one of the values defined by RPT_ALL_MID_DEVICES).

◆ RDMNET_UID_IS_DYNAMIC

#define RDMNET_UID_IS_DYNAMIC ( uidptr )

Value:

  ((((uidptr)->manu & 0x8000u) != 0) && !RDMNET_UID_IS_CONTROLLER_BROADCAST(uidptr) && \
   !RDMNET_UID_IS_DEVICE_MANU_BROADCAST(uidptr) && !RDM_UID_IS_BROADCAST(uidptr) &&    \
   !RDMNET_UID_IS_DYNAMIC_UID_REQUEST(uidptr))

Determine whether a UID is a Dynamic UID as defined in ANSI E1.33.

Note that !RDMNET_UID_IS_DYNAMIC() does not imply RDMNET_UID_IS_STATIC(), because broadcast and null UID values are neither dynamic nor static UIDs.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (UID is an E1.33 Dynamic UID) or false (UID is not an E1.33 Dynamic UID).

◆ RDMNET_UID_IS_DYNAMIC_UID_REQUEST

#define RDMNET_UID_IS_DYNAMIC_UID_REQUEST ( uidptr ) ((((uidptr)->manu & 0x8000u) != 0) && (uidptr)->id == 0u)

Determine whether a UID is a Dynamic UID Request as defined in ANSI E1.33.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (UID is an E1.33 Dynamic UID Request) or false (UID is not an E1.33 Dynamic UID Request).

◆ RDMNET_UID_IS_STATIC

#define RDMNET_UID_IS_STATIC ( uidptr ) (!RDM_UID_IS_NULL(uidptr) && ((uidptr)->manu & 0x8000u) == 0)

Determine whether a UID is a Static UID as defined in ANSI E1.33.

Note that !RDMNET_UID_IS_STATIC() does not imply RDMNET_UID_IS_DYNAMIC(), because broadcast and null UID values are neither dynamic nor static UIDs.

Parameters

uidptr Pointer to RdmUid to check.

Returns: true (UID is an E1.33 Static UID) or false (UID is not an E1.33 Static UID).

Typedef Documentation

◆ RdmUid

typedef struct RdmUid RdmUid

The UID type. Don't forget that the top bit of the manu field has special meaning. The helper macros are your friend!

Function Documentation

◆ rdm_string_to_uid()

bool rdm_string_to_uid	(	const char *	str,
		RdmUid *	uid
	)

Create a UID from a string representation.

There is no standard for string representations of UIDs, but two common conventions exist: mmmm:dddddddd and mmmmdddddddd, where mmmm is the 4-digit ESTA manufacturer ID represented in hexadecimal, and dddddddd is the 8-digit device ID represented in hexadecimal. This function accepts either of these forms as input.

Parameters

[in]	str	The null-terminated string to convert.
[out]	uid	UID to fill in with the parse result.

Returns: true (parse successful) or false (invalid argment/parse failure).

◆ rdm_uid_compare()

int rdm_uid_compare	(	const RdmUid *	a,
		const RdmUid *	b
	)

Compare two UIDs.

Parameters

a	First RdmUid to compare.
b	Second RdmUid to compare.

Returns: < 0 (uidptr1 is less than uidptr2); 0 (uidptr1 is equal to uidptr2); > 0 (uidptr1 is greater than uidptr2)

◆ rdm_uid_to_string()

bool rdm_uid_to_string	(	const RdmUid *	uid,
		char *	buf
	)

Create a string representation of a UID.

The resulting string will be of the form mmmm:dddddddd, where mmmm is the 4-digit ESTA manufacturer ID represented in hexadecimal, and dddddddd is the 8-digit device ID represented in hexadecimal.

Parameters

[in]	uid	UID to convert to a string.
[out]	buf	Character buffer to which to write the resulting string. Must be at least of size RDM_UID_STRING_BYTES.

Returns: true (conversion successful) or false (invalid argument).

Variable Documentation

◆ kRdmBroadcastUid

const RdmUid kRdmBroadcastUid

extern

A UID that is equal to BROADCAST_ALL_DEVICES_ID as defined in ANSI E1.20.

◆ kRdmnetControllerBroadcastUid

const RdmUid kRdmnetControllerBroadcastUid

extern

A UID that is equal to RPT_ALL_CONTROLLERS as defined in ANSI E1.33.

◆ kRdmnetDeviceBroadcastUid

const RdmUid kRdmnetDeviceBroadcastUid

extern

A UID that is equal to RPT_ALL_DEVICES as defined in ANSI E1.33.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RDM_GET_DEVICE_ID

◆ RDM_GET_MANUFACTURER_ID

◆ RDM_INIT_STATIC_UID

◆ RDM_UID_EQUAL

◆ RDM_UID_IS_BROADCAST

◆ RDM_UID_IS_NULL

◆ RDM_UID_STRING_BYTES

◆ RDMNET_DEVICE_BROADCAST_MANU_ID

◆ RDMNET_DEVICE_BROADCAST_MANU_MATCHES

◆ RDMNET_INIT_DEVICE_MANU_BROADCAST

◆ RDMNET_INIT_DYNAMIC_UID_REQUEST

◆ RDMNET_UID_IS_CONTROLLER_BROADCAST

◆ RDMNET_UID_IS_DEVICE_BROADCAST

◆ RDMNET_UID_IS_DEVICE_MANU_BROADCAST

◆ RDMNET_UID_IS_DYNAMIC

◆ RDMNET_UID_IS_DYNAMIC_UID_REQUEST

◆ RDMNET_UID_IS_STATIC

Typedef Documentation

◆ RdmUid

Function Documentation

◆ rdm_string_to_uid()

◆ rdm_uid_compare()

◆ rdm_uid_to_string()

Variable Documentation

◆ kRdmBroadcastUid

◆ kRdmnetControllerBroadcastUid

◆ kRdmnetDeviceBroadcastUid