updated README

README.md

@@ -13,7 +13,7 @@ _WARNING: this project is still in development, don't expect it to work for you_
 
 Hardware info
 -------------
-This firmware is designed for esp8266 modules which have most esp I/O pins available.
+This firmware is designed for esp8266 modules which have most ESP I/O pins available.
 The expected connections are:
 - URXD: connect to TX of microcontroller
 - UTXD: connect to RX of microcontroller
@@ -26,6 +26,7 @@ If you are using an FTDI connector, GPIO12 goes to DTR and GPIO13 goes to CTS
 
 Initial flashing
 ----------------
+(This is not necessary if you receive one of the jn-esp or esp-bridge modules.)
 If you want to simply flash the provided firmware binary, you can use your favorite
 ESP8266 flashing tool and flash the following:
 - `boot_v1.3(b3).bin` from the official `esp_iot_sdk_v1.0.1` to 0x00000
@@ -34,21 +35,44 @@ ESP8266 flashing tool and flash the following:
 Note that the firmware assumes a 512KB flash chip, which most of the esp-01 thru esp-11
 modules appear to have.
 
-Wifi configuration
----------------------
+Wifi configuration overview
+------------------
+The end state is to have the esp8266 join your pre-existing wifi network as a pure station.
+However, in order to get there the esp8266 will start out as an access point and you'll have
+to join its network to configure it. The short version is:
+1. the esp-link creates a wifi access point
+2. your laptop joins as a station and you configure the esp-link wifi with your network info
+   by pointing your browser at `http://192.168.4.1/`
+3. the esp-link joins your network while continuing to also be an access point ("AP+STA")
+4. the esp-link succeeds in connecting and shuts down its own access point
+5. if the esp-link looses your network it brings up its access point again
+
+LED indicators
+--------------
+Assuming the above LED configuration, the green LED will show the wifi status as follows:
+- Very short flash once a second: not connected to a network (but it shold present its own AP)
+- Even on/off at 1HZ: connected to your network but no IP address (waiting for DHCP)
+- Steady on with very short off every 3 seconds: connected to your network with an IP address
+  (esp-link shuts down its AP after 15 seconds)
+
+The yellow LED will blink briefly ever time serial data is sent or received by the esp-link.
+(This does not function yet.)
+
+Wifi configuration details
+--------------------------
 After you have serially flashed the module it will create a wifi access point (AP) with an
 SSID of the form `ESP_012ABC` where 012ABC is a piece of the module's MAC address.
 Using a laptop, phone, or tablet connect to this SSID and then open a browser pointed at
-http://192.168.0.1, you should them see the esp-link web site.
+http://192.168.4.1, you should then see the esp-link web site.
 
-Now configure the wifi. The typical desired configuration is for the esp-link to be a
+Now configure the wifi. The desired configuration is for the esp-link to be a
 station on your local wifi network so can communicate with it from all your computers.
 
-To make this happen, navigate to the wifi page and hit the "change to STA+AP mode" button.
-This will cause the esp8266 to restart and yo will have to wait 5-10 seconds until you can 
-reconnect to the ESP_123ABC wifi network and refres the wifi settings page.
+To make this happen, navigate to the wifi page and you should see the esp-link scan
+for available networks.
+If nothing happens verify that it is in AP+STA mode and not in AP-only mode (I need to fix this).
 
-At this point you should see a list of detected networks on the web page and you can select
+You should then see a list of detected networks on the web page and you can select
 yours. Enter a password if your network is secure (recommended...) and hit the connect button.
 
 You should now see that the esp-link has connected to your network and it should show you
@@ -65,7 +89,6 @@ back to AP+STA mode and thus both present its ESP_012ABC-style network and try t
 the requested network, which will presumably not work or it wouldn't be in fail-safe mode
 in the first place. You can then connect to the network and reconfigure the station part.
 
-
 Building the firmware
 ---------------------
 The firmware has been built using the [esp-open-sdk](https://github.com/pfalcon/esp-open-sdk)
@@ -91,8 +114,10 @@ Now, build the code: `make`
 Flashing the firmware
 ---------------------
 This firmware supports over-the-air (OTA) flashing, so you do not have to deal with serial
-flashing again after the initial one! The recommended way to flash is to use `make wiflash`,
-which assumes that you set ESP_HOSTNAME to the hostname or IP address of your esp-link
+flashing again after the initial one! The recommended way to flash is to use `make wiflash`
+if you are also building the firmware or else `./wiflash.sh` if you are downloading binary
+firmware versions,
+`make wiflash` assumes that you set ESP_HOSTNAME to the hostname or IP address of your esp-link.
 
 The flashing, restart, and re-associating with your wireless network takes about 15 seconds
 and is fully automatic. The 512KB flash are divided into two 236KB partitions allowing for new
@@ -100,3 +125,7 @@ code to be uploaded into one partition while running from the other. This is the
 OTA upgrade method supported by the SDK, except that the firmware is POSTed to the module
 using curl as opposed to having the module download it from a cloud server.
 
+If you are downloading the binary versions of the firmware (links forthcoming) you need to have
+both `user1.bin` and `user2.bin` handy and run `wiflash.sh <esp-hostname> user1.bin user2.bin`.
+This will query the esp-link for which file it needs, upload the file, and then reconnect to
+ensure all is well.