From 2f8628590e675ebc55ac24893f6cab057c4e4968 Mon Sep 17 00:00:00 2001 From: Mathieu Carbou Date: Fri, 5 Jul 2024 22:25:39 +0200 Subject: [PATCH] update doc --- docs/index.md | 8 ++++++++ docs/manual.md | 8 ++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3d6112d..983d795 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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) @@ -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. diff --git a/docs/manual.md b/docs/manual.md index 45468e2..2370e7c 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -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. @@ -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