diff --git a/README.md b/README.md index 22b7698c..fda91fe4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ Various tools, examples, and documentation for communicating with Hoymiles micro In particular: -* `doc\hoymiles-format-description.txt` is a detailed description of the communications format and the history of this project -* The `tools` folder contains various software tools for RaspberryPi and Arduino +* `doc/hoymiles-format-description.txt` is a detailed description of the communications format and the history of this project +* `doc/getting-started-ESP8266.md` shows the hardware setup for an ESP8266-based system +* The `tools` folder contains various software tools for RaspberryPi, Arduino and ESP8266/ESP32 Contributors are always welcome! diff --git a/doc/AhoyMiles.fzz b/doc/AhoyMiles.fzz new file mode 100644 index 00000000..c072d083 Binary files /dev/null and b/doc/AhoyMiles.fzz differ diff --git a/doc/AhoyMiles_bb.png b/doc/AhoyMiles_bb.png new file mode 100644 index 00000000..9704aeda Binary files /dev/null and b/doc/AhoyMiles_bb.png differ diff --git a/doc/AhoyMiles_schem.png b/doc/AhoyMiles_schem.png new file mode 100644 index 00000000..b955be78 Binary files /dev/null and b/doc/AhoyMiles_schem.png differ diff --git a/doc/getting-started-ESP8266.md b/doc/getting-started-ESP8266.md new file mode 100644 index 00000000..d3e064b6 --- /dev/null +++ b/doc/getting-started-ESP8266.md @@ -0,0 +1,45 @@ +# Getting Started with an ESP8266 + +Wire Connections + +```ditaa + +-----------+ +-----------+ + | ESP8266 |--colour--| nRF24L01+ | + | | | | + | GND |---black--|[GND] | + | +3.3V |----red---| VCC | + | D4 |---grey---| CE | + | D8 |--purple--| CSN | + | D5 |---blue---| SCK | + | D7 |---green--| MOSI | + | D6 |---brown--| MISO | + | D3 |--yellow--| IRQ | + +-----------+ +-----------+ +``` + +![plot](./AhoyMiles_bb.png) + +Fritzing diagrams & schematics +* [AhoyMiles_bb.png](./AhoyMiles_bb.png) +* [AhoyMiles_schem.png](./AhoyMiles_schem.png) +* [AhoyMiles.fzz](./AhoyMiles.fzz) + +Libraries to be installed in Arduino IDE: +* RF24 +* TimeLib + +Verify & Compile +* Connect to WiFi Network `ESP AHOY` +* Use password `esp_8266` +* Connect to Network settings + +Setup +* WiFi + * Enter SSID `mynetwork` + * Enter Password `mypassword` +* Device Host Name + * Enter Device Name `esp-ahoy` +* General + * Hoymiles Address (e.g. 114173123456) `11:41:73:12:34:56` + * [x] Reboot device after successful save +Save