Skip to content

Commit

Permalink
Update 03-Protocol-Overview.md
Browse files Browse the repository at this point in the history
Fix typo
  • Loading branch information
Fi3 authored Oct 19, 2024
1 parent 81b61b5 commit 02b0963
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion 03-Protocol-Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The message framing is outlined below:

| Field Name | Type | Description |
| -------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| extension_type | U16 | Unique identifier of the extension describing this protocol message. <br>Most significant bit (i.e.bit 15, 0-indexed, aka channel_msg) indicates a message which is specific to a channel, whereas if the most significant bit is unset, the message is to be interpreted by the immediate receiving device. <br>Note that the channel_msg bit is ignored in the extension lookup, i.e.an extension_type of 0x8ABC is for the same "extension" as 0x0ABC. <br>If the channel_msg bit is set, the first four bytes of the payload field is a U32 representing the channel_id this message is destined for (these bytes are repeated in the message framing descriptions below). <br>Note that for the Job Declaration and Template Distribution Protocols the channel_msg bit is always unset. |
| extension_type | U16 | Unique identifier of the extension describing this protocol message. <br>Least significant bit (i.e.bit 15, 0-indexed, aka channel_msg) indicates a message which is specific to a channel, whereas if the most significant bit is unset, the message is to be interpreted by the immediate receiving device. <br>Note that the channel_msg bit is ignored in the extension lookup, i.e.an extension_type of 0x8ABC is for the same "extension" as 0x0ABC. <br>If the channel_msg bit is set, the first four bytes of the payload field is a U32 representing the channel_id this message is destined for (these bytes are repeated in the message framing descriptions below). <br>Note that for the Job Declaration and Template Distribution Protocols the channel_msg bit is always unset. |
| msg_type | U8 | Unique identifier of the extension describing this protocol message |
| msg_length | U24 | Length of the protocol message, not including this header |
| payload | BYTES | Message-specific payload of length msg_length. If the MSB in extension_type (the channel_msg bit) is set the first four bytes are defined as a U32 "channel_id", though this definition is repeated in the message definitions below and these 4 bytes are included in msg_length. |
Expand Down

0 comments on commit 02b0963

Please sign in to comment.