From 5dbd4b5c9e1836192c49174e7017e850b08c7572 Mon Sep 17 00:00:00 2001 From: Leon Krieg Date: Tue, 27 Aug 2024 18:22:45 +0200 Subject: [PATCH] Update documentation --- README | 47 ++++++++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/README b/README index a78dfcc..53f02e3 100644 --- a/README +++ b/README @@ -1,32 +1,37 @@ ## Serial Interface -Instead of polling for input we use an interrupt vector -to write data to a rx ring buffer when it's available. + Instead of polling for input we use an interrupt vector + to write data to a rx ring buffer when it's available. -We parse commands using a state machine so we can deal -with small chunks of characters at a time and spit out -the parsed command when the transmission has finished. + We parse commands using a state machine so we can deal + with small chunks of characters at a time and spit out + the parsed command when the transmission has finished. -TODO: System clock frequency should be a multiple of -1.8432MHz for perfect USART. This means we would need -an external crystal oscillator. - -TODO: Do we need to handle backspaces for interactive -serial consoles?! Overkill?! + TODO: System clock frequency should be a multiple of + 1.8432MHz for perfect USART. This means we would need + an external crystal oscillator. ### Supported Commands -Optional decimal point for numbers. + - RUN + - STOP + - TEMP + - DEWP -- START -- RESET -- STOP -- SET TEMP 20.0 -- SET DEWP 60.0 + Decimal point for numbers is optional. Make sure you + have disabled hardware flow control on the client side. + + TODO: Do we need to handle backspaces for interactive + serial consoles?! Overkill?! ### Web Interface Example -There is a little example web interface you can check -out in the opt/webgui directory. This simple php page -demonstrates how you can create a custom interface for -your drybox. For more info see the README file there. + There is a little example web interface you can check + out in the opt/webgui directory. The simple php page + demonstrates how you can create a custom interface for + your drybox. For more info see the README file there. + + You may need to run the following command to load the + optional submodules if you can't see the webgui folder: + + git submodule update --init