Skip to content
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-31 snapshot #43

Open
wants to merge 1 commit into
base: timetravel-2024-07-30
Choose a base branch
from

Conversation

sthagen
Copy link
Contributor

@sthagen sthagen commented Aug 2, 2024

Next warp 2024-08-01 ← 2024-07-31 ← 2024-07-30

Well, actually I skipped one snapshot and this is now the mqtt-sn-v2.0-wd-snapshot-20240801T194400Z harvesting what happened on 2024-07-31 and 2024-08-01 - working around problems (google or word docs not orderly exposing changes) brings up additional problems.

Sorry for that.

@sthagen sthagen self-assigned this Aug 2, 2024
@sthagen sthagen added documentation Improvements or additions to documentation editorial Mostly editorial changes. labels Aug 2, 2024
@sthagen
Copy link
Contributor Author

sthagen commented Aug 2, 2024

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-20240731T053800Z.md mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md
--- mqtt-sn-v2.0-wd-20240731T053800Z.md	2024-07-31 07:39:14
+++ mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md	2024-07-31 20:50:55
@@ -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.
-* deletes 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.12section 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.12section 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.12section 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
@@ -1033,8 +1033,8 @@
 | SUBACK | YES |
 | UNSUBSCRIBE | YES |
 | UNSUBACK | YES |
-| PINGREQ | YESNO |
-| PINGRESP | YESNO |
+| PINGREQ | YES |
+| PINGRESP | YES |
 | DISCONNECT | NO |
 | AUTH | NO |
 | ADVERTISE | NO |
\ No newline at end of file

and:

❯ diff -u mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md mqtt-sn-v2.0-wd-snapshot-20240801T194400Z.md
--- mqtt-sn-v2.0-wd-snapshot-20240731T184900Z.md	2024-07-31 20:50:55
+++ mqtt-sn-v2.0-wd-snapshot-20240801T194400Z.md	2024-08-01 21:45:50
@@ -1581,19 +1581,19 @@

 #### **3.1.5.6 Authentication Method Length (optional, only with *Auth* flag set)** {#3.1.5.6-authentication-method-length-(optional,-only-with-auth-flag-set)}

-Single byte value (max 0-255 bytes), representing the length of field used to specify the authentication method. Refer to LINKED TO AUTH for more information about extended authentication.
+Single byte value (max 0-255 bytes), representing the length of field used to specify the authentication method. Refer to [section 4.11](\#4.11-enhanced-authentication) for more information about extended authentication.

 #### **3.1.5.7 Authentication Method (optional, only with *Auth* flag set)** {#3.1.5.7-authentication-method-(optional,-only-with-auth-flag-set)}

-A UTF-8 Encoded String containing the name of the authentication method. Refer to LINKED TO AUTH for more information about extended authentication.
+A UTF-8 Encoded String containing the name of the authentication method. Refer to [section 4.11](\#4.11-enhanced-authentication) for more information about extended authentication.

 #### **3.1.5.8 Authentication Data Length (optional, only with *Auth* flag set)** {#3.1.5.8-authentication-data-length-(optional,-only-with-auth-flag-set)}

-Two byte value (max 0-65535 bytes), representing the length of field used to specify the authentication data. Refer to LINKED TO AUTH for more information about extended authentication.
+Two byte value (max 0-65535 bytes), representing the length of field used to specify the authentication data. Refer to [section 4.11](\#4.11-enhanced-authentication) for more information about extended authentication.

 #### **3.1.5.9 Authentication Data (optional, only with *Auth* flag set)** {#3.1.5.9-authentication-data-(optional,-only-with-auth-flag-set)}

-Binary Data containing authentication data. The contents of this data are defined by the authentication method and the state of already exchanged authentication data. Refer to LINKED TO AUTH for more information about extended authentication.
+Binary Data containing authentication data. The contents of this data are defined by the authentication method and the state of already exchanged authentication data. Refer to [section 4.11](\#4.11-enhanced-authentication) for more information about extended authentication.

 #### **3.1.5.10 Assigned Client Identifier** {#3.1.5.10-assigned-client-identifier}

\ No newline at end of file

I mixed up two dates when assessing the harvest from the end of the day and the beginning of the next day mapping to a date by hand instead of just relying on a version control system is so unusual for me. Sorry.

So this branch name is in reality showing the changes of two days of work:

  1. 2024-07-30 → 2024-07-31
  2. 2024-07-31 → 2024-08-01

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation editorial Mostly editorial changes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant