From 2a96abf2a1bf1bab57e4a933d18cda8b52e6e022 Mon Sep 17 00:00:00 2001 From: Christian Seiler Date: Sat, 30 May 2026 09:41:35 +0200 Subject: [PATCH] Specification: better document the differences between v1 and v2 --- Specification.rst | 64 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/Specification.rst b/Specification.rst index f31096b..749e7fc 100644 --- a/Specification.rst +++ b/Specification.rst @@ -228,6 +228,8 @@ This section is similar to the "List of drawn elements (timespan)" section, but After the last timestamp the list of elements follows (as with the "List of drawn elements (always)" and "List of drawn elements (timespan)" elements). +This was added in version 2 of the format. + File Global Expiry Date ----------------------- @@ -242,6 +244,8 @@ once the expiry timestamp is reached. 4 | Expiry Date Timestamp (High) | +------------------------+------------------------+------------------------+------------------------+ +This was added in version 2 of the format. + Custom Font ----------- @@ -401,7 +405,7 @@ Flags +-----------+---------------------------------------------------+ | Bit | Description | +===========+===================================================+ -| ``0`` | Line color is dark, not white | +| ``0`` | Line color is dark, not white (added in v2) | +-----------+---------------------------------------------------+ | ``1`` .. | Reserved for future use | | ``7`` | | @@ -459,6 +463,26 @@ Clipped Text 16.. | Text ... | Padding (if required) | +------------------------+------------------------+------------------------+------------------------+ +Version 1 Format +```````````````` + +This was changed in version 2, and the old format is like this: + + 0 1 2 3 + +------------------------+------------------------+------------------------+------------------------+ + 0 | Type: 16 | X Offset | + +------------------------+------------------------+------------------------+------------------------+ + 4 | Y Offset | Width | + +------------------------+------------------------+------------------------+------------------------+ + 8 | Height | Font Index | + +------------------------+------------------------+------------------------+------------------------+ + 12 | Text Length | Text ... | + +------------------------+------------------------+------------------------+------------------------+ + ... | ... Text | Padding (if required) | + +------------------------+------------------------+------------------------+------------------------+ + +(There are no text flags present.) + Text Flags `````````` @@ -498,6 +522,26 @@ Horizontally Scrolling Text 20.. | ... Text | Padding (if required) | +------------------------+------------------------+------------------------+------------------------+ +Version 1 Format +```````````````` + +This was changed in version 2, and the old format is like this: + + 0 1 2 3 + +------------------------+------------------------+------------------------+------------------------+ + 0 | Type: 17 | X Offset | + +------------------------+------------------------+------------------------+------------------------+ + 4 | Y Offset | Width | + +------------------------+------------------------+------------------------+------------------------+ + 8 | Height | Flags | Scroll Speed | + +------------------------+------------------------+------------------------+------------------------+ + 12 | Font Index | Text Length | + +------------------------+------------------------+------------------------+------------------------+ + ... | ... Text | Padding (if required) | + +------------------------+------------------------+------------------------+------------------------+ + +(There are no text flags present.) + Current Time ------------ @@ -514,6 +558,24 @@ Current Time 16 | Flags | Reserved | +------------------------+------------------------+------------------------+------------------------+ +Version 1 Format +```````````````` + +This was changed in version 2, and the old format is like this: + + 0 1 2 3 + +------------------------+------------------------+------------------------+------------------------+ + 0 | Type: 32 | X Offset | + +------------------------+------------------------+------------------------+------------------------+ + 4 | Y Offset | Width | + +------------------------+------------------------+------------------------+------------------------+ + 8 | Height | Font Index | + +------------------------+------------------------+------------------------+------------------------+ + 12 | UTC Offset (Minutes) | Flags | + +------------------------+------------------------+------------------------+------------------------+ + +(There are no text flags present.) + UTC Offset ``````````