Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling and grammar fixes. #24

Merged
merged 2 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ The above command will create a Virtual Environment in the subdirectory venv in
Activate the Virtual Environment:
- For Linux Based OS Or Mac-OS: source venv/bin/activate
- For Windows With CMD: venv\Scripts\activate.bat
- For Windows With Power shell: .\venv\Scripts\activate.ps1
- For Windows With PowerShell: .\venv\Scripts\activate.ps1
- For Windows With Unix Like Shells For Example Git Bash CLI: source venv/Scripts/activate

Download the OpenDTU-OnBattery-docs ZIP file and expamd it inside the venv directory.
Download the OpenDTU-OnBattery-docs ZIP file and expand it inside the venv directory.
Using the command editor (cmd.exe), switch to that directory and give the command:
```sh
pip3 install -r requirements.txt
Expand Down
2 changes: 1 addition & 1 deletion docs/3rd_party/prometheus_database.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Using Prometheus for data collection

The prometheus database is used for many projects for data collection. It is relatively easy to setup and use.
The prometheus database is used for many projects for data collection. It is relatively easy to set up and use.

For installation, you can follow a [guide provided by the prometheus devs](https://prometheus.io/docs/introduction/first_steps/).

Expand Down
2 changes: 1 addition & 1 deletion docs/firmware/battery_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following data providers (battery interfaces) are supported:

The MQTT battery provider is the most generic interface. Use it if your battery already
publishes state of charge and/or voltage information to the MQTT broker. This option does
not require to separately connect OpenDTU-OnBattery to your battery (managemen
not require to separately connect OpenDTU-OnBattery to your battery (management
system), i.e., no setup of hardware is required to use this interface.

Refer to the [MQTT battery settings
Expand Down
6 changes: 3 additions & 3 deletions docs/firmware/compile_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Step by Step

1. Install [PlatformIO Core](https://platformio.org/install/cli){target=_blank} (PIO).
1. Install the prerequisits to be able to [build the
WebApp](compile_webapp.md#install-prerequisits).
1. Install the prerequisites to be able to [build the
WebApp](compile_webapp.md#install-prerequisites).
1. Clone the [source code repository](https://github.com/hoylabs/OpenDTU-OnBattery).
You really have to clone the source code repository. Do not download and
extract a source ZIP file. During the build process the Git hash is embedded
Expand All @@ -20,4 +20,4 @@
## Other Popular PlatformIO Tasks

* Clean the sources: `platformio run -e generic_esp32s3 -t clean`
* Erase flash: `platformio run -e generic_esp32s3 -t erase`
* Erase flash: `platformio run -e generic_esp32s3 -t erase`
4 changes: 2 additions & 2 deletions docs/firmware/compile_vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Step by Step

1. [Download](https://git-scm.com/downloads/){target=_blank} and install Git.
1. Install the prerequisits to be able to [build the
WebApp](compile_webapp.md#install-prerequisits).
1. Install the prerequisites to be able to [build the
WebApp](compile_webapp.md#install-prerequisites).
1. Install [Visual Studio Code](https://code.visualstudio.com/download){target=_blank} (vscode).
1. In vscode, install the [PlatformIO
Extension](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide){target=_blank}.
Expand Down
8 changes: 4 additions & 4 deletions docs/firmware/compile_webapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## General information

The WebApp works completly independent from the C/C++ firmware. When compiling
The WebApp works completely independent of the C/C++ firmware. When compiling
the firmware, the pre-compiled WebApp will be embedded into the firmware `.bin`
file. The WebApp is served to the browser by the embedded web server and then
runs on the client side. The communication between the frontend and the ESP32
Expand All @@ -22,10 +22,10 @@ automatically to your ESP32 (configurable IP address). That means you can
develop the webinterface without flashing the ESP32 (if the WebAPI stays the
same).

## Install prerequisits
## Install prerequisites

* Determine the version of Node.js to be used: See the value for `node-version`
in the [Github workflow][3], which is the canonical version to use.
in the [GitHub workflow][3], which is the canonical version to use.
* Install Node.js to be able to work with the WebApp.
* The `yarn` package manager is required to install Node.js packages and to
execute commands related to the WebApp. To make `yarn` available, you should
Expand All @@ -52,7 +52,7 @@ same).
## Building the WebApp

The WebApp is build using `yarn`. First of all you have to install or update
all the dependencies. Afterwards the app will be build. Start a Terminal of
all the dependencies. Afterwards the app will be built. Start a Terminal of
your choice and enter the following commands:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/firmware/configuration/device_reboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

#### Reboot :material-button-cursor:{title="Button"}

Press this button to restart the ESP. A additional confirmation is required before the action is performed.
Press this button to restart the ESP. An additional confirmation is required before the action is performed.
4 changes: 2 additions & 2 deletions docs/firmware/configuration/device_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The table shows all available pin configurations and how they are assigned curre

### Display

This settings apply to a properbly connected display. See [Device Profiles](../device_profiles.md) for display types and pin assignment.
These settings apply to a properly connected display. See [Device Profiles](../device_profiles.md) for display types and pin assignment.

#### Switch off if no solar :material-toggle-switch:{title="Switch"}

Expand Down Expand Up @@ -54,7 +54,7 @@ The contrast setting is only supported by some displays and the impact is also d

### LEDs

This settings apply to properbly connected LEDs[^1]. See [Device Profiles](../device_profiles.md) for LED function and pin assignment.
These settings apply to properly connected LEDs[^1]. See [Device Profiles](../device_profiles.md) for LED function and pin assignment.

#### Equal brightness :material-toggle-switch:{title="Switch"}

Expand Down
4 changes: 2 additions & 2 deletions docs/firmware/configuration/dpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Doing so will prevent battery discharging during the day, but will also prevent
discharging during the night if the start threshold was not reached.

!!!note "Efficiency"
With Solar-Passthrough disabled, it is more efficient to chose a low
With Solar-Passthrough disabled, it is more efficient to choose a low
start threshold and to disable this option, such that produced energy is
used immediately rather than stored in the battery first.

Expand Down Expand Up @@ -287,7 +287,7 @@ In order to not stop the inverter too early (stop threshold) while the battery
is being discharged, this load correction factor can be specified to calculate
(estimate) the battery voltage if it became idle. In other words: This value
should be chosen such that the battery settles back to around the stop
threshold voltage in the moment the DPL decides to stop discharging the battery
threshold voltage at the moment the DPL decides to stop discharging the battery
because it hit the stop threshold.

`corrected (idle) voltage = measured battery voltage + (power * correction factor)`
Expand Down
2 changes: 1 addition & 1 deletion docs/firmware/configuration/dtu_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The possible settings depend on the RF module ([NRF24L01+](../../hardware/nrf24l

#### Serial :material-form-textbox:{title="Textbox"}

The serial of the DTU which is used to communicate with the inverters. It's like the inverter serial number but belongs to the DTU. A random number is generated on the first start of OpenDTU-OnBattery and persisted in the configuration. It is important that all the DTU's in RF[^1] range have different serial numbers.
The serial of the DTU which is used to communicate with the inverters. It's like the inverter serial number but belongs to the DTU. A random number is generated on the first start of OpenDTU-OnBattery and persisted in the configuration. It is important that all the DTUs in RF[^1] range have different serial numbers.

#### Poll Interval: :material-form-textbox:{title="Textbox"}

Expand Down
2 changes: 1 addition & 1 deletion docs/firmware/configuration/firmware_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
#### File selection :material-file-upload:{title="File"}

Choose the firmware file which you want to flash. See [this](../flash_esp.md) overview for a list of pre-compiled files.
After the upload and flash process is complete the device will automatically restart. For further information please refere to the [Update Instructions](../update.md).
After the upload and flash process is complete the device will automatically restart. For further information please refer to the [Update Instructions](../update.md).
6 changes: 3 additions & 3 deletions docs/firmware/configuration/inverter_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#### Serial :material-form-textbox:{title="Textbox"}

The unique serial number of the inverter. It can be found on a lable at the backside of the inverter.
The unique serial number of the inverter. It can be found on a label at the backside of the inverter.

#### Name :material-form-textbox:{title="Textbox"}

Expand All @@ -34,7 +34,7 @@ A custom name that identifies the inverter. You can choose whatever you want.
| Status | Indicates whether Poll and Send are enabled. Yellow means only during the day, black also at night.<ul><li>:material-arrow-down: Poll</li><li>:material-arrow-up: Send</li></ul> |
| Serial | Serial number |
| Name | Custom name |
| Type | The detected inverter type based on the serial number. If you get `Unknown` in this column you either misstyped the number or your inverter is not yet supported. |
| Type | The detected inverter type based on the serial number. If you get `Unknown` in this column you either mistyped the number or your inverter is not yet supported. |

#### Save order :material-button-cursor:{title="Button"}

Expand Down Expand Up @@ -64,7 +64,7 @@ When enabled, the inverter gets also polled at night times.

##### Send commands :material-toggle-switch:{title="Switch"}

When enabled, control commands (e.g. restart/poweroff/limit) will be send to the inverter. Otherwise the commands get dropped.
When enabled, control commands (e.g. restart/poweroff/limit) will be sent to the inverter. Otherwise the commands get dropped.

##### Send commands at night :material-toggle-switch:{title="Switch"}

Expand Down
16 changes: 8 additions & 8 deletions docs/firmware/configuration/mqtt_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Enables or disables the [Home Assistant MQTT Auto Discovery](https://www.home-as

### MQTT Broker Parameter

This settings are only visible if [MQTT](#enable-mqtt) is enabled.
These settings are only visible if [MQTT](#enable-mqtt) is enabled.

#### Hostname :material-form-textbox:{title="Textbox"}

Host name or IP address of your MQTT broker. Make sure your DNS servers are set-up properly if you specify a host name.
Host name or IP address of your MQTT broker. Make sure your DNS servers are set up properly if you specify a host name.

#### Port :material-form-textbox:{title="Textbox"}

Expand Down Expand Up @@ -53,19 +53,19 @@ Enables the CleanSession[^3] flag for MQTT communication.

#### Enable Retain flag :material-toggle-switch:{title="Switch"}

Publish all information with retain[^2] flag. This has the advantage that each value is immediatly avilable if you connect to your broker and subscribe to the specific topics you will get immediatly the latest values.
Publish all information with retain[^2] flag. This has the advantage that each value is immediately available if you connect to your broker and subscribe to the specific topics you will get immediately the latest values.

#### Enable TLS :material-toggle-switch:{title="Switch"}

Enables a secure TLS connection to your MQTT broker. If using this you have to get a proper certificate (self signed will not work, is has to be signed by a CA) and the hostname entered as MQTT Hostname must match the CN in the certificate. You must also specify the CA-Root-Certificate.
Enables a secure TLS connection to your MQTT broker. If using this you have to get a proper certificate (self signed will not work, it has to be signed by a CA) and the hostname entered as MQTT Hostname must match the CN in the certificate. You must also specify the CA-Root-Certificate.

#### CA-Root-Certificate :material-form-textbox:{title="Textbox"}

The root certificate of your CA if you are using a TLS connection to your broker. Should include the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` tags.

#### Enable TLS Certificate Login :material-toggle-switch:{title="Switch"}

Uses certificates to authenticate agains a MQTT broker. When enabled, the **TLS Client-Certificate** and the **TLS Client-Key** has to be supplied.
Uses certificates to authenticate against a MQTT broker. When enabled, the **TLS Client-Certificate** and the **TLS Client-Key** has to be supplied.

#### TLS Client-Certificate :material-form-textbox:{title="Textbox"}

Expand All @@ -77,7 +77,7 @@ Should include the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`

### LWT Parameters

This settings are only visible if [MQTT](#enable-mqtt) is enabled.
These settings are only visible if [MQTT](#enable-mqtt) is enabled.

#### LWT Topic :material-form-textbox:{title="Textbox"}

Expand All @@ -97,7 +97,7 @@ Sets the QoS of the LWT topic.

### Home Assistant MQTT Auto Discovery Parameters

This settings are only visible if [Enable Home Assistant MQTT Auto Discovery](#enable-home-assistant-mqtt-auto-discovery) is enabled.
These settings are only visible if [Enable Home Assistant MQTT Auto Discovery](#enable-home-assistant-mqtt-auto-discovery) is enabled.

Home Assistant provides the [MQTT integration](https://www.home-assistant.io/integrations/mqtt/){target=_blank} and through this integration it is possible to exploit and manage the messages published by OpenDTU-OnBattery.
Once this integration on home assistant is configured with the same MQTT broker, it is possible to create devices manually or through the autodiscovery function.
Expand All @@ -108,7 +108,7 @@ The base under which all Home Assistant MQTT Auto Discovery magic happens. If yo

#### Enable Retain Flag :material-toggle-switch:{title="Switch"}

Publish all auto discovery information with retain[^2] flag. This has the advantage that Home Assistant automaticaly finds all devices on restart.
Publish all auto discovery information with retain[^2] flag. This has the advantage that Home Assistant automatically finds all devices on restart.

#### Enable Expiration :material-toggle-switch:{title="Switch"}

Expand Down
6 changes: 3 additions & 3 deletions docs/firmware/configuration/network_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Settings / Parameters

### WiFi Information (Station)
### Wi-Fi Information (Station)

#### Status

Expand All @@ -18,9 +18,9 @@

#### RSSI

### Wifi Information (Access Point)
### Wi-Fi Information (Access Point)

This section contain information about the internal access point which will be opened at device startup or if no connection to the configured WiFi or ethernet can be established.
This section contain information about the internal access point which will be opened at device startup or if no connection to the configured Wi-Fi or ethernet can be established.

#### Status

Expand Down
24 changes: 12 additions & 12 deletions docs/firmware/configuration/network_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,43 +7,43 @@
## Settings / Parameters

!!! note "Note"
Some of this settings apply to the WiFi interface and the ethernet interface (if available on your board and configured). If ethernet is connected, the WiFi connection will be disabled and it's settings will be transfered to the ethernet interface (also the other way around). The ethernet interface has higher priority.
Some of these settings apply to the Wi-Fi interface and the ethernet interface (if available on your board and configured). If ethernet is connected, the Wi-Fi connection will be disabled and its settings will be transferred to the ethernet interface (also the other way around). The ethernet interface has higher priority.

### WiFi Configuration

#### WiFi SSID :material-form-textbox:{title="Textbox"}
#### Wi-Fi SSID :material-form-textbox:{title="Textbox"}

The SSID[^1] / name of your WiFi network.
The SSID[^1] / name of your Wi-Fi network.

#### WiFi Password :material-form-textbox:{title="Textbox"}
#### Wi-Fi Password :material-form-textbox:{title="Textbox"}

Optional password for the access point, if required.

#### WiFi Hostname :material-form-textbox:{title="Textbox"}
#### Wi-Fi Hostname :material-form-textbox:{title="Textbox"}

The host name with which OpenDTU-OnBattery logs on to various services (DNS server, MQTT server, mDNS). This name must be unique in the LAN[^2]. The text `%06X` will be replaced internally by the ChipID of the ESP. This helps to keep the hostname unique. The hostname will be also used if the ESP is connected via ethernet.

#### Enable DHCP :material-toggle-switch:{title="Switch"}

If DHCP is enabled the OpenDTU-OnBattery will request it's network information like IP/Netmask/Gateway from e.g. your router. If you disable this function you have to enter these settings manually.
If DHCP is enabled the OpenDTU-OnBattery will request its network information like IP/Netmask/Gateway from e.g. your router. If you disable this function you have to enter these settings manually.

### Static IP Configuration

#### IP Address :material-form-textbox:{title="Textbox"}

IP Address which is assigned to either the WiFi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`
IP Address which is assigned to either the Wi-Fi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`

#### Netmask :material-form-textbox:{title="Textbox"}

The Netmask which is assigned to either the WiFi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. The default value for a Class-C network (which you have most likely should be `255.255.255.0`).
The Netmask which is assigned to either the Wi-Fi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. The default value for a Class-C network (which you have most likely should be `255.255.255.0`).

#### Default Gateway :material-form-textbox:{title="Textbox"}

The default gateway which is assigned to either the WiFi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. For a standard home network this should be the IP of your router (e.g. `192.168.178.1`).
The default gateway which is assigned to either the Wi-Fi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. For a standard home network this should be the IP of your router (e.g. `192.168.178.1`).

#### DNS Server 1 :material-form-textbox:{title="Textbox"}

The DNS server which is assigned to either the WiFi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. For a standard home network this should be the IP of your router (e.g. `192.168.178.1`).
The DNS server which is assigned to either the Wi-Fi interface or the ethernet interface (if applicable). Format: `xxx.xxx.xxx.xxx`. For a standard home network this should be the IP of your router (e.g. `192.168.178.1`).

#### DNS Server 2 :material-form-textbox:{title="Textbox"}

Expand All @@ -55,11 +55,11 @@ Please see [DNS Server 1](#dns-server-1)

Enables or disables the mDNS publication of the IP address and version the OpenDTU-OnBattery. This is useful to address the DTU in the network with its DNS name if no DNS server (e.g. on the router) is available. The generated mDNS name is composed as follows: `<WiFi Hostname>.local`.

### WiFi Configuration (Admin AccessPoint)
### Wi-Fi Configuration (Admin AccessPoint)

#### AccessPoint Timeout :material-form-textbox:{title="Textbox"}

After each device restart, if no valid WiFi configuration is found or if the configured AccessPoint is not found, an internal AccessPoint is opened. In case that the Wifi configuration is valid and the infrastrcuture AP[^3] is reachable, the internal AP is closed after the time configured in this setting.
After each device restart, if no valid Wi-Fi configuration is found or if the configured AccessPoint is not found, an internal AccessPoint is opened. In case that the Wi-Fi configuration is valid and the infrastructure AP[^3] is reachable, the internal AP is closed after the time configured in this setting.

[^1]: [SSID](https://en.wikipedia.org/wiki/Service_set_(802.11_network)#SSID){target=_blank}
[^2]: [Local Area Network](https://en.wikipedia.org/wiki/Local_area_network){target=_blank}
Expand Down
4 changes: 2 additions & 2 deletions docs/firmware/configuration/ntp_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ NTP servers provide the time in UTC[^1] time format. It is necessary to convert

#### Sunrise

Time of todays sunrise. Used to set the day/night mode.
Time of today's sunrise. Used to set the day/night mode.

#### Sunset

Time of todays sunset. Used to set the day/night mode.
Time of today's sunset. Used to set the day/night mode.

#### Mode

Expand Down
Loading