Notification Messages Sent From Device To Host (Extended Notifications Only); About Notification Messages - Magtek mDynamo Programmer's Manual

6 - Notification Messages Sent from Device to Host (Extended Notifications Only)

6 Notification Messages Sent from Device to Host (Extended
Notifications Only)
6.1

About Notification Messages

This section provides detail about unsolicited generic notification messages the device sends to the host,
Each subsection is tagged with the features, connection types, and data formats for which it is relevant.
Notification messages may be split into multiple packets, each containing a portion of the complete
notification message. This allows notification messages to exceed the maximum packet sizes of the
connection type and data format. After the host receives a complete notification message, it will have a
notification identifier, a complete data length, and a complete notification message data field.
How the host interprets incoming packets to find the data detailed in this section depends on the
connection type (see section 2 Connection Types) and the data format (see section 3 Data Formats). All
packets arrive at the host in the format-dependent structure shown in Table 6-1. Each incoming packet
can be interpreted using Table 6-2. The notification message can be interpreted by first assembling all
packets pertaining to the notification message, then looking up the corresponding Notification Identifier
in the sections that follow.
Table 6-1 - How Notification Message Packets Arrive
Format
HID
Table 6-2 - Structure of Packets That Form a Notification Message
Offset Field Name
Partial Data
0..1
Length
2..3 Data Offset
Notification
4..5
Identifier
Complete
6..7
Data Length
8..n Data
mDynamo| OEM Secure Card Reader Authenticator | Programmer's Manual (COMMANDS)
Report identifier 2, Usage identifier 0x20
The length of the Data field contained in the current message. This field is in
big endian format. If this value is not equal to the Complete Data Length, the
device is sending the notification using multiple packets.
The offset position in bytes within the entire assembled notification where the
first byte of the current packet's Data field is located. This field is in big endian
format. The first byte of the entire notification's Data is at offset zero.
The type of notification being sent. This field is in big endian format. The
value corresponds to the notification identifier numbers in the headings of the
subsections of section 6 Notification Messages Sent from Device to Host
(Extended Notifications Only). In many cases, two-byte notification identifiers
are assigned such that the high byte indicates a group of related commands, and
the low byte specifies a command within that group.
The total length of data for the entire notification message, summing all Partial
Data Lengths for multiple packets. This field is in big endian format. If this
value is not equal to the Partial Data Length of the current packet, the device is
sending the data using multiple packets.
May contain part or all of the notification data. The size of this field is
contained in the Partial Data Length field.
Page 32 of 167 (D998200151-200)
Where to Find Value
Description