From 4d39a454c1c3114436a918d6d0b305118e28df52 Mon Sep 17 00:00:00 2001 From: Luc Date: Wed, 3 Jun 2015 21:05:28 +0800 Subject: [PATCH] Update README.md --- README.md | 52 +++++++++++++++++++--------------------------------- 1 file changed, 19 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index a0c0aebb..0ebb3bab 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,19 @@ FW for ESP8266 used with 3D printer ##Description -Thanks to @disneysw for bringing this module idea and basic code +Thanks to @disneysw for bringing this module idea Thanks to @lkarlslund for suggestion about independant reset using GPIO2 -Have a bridge configurable by web and optionally by printer -Have a front end to know what is the wifi status or know what is the print status - this part can be optional and removed by compilation directive if no need -... -TBD +Have a bridge configurable by web (implemented) and optionally by printer (not yet implemented) +Have a front end to know what is the wifi status (implemented) or know what is the print status (not yet implemented) - this part can be optional and removed by compilation directive if no need + ##Hardware connection --Use GPIO2 to ground to reset all settings in hard way - 2-6 sec after boot / not before!! Set GPIO2 to ground before boot change boot mode and go to special boot that do not reach FW - I did not found information on this. Currently boot take 10 sec - giving 8 seconds to connect GPIO2 to GND and do an hard recovery for settings --Use GPIO0 to ground to be in update mode --Use a switch to reset/disable module --TODO: Full wiring with drawing -TBD + ##Development Currently using [Arduino IDE 1.6.4](http://arduino.cc/en/Main/Software) with the esp8266 module from board manager added from [github.com/esp8266/Arduino](https://github.com/esp8266/Arduino) @@ -27,21 +26,20 @@ Additionnaly: ##Flash the Module *Tools: ---Use IDE to upload directly ---Use esp flasher: https://github.com/nodemcu/nodemcu-flasher for 0x00000 and 0X00004 binaries +--Use IDE to upload directly (latest version of board manager module generate one binary) *Connection ---Connect GPIO0 to ground to be in update mode +--Connect GPIO0 to ground to be in update mode -##Wifi connection +##Web configuration *Wifi Mode : Access point / Client station *IP Generation: DHCP/Static IP *IP/MASK/GATEWAY for static data *Baud Rate for serial (supported : 9600, 19200, 38400, 57600, 115200, 230400) -... -TBD +*web port and data port + -##Configuration +##Default Configuration Default Settings: AP:ESP8266 PW:12345678 @@ -54,58 +52,46 @@ IP Mode: Static IP IP: 192.168.0.1 Mask: 255.255.255.0 GW:192.168.0.1 -Baud rate: 9600 +Baud rate: 9600 +Web port:80 +Data port: 8888 -From web: -port 80 ---Need picture and flow +These are the UI when css is in cache or internet is available:


-... -TBD - - ##Commands from/to serial(not yet implemented): *from module to printer [Need Printer FW support and can be disabled in ESP FW] -M800 S1 , restart module done need a wifi/activity restart -M801 [Message], Error message from module -M802 [Message], Status message from module -M804 [AP/STATION,SSID,DHC/STATIC,IP,MASK,GW,STATUS,MAC ADDRESSS, BAUD?], ]Module configuration without password - ... - TBD *from host to printer (not yet implemented) [Need Printer FW support] on port 8888 -M803 [IP, AP,SSID, Password....], ]Module configuration settings to be used by module -M805 query to get M804 informations - ... - TBD + *from printer to module [Need Printer FW support and can be disabled in ESP FW] (not yet implemented) -request configuration/status (generate the M804 as answer) -set AP/STATION,SSID,PASSSWORD,DHC/STATIC,IP,MASK,GW,BAUD from serial - ... - TBD -##Front End [need Printer FW support it] or just display module status +##Front End (not yet implemented) [need Printer FW support it] or just display module status --Display printer status --Display temperatures --Display print progress if any --List SDCard Content ---Launch/Stop/(Pause?) a Print +--Launch/Stop/(Pause?) a Print ##TODO -- Define Front End Functions --- do the bridge serial/TCPIP --- do coding -- do testing -- do a complete drawing for connections --- add some Javascript to enhance web UI --- allow to change ports from Web UI, currently fixed to 80 and 8888 +-- add some Javascript to enhance web UI more to come