Entities Reference

Entities Reference

Each inverter serial number creates a separate device in Home Assistant. All entity IDs follow the pattern:

{domain}.{device_name_slug}_{entity_name_slug}

Because HA generates the slug from the device alias (set by the inverter or the Sunsynk app), the exact prefix will vary. To find your prefix: go to Settings → Devices & Services → Sunsynk → your device → any entity and note the entity ID.

In the tables below, {prefix} represents your inverter's entity ID prefix (e.g. sunsynk or my_house_5kw).

---

Sensors (read-only)

PV / Solar

Entity ID	Friendly Name	Unit	Notes
sensor.{prefix}_pv_total_power	PV Total Power	W	Sum of all MPPT strings
sensor.{prefix}_pv_generation_today	PV Generation Today	kWh	Resets at midnight
sensor.{prefix}_pv_generation_total	PV Generation Total	kWh	Lifetime total
sensor.{prefix}_pv_grid_tip_power	PV Grid Tip Power	W
sensor.{prefix}_pv_mppt_1_power	PV MPPT 1 Power	W	Dynamic — only created if inverter reports MPPT data
sensor.{prefix}_pv_mppt_1_voltage	PV MPPT 1 Voltage	V	Dynamic
sensor.{prefix}_pv_mppt_1_current	PV MPPT 1 Current	A	Dynamic
sensor.{prefix}_pv_mppt_2_power	PV MPPT 2 Power	W	Dynamic — only if second string exists
sensor.{prefix}_pv_mppt_2_voltage	PV MPPT 2 Voltage	V	Dynamic
sensor.{prefix}_pv_mppt_2_current	PV MPPT 2 Current	A	Dynamic

Dynamic sensors are discovered on the first successful data fetch and registered automatically. If they are missing after first setup, reload the integration.

Battery

Entity ID	Friendly Name	Unit	Notes
sensor.{prefix}_battery_soc	Battery SOC	%	State of charge
sensor.{prefix}_battery_bms_soc	Battery BMS SOC	%	SOC reported by BMS
sensor.{prefix}_battery_power	Battery Power	W	Positive = charging, negative = discharging
sensor.{prefix}_battery_voltage	Battery Voltage	V
sensor.{prefix}_battery_current	Battery Current	A
sensor.{prefix}_battery_temperature	Battery Temperature	°C
sensor.{prefix}_battery_bms_voltage	Battery BMS Voltage	V
sensor.{prefix}_battery_bms_current	Battery BMS Current	A
sensor.{prefix}_battery_bms_temperature	Battery BMS Temperature	°C
sensor.{prefix}_battery_charge_today	Battery Charge Today	kWh
sensor.{prefix}_battery_discharge_today	Battery Discharge Today	kWh
sensor.{prefix}_battery_charge_this_month	Battery Charge This Month	kWh
sensor.{prefix}_battery_discharge_this_month	Battery Discharge This Month	kWh
sensor.{prefix}_battery_charge_this_year	Battery Charge This Year	kWh
sensor.{prefix}_battery_discharge_this_year	Battery Discharge This Year	kWh
sensor.{prefix}_battery_charge_total	Battery Charge Total	kWh	Lifetime
sensor.{prefix}_battery_discharge_total	Battery Discharge Total	kWh	Lifetime
sensor.{prefix}_battery_capacity	Battery Capacity	Ah
sensor.{prefix}_battery_charge_voltage	Battery Charge Voltage	V
sensor.{prefix}_battery_discharge_voltage	Battery Discharge Voltage	V
sensor.{prefix}_battery_charge_current_limit	Battery Charge Current Limit	A
sensor.{prefix}_battery_discharge_current_limit	Battery Discharge Current Limit	A
sensor.{prefix}_battery_max_charge_current_limit	Battery Max Charge Current Limit	A
sensor.{prefix}_battery_max_discharge_current_limit	Battery Max Discharge Current Limit	A
sensor.{prefix}_battery_slot_1_soc	Battery 1 SOC	%	Dynamic — only if second battery pack is connected
sensor.{prefix}_battery_slot_1_voltage	Battery 1 Voltage	V	Dynamic
sensor.{prefix}_battery_slot_1_current	Battery 1 Current	A	Dynamic
sensor.{prefix}_battery_slot_1_power	Battery 1 Power	W	Dynamic
sensor.{prefix}_battery_slot_1_temperature	Battery 1 Temperature	°C	Dynamic
sensor.{prefix}_battery_slot_2_*	Battery 2 …	various	Dynamic — only if third battery pack present

Grid

Entity ID	Friendly Name	Unit	Notes
sensor.{prefix}_grid_power	Grid Power	W	Positive = import, negative = export
sensor.{prefix}_grid_reactive_power	Grid Reactive Power	W
sensor.{prefix}_grid_frequency	Grid Frequency	Hz
sensor.{prefix}_grid_power_factor	Grid Power Factor	—
sensor.{prefix}_grid_import_today	Grid Import Today	kWh
sensor.{prefix}_grid_export_today	Grid Export Today	kWh
sensor.{prefix}_grid_import_total	Grid Import Total	kWh	Lifetime
sensor.{prefix}_grid_export_total	Grid Export Total	kWh	Lifetime
sensor.{prefix}_grid_limiter_total_power	Grid Limiter Total Power	W
sensor.{prefix}_grid_phase_1_voltage	Grid Phase 1 Voltage	V	Dynamic — 3-phase inverters only
sensor.{prefix}_grid_phase_1_current	Grid Phase 1 Current	A	Dynamic
sensor.{prefix}_grid_phase_1_power	Grid Phase 1 Power	W	Dynamic
sensor.{prefix}_grid_phase_2_*	Grid Phase 2 …	various	Dynamic
sensor.{prefix}_grid_phase_3_*	Grid Phase 3 …	various	Dynamic

Load / Consumption

Entity ID	Friendly Name	Unit	Notes
sensor.{prefix}_load_total_power	Load Total Power	W
sensor.{prefix}_load_energy_used_today	Load Energy Used Today	kWh
sensor.{prefix}_load_total_energy_used	Load Total Energy Used	kWh	Lifetime
sensor.{prefix}_load_frequency	Load Frequency	Hz
sensor.{prefix}_load_ups_power_l1	Load UPS Power L1	W
sensor.{prefix}_load_ups_power_l2	Load UPS Power L2	W
sensor.{prefix}_load_ups_power_l3	Load UPS Power L3	W
sensor.{prefix}_load_ups_total_power	Load UPS Total Power	W
sensor.{prefix}_load_phase_1_voltage	Load Phase 1 Voltage	V	Dynamic — 3-phase inverters only
sensor.{prefix}_load_phase_1_current	Load Phase 1 Current	A	Dynamic
sensor.{prefix}_load_phase_1_power	Load Phase 1 Power	W	Dynamic

Inverter Output

Entity ID	Friendly Name	Unit	Notes
sensor.{prefix}_inverter_input_power	Inverter Input Power	W	DC input
sensor.{prefix}_inverter_output_power	Inverter Output Power	W	AC output
sensor.{prefix}_inverter_output_frequency	Inverter Output Frequency	Hz
sensor.{prefix}_inverter_dc_temperature	Inverter DC Temperature	°C
sensor.{prefix}_inverter_ac_igbt_temperature	Inverter AC (IGBT) Temperature	°C
sensor.{prefix}_inverter_phase_1_voltage	Inverter Phase 1 Voltage	V	Dynamic — 3-phase only
sensor.{prefix}_inverter_phase_1_current	Inverter Phase 1 Current	A	Dynamic
sensor.{prefix}_inverter_phase_1_power	Inverter Phase 1 Power	W	Dynamic

Inverter Info (Diagnostic)

These entities are in the Diagnostic category and hidden by default in the entity list. They are visible on the device page.

Entity ID	Friendly Name	Notes
sensor.{prefix}_ac_power	AC Power
sensor.{prefix}_rated_power	Rated Power
sensor.{prefix}_status	Status
sensor.{prefix}_run_status	Run Status
sensor.{prefix}_serial_number	Serial Number
sensor.{prefix}_alias	Alias	Name set in Sunsynk app
sensor.{prefix}_brand	Brand
sensor.{prefix}_model	Model
sensor.{prefix}_last_cloud_update	Last Cloud Update	Timestamp of last inverter upload to cloud
sensor.{prefix}_firmware_master_version	Firmware Master Version
sensor.{prefix}_firmware_soft_version	Firmware Soft Version
sensor.{prefix}_firmware_hard_version	Firmware Hard Version
sensor.{prefix}_firmware_hmi_version	Firmware HMI Version
sensor.{prefix}_firmware_bms_version	Firmware BMS Version
sensor.{prefix}_firmware_comm_version	Firmware Comm Version
sensor.{prefix}_plant_name	Plant Name
sensor.{prefix}_generation_today	Generation Today	kWh — inverter's own counter
sensor.{prefix}_generation_this_month	Generation This Month	kWh
sensor.{prefix}_generation_this_year	Generation This Year	kWh
sensor.{prefix}_generation_total	Generation Total	kWh
sensor.{prefix}_number_of_batteries	Number of Batteries

Solar Forecast (optional)

See Solar Forecast for full details.

Entity ID	Friendly Name	Unit
sensor.solar_forecast_today	Solar Forecast Today	kWh
sensor.solar_forecast_tomorrow	Solar Forecast Tomorrow	kWh
sensor.solar_forecast_cloud_cover	Solar Forecast Cloud Cover	%
sensor.solar_forecast_precipitation	Solar Forecast Precipitation	mm
sensor.solar_forecast_ghi	Solar Forecast GHI	W/m²
sensor.solar_forecast_dni	Solar Forecast DNI	W/m²

---

Numbers (writable settings)

Number entities allow you to change inverter settings directly from HA. They appear on the device page under Controls.

Changes are written to the inverter via the Sunsynk API. After writing, the integration requests a data refresh to confirm the new value.

Power / Grid

Entity ID	Friendly Name	Unit	Range
number.{prefix}_setting_zero_export_power	Zero Export Power	W	0–inverter max
number.{prefix}_setting_solar_max_sell_power	Solar Max Sell Power	W	0–inverter max
number.{prefix}_setting_pv_max_limit	PV Max Limit	%	0–100
number.{prefix}_setting_sell_time_1_power … _6_power	Sell Time 1–6 Power	W	Per time slot

Battery

Entity ID	Friendly Name	Unit	Notes
number.{prefix}_setting_battery_shutdown_cap	Battery Shutdown Capacity	%	SOC at which inverter stops discharging
number.{prefix}_setting_battery_restart_cap	Battery Restart Capacity	%	SOC at which inverter resumes after shutdown
number.{prefix}_setting_battery_low_cap	Battery Low Capacity	%	Low battery warning threshold
number.{prefix}_setting_battery_max_current_charge	Battery Max Charge Current	A	Hard maximum
number.{prefix}_setting_battery_max_current_discharge	Battery Max Discharge Current	A	Hard maximum
number.{prefix}_setting_charge_current	Charge Current	A	Active setpoint
number.{prefix}_setting_discharge_current	Discharge Current	A	Active setpoint

System Mode

Entity ID	Friendly Name	Notes
number.{prefix}_setting_sys_work_mode	System Work Mode	0=Selling first, 1=Zero export, 2=Limit export, 3=Self use, 4=Time of use
number.{prefix}_setting_batt_mode	Battery Mode	0=Lithium, 1=Lead-acid, 2=User
number.{prefix}_setting_energy_mode	Energy Mode	0=Battery priority, 1=Load priority

Time Slots (1–6)

Each of the 6 time slots has:

Entity ID	Friendly Name	Unit
number.{prefix}_setting_cap{N}	Time Slot N Capacity	%
number.{prefix}_setting_sell_time{N}_pac	Sell Time N Power	W

Generator

Entity ID	Friendly Name	Unit
number.{prefix}_setting_generator_start_cap	Generator Start Capacity	%
number.{prefix}_setting_gen_on_cap	Generator On Capacity	%
number.{prefix}_setting_gen_off_cap	Generator Off Capacity	%

---

Switches (on/off settings)

System

Entity ID	Friendly Name
switch.{prefix}_setting_solar_sell	Solar Sell
switch.{prefix}_setting_battery_on	Battery On
switch.{prefix}_setting_grid_always_on	Grid Always On
switch.{prefix}_setting_allow_remote_control	Allow Remote Control
switch.{prefix}_setting_peak_and_valley	Peak and Valley

Time Slots (1–6)

Entity ID	Friendly Name
switch.{prefix}_setting_time{N}on	Time Slot N On

Active Days

Entity ID	Friendly Name
switch.{prefix}_setting_monday_on	Monday Active
switch.{prefix}_setting_tuesday_on	Tuesday Active
switch.{prefix}_setting_wednesday_on	Wednesday Active
switch.{prefix}_setting_thursday_on	Thursday Active
switch.{prefix}_setting_friday_on	Friday Active
switch.{prefix}_setting_saturday_on	Saturday Active
switch.{prefix}_setting_sunday_on	Sunday Active

Generator

Entity ID	Friendly Name
switch.{prefix}_setting_gen_charge_on	Generator Charge On
switch.{prefix}_setting_sd_charge_on	SD Charge On
switch.{prefix}_setting_gen_time{N}on	Generator Time Slot N On

---

Text entities

Time slot start times are writable text entities (format: HH:MM).

Entity ID	Friendly Name
text.{prefix}_setting_sell_time{N}	Sell Time N Start

---

State classes and long-term statistics

Entities with state_class: total_increasing (energy counters) are automatically included in HA's Long-Term Statistics and visible in the Energy Dashboard. You can use them in:

• Settings → Energy — configure your solar and grid entities for the energy dashboard
• History — view historical data for any entity
• Statistics cards in Lovelace — bar charts of daily/monthly totals