diff --git a/.gitignore b/.gitignore index 1f1befdc..3f5c950f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /public /.hugo_build.lock +/resources diff --git a/README.md b/README.md new file mode 100644 index 00000000..59904b2f --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Information + +This repository contains the sources for [AhoyDTU](http://ahoydtu.de). The sources are converted by a *static site generator* [Hugo](https://gohugo.io/). +The main Repository URL is: [](https://github.com/lumapu/ahoy) + + +# Contribute + +Feel free to modify / add contents of the website which helps other users to understand better how to start or use AhoyDTU. + +## Quick Howto + +* edit files inside the directory `content` most of them are Markdown files (\*.md). +* once you're finish commit your changes (as Pull-Request) +* wait until a collaborator merges your changes + +## Design / CSS + +* this site uses [Bootstrap 5](https://getbootstrap.com/docs/5.2/getting-started/introduction/) + +## Offline convertion of sources to website + +### Docker + +* you can use a local docker container which runs Hugo to convert the sources to a static site: + `docker run --rm -it -v ${pwd}\:/src -p 80:1313 klakegg/hugo:0.101.0-ext-alpine shell` +* from the shell start hugo server by typing `hugo server` +* point your browser to http://localhost + +### Hokus + +Hokus is a WYSIWYG Hugo Editor [](https://www.hokuscms.com/) diff --git a/content/flash/index.md b/content/flash/index.md new file mode 100644 index 00000000..3960ff3f --- /dev/null +++ b/content/flash/index.md @@ -0,0 +1,11 @@ +--- +title: "Install Firmware" +date: 2022-10-26T22:49:15Z +tags: [] +draft: false +type: flash +layout: flash +--- + + +You can easily upload the latest firmware to your ESP. diff --git a/content/getting_started/index.md b/content/getting_started/index.md index c6c12ac7..4e36ad82 100644 --- a/content/getting_started/index.md +++ b/content/getting_started/index.md @@ -27,6 +27,13 @@ The hardware insists only in two modules: ## Software / Firmware +### Guided Installation +Switch to our [Online Installer](/flash) + +### manual Installation The firmware can be found on [Github](https://github.com/lumapu/ahoy). Point to the releases section on the right part of the page and download the zip-file. It contains binaries for both ESP models. +### Compile firmware from sources +n/a + ### Flash diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 4a5d4120..15ef0d29 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -3,10 +3,9 @@ {{ partial "head.html" . }} {{ partial "nav.html" . }} -
-
- {{ block "main" . }}{{ end }} -
+
+ {{ block "main" . }} + {{ end }}
{{ partial "footer.html" . }} diff --git a/layouts/_default/list.html b/layouts/_default/list.html index e024b4e1..71403f95 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -1,26 +1,28 @@ {{ define "main" }} -

{{ .Title }}

- {{ range $grp := $.Site.Data.faq.groups }} -
-

{{.name}}

-
- {{ $counter := 0 }} - {{ range .items }} -
- {{ $counter = add $counter 1 }} -

- -

-
-
- {{.answer}} +
+

{{ .Title }}

+ {{ range $grp := $.Site.Data.faq.groups }} +
+

{{.name}}

+
+ {{ $counter := 0 }} + {{ range .items }} +
+ {{ $counter = add $counter 1 }} +

+ +

+
+
+ {{.answer}} +
+ {{ end }}
- {{ end }}
{{ end }} {{ end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 3fca1777..e4878560 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -1,6 +1,8 @@ {{ define "main" }} -

{{ .Title }}

-{{ .Content }} +
+

{{ .Title }}

+ {{ .Content }} +
{{ end }} diff --git a/layouts/flash/flash.html b/layouts/flash/flash.html new file mode 100644 index 00000000..31a43824 --- /dev/null +++ b/layouts/flash/flash.html @@ -0,0 +1,68 @@ + + + {{ partial "head.html" . }} + + + {{ partial "nav.html" . }} +
+
+

{{ .Title }}

+

{{ .Content }}

+
+

1 Install firmware

+ + + + + + + + +
+

2 Connect to ESP

+
+
+
    +
  • a Your ESP opens an WiFi access point (AP) with SSID AHOY-DTU
    • +
  • b Connect to this WiFi with some client (Laptop, Smartphone)
    • +
  • c The default password is esp_8266
    • +
  • d Navigate to the Settings page
    • +
  • e Open the section WiFi and press Scan
    • +
  • f Select your home network and type your password
    • +
  • g Scroll down, check Reboot device after successful save and press save
    • +
+
+
+
+

3 Find device in home LAN / Wifi

+
+
+
+ option a +
+
+ Check a serial console during boot of ESP. It will print the IP which it got from DHCP server. +
+
+
+
+ option b +
+
+ Check devices listed in your WiFi router (eg. Fritz!Box). You should be able to find an IP-address like 192.168.x.x +
+
+
+
+

4 Settings

+ Point to Settings again and configure the device on your needs. + +
+
+ {{ partial "footer.html" . }} + + diff --git a/layouts/index.html b/layouts/index.html index f80513a0..ef175ebe 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,8 +1,58 @@ {{ define "main" }} -
-

{{ .Site.Title }}

-

{{ .Site.Params.homeText | markdownify }}

+
+ ahoyDTU logo +

{{ .Site.Title }}

+
+

{{ .Site.Params.homeText | markdownify }}

+
+
+ +
+ +
+
+
+

Visualization

+

Read all the values of your Hoymiles® inverter without cloud.
+ Dig deeper into your inverter. All the AC parameters (green area) are read from your inverter. You'll get an extra information field (blue) for each DC input. You're able to monitor your individual panels for shadows or damage.

+
+
+ +
+
+
+ +
+ +
+
+
+ +
+
+

Hardware

+

The hardware consists only of two components: ESP8266 and NRF2401L+ module.
+ As a total hardware cost of 10 - 15€ (depends on distributor) it will be the cheapest part of your photovoltaic system. + The components can be easily soldered together and flashed using our online flash tool

+
+
+
+ +
+ +
+
+
+

Connectivity

+

The Firmware supports MQTT and has an API. All measured values will be published with an individual topic.
+ With MQTT you can use AhoyDTU nearly in all home automatisation systems.
+ The API is based on JSON objects.

+
+
+ +
+
{{ end }} diff --git a/layouts/partials/nav.html b/layouts/partials/nav.html index 8615e535..4dad1a8a 100644 --- a/layouts/partials/nav.html +++ b/layouts/partials/nav.html @@ -7,7 +7,7 @@
    {{ range .Site.Menus.main }} -
  • +
  • {{ .Name }}
    • {{ end }} diff --git a/static/css/style.css b/static/css/style.css index 059c7dd6..f7601b61 100644 --- a/static/css/style.css +++ b/static/css/style.css @@ -17,3 +17,11 @@ h2, h3, h4 { margin-top: 15px; color: #0d6efd; } + +.b-example-divider { + height: 3rem; + background-color: rgba(0, 0, 0, .1); + border: solid rgba(0, 0, 0, .15); + border-width: 1px 0; + box-shadow: inset 0 .5em 1.5em rgba(0, 0, 0, .1), inset 0 .125em .5em rgba(0, 0, 0, .15); +} diff --git a/static/firmware/221030_ahoy_0.5.28_esp32_2e08ee0.bin b/static/firmware/221030_ahoy_0.5.28_esp32_2e08ee0.bin new file mode 100644 index 00000000..f130a3c3 Binary files /dev/null and b/static/firmware/221030_ahoy_0.5.28_esp32_2e08ee0.bin differ diff --git a/static/firmware/221030_ahoy_0.5.28_esp8266_2e08ee0.bin b/static/firmware/221030_ahoy_0.5.28_esp8266_2e08ee0.bin new file mode 100644 index 00000000..02789f97 Binary files /dev/null and b/static/firmware/221030_ahoy_0.5.28_esp8266_2e08ee0.bin differ diff --git a/static/firmware/bootloader.bin b/static/firmware/bootloader.bin new file mode 100644 index 00000000..d8421d3c Binary files /dev/null and b/static/firmware/bootloader.bin differ diff --git a/static/firmware/manifest.json b/static/firmware/manifest.json new file mode 100644 index 00000000..ee570433 --- /dev/null +++ b/static/firmware/manifest.json @@ -0,0 +1,23 @@ +{ + "name": "AhoyDTU", + "version": "0.5.28", + "funding_url": "https://ko-fi.com/lumapu", + "new_install_prompt_erase": true, + "builds": [ + { + "chipFamily": "ESP32", + "parts": [ + { "path": "/firmware/bootloader.bin", "offset": 4096 }, + { "path": "/firmware/partitions.bin", "offset": 32768 }, + { "path": "/firmware/ota.bin", "offset": 57344 }, + { "path": "/firmware/221030_ahoy_0.5.28_esp32_2e08ee0.bin", "offset": 65536 } + ] + }, + { + "chipFamily": "ESP8266", + "parts": [ + { "path": "/firmware/221030_ahoy_0.5.28_esp8266_2e08ee0.bin", "offset": 0 } + ] + } + ] +} diff --git a/static/firmware/ota.bin b/static/firmware/ota.bin new file mode 100644 index 00000000..13562cab Binary files /dev/null and b/static/firmware/ota.bin differ diff --git a/static/firmware/partitions.bin b/static/firmware/partitions.bin new file mode 100644 index 00000000..0e52b4c4 Binary files /dev/null and b/static/firmware/partitions.bin differ diff --git a/static/img/comp/connect.png b/static/img/comp/connect.png new file mode 100644 index 00000000..86d192ef Binary files /dev/null and b/static/img/comp/connect.png differ diff --git a/static/img/comp/wemosNrf24.png b/static/img/comp/wemosNrf24.png new file mode 100644 index 00000000..1280a0d1 Binary files /dev/null and b/static/img/comp/wemosNrf24.png differ diff --git a/static/img/comp/wemosNrf24.svg b/static/img/comp/wemosNrf24.svg new file mode 100644 index 00000000..53844544 --- /dev/null +++ b/static/img/comp/wemosNrf24.svg @@ -0,0 +1,439 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + D1 + mini + + + + + + + + + + + + + + + + + + + + + + + + + + + + NRF24L01+ + + + diff --git a/static/img/logo1_small.png b/static/img/logo1_small.png new file mode 100644 index 00000000..3b3edbd1 Binary files /dev/null and b/static/img/logo1_small.png differ diff --git a/static/img/screenshot/live.png b/static/img/screenshot/live.png new file mode 100644 index 00000000..47a95ee8 Binary files /dev/null and b/static/img/screenshot/live.png differ