3pp-mirror/ahoy
1
0
Fork 0
mirror of https://github.com/lumapu/ahoy.git synced 2025-05-19 20:06:11 +02:00
Code Issues Projects Releases Packages Wiki Activity

fixed markdown syntax, typos and http://ahoy-dtu/ link

Browse source
This commit is contained in:
stefan123t 2022-09-15 23:06:26 +02:00
parent 3f9fe399d3
commit 5870bcea1b
1 changed files with 42 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

68
tools/esp8266/README.md
View file

@ -34,9 +34,11 @@ This page describes how the module of a Wemos D1 mini and ESP8266 is wired to th
Further information will help you to communicate to the compatible inverters. Further information will help you to communicate to the compatible inverters.
## Compatiblity ## Compatiblity
For now the following Inverters should work out of the box: For now the following Inverters should work out of the box:
Hoymiles Inverters Hoymiles Inverters
- HM300 - HM300
- HM350 - HM350
- HM400 - HM400
@ -48,12 +50,13 @@ Hoymiles Inverters
- HM1500 - HM1500
TSun Inverters: TSun Inverters:
- TSOL-350 - TSOL-350
- TSOL-400 - TSOL-400
- othery may work as well (need to be veryfied). - others may work as well (need to be verified).
## Things needed ## Things needed
In order to build your own Ahoy DTU, you will need some things.<br/> In order to build your own Ahoy DTU, you will need some things.<br/>
This list is not closing as the Maker Community offers more Boards than we could cover in this Readme.<br/><br/> This list is not closing as the Maker Community offers more Boards than we could cover in this Readme.<br/><br/>
@ -78,12 +81,15 @@ To also run our sister project OpenDTU and be upwards compatible for the future
| **Total costs** | **14,89 Euro** | | **Total costs** | **14,89 Euro** |
#### There are fake NRF24L01+ Modules out there #### There are fake NRF24L01+ Modules out there
Watch out, there are some fake NRF24L01+ Modules out there that seem to use rebranded NRF24L01 Chips (without the +).<br/> Watch out, there are some fake NRF24L01+ Modules out there that seem to use rebranded NRF24L01 Chips (without the +).<br/>
An example can be found in [Issue #230](https://github.com/grindylow/ahoy/issues/230).<br/> An example can be found in [Issue #230](https://github.com/grindylow/ahoy/issues/230).<br/>
You are welcome to add more examples of faked chips. We will that information here.<br/> You are welcome to add more examples of faked chips. We will add that information here.<br/>
## Wiring things up ## Wiring things up
The NRF24L01+ radio module is connected to the standard SPI pins: The NRF24L01+ radio module is connected to the standard SPI pins:
- SCLK (Signal Clock), - SCLK (Signal Clock),
- MISO (Master In Slave Out) and - MISO (Master In Slave Out) and
- MOSI (Master Out Slave In) - MOSI (Master Out Slave In)
@ -91,6 +97,7 @@ The NRF24L01+ radio module is connected to the standard SPI pins:
*These pins need to be configured in the config.h.* *These pins need to be configured in the config.h.*
Additional, there are 3 pins, which can be set individual: Additional, there are 3 pins, which can be set individual:
- CS (Chip Select), - CS (Chip Select),
- CE (Chip Enable) and - CE (Chip Enable) and
- IRQ (Interrupt) - IRQ (Interrupt)
@ -98,23 +105,31 @@ Additional, there are 3 pins, which can be set individual:
*These pins can be changed from the /setup URL.* *These pins can be changed from the /setup URL.*
#### ESP8266 wiring example #### ESP8266 wiring example
This is an example wiring using a Wemos D1 mini.<br> This is an example wiring using a Wemos D1 mini.<br>
##### Schematic ##### Schematic
![Schematic](../../doc/AhoyWemos_Schaltplan.jpg) ![Schematic](../../doc/AhoyWemos_Schaltplan.jpg)
##### Symbolic view ##### Symbolic view
![Symbolic](../../doc/AhoyWemos_Steckplatine.jpg) ![Symbolic](../../doc/AhoyWemos_Steckplatine.jpg)
#### ESP32 wiring example #### ESP32 wiring example
Example wiring for a 38pin ESP32 module Example wiring for a 38pin ESP32 module
##### Schematic ##### Schematic
![Schematic](../../doc/Wiring_ESP32_Schematic.png) ![Schematic](../../doc/Wiring_ESP32_Schematic.png)
##### Symbolic view ##### Symbolic view
![Symbolic](../../doc/Wiring_ESP32_Symbol.png) ![Symbolic](../../doc/Wiring_ESP32_Symbol.png)
##### ESP32 GPIO settings ##### ESP32 GPIO settings
For this wiring, set the 3 individual GPIOs under the /setup URL: For this wiring, set the 3 individual GPIOs under the /setup URL:
``` ```
@ -124,11 +139,12 @@ IRQ D0 (GPIO16 - no IRQ!)
``` ```
## Flash the Firmware on your Ahoy DTU Hardware ## Flash the Firmware on your Ahoy DTU Hardware
Once your Hardware is ready to run, you need to flash the Ahoy DTU Firmware to your Board.
You can either build your own using your own configuration or use one or our pre-compiled generic builds.
Once your Hardware is ready to run, you need to flash the Ahoy DTU Firmware to your Board.
You can either build your own using your own configuration or use one of our pre-compiled generic builds.
#### Compiling your own Version #### Compiling your own Version
This information suits you if you want to configure and build your own firmware. This information suits you if you want to configure and build your own firmware.
This code comes to you as a **PlatformIO** project and can be compiled using the **PlatformIO** Addon.<br/> This code comes to you as a **PlatformIO** project and can be compiled using the **PlatformIO** Addon.<br/>
@ -139,13 +155,13 @@ If you do not want to compile your own build, you can use one of our ready-to-fl
- number of supported inverters (set to 3 by default) `config.h` - number of supported inverters (set to 3 by default) `config.h`
- DTU radio id `config.h` (default = 1234567801) - DTU radio id `config.h` (default = 1234567801)
- unformated list in webbrowser `/livedata` `config.h`, `LIVEDATA_VISUALIZED` - unformatted list in webbrowser `/livedata` `config.h`, `LIVEDATA_VISUALIZED`
Alternativly, instead of modifying `config.h`, `config_override_example.h` can be copied to `config_override.h` and customized. Alternativly, instead of modifying `config.h`, `config_override_example.h` can be copied to `config_override.h` and customized.
config_override.h is excluded from version control and stays local. config_override.h is excluded from version control and stays local.
#### Using a ready-to-flash binary using nodemcu-pyflasher #### Using a ready-to-flash binary using nodemcu-pyflasher
This information suits you if you just want to use an easy way. This information suits you if you just want to use an easy way.
1. download the flash-tool [nodemcu-pyflasher](https://github.com/marcelstoer/nodemcu-pyflasher) 1. download the flash-tool [nodemcu-pyflasher](https://github.com/marcelstoer/nodemcu-pyflasher)
@ -156,58 +172,53 @@ This information suits you if you just want to use an easy way.
6. flash the ESP with the compiled firmware using the UART pins or 6. flash the ESP with the compiled firmware using the UART pins or
7. repower the ESP 7. repower the ESP
8. the ESP will start as access point (AP) if there is no network config stored in its eeprom 8. the ESP will start as access point (AP) if there is no network config stored in its eeprom
9. connect to the AP, you will be forwarded to the setup page 9. connect to the AP (password: `esp_8266`), you will be forwarded to the setup page
10. configure your WiFi settings, save, repower 10. configure your WiFi settings, save, repower
11. check your router or serial console for the IP address of the module. You can try ping the configured device name as well. 11. check your router or serial console for the IP address of the module. You can try ping the configured device name as well.
Once your Ahoy DTU is running, you can use the Over The Air (OTA) capabilities to update your firmware. Once your Ahoy DTU is running, you can use the Over The Air (OTA) capabilities to update your firmware.
! ATTENTION: If you update from a very low version to the newest, please make sure to wipe all flash data! ! ATTENTION: If you update from a very low version to the newest, please make sure to wipe all flash data!
## Connect to your Ahoy DTU ## Connect to your Ahoy DTU
When everything is wired up and the firmware is flashed, it is time to connect to your Ahoy DTU. When everything is wired up and the firmware is flashed, it is time to connect to your Ahoy DTU.
#### Your Ahoy DTU is very verbose using the Serial Console #### Your Ahoy DTU is very verbose using the Serial Console
When connected to your computer, you can open a Serial Console to obtain additional information.<br/> When connected to your computer, you can open a Serial Console to obtain additional information.<br/>
This might be useful in case of any troubles that might occur as well as to simply<br/> This might be useful in case of any troubles that might occur as well as to simply<br/>
obtain information about the converted values which were read out of the inverter(s). obtain information about the converted values which were read out of the inverter(s).
#### Connect to the Ahoy DTU Webinterface using your Browser #### Connect to the Ahoy DTU Webinterface using your Browser
After you have sucessfully flashed and powered your Ahoy DTU, you can access it via your Browser.<br/> After you have sucessfully flashed and powered your Ahoy DTU, you can access it via your Browser.<br/>
If your Ahoy DTU was able to log into the configured WiFi Network, it will try to obtain an IP-Address<br/> If your Ahoy DTU was able to log into the configured WiFi Network, it will try to obtain an IP-Address<br/>
from your local DHCP Server (in most cases thats your Router).<br/><br/> from your local DHCP Server (in most cases thats your Router).<br/><br/>
In case it could not connect to your configured Network, it will provide its own WiFi Network that you can<br/> In case it could not connect to your configured Network, it will provide its own WiFi Network that you can<br/>
connect to for furter configuration.<br/> connect to for furter configuration.<br/>
The WiFi SSID *(the WiFi Name)* and Passwort is configured in the config.h and defaults to the SSID "AHOY-DTU" with the Passwort "esp_8266".<br/> The WiFi SSID *(the WiFi Name)* and Passwort is configured in the config.h and defaults to the SSID "`AHOY-DTU`" with the Passwort "`esp_8266`".<br/>
The Ahoy DTU will keep that Network open for a certain amount of time (also configurable in the config.h and defaults to 60secs).<br/> The Ahoy DTU will keep that Network open for a certain amount of time (also configurable in the config.h and defaults to 60secs).<br/>
If nothing connects to it and that time runs up, it will retry to connect to the configured network an so on.<br/> If nothing connects to it and that time runs up, it will retry to connect to the configured network an so on.<br/>
<br/> <br/>
If connected to your local Network, you just have to find out the used IP Address. In most cases your Router will give you a hint.<br/> If connected to your local Network, you just have to find out the used IP Address or try the default name [http://ahoy-dtu/](http://ahoy-dtu/). In most cases your Router will give you a hint.<br/>
If you connect to the WiFi the Ahoy DTU opens in case it could not connect to any other Network, the IP-Address of your Ahoy DTU is 192.168.1.1.<br/> If you connect to the WiFi the Ahoy DTU opens in case it could not connect to any other Network, the IP-Address of your Ahoy DTU is [http://192.168.1.1/](http://192.168.1.1/).<br/>
Just open the IP-Address in your browser.<br/> Just open the IP-Address in your browser.<br/>
<br/> <br/>
The webinterface has the following abilities: The webinterface has the following abilities:
- OTA Update (Over The Air Update) - OTA Update (Over The Air Update)
- Configuration (Wifi, inverter(s), NTP Server, Pinout, MQTT, Amplifier Power Level, Debug) - Configuration (Wifi, inverter(s), NTP Server, Pinout, MQTT, Amplifier Power Level, Debug)
- visual display of the connected inverters / modules - visual display of the connected inverters / modules
- some statistics about communication (debug) - some statistics about communication (debug)
##### HTTP based Pages ##### HTTP based Pages
To take control of your Ahoy DTU, you can directly call one of the following sub-pages (e.g. http://192.168.1.1/setup ).<br/>
To take control of your Ahoy DTU, you can directly call one of the following sub-pages (e.g. [http://ahoy-dtu/setup](http://ahoy-dtu/setup) or [http://192.168.1.1/setup](http://192.168.1.1/setup) ).<br/>
| page | use | output | | page | use | output |
| ---- | ------ | ------ | | ---- | ------ | ------ |
| /uptime | displays the uptime uf your Ahoy DTU | 0 Days, 01:37:34; now: 2022-08-21 11:13:53 | | /uptime | displays the uptime of your Ahoy DTU | 0 Days, 01:37:34; now: 2022-08-21 11:13:53 |
| /reboot | reboots the Ahoy DTU | | | /reboot | reboots the Ahoy DTU | |
| /erase | erases the EEPROM | | | /erase | erases the EEPROM | |
| /factory | resets to the factory defaults configured in config.h | | | /factory | resets to the factory defaults configured in config.h | |
@ -219,13 +230,10 @@ When everything is wired up and the firmware is flashed, it is time to connect t
| /json | gets live-data in JSON format | json output from the livedata | | /json | gets live-data in JSON format | json output from the livedata |
| /api | | | | /api | | |
## MQTT command to set the DTU without webinterface ## MQTT command to set the DTU without webinterface
[Read here](https://github.com/grindylow/ahoy/blob/main/tools/esp8266/User_Manual.md) [Read here](https://github.com/grindylow/ahoy/blob/main/tools/esp8266/User_Manual.md)
## Used Libraries ## Used Libraries
| Name | version | License | | Name | version | License |
@ -242,13 +250,11 @@ When everything is wired up and the firmware is flashed, it is time to connect t
| `PubSubClient` | 2.8 | MIT | | `PubSubClient` | 2.8 | MIT |
| `ArduinoJson` | 6.19.4 | MIT | | `ArduinoJson` | 6.19.4 | MIT |
## Contact ## Contact
We run a Discord Server that can be used to get in touch with the Developers and Users. We run a Discord Server that can be used to get in touch with the Developers and Users.
https://discord.gg/WzhxEY62mB <https://discord.gg/WzhxEY62mB>
## ToDo ## ToDo