Merge pull request #6 from HAW-RN/encoding

Encoding
HAW-RN · Jun 2, 2024 · bd3bcb8 · bd3bcb8
2 parents e751161 + e4acb7b
commit bd3bcb8
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/protocol/03_encoding.md b/protocol/03_encoding.md
@@ -1,7 +1,23 @@
 # Encoding
 
 ## Requirements
+- The protocols must use JavaScript Object Notation (JSON).
+- The JSON string must be UTF-8 encoded.
+- ...
 
 ## Format
+### Header
+| Type  | Name      | Description                                      |
+|-------|-----------|--------------------------------------------------|
+| int_? | Length    | Message length (including or excluding?) header. | 
+| int_? | Checksum  | ...                                              |
+TODO:
+- Define int sizes. The length cannot exceed the uint16 range. However, it may be more convenient to use int32 in languages that do not support unsigned types.
+- Select a checksum algorithm.
+
+### Data
+| Type    | Name | Description                             |
+|---------|------|-----------------------------------------|
+| String  | Data | JSON message encoded as a UTF-8 string. |
 
 ## Example