Update documentation
This commit is contained in:
47
README
47
README
@@ -1,32 +1,37 @@
|
|||||||
## Serial Interface
|
## Serial Interface
|
||||||
|
|
||||||
Instead of polling for input we use an interrupt vector
|
Instead of polling for input we use an interrupt vector
|
||||||
to write data to a rx ring buffer when it's available.
|
to write data to a rx ring buffer when it's available.
|
||||||
|
|
||||||
We parse commands using a state machine so we can deal
|
We parse commands using a state machine so we can deal
|
||||||
with small chunks of characters at a time and spit out
|
with small chunks of characters at a time and spit out
|
||||||
the parsed command when the transmission has finished.
|
the parsed command when the transmission has finished.
|
||||||
|
|
||||||
TODO: System clock frequency should be a multiple of
|
TODO: System clock frequency should be a multiple of
|
||||||
1.8432MHz for perfect USART. This means we would need
|
1.8432MHz for perfect USART. This means we would need
|
||||||
an external crystal oscillator.
|
an external crystal oscillator.
|
||||||
|
|
||||||
TODO: Do we need to handle backspaces for interactive
|
|
||||||
serial consoles?! Overkill?!
|
|
||||||
|
|
||||||
### Supported Commands
|
### Supported Commands
|
||||||
|
|
||||||
Optional decimal point for numbers.
|
- RUN
|
||||||
|
- STOP
|
||||||
|
- TEMP <float>
|
||||||
|
- DEWP <float>
|
||||||
|
|
||||||
- START
|
Decimal point for numbers is optional. Make sure you
|
||||||
- RESET
|
have disabled hardware flow control on the client side.
|
||||||
- STOP
|
|
||||||
- SET TEMP 20.0
|
TODO: Do we need to handle backspaces for interactive
|
||||||
- SET DEWP 60.0
|
serial consoles?! Overkill?!
|
||||||
|
|
||||||
### Web Interface Example
|
### Web Interface Example
|
||||||
|
|
||||||
There is a little example web interface you can check
|
There is a little example web interface you can check
|
||||||
out in the opt/webgui directory. This simple php page
|
out in the opt/webgui directory. The simple php page
|
||||||
demonstrates how you can create a custom interface for
|
demonstrates how you can create a custom interface for
|
||||||
your drybox. For more info see the README file there.
|
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
|
||||||
|
|||||||
Reference in New Issue
Block a user