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..ad373047 --- /dev/null +++ b/doc/getting-started-ESP8266.md @@ -0,0 +1,28 @@ +# Getting Started with an ESP8266 + +``` +Wire Connections + + +-----------+ +-----------+ + | nRF24L01+ |--colour--| ESP8266 | + | | | | + | GND |---black--| GND | + | VCC |----red---| +3.3V | + | CE |---grey---| D4 | + | CSN |--purple--| D8 | + | SCK |---blue---| D5 | + | MOSI |---green--| D7 | + | MISO |---brown--| D6 | + | IRQ |--yellow--| D3 | + +-----------+ +-----------+ +``` + +![plot](./AhoyMiles_bb.png) + +See + +* AhoyMiles_bb.png +* AhoyMiles_schem.png +* AhoyMiles.fzz + +by "isnoAhoy"