Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieucarbou committed Jul 5, 2024
1 parent b0bcdf3 commit 2f86285
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ _YaSolR_ is built with this vision in mind:
- [Monitoring and Management](#monitoring-and-management)
- [MQTT, REST API and Home Automation Systems](#mqtt-rest-api-and-home-automation-systems)
- [Networking / Offline](#networking--offline)
- [PID Control and Tuning](#pid-control-and-tuning)
- [Remote Capabilities](#remote-capabilities)
- [Virtual Excess and EV Charger Compatibility](#virtual-excess-and-ev-charger-compatibility)
- [OSS vs PRO](#oss-vs-pro)
Expand Down Expand Up @@ -189,6 +190,13 @@ The router can be completely controlled remotely through a Home Automation Syste
- `NTP` support to synchronize time and date with Internet. If not activated, it is still possible to manually sync with your browser.
- `Offline Mode`: **The router can work without WiFi, even teh features requiring time and date.**

### PID Control and Tuning

The router uses a PID controller to control the dimmers and you have full control over the PID parameters to tune it.
Demo:

[![PID Tuning in YaSolR (Yet Another Solar Router)](http://img.youtube.com/vi/ygSpUxKYlUE/0.jpg)](http://www.youtube.com/watch?v=ygSpUxKYlUE "PID Tuning in YaSolR (Yet Another Solar Router)")

### Remote Capabilities

You can split the router in several modules to facilitate the installation.
Expand Down
8 changes: 4 additions & 4 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,10 +444,10 @@ 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.

You can change the PID settings at runtime and the effect will appear immediately.
**If you find better settings, please do not hesitate to share them with the community.**

`Real-time PID Data` can be activated to see the PID action in real time in teh graphs.

**If you find better settings, please do not hesitate to share them with the community.**
**Do not leave this option always activated because the data flow is so high that it impacts the ESP32 performance.**

You are supposed to know how to tune a PID controller.
If not, please research on Google.
Expand All @@ -472,11 +472,11 @@ Here are some basic links to start with, which talks about the code used under t

**PID Tuning through WebSocket**

When `Real-time PID Data` is activated, a WebSocket endpoint is available at `/ws/debug/pid` and will stream all the PID data in real time in a `CSV` format when automatic dimmer control is activated.
When `Real-time PID Data` is activated, a WebSocket endpoint is available at `/ws/pid/csv` and will stream all the PID data in real time in a `CSV` format when automatic dimmer control is activated.
You can quickly show then and process then in `bash` with `websocat` by typing for example:

```bash
❯ websocat ws://192.168.125.123/ws/debug/pid
❯ websocat ws://192.168.125.123/ws/pid/csv
pMode,dMode,icMode,rev,setpoint,kp,ki,kd,outMin,outMax,input,output,error,sum,pTerm,iTerm,dTerm
2,1,2,0,800,0.300,0.400,0.200,-10000,10000,780.645,1109.700,19.355,1104.889,7.217,7.742,4.811
2,1,2,0,800,0.300,0.400,0.200,-10000,10000,778.620,1114.453,21.380,1114.048,0.607,8.552,0.405
Expand Down

0 comments on commit 2f86285

Please sign in to comment.