diff --git a/docs/README b/docs/README index 4918a5d..8e78b47 100644 --- a/docs/README +++ b/docs/README @@ -7,7 +7,7 @@ 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 + NOTE: System clock frequency should be a multiple of 1.8432MHz for perfect USART. This means we would need an external crystal oscillator. @@ -22,17 +22,28 @@ 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. The simple php page - demonstrates how you can create a custom interface for - your drybox. For more info see the README file there. + There is an example https and websocket server (written + in Python) which serves a simple Javascript shell that + controls your box. Its main purpose is to give you a + demonstration on how you can write a custom bridge or + interface. - You may need to run the following command to load the + Check out the directory "/opt/webgui" under the project + root. You may need to run the following command to load optional submodules if you can't see the webgui folder: - git submodule update --init + $ git submodule update --init + + First you need to generate a self signed certificate to + ensure SSL encryption. Run the following command in the + webgui root directory: + + $ ./configure + + To manually start the server you can use the Makefile + (but it's recommended to run the server as a daemon as + soon as the server starts): + + $ make run