Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieucarbou committed Aug 1, 2024
1 parent b5e1c25 commit aeea5ed
Showing 1 changed file with 36 additions and 20 deletions.
56 changes: 36 additions & 20 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ With [Espressif Flash Tool](https://www.espressif.com/en/support/download/other-
> ##### IMPORTANT
>
> Be careful to not forget the `0`
> {: .block-important }
{: .block-important }

![Espressif Flash Tool](assets/img/screenshots/Espressif_Flash_Tool.png)

Expand All @@ -110,7 +110,7 @@ With [Espressif Flash Tool](https://www.espressif.com/en/support/download/other-
> ##### TIP
>
> Captive Portal and Access Point address: [http://192.168.4.1/](http://192.168.4.1/)
> {: .block-tip }
{: .block-tip }

A captive portal (Access Point) is started for the first time to configure the WiFi network, or when the application starts and cannot join an already configured WiFi network fro 15 seconds.

Expand Down Expand Up @@ -211,7 +211,7 @@ The output sections show the state of the outputs and the possibility to control
> ##### IMPORTANT
>
> A PZEM is required to see the measurements of each outputs.
> {: .block-important }
{: .block-important }

**Dimmer Control:**

Expand Down Expand Up @@ -244,7 +244,7 @@ The following settings are visible if `Bypass Automatic Control` is activated.
> ##### TIP
>
> All these settings are applied immediately and do not require a restart
> {: .block-tip }
{: .block-tip }

### `Relays` section

Expand Down Expand Up @@ -328,7 +328,7 @@ Make sure the computer won't g oto sleep!
> ##### IMPORTANT
>
> MQTT must be restarted to apply the changes.
> {: .block-important }
{: .block-important }

#### MQTT as a Grid Source

Expand All @@ -342,7 +342,7 @@ Make sure the computer won't g oto sleep!
> ##### IMPORTANT
>
> The ESP32 must be restarted to apply the changes.
> {: .block-important }
{: .block-important }

MQTT topics are less accurate because depend on the refresh rate of this topic, and an expiration delay of a few seconds is set in order to stop any routing if no update is received in time.
Also, there is **1 minute expiration delay** after which the values will be considered as invalid.
Expand All @@ -361,7 +361,7 @@ So this is important to make sure that the topic will be refreshed, otherwise fe
> ##### IMPORTANT
>
> The ESP32 must be restarted to apply the changes.
> {: .block-important }
{: .block-important }

#### Home Assistant Discovery

Expand All @@ -377,7 +377,7 @@ YaSolR supports Home Assistant Discovery: if configured, it will **automatically
> ##### IMPORTANT
>
> MQTT must be restarted to apply the changes.
> {: .block-important }
{: .block-important }

The complete reference of the published data in MQTT is available [here](mqtt).
The published data can be explored with [MQTT Explorer](https://mqtt-explorer.com/).
Expand Down Expand Up @@ -429,7 +429,7 @@ It perfectly OK for a ZCD, but you cannot use a pin that can only be read for a
> ##### IMPORTANT
>
> If you change one of these settings, please stop and restart the corresponding Hardware.
> {: .block-important }
{: .block-important }

### `Hardware` section

Expand Down Expand Up @@ -457,7 +457,7 @@ This section allows to further configure some hardware settings and calibrate th
> ##### IMPORTANT
>
> If you change one of these settings in the hardware section, please restart the corresponding hardware or the YaSolR device.
> {: .block-important }
{: .block-important }

#### Grid Frequency

Expand All @@ -468,7 +468,7 @@ This section allows to further configure some hardware settings and calibrate th
> ##### DANGER
>
> For advanced users only.
> {: .block-danger }
{: .block-danger }

- `Output 1 Dimmer Min/Max Remapping`
- `Output 2 Dimmer Min/Max Remapping`
Expand All @@ -487,7 +487,7 @@ For example, if you set the range to `10-80%, then the new 0 will match a duty c
> A good start is to find the triggering voltage of the voltage regulator (usually around 1V) and the maximum voltage (usually around 8V) which matches 100%.
> This is usually written in the specifications of the voltage regulator.
> Then remap the dimmer ranges to match these values like the example above.
> {: .block-tip }
{: .block-tip }

#### Display

Expand Down Expand Up @@ -529,7 +529,7 @@ You must use a SSR for that, because the relay will be switched on and off frequ
> ##### NOTE
>
> Remember that the voltage is not dimmed: these are 2 normal relays
> {: .block-note }
{: .block-note }

> ##### WARNING
>
Expand All @@ -538,7 +538,7 @@ You must use a SSR for that, because the relay will be switched on and off frequ
> If you need to switch other types of load in a more complex way with some hysteresis or other complex conditions, you can use the MQTT, REST API, Home Assistant or Jeedom to query the `Virtual Power` metric and execute an automation based on this value.
> The automation can then control the router relays remotely. The relays need to be set in `Manual Control`.
> Remember that these relays are not power contactors and should not be used to directly control high power loads like an Electric Vehicle charge, a pump, etc.
> {: .block-warning }
{: .block-warning }

> ##### TIP
>
Expand Down Expand Up @@ -652,7 +652,7 @@ You can read more at:
> ##### DANGER
>
> For advanced users only.
> {: .block-danger }
{: .block-danger }

This page allows to tune the PID algorithm used to control the automatic routing.
Use only if you know what you are doing and know how to tweak a PID controller.
Expand All @@ -675,7 +675,7 @@ To reset the other values to their default value, just click on the validate / e
> ##### TIP
>
> If you find better settings, please do not hesitate to share them with the community.
> {: .block-tip }
{: .block-tip }

[![](assets/img/screenshots/pid_tuning.jpeg)](assets/img/screenshots/pid_tuning.jpeg)

Expand Down Expand Up @@ -782,7 +782,7 @@ When using a remote JSY with the router, the following rules apply:
>
> JSY Remote app is automatically detected on the same network: you don't need to configure anything.
> As soon as the Sender app will start sending data, YaSolR will receive it and display it.
> {: .block-tip }
{: .block-tip }

### LEDs

Expand Down Expand Up @@ -831,18 +831,34 @@ So the router will take whatever is not used by the EV box.
The Zero-Cross Detection (ZCD) module is used to detect the zero-crossing of the grid voltage.
It is required, whether you use a Robodyn or SSR or any routing algorithm (phase control or burst mode).

When activating `Zero-Cross Detection` in the hardware page, YaSolR will first start a pulse analyzer to grab some statistics about the pulse characteristics: period and length.
This characteristics are used to fine-tune the TRIAC firing and they can be viewed in the dashboard, in the statistics section:

- `ZCD: Pulse Length` (will depends on your ZCD module)
- `ZCD: Pulse Period` (should be around 10ms for 50Hz and 8ms for 60Hz)

Once the pulse analysis if finished (it should last around 1 second), the ZCD module will be activated and the router will start routing.

Note that if the electricity is not available when YaSolR starts, the pulse analyser will wait until the electricity is back to start the pulse analysis and then activate the ZCD module.

> ##### TIP
>
> The Robodyn includes a ZCD (its ZC pin).
> Do not forget to activate the ZCD module in the `Hardware` section.
> {: .block-tip }
{: .block-tip }

You can also use a dedicated ZCD module like the one suggested on this website (build menu).
> ##### IMPORTANT
>
> Robodyn has a very bad ZCD circuit. I strongly suggest you use a dedicated ZCD module instead.
> Please have a look at these blog articles on YaSolR website for more information:
> - [2024-07-24 - The Importance of a good ZCD circuit](./blog/2024-07-24_the_importance_of_a_good_zcd_circuit)
> - [2024-07-31 - Zero-Cross Pulse Detection](./blog/2024-07-31_zero-cross_pulse_detection)
{: .block-important }

> ##### IMPORTANT
>
> `Virtual Grid Power` requires a PZEM or JSY in place to measure the routed power.
> {: .block-important }
{: .block-important }

## Help and support

Expand Down

0 comments on commit aeea5ed

Please sign in to comment.