Mention the victron protocol label per sensor (#166)

This commit is contained in:
Sebastian Muszynski 2024-06-10 13:30:03 +02:00 committed by GitHub
parent 0da509c043
commit 9d71066bd8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

157
README.md
View File

@ -125,82 +125,90 @@ The `uart_id` and `victron_id` is optional if you use a single UART / victron de
The victron device pushs one status message per second. To reduce the update interval of the ESPHome entities please use the `throttle` parameter to discard some messages.
The available numeric sensors are:
- `max_power_yesterday`
- `max_power_today`
- `yield_total`
- `yield_yesterday`
- `yield_today`
- `panel_voltage`
- `panel_power`
- `battery_voltage`
- `battery_voltage_2`
- `battery_voltage_3`
- `auxiliary_battery_voltage`
- `midpoint_voltage_of_the_battery_bank`
- `midpoint_deviation_of_the_battery_bank`
- `battery_current`
- `battery_current_2`
- `battery_current_3`
- `day_number`
- `charging_mode_id`
- `error_code`
- `warning_code`
- `tracking_mode_id`
- `device_mode_id`
- `load_current`
- `ac_out_voltage`
- `ac_out_current`
- `ac_out_apparent_power`
- `battery_temperature`
- `instantaneous_power`
- `consumed_amp_hours`
- `state_of_charge`
- `time_to_go`
- `depth_of_the_deepest_discharge`
- `depth_of_the_last_discharge`
- `depth_of_the_average_discharge`
- `number_of_charge_cycles`
- `number_of_full_discharges`
- `cumulative_amp_hours_drawn`
- `min_battery_voltage`
- `max_battery_voltage`
- `last_full_charge`
- `number_of_automatic_synchronizations`
- `number_of_low_main_voltage_alarms`
- `number_of_high_main_voltage_alarms`
- `number_of_low_auxiliary_voltage_alarms`
- `number_of_high_auxiliary_voltage_alarms`
- `min_auxiliary_battery_voltage`
- `max_auxiliary_battery_voltage`
- `amount_of_discharged_energy`
- `amount_of_charged_energy`
- `dc_monitor_mode_id`
- `off_reason_bitmask`
## Entities
The available text sensors are:
- `charging_mode`
- `error`
- `warning`
- `tracking_mode`
- `device_mode`
- `firmware_version`
- `firmware_version_24bit`
- `device_type`
- `serial_number`
- `hardware_revision`
- `alarm_condition_active`
- `alarm_reason`
- `model_description`
- `dc_monitor_mode`
- `off_reason`
### Binary sensors
Binary sensors:
| Label | Sensor name |
|-------|---------------|
| LOAD | `load_state` |
| Relay | `relay_state` |
- `load_state`
- `relay_state`
### Sensors
Big thanks for help to ssieb for the support!
| Label | Sensor name |
|----------|-------------------------------------------|
| AC_OUT_V | `ac_out_voltage` |
| AC_OUT_I | `ac_out_current` |
| AC_OUT_S | `ac_out_apparent_power` |
| CE | `consumed_amp_hours` |
| CS | `charging_mode_id` |
| DM | `midpoint_deviation_of_the_battery_bank` |
| ERR | `error_code` |
| HSDS | `day_number` |
| MPPT | `tracking_mode_id` |
| I | `battery_current` |
| I2 | `battery_current_2` |
| I3 | `battery_current_3` |
| IL | `load_current` |
| MODE | `device_mode_id` |
| MON | `dc_monitor_mode_id` |
| OR | `off_reason_bitmask` |
| P | `instantaneous_power` |
| PPV | `panel_power` |
| SOC | `state_of_charge` |
| T | `battery_temperature` |
| TTG | `time_to_go` |
| VPV | `panel_voltage` |
| V | `battery_voltage` |
| V2 | `battery_voltage_2` |
| V3 | `battery_voltage_3` |
| VM | `midpoint_voltage_of_the_battery_bank` |
| VS | `auxiliary_battery_voltage` |
| WARN | `warning_code` |
| H1 | `depth_of_the_deepest_discharge` |
| H2 | `depth_of_the_last_discharge` |
| H3 | `depth_of_the_average_discharge` |
| H4 | `number_of_charge_cycles` |
| H5 | `number_of_full_discharges` |
| H6 | `cumulative_amp_hours_drawn` |
| H7 | `min_battery_voltage` |
| H8 | `max_battery_voltage` |
| H9 | `last_full_charge` |
| H10 | `number_of_automatic_synchronizations` |
| H11 | `number_of_low_main_voltage_alarms` |
| H12 | `number_of_high_main_voltage_alarms` |
| H13 | `number_of_low_auxiliary_voltage_alarms` |
| H14 | `number_of_high_auxiliary_voltage_alarms` |
| H15 | `min_auxiliary_battery_voltage` |
| H16 | `max_auxiliary_battery_voltage` |
| H17 | `amount_of_discharged_energy` |
| H18 | `amount_of_charged_energy` |
| H19 | `yield_total` |
| H20 | `yield_today` |
| H21 | `max_power_today` |
| H22 | `yield_yesterday` |
| H23 | `max_power_yesterday` |
### Text sensors
| Label | Sensor name |
|-------|--------------------------|
| Alarm | `alarm_condition_active` |
| AR | `alarm_reason` |
| BMV | `model_description` |
| CS | `charging_mode` |
| ERR | `error` |
| FW | `firmware_version` |
| FWE | `firmware_version_24bit` |
| HC# | `hardware_revision` |
| MODE | `device_mode` |
| MON | `dc_monitor_mode` |
| MPPT | `tracking_mode` |
| OR | `off_reason` |
| PID | `device_type` |
| WARN | `warning` |
| SER# | `serial_number` |
## Debugging
@ -210,3 +218,8 @@ If this component doesn't work out of the box for your device please flash the `
```
esphome run debug-esp8266-example.yaml
```
## Thanks
Big thanks for help to ssieb for the support!