Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@mathieucarbou
mathieucarbou committed Aug 1, 2024
1 parent b5e1c25 commit 6474c3e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 23 deletions.
10 changes: 3 additions & 7 deletions docs/buy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,18 @@ description: Buy

OSS and Pro firmware are the same, except that the PRO version relies on commercial (paid) libraries and provides some additional features based on a better dashboard.

**The Pro version is only 25 euros** and gives access to all the perks of the Pro version below:
**The Pro version is only 20 euros** and gives access to all the perks of the Pro version below:

| Feature | OSS (Free) | PRO (Paid) |
| -------------------------------- | :--------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Dashboard | Overview **only** | Full Dashboard as seen in the screenshots |
| Manual Dimmer Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Manual Bypass Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Manual Relay Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Configuration | Debug Config Page | **From Dashboard**<br>Debug Config Page |
| Automatic Resistance Calibration | ❌ | ✅ |
| Energy Reset | ❌ | ✅ |
| GPIO Config and Health | ❌ | ✅ |
| Hardware Config and Health | ❌ | ✅ |
| Output Statistics | ❌ | ✅ |
| PID Tuning View | ❌ | ✅ |
| PZEM Pairing | ❌ | ✅ |
| Help & Support | [Facebook Group](https://www.facebook.com/groups/yasolr) | [Facebook Group](https://www.facebook.com/groups/yasolr) <br> [Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions) <br> [Bug Report](https://github.com/mathieucarbou/YaSolR-OSS/issues) |
| Web Console | [WebSerial Lite](https://github.com/mathieucarbou/WebSerialLite) | [WebSerial Pro](https://www.webserial.pro) |
| Dashboard | [ESP-DASH](https://github.com/ayushsharma82/ESP-DASH) | [ESP-DASH Pro](https://espdash.pro) |
Expand All @@ -35,8 +31,8 @@ The money helps funding the hardware necessary to test and develop the firmware.

1. Get a **[Github](https://github.com/)** account so that I can add your GitHub username to the project repository from where you can download all the firmware files.

2. Make a donation of **25 euros or more** (through [Github](https://github.com/sponsors/mathieucarbou) or [Paypal](https://www.paypal.com/donate/?hosted_button_id=QJYRAPXGEDCNS)).
Any sponsoring of 25 euros or more will give access to the **Pro version and all the upcoming updates for an unlimited time**!
2. Make a donation of **20 euros or more** (through [Github](https://github.com/sponsors/mathieucarbou) or [Paypal](https://www.paypal.com/donate/?hosted_button_id=QJYRAPXGEDCNS)).
Any sponsoring of 20 euros or more will give access to the **Pro version and all the upcoming updates for an unlimited time**!

> ##### IMPORTANT
>
Expand Down
27 changes: 12 additions & 15 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,19 @@ But this website will help you pick and build your router.
YaSolR is one of the **most optimized and powerful** Solar Router firmware available:

- **12-bits resolution** with linear interpolation for a precise TRIAC control
- **Up to 25 measurements / second** with a local JSY
- **Up to 20 measurements / second** with a remote JSY
- **PID Controller** optimized and customizable
- **PID Tuning** web interface
- **RMT Peripheral** used for DS18 readings
- **Harmonics** can be lowered to comply with regulations thanks to several settings
- **Custom dimmer library** optimized for ESP32 (🚧)
- **MCPWM** (Motor Control Pulse Width Modulator) for phase control (🚧)
- **3-Phase** support
- **Precise Zero-Cross Detection with ZC pulse analysis**
- **Custom dimmer library** optimized for ESP32 (🚧)
- **Dimmer range remapping** like Shelly Dimmers
- **Frequency auto-detection** (support any frequency: not only 50/60Hz)
- **Harmonics** can be lowered to comply with regulations thanks to several settings
- **MCPWM** (Motor Control Pulse Width Modulator) for phase control (🚧)
- **PID Controller** optimized and customizable
- **PID Tuning** web interface
- **Precise Power Calibration**
- **Precise Zero-Cross Detection with ZC pulse analysis**
- **RMT Peripheral** used for DS18 readings
- **Up to 20 measurements / second** with a remote JSY
- **Up to 25 measurements / second** with a local JSY

This is a big **Open-Source** project following **best development practices**.
YaSolR is:
Expand All @@ -42,7 +43,7 @@ YaSolR is:
- **easy to use** with one of the **best easy-to-use and responsive Web Interface**, **REST** API and **MQTT** API
- compatible with **Home Assistant** and other home automation systems (Auto Discovery)
- compatible with **EV Charging Box** like OpenEVSE
- compatible with **110/230V 50/60Hz**
- compatible with **110/230V, at any frequency: not only 50/60Hz**
- compatible with **remote** dimmer, relay, temperature, measurement (**ESP-Now** / **UDP**)
- compatible with **many hardware components**:
- ESP32 Dev Kit
Expand Down Expand Up @@ -240,22 +241,18 @@ Thanks to power measurement, the router also provides these features:

OSS and Pro firmware are the same, except that the PRO version relies on commercial (paid) libraries and provides some additional features based on a better dashboard.

**The Pro version is only 25 euros** and gives access to all the perks of the Pro version below:
**The Pro version is only 20 euros** and gives access to all the perks of the Pro version below:

| Feature | OSS (Free) | PRO (Paid) |
| -------------------------------- | :--------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Dashboard | Overview **only** | Full Dashboard as seen in the screenshots |
| Manual Dimmer Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Manual Bypass Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Manual Relay Control | Home Assistant<br>MQTT API<br>REST API | **From Dashboard**<br>Home Assistant<br>MQTT API<br>REST API |
| Configuration | Debug Config Page | **From Dashboard**<br>Debug Config Page |
| Automatic Resistance Calibration | ❌ | ✅ |
| Energy Reset | ❌ | ✅ |
| GPIO Config and Health | ❌ | ✅ |
| Hardware Config and Health | ❌ | ✅ |
| Output Statistics | ❌ | ✅ |
| PID Tuning View | ❌ | ✅ |
| PZEM Pairing | ❌ | ✅ |
| Help & Support | [Facebook Group](https://www.facebook.com/groups/yasolr) | [Facebook Group](https://www.facebook.com/groups/yasolr) <br> [Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions) <br> [Bug Report](https://github.com/mathieucarbou/YaSolR-OSS/issues) |
| Web Console | [WebSerial Lite](https://github.com/mathieucarbou/WebSerialLite) | [WebSerial Pro](https://www.webserial.pro) |
| Dashboard | [ESP-DASH](https://github.com/ayushsharma82/ESP-DASH) | [ESP-DASH Pro](https://espdash.pro) |
Expand Down
23 changes: 22 additions & 1 deletion docs/manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,10 @@ This section allows to further configure some hardware settings and calibrate th

- `Nominal Grid Frequency`: the nominal grid frequency.

`Auto-detect` will automatically detect the grid frequency based on the connected measurement devices, or remote ones, or thanks to the pulse analyzer.
It is recommended to leave the setting to `Auto-detect` unless you have a good reason to force it.
The reason is that the grid utility frequency can change for example from 50Hz to 51Hz after a power failure in case a generator is installed.

#### Dimmer Range Remapping

> ##### DANGER
Expand Down Expand Up @@ -831,13 +835,30 @@ 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 }

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
>
Expand Down

0 comments on commit 6474c3e

Please sign in to comment.