diff --git a/README.md b/README.md index 74c82b1..1521920 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ESP-LINK: Wifi-Serial Bridge w/REST&MQTT ======================================== + The esp-link firmware connects a micro-controller to the internet using an ESP8266 Wifi module. It implements a number of features: @@ -39,10 +40,16 @@ fork and added cool new features as well as bug fixes. In this document: [goals](#esp-link-goals), [uses](#esp-link-uses), [eye candy](#eye-candy), [getting-started](#getting-started), [contact](#contact). -Separate documents: [hardware configuration](FLASHING.md), [serial flashing](FLASHING.md), [troubleshooting](TROUBLESHOOTING.md), -[over-the-air flashing](BUILDING.md#updating-the-firmware-over-the-air), [building esp-link](BUILDING.md), -[flash layout](FLASH.md), [serial bridge](), -[flashing an attached uC](UCFLASHING.md), [MQTT and outbound REST requests](RESTMQTT.md), [service web pages](WEB-SERVER.md) +Separate documents: +- [hardware configuration](FLASHING.md), [serial flashing](FLASHING.md#initial-serial-flashing) +- [wifi configuration](WIFI-CONFIG.md) +- [troubleshooting](TROUBLESHOOTING.md), [LED indicators](TROUBLESHOOTING.md#led-indicators) +- [serial bridge]() +- [flashing an attached uC](UC-FLASHING.md) +- [MQTT and outbound REST requests](RESTMQTT.md) +- [service web pages](WEB-SERVER.md) +- [building esp-link](BUILDING.md), [over-the-air flashing](BUILDING.md#updating-the-firmware-over-the-air) +- [flash layout](FLASH.md) For quick support and questions chat at [![Chat at https://gitter.im/jeelabs/esp-link](https://badges.gitter.im/esp-link.svg)](https://gitter.im/jeelabs/esp-link) diff --git a/RESTMQTT.md b/RESTMQTT.md index f0405c4..1383db8 100644 --- a/RESTMQTT.md +++ b/RESTMQTT.md @@ -1,4 +1,4 @@ -Outbound HTTP REST requests and MQTT client +Esp-link: Outbound HTTP REST requests and MQTT client ------------------------------------------- The V2 versions of esp-link use the SLIP protocol over the serial link to support simple outbound @@ -11,4 +11,4 @@ with that callback address. This enables asynchronous communication where esp-li uC when requests complete or when other actions happen, such as wifi connectivity status changes. You can find REST and MQTT libraries as well as demo sketches in the -https://github.com/jeelabs/el-client[el-client] repository. +[el-client](https://github.com/jeelabs/el-client) repository. diff --git a/UC-FLASHING.md b/UC-FLASHING.md index f4e3250..fd2ba63 100644 --- a/UC-FLASHING.md +++ b/UC-FLASHING.md @@ -50,11 +50,11 @@ sequence and not issue a reset if you use port 23. If you are having trouble with the built-in programmer and see something like this: --------------------- +``` # ./avrflash 192.168.3.104 blink.hex Error checking sync: FAILED to SYNC: abandoned after timeout, got: :\xF/\x00\xCj\xCz\xCJ\xCZ\xC\xAÜ\xC\xAä\xC\xAÜ\xC\xAä\xC\xBì\xC\xBô\xC\xBì\xC\xBô\xC\xAÜ\xC\xAä\xC --------------------- +``` the most likely cause is a baud rate mismatch and/or a bad connection from the esp8266 to the AVRs reset line. @@ -68,9 +68,9 @@ baud rate may be incorrect. The output of a successful flash using the built-in programmer looks like this: --------------------- +``` Success. 3098 bytes at 57600 baud in 0.8s, 3674B/s 63% efficient --------------------- +``` This says that the sketch comprises 3098 bytes of flash, was written in 0.8 seconds (excludes the initial sync time) at 57600 baud,