Frontend: Difference between revisions
m Board to frontend format |
Detailed summaries in each section |
||
| Line 1: | Line 1: | ||
- [https://codeberg.org/Capstone/Interface Interface Repo] | - [https://codeberg.org/Capstone/Interface Interface Repo] | ||
The frontend is a browser-based tool for operating the async radio device. It also contains debug tools for developing and debugging the device. | |||
== Message Exchange == | == Message Exchange == | ||
| Line 12: | Line 14: | ||
<blockquote><code>\x1c</code>[message sender]<code>\x1d</code>: <code>\x1e</code>[message text]<code>\x1f</code></blockquote> | <blockquote><code>\x1c</code>[message sender]<code>\x1d</code>: <code>\x1e</code>[message text]<code>\x1f</code></blockquote> | ||
Messages are sent in this format when entered into the frontend text bar. | |||
The board parses this format as a command, isolating the sender and text strings. In the future, those strings will be entered into the board's message storage. | |||
=== Board to Frontend === | === Board to Frontend === | ||
<blockquote><code>\x01</code>[message sender]<code>\x02</code>: <code>\x03</code>[message text]<code>\x04</code></blockquote> | <blockquote><code>\x01</code>[message sender]<code>\x02</code>: <code>\x03</code>[message text]<code>\x04</code></blockquote> | ||
Messages are sent in this format when using the <code>msg</code> command. In the future, this format will also be used to transfer message history to frontend. | |||
The frontend parses this format as a message, isolating the sender and text strings. These strings are entered into the frontend's message storage and display. | |||
Revision as of 11:57, 19 October 2026
The frontend is a browser-based tool for operating the async radio device. It also contains debug tools for developing and debugging the device.
Message Exchange
When a user enters a message on the frontend, it is sent Frontend to Board, and then Board to Board (radio communication). When a message is received and displayed, it is sent Board to Board, and then Board to Frontend.
In both cases, special USART characters are used to wrap messages, flagging them for each system while remaining invisible to terminal users.
Frontend to Board
Message format:
\x1c[message sender]\x1d:\x1e[message text]\x1f
Messages are sent in this format when entered into the frontend text bar.
The board parses this format as a command, isolating the sender and text strings. In the future, those strings will be entered into the board's message storage.
Board to Frontend
\x01[message sender]\x02:\x03[message text]\x04
Messages are sent in this format when using the msg command. In the future, this format will also be used to transfer message history to frontend.
The frontend parses this format as a message, isolating the sender and text strings. These strings are entered into the frontend's message storage and display.