-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Timetravel 2024-07-30 snapshot #42
Open
sthagen
wants to merge
1
commit into
timetravel-2024-07-27
Choose a base branch
from
timetravel-2024-07-30
base: timetravel-2024-07-27
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Stefan Hagen <[email protected]>
The corresponding diff from the freshly available download as markdown route is even more to the point (because the vendor platform has stable image identifiers and a line length limit of 512 🙈 it seems): ❯ diff -u mqtt-sn-v2.0-wd-snapshot-20240728T044900Z.md mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md
--- mqtt-sn-v2.0-wd-snapshot-20240728T044900Z.md 2024-07-28 06:50:15
+++ mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md 2024-07-31 20:50:55
@@ -112,7 +112,7 @@
[2.3 MQTT-SN Packet Fields 24](\#2.3-mqtt-sn-packet-fields)
-[2.3.1 Protocol Id 24](\#2.3.1-protocol-id)
+[2.3.1 Protocol Id 24](\#2.3.1-protocol-versionid)
[2.3.2 Radius 24](\#2.3.2-radius)
\ No newline at end of file
@@ -662,11 +662,11 @@
A program or device that uses MQTT-SN. A Client:
-* opens a Virtual Connection to a Server.
+* creates a Virtual Connection to a Server.
* publishes Application Messages that other Clients might be interested in.
* subscribes to request Application Messages that it is interested in receiving.
* unsubscribes to remove a request for Application Messages.
-* closes the Virtual Connection to the Server.
+* deletes the Virtual Connection to the Server.
and/or:
\ No newline at end of file
@@ -755,11 +755,11 @@
**Malformed Packet:**
-A Control Packet that cannot be parsed according to this specification. Refer to [section 4.11](\#4.12-handling-errors) for information about error handling.
+A Control Packet that cannot be parsed according to this specification. Refer to [section 4.12](\#4.12-handling-errors) for information about error handling.
**Protocol Error:**
-An error that is detected after the packet has been parsed and found to contain data that is not allowed by the protocol or is inconsistent with the state of the Client or Server. Refer to [section 4.11](\#4.12-handling-errors) for information about error handling.
+An error that is detected after the packet has been parsed and found to contain data that is not allowed by the protocol or is inconsistent with the state of the Client or Server. Refer to [section 4.12](\#4.12-handling-errors) for information about error handling.
**Will Message:**
\ No newline at end of file
@@ -833,7 +833,7 @@
1. Support for sleeping clients allows battery operated devices to enter a low power mode. In this state, Application Messages for the Client are buffered by the Gateway and delivered when the client wakes.
-1. A new Quality of Service level (WITHOUT SESSION) is introduced in MQTT-SN, allowing devices to publish without a GW session having been established.
+1. A new Quality of Service level (WITHOUT SESSION) is introduced in MQTT-SN, allowing devices to publish without a session having been established.
1. MQTT-SN has fewer requirements on the underlying transport and it can use connectionless network transports such as User Datagram Protocol (UDP).
\ No newline at end of file
@@ -867,9 +867,9 @@
The character data in a UTF-8 Encoded String MUST be well-formed UTF-8 as defined by the Unicode specification [\[Unicode\]](https://docs.oasis-open.org/mqtt/mqtt/v5.0/cos02/mqtt-v5.0-cos02.html\#Unicode) and restated in RFC 3629 [\[RFC3629\]](https://docs.oasis-open.org/mqtt/mqtt/v5.0/cos02/mqtt-v5.0-cos02.html\#RFC3629). In particular, the character data MUST NOT include encodings of code points between U+D800 and U+DFFF \[MQTT-SN-1.7.4-1\].
-If the Client or Server receives an MQTT-SN Control Packet containing ill-formed UTF-8 it is a Malformed Packet. Refer to [section 4.11](\#4.12-handling-errors) for information about handling errors.
+If the Client or Server receives an MQTT-SN Control Packet containing ill-formed UTF-8 it is a Malformed Packet. Refer to [section 4.12](\#4.12-handling-errors) for information about handling errors.
-A UTF-8 Encoded String MUST NOT include an encoding of the null character U+0000 \[MQTT-SN-1.7.4-2\]. If a receiver (Server or Client) receives an MQTT-SN Control Packet containing U+0000 in a UTF-8 Encoded String it is a Malformed Packet.
+A UTF-8 Encoded String MUST NOT include an encoding of the null character U+0000 \[MQTT-SN-1.7.4-2\]. If a receiver (Server or Client) receives an Control Packet containing U+0000 in a UTF-8 Encoded String it is a Malformed Packet.
UTF-8 Encoded Strings SHOULD NOT include the Unicode \[Unicode\] code points listed below. If a receiver (Server or Client) receives an MQTT-SN Control Packet with UTF-8 Encoded Strings containing any of them it MAY treat it as a Malformed Packet. These are the Disallowed Unicode code points.
\ No newline at end of file
@@ -966,7 +966,7 @@
| **PUBCOMP** | 0x0E | Client to Gateway or Gateway to Client | Publish complete (QoS 2 delivery part 3\) |
| **PUBREC** | 0x0F | Client to Gateway or Gateway to Client | Publish received (QoS 2 delivery part 1\) |
| **PUBREL** | 0x10 | Client to Gateway or Gateway to Client | Publish release (QoS 2 delivery part 2\) |
-| **PUBLISH-WITHOUT-SESSION** | 0x11 | Client to Gateway | Publish packet for out of a session messages which have no session on the gateway or broker |
+| **PUBLISH-WITHOUT-SESSION** | 0x11 | Client to Gateway | Publish packet for out of a session messages which have no session on the gateway or broker |
| **SUBSCRIBE** | 0x12 | Client to Gateway | Subscribe request |
| **SUBACK** | 0x13 | Gateway to Client | Subscribe acknowledgment |
| **UNSUBSCRIBE** | 0x14 | Client to Gateway | Unsubscribe request |
\ No newline at end of file
@@ -974,9 +974,9 @@
| **PINGREQ** | 0x16 | Client to Gateway | PING request |
| **PINGRESP** | 0x17 | Gateway to Client | PING response |
| **DISCONNECT** | 0x18 | Client to Gateway or Gateway to Client | Disconnect notification |
-| **WAKEUP** | 0x19 | | Wake up request |
-| **\- Reserved \-** | 0x1A-0x1D | | Forbidden (Old Will Range) |
-| **\- Reserved \-** | 0x1E-0xFD | | Forbidden |
+| **WAKEUP** | 0x19 | Gateway to Client | Wake up request |
+| **\- Reserved \-** | 0x1A-0x1D | Forbidden | ReservedForbidden (Old Will Range) |
+| **\- Reserved \-** | 0x1E-0xFD | Forbidden | ReservedForbidden |
| **FORWARDER ENCAPSULATION** | 0xFE | Forwarder to Client or Forwarder to Gateway | Encapsulated MQTT-SN packet |
| **PROTECTION ENCAPSULATION** | 0xFF | Client to Gateway or Gateway to Client | A protection envelope that can encapsulate any MQTT-SN packet with the exception of Forwarder-Encapsulation packet (0xFE) |
\ No newline at end of file
@@ -1033,8 +1033,8 @@
| SUBACK | YES |
| UNSUBSCRIBE | YES |
| UNSUBACK | YES |
-| PINGREQ | NO |
-| PINGRESP | NO |
+| PINGREQ | YES |
+| PINGRESP | YES |
| DISCONNECT | NO |
| AUTH | NO |
| ADVERTISE | NO |
\ No newline at end of file
@@ -1069,9 +1069,9 @@
## **2.3 MQTT-SN Packet Fields** {#2.3-mqtt-sn-packet-fields}
-### **2.3.1 Protocol Id** {#2.3.1-protocol-id}
+### **2.3.1 Protocol VersionId** {#2.3.1-protocol-versionid}
-The *Protocol Id* is 1-byte long. It is only present in a CONNECT packet and corresponds to the MQTT ‘protocol name’ and ‘protocol version’.
+The *Protocol VersionId* is 1-byte long. It is only present in a CONNECT packet and corresponds to the MQTT ‘protocol name’ and ‘protocol version’.
It is coded 0x02. 0x01 was used for MQTT-SN 1.2. All other values are reserved.
\ No newline at end of file
@@ -1283,7 +1283,7 @@
| Byte 1 | Length | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | |
| | ***CONNECT FLAGS*** | | | | | | | | | | | | |
-| | Reserved* | | Default Awake Messages | | | | | | Auth | | Will | | Clean Start |
+| | *Reserved* | | Default Awake Messages | | | | | | Auth | | Will | | Clean Start |
| Byte 3 | *0* | | *X* | *X* | *X* | | | *X* | *X* | | *X* | | *X* |
| | ***WILL FLAGS (OPTIONAL \- ONLY WHEN WILL FLAG SET)*** | | | | | | | | | | | | |
| | *Reserved* | | | | | Will Retain | Will QoS | | | | Will Topic Type | | |
\ No newline at end of file
@@ -1315,7 +1315,7 @@
Table 14: CONNECT packet
-The CONNECT packet is sent from the Client to the Gateway to create or continue a Session.
+The CONNECT packet is sent from the Client to the Gateway to create a Virtual Connection able to create or continue a Session.
#### **3.1.4.1 Length & Packet Type** {#3.1.4.1-length-&-packet-type}
\ No newline at end of file
@@ -1516,7 +1516,7 @@
| Byte 1 | Length | | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | | |
| | ***CONNACK FLAGS*** | | | | | | | | | | | | | |
-| | Reserved* | | | | | | | | | | | | Auth | Session Present |
+| | *Reserved* | | | | | | | | | | | | Auth | Session Present |
| Byte 3 | 0 | | 0 | | 0 | | 0 | | 0 | | 0 | | X | X |
| Byte 4 | Packet Identifier MSB | | | | | | | | | | | | | |
| Byte 5 | Packet Identifier LSB | | | | | | | | | | | | | |
\ No newline at end of file
@@ -1753,7 +1753,7 @@
| Byte 1 | Length | | | | | | | | | | | | | |
| Byte 2 | Packet Type (0x11) | | | | | | | | | | | | | |
| | ***PUBWOS FLAGS*** | | | | | | | | | | | | | |
-| | Reserved* | | | | *Retain* | | | *Reserved* | | | *Topic Type* | | | |
+| | *Reserved* | | | | *Retain* | | | *Reserved* | | | *Topic Type* | | | |
| Byte 3 | *0* | | *0* | *0* | *X* | | | *0* | | *0* | *X* | | | *X* |
| Byte 4 | Topic Data MSB | | | | | | | | | | | | | |
| Byte 5 | Topic Data LSB | | | | | | | | | | | | | |
\ No newline at end of file
@@ -1807,7 +1807,7 @@
| Byte 1 | Length | | | | | | | | | | | | | |
| Byte 2 | Packet Type (0x0C) | | | | | | | | | | | | | |
| | ***PUBLISH QoS 0 FLAGS*** | | | | | | | | | | | | | |
-| | Reserved* | | *QoS* | | *Retain* | | | *Reserved* | | *Reserved* | *Topic Type* | | | |
+| | *Reserved* | | *QoS* | | *Retain* | | | *Reserved* | | *Reserved* | *Topic Type* | | | |
| Byte 3 | *0* | | *0* | *0* | *X* | | | *0* | | *0* | *X* | | | *X* |
| Byte 4 | Topic Data MSB | | | | | | | | | | | | | |
| Byte 5 | Topic Data LSB | | | | | | | | | | | | | |
\ No newline at end of file
@@ -1850,7 +1850,7 @@
| Byte 1 | Length | | | | | | | | | | | | | |
| Byte 2 | Packet Type (0x0C) | | | | | | | | | | | | | |
| | ***PUBLISH QoS 1&2 FLAGS*** | | | | | | | | | | | | | |
-| | DUP* | | *QoS* | | *Retain* | | | *Reserved* | | *Reserved* | *Topic Type* | | | |
+| | *DUP* | | *QoS* | | *Retain* | | | *Reserved* | | *Reserved* | *Topic Type* | | | |
| Byte 3 | *X* | | *X* | *X* | *X* | | | *0* | | *0* | *X* | | | *X* |
| Byte 4 | Packet Identifier MSB | | | | | | | | | | | | | |
| Byte 5 | Packet Identifier LSB | | | | | | | | | | | | | |
\ No newline at end of file
@@ -2066,7 +2066,7 @@
| Byte 1 | Length | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | |
| | ***SUBSCRIBE FLAGS*** | | | | | | | | | | | | |
-| | No Local* | | *QoS* | | | *Retain as published* | | *Retain Handling* | | | *Topic Type* | | |
+| | *No Local* | | *QoS* | | | *Retain as published* | | *Retain Handling* | | | *Topic Type* | | |
| Byte 3 | *X* | | *X* | *X* | | *X* | | *X* | | *X* | *X* | | *X* |
| Byte 4 | Packet Identifier MSB | | | | | | | | | | | | |
| Byte 5 | Packet Identifier LSB | | | | | | | | | | | | |
\ No newline at end of file
@@ -2135,7 +2135,7 @@
| Byte 1 | Length | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | |
| | ***SUBACK FLAGS*** | | | | | | | | | | | | |
-| | Reserved* | | *Reserved* | | *Reserved* | | | *Reserved* | *Reserved* | | *Topic Type* | | |
+| | *Reserved* | | *Reserved* | | *Reserved* | | | *Reserved* | *Reserved* | | *Topic Type* | | |
| Byte 3 | *0* | | *0* | *0* | *0* | | | *0* | *0* | | *X* | | *X* |
| Byte 4 | Topic Data MSB | | | | | | | | | | | | |
| Byte 5 | Topic Data LSB | | | | | | | | | | | | |
\ No newline at end of file
@@ -2176,7 +2176,7 @@
| Byte 1 | Length | | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | | |
| | ***UNSUBSCRIBE FLAGS*** | | | | | | | | | | | | | |
-| | Reserved* | | *Reserved* | | *Reserved* | | | *Reserved* | | | *Reserved* | *Topic Type* | | |
+| | *Reserved* | | *Reserved* | | *Reserved* | | | *Reserved* | | | *Reserved* | *Topic Type* | | |
| Byte 3 | *0* | | *0* | *0* | *0* | | | *0* | | | *0* | *X* | | *X* |
| Byte 4 | Packet Identifier MSB | | | | | | | | | | | | | |
| Byte 5 | Packet Identifier LSB | | | | | | | | | | | | | |
\ No newline at end of file
@@ -2320,7 +2320,7 @@
| Byte 1 | Length | | | | | | | | | | | | | | | |
| Byte 2 | Packet Type | | | | | | | | | | | | | | | |
| | ***DISCONNECT FLAGS*** | | | | | | | | | | | | | | | |
-| | Reserved* | | | | | | | | *Reason Code Present* | | *Session Expiry Interval Present* | | *Reason String Present* | | | *Retain Registrations* |
+| | *Reserved* | | | | | | | | *Reason Code Present* | | *Session Expiry Interval Present* | | *Reason String Present* | | | *Retain Registrations* |
| Byte 3 | 0 | | 0 | | 0 | | 0 | | X | | X | | X | | X | |
| Byte 4 | Reason Code (optional) | | | | | | | | | | | | | | | |
| Byte 5 | Session Expiry Interval MSB (optional) | | | | | | | | | | | | | | | |
\ No newline at end of file
@@ -3573,7 +3573,7 @@
| Byte 1 | Length | | | | | | | | | | | | |
| Byte 2 | Packet Type (0x0C) | | | | | | | | | | | | |
| | ***PUBLISH-M1 FLAGS*** | | | | | | | | | | | | |
-| | DUP* | | *QoS* | | *Retain* | | | *Reserved* | *Reserved* | *Topic Id Type* | | | |
+| | *DUP* | | *QoS* | | *Retain* | | | *Reserved* | *Reserved* | *Topic Id Type* | | | |
| Byte 3 | *X* | | *X* | *X* | *X* | | | *0* | *0* | *X* | | | *X* |
| Byte 4 | Topic Id MSB | | | | | | | | | | | | |
| Byte 5 | Topic Id LSB | | | | | | | | | | | | |
\ No newline at end of file |
sthagen
added
documentation
Improvements or additions to documentation
editorial
Mostly editorial changes.
labels
Aug 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Next warp 2024-07-30 ← 2024-07-27