Device Monitoring Studio Documentation Advanced Features Protocol Binding Custom Protocols Predefined Fields
Several predefined fields and functions are available for a custom protocol. This topic lists all those predefined components.
This section lists predefined fields available in all components: USB, Serial and Network:
FILETIMEstructure (that is, it is a 64-bit unsigned integer representing the number of 100-nanosecond intervals since January 1, 1601). The time is UTC time.
Serial Monitor and Serial Bridge add the following predefined fields:
A value from
PacketType enumeration (std_serialdefs.h). May be one of the following values:
|Port connection/disconnection packet.|
|General packet. Contains either sent (written) or received (read) data.|
|Port open packet.|
|I/O Request packet.|
trueif this packet is captured on its way UP or equals
falseif it is captured on its way DOWN.
NTSTATUScode, as defined in WDK.
The following global functions are available:
Returns the current monitoring session's communication mode. See
ECommunicationType enumeration defined in
std_serialdefs.h. May be one of the following values:
|No special communication mode is set.|
|PPP communication mode is configured for a session.|
|“One packet a line” communication mode is configured for a session.|
|MODBUS communication mode is configured for a session.|
trueif “Parse requests on WRITE (responses on READ)” global setting is checked,
trueif RTU mode is configured for MODBUS in settings,
USB Monitor adds the following predefined fields and functions:
USB packet type. May be one of the following values:
|USB Request Block. Custom protocol should mainly focus on this packet type.|
|Device connection packet.|
|Device disconnection packet.|
|Device surprise removal packet.|
|Device Query ID packet.|
|Device Query Text packet.|
|Internal packet used to report updated configuration descriptor to the USB Monitor. Should be ignored by custom protocol.|
|Device Query Interface packet.|
trueif this packet is captured on its way UP or false if it is captured on its way DOWN.
Network Monitor adds the following predefined fields:
truefor Send packets and
falsefor Receive packets.