diff --git a/docs/buy.md b/docs/buy.md index 664a88b..7c554d4 100644 --- a/docs/buy.md +++ b/docs/buy.md @@ -10,20 +10,24 @@ OSS and Pro firmware are the same, except that the PRO version relies on commerc **The Pro version is only 25 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
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Manual Bypass Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Manual Relay Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Configuration | Debug Config Page | **From Dashboard**
Debug Config Page | -| Health View from Dashboard | ❌ | ✅ | -| Statistics and Charts | ❌ | ✅ | -| PZEM Pairing | ❌ | ✅ | -| Help & Support | [Facebook Group](https://www.facebook.com/groups/yasolr) | [Facebook Group](https://www.facebook.com/groups/yasolr)
[Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions)
[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) | -| OTA Firmware Update | [ElegantOTA](https://github.com/ayushsharma82/ElegantOTA) | [ElegantOTA Pro](https://elegantota.pro) | +| Feature | OSS (Free) | PRO (Paid) | +| -------------------------------- | :--------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| Dashboard | Overview **only** | Full Dashboard as seen in the screenshots | +| Manual Dimmer Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Manual Bypass Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Manual Relay Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Configuration | Debug Config Page | **From Dashboard**
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)
[Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions)
[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) | +| OTA Firmware Update | [ElegantOTA](https://github.com/ayushsharma82/ElegantOTA) | [ElegantOTA Pro](https://elegantota.pro) | The money helps funding the hardware necessary to test and develop the firmware. diff --git a/docs/index.md b/docs/index.md index 8f73b42..a661a70 100644 --- a/docs/index.md +++ b/docs/index.md @@ -235,20 +235,24 @@ OSS and Pro firmware are the same, except that the PRO version relies on commerc **The Pro version is only 25 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
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Manual Bypass Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Manual Relay Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | -| Configuration | Debug Config Page | **From Dashboard**
Debug Config Page | -| Health View from Dashboard | ❌ | ✅ | -| Statistics and Charts | ❌ | ✅ | -| PZEM Pairing | ❌ | ✅ | -| Help & Support | [Facebook Group](https://www.facebook.com/groups/yasolr) | [Facebook Group](https://www.facebook.com/groups/yasolr)
[Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions)
[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) | -| OTA Firmware Update | [ElegantOTA](https://github.com/ayushsharma82/ElegantOTA) | [ElegantOTA Pro](https://elegantota.pro) | +| Feature | OSS (Free) | PRO (Paid) | +| -------------------------------- | :--------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| Dashboard | Overview **only** | Full Dashboard as seen in the screenshots | +| Manual Dimmer Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Manual Bypass Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Manual Relay Control | Home Assistant
MQTT API
REST API | **From Dashboard**
Home Assistant
MQTT API
REST API | +| Configuration | Debug Config Page | **From Dashboard**
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)
[Forum](https://github.com/mathieucarbou/YaSolR-OSS/discussions)
[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) | +| OTA Firmware Update | [ElegantOTA](https://github.com/ayushsharma82/ElegantOTA) | [ElegantOTA Pro](https://elegantota.pro) | The money helps funding the hardware necessary to test and develop the firmware. diff --git a/docs/manual.md b/docs/manual.md index dc60f47..d91e09f 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -216,7 +216,7 @@ Note: PZEM is required to see the measurements of each outputs. **Bypass Control:** -- `Bypass`: Activate or deactivate bypass. +- `Bypass`: Activate or deactivate bypass(force heating) Only available when the bypass is not in automatic mode. Otherwise the bypass state is displayed. - `Bypass Automatic Control`: Activate or deactivate automatic bypass based on hours and/or temperature. @@ -229,7 +229,7 @@ Note: PZEM is required to see the measurements of each outputs. ### `Relays` section -YaSolR supports 2 relays (Electromechanical or SSR, controlled with 3.3V DC) to control external loads, or to be connected to the A1 and A2 terminals of a power contactor. +YaSolR supports 2 additional relays (Electromechanical or SSR, controlled with 3.3V DC) to control external loads, or to be connected to the A1 and A2 terminals of a power contactor. Relays can also be connected to the other resistance of the water tank (tri-phase resistance) as described in the [recommendations to reduce harmonics and flickering](./overview#recommendations-to-reduce-harmonics-and-flickering), in order to improve the routing and reduce harmonics. You must use a SSR for that, because the relay will be switched on and off frequently. @@ -425,6 +425,13 @@ This section allows to enable / disable some features of the router, and get som All these components are activated **live without the need to restart the router**. +**Notes:** + +- `Output 1 Relay` / `Output 2 Relay`: these are the SSR or Electromechanical relays connected to the ESP32 and used whn you activate bypass mode. + Only activate if you have connected some relays to be used for the output bypass. +- `Relay 1` / `Relay 2`: these are the SSR or Electromechanical relays connected to the ESP32 and used to control external loads. + Only activate if you have connected some relays to be used for external loads. + ### `Hardware Config` section This section allows to further configure some hardware settings and calibrate the resistance values of the loads. @@ -446,8 +453,8 @@ This section allows to further configure some hardware settings and calibrate th #### Relays -- `Output 1 Bypass Relay Type`: the relay type for Output 1 Bypass: Normally Open (NO) or Normally Closed (NC). -- `Output 2 Bypass Relay Type`: the relay type for Output 2 Bypass: Normally Open (NO) or Normally Closed (NC). +- `Output 1 Relay Type (Bypass)`: the relay type for Output 1 Bypass: Normally Open (NO) or Normally Closed (NC). +- `Output 2 Relay Type (Bypass)`: the relay type for Output 2 Bypass: Normally Open (NO) or Normally Closed (NC). - `Relay 1 Type`: the relay type for Relay 1: Normally Open (NO) or Normally Closed (NC). - `Relay 2 Type`: the relay type for Relay 2: Normally Open (NO) or Normally Closed (NC). @@ -458,17 +465,44 @@ This section allows to further configure some hardware settings and calibrate th - `Output 1 Resistance`: the resistance value in Ohms of the load connected to Output 1 - `Output 2 Resistance`: the resistance value in Ohms of the load connected to Output 2 -Be careful to put a value that you have correctly measured! +Be careful to put a value that you have correctly measured with a multimeter, or calculated (see formula below). An approximation will cause the router to not properly work because it won't be able to adjust the exact amount of power to send. +Remember the equation: + +``` +R = U * U / P +``` + +where: + +- `P` is the _nominal_ power in Watts given by the manufacturer of the resistance +- `U` is the _nominal_ voltage in Volts, usually 230V in Europe and 120V in the US/Canada +- `R` is the resistance in Ohms + +**Reading the resistance value from a PZEm or JSY** + If you have a PZEM or JSY device attached, they can help you. You can set the dimmer in manual mode and set it to 50% and 100% and read the resistance value. Then you just have to report it in the `Hardware Config` page. -2. **PZEM-004T v3:** If you have wired a PZEM-004T v3 connected to each output, it will measure the resistance value when routing. +- **PZEM-004T v3:** If you have wired a PZEM-004T v3 connected to each output, it will measure the resistance value when routing. +- **JSY-MK-194T:** If you have a JSY-MK-194T, you can activate the dimmers one by one to 100% and wait for the values to stabilize. + The router will then display the resistance value in the `Overview` page, thanks to the JSY. + +**Using the automatic detection feature** (🚧) + +- `Output 1 Resistance Detection`: start the automatic detection of the resistance value of the load connected to Output 1 +- `Output 2 Resistance Detection`: start the automatic detection of the resistance value of the load connected to Output 2 -3. **JSY-MK-194T:** If you have a JSY-MK-194T, you can activate the dimmers one by one to 100% and wait for the values to stabilize. - The router will then display the resistance value in the `Overview` page, thanks to the JSY. +This is the easiest way to calibrate the resistance values: when a PZEM or JSY is installed, the router will be able to automatically calculate the resistance. +For that, click on the corresponding buttons and wait a few seconds. +You can at the same time check the statistics on the `Output` or `Overview` sections. +Once done, the resistance value will be put in the corresponding field. +Any previously set value will be erased. + +To use this feature, make sure that the resistance will really draw some current. +It won't work if the water heater has already reached its threshold temperature. #### PZEM Pairing @@ -594,6 +628,11 @@ The advantage is a simple setup, the drawbacks are: - the dimmer will heat up. - the power output of he dimmer counts as routed power so the routed power and energy will also contain the bypass power. +In the `Hardware` section, `Output 1 Relay (Bypass)` and `Output 2 Relay (Bypass)` both specify if a relay is installed for the output, on top of the dimmer of course, and if it should be used when bypass is activated. +If no relay is installed, the dimmer will be used and will be set to 100%. + +In the `Hardware Config` section, `Output 1 Relay Type (Bypass)` and `Output 2 Relay Type (Bypass)` are used to specify the type of the relay: `Normally Open` or `Normally Closed`. + ### Display Supported displays are any I2C OLED Display of type `SSD1307`, `SH1106`, `SH1107`.