UADP Message

This page summarizes the Lua table fields used for UADP PubSub messages.

Common Fields

Field	Type	Notes
PublisherId	number or string, optional	Publisher identifier.
PublisherIdType	optional	Detected from PublisherId when omitted.
DataSetClassId	GUID, optional	Dataset class identifier.
GroupHeader	table, optional	Writer group and sequence information.
TimeStamp	DateTime	Message timestamp.
Picoseconds	UInt16	Additional timestamp precision.
SecurityHeader	table	Security flags and token information.
DataSetMessages	array	Dataset messages in the network message.
DiscoveryAnnouncement	table	Discovery announcement. Used instead of DataSetMessages for announcement messages.
SecurityFooter	table	Optional security footer.
Signature	ByteString	Optional message signature.

GroupHeader

Field	Type	Notes
WriterGroupId	UInt16	Writer group identifier.
GroupVersion	UInt32	Writer group version.
NetworkMessageNumber	UInt16	Network message number.
SequenceNumber	UInt16	Network message sequence number.

SecurityHeader

Field	Type	Notes
NetworkMessageSignedEnabled	boolean	Network message signature flag.
NetworkMessageEncryptedEnabled	boolean	Network message encryption flag.
SecurityFooterEnabled	boolean	Security footer flag.
ForceKeyResetEnabled	boolean	Key reset flag.
SecurityTokenID	UInt32	Security token identifier.
MessageNonce	ByteString	Message nonce.
SecurityFooterSize	UInt16	Security footer size.

UADP DataSetMessage

Field	Type	Notes
DataSetWriterId	UInt16	Dataset writer identifier.
DataSetMessageSequenceNumber	UInt16	Dataset message sequence number.
Timestamp	DateTime	Dataset message timestamp.
PicoSeconds	UInt16	Additional timestamp precision.
Status	UInt16	Dataset message status.
ConfigurationVersionMajorVersion	UInt16	Major configuration version.
ConfigurationVersionMinorVersion	UInt16	Minor configuration version.
DataSetMessageType	4-bit value	Dataset message type.
FieldEncoding	2-bit value	Field encoding type.
Fields	array	Published fields.
PagingSize	number	Paging size.
Padding	ByteString	Padding bytes.

Fields entries use this shape:

Field	Type	Notes
Index	number	Field index.
Value	any supported value	Field value.

UADP AnnouncementMessage

DATASET_METADATA

Field	Type	Notes
DiscoveryAnnouncement	table	Root announcement object.
AnnouncementType	uadp.announcementType.DATASET_METADATA	Announcement kind.
SequenceNumber	UInt16	Announcement sequence number.
DatasetMetadata	table	Dataset metadata payload.
DatasetMetadata.DataSetWriterId	UInt16	Dataset writer identifier.
DatasetMetadata.StatusCode	StatusCode	Metadata status.
DatasetMetadata.Metadata	table	Metadata content.

Metadata

Field	Type	Notes
Namespaces	string array	Namespace URI list.
StructureDataTypes	array	Structure data type metadata.
EnumDataTypes	array	Enum data type metadata.
SimpleDataTypes	array	Simple data type metadata.
Name	string	Dataset name.
Description	LocalizedText	Dataset description.
DataSetClassId	GUID	Dataset class identifier.
ConfigurationVersion	table	Contains MajorVersion and MinorVersion.
Fields	array of tables	Dataset field metadata.

Metadata Fields

Field	Type	Notes
Name	string	Field name.
Description	LocalizedText	Field description.
FieldFlags	number	Field flags.
BuiltInType	number	Built-in type identifier.
DataType	NodeId	Data type NodeId.
ValueRank	Int32	Value rank.
ArrayDimensions	array	Array dimensions.
MaxStringLength	UInt32	Maximum string length.
DataSetFieldId	GUID	Dataset field identifier.
Properties	array	Field properties. Each property has Name and Value.