Jump to content

Frontend usart interface

From Ratpack
Revision as of 14:17, 24 September 2026 by Nelson (talk | contribs)


USART protocol for talking with frontend

HELP

- debug command, prints out command and description of usage for all commands registered

Example format (THESE ARENT REAL COMMANDS)

help: prints command output and description for all commands
dump_debug: starts writing raw adc data to terminal
listknownmessages_gui: returns a list of indices of messages the board knows about


list_indicies_of_known_messages

A returns a space separated list of indicies of every index of every known messages. Each message recieved/put out gets a per-board index.

Example format

list_indicies_of_known_messages                <= command to stm
4 5 6 7 8                                      <= from stm

print_message [int n]

Prints a pgp-like formatted message stored in the stm's memeory

Example format

print_message                <= command to stm
5                            <= command to stm
this is my message
you can't have lines over 40 chars
or lines with a pipe
but that's okay|                          <= text from board, raw text of message, | terminated

send_message_to_board

Puts the board into uart multi-line receiving mode, interface will send the string content of a message, maybe format it to handle required feilds.

Example format

send_message_to_board                <= command to stm
this is my very cool message
it contains a couple of lines
and some fun smiles :) :p|           <= text to stm, raw text of message, | terminated

The gui will then write out the message content to be sent out by the board

load_callsign_into_board

Puts board into one line uart receiving mode, then the gui enters a callsign as text, to be sent out at the end of each message per fcc

SUBJECT TO CHANGE! WE probably don't feel like writing a ascii => morse thing then a manual beeper, we may want to hardcode that Example format

load_callsign_into_board        <= command to stm
aadaaa                          <= callsign as text sent to stm from gui controller

Notes:

- serial number id is hardcoded
-