1.3.1 - 2.0.x DSM_STATE Removeal

[cayossarian]

EDIT - DSM State is the sensor the integration will continue to use. Do not rely on DSM Grid State as that is simply an alias for DSM State and could be removed in a future version of the integration. See the final answer for the summary.

DSM State Sensor: What Changed and Why

Summary

The DSM State sensor was removed in v2.0. It has been replaced by sensors that answer the questions users actually care about more accurately.

What the original sensor was

The SPAN panel firmware provides two internal DSM fields via its REST API:

• dsmState (DSM_ON_GRID / DSM_OFF_GRID) -- a reliable, firmware-computed grid connectivity indicator based on internal hardware signals (transfer switch
  state, relay position, CT measurements)
• dsmGridState (DSM_GRID_UP / DSM_GRID_DOWN) -- whether the grid is the dominant power source

The v1 integration exposed both as sensors. The firmware's dsmState was likely accurate -- the problem arose when the integration moved to the eBus MQTT
transport, which does not expose either field. Our attempt to reconstruct DSM State from available MQTT signals produced a lossy derivation that mapped
dominant-power-source to DSM_GRID_UP/DSM_GRID_DOWN. This meant solar owners would see DSM_GRID_DOWN during the day even though their grid connection was
perfectly fine -- the grid just wasn't the primary source of power at that moment.

Rather than ship a misleading reconstruction, we removed it and replaced it with sensors that honestly represent the available data.

What replaced it

Question you want to answer	Sensor to use	Values
Is the grid connected?	DSM Grid State	DSM_ON_GRID / DSM_OFF_GRID
What is providing the most power?	Dominant Power Source	GRID, BATTERY, PV, GENERATOR, NONE
What mode is the panel in?	Current Run Config	PANEL_ON_GRID / PANEL_OFF_GRID / PANEL_BACKUP

DSM Grid State uses multiple signals from the panel to determine whether the grid is actually connected: battery grid-state (authoritative when a BESS is
commissioned), dominant power source, upstream lugs power, and power-flows grid measurement. A solar-dominant panel correctly reports DSM_ON_GRID as long as
any power is flowing to or from the grid. This sensor is our best approximation of the firmware's original dsmState computation using the signals available
via eBus MQTT.

Dominant Power Source exposes the raw value that the old DSM State sensor was collapsing into a binary. Instead of losing information, you now see exactly
what is providing the most power at any moment.

Updating your automations

If you had	Replace with
DSM State == DSM_GRID_UP	Dominant Power Source == GRID
DSM State == DSM_GRID_DOWN	Dominant Power Source is BATTERY, PV, or GENERATOR
"Alert me when the grid goes down"	DSM Grid State == DSM_OFF_GRID
"Is the panel running on backup?"	Current Run Config == PANEL_BACKUP

For solar owners

The old sensor was especially problematic for solar installations. During peak production, the grid is typically still connected but solar is the dominant
source. The old DSM_GRID_DOWN value implied a grid outage when there was none.

With the new sensors:

• Dominant Power Source = PV tells you solar is currently dominant
• DSM Grid State = DSM_ON_GRID confirms the grid is still connected
• Both can be true simultaneously, which is the normal daytime state for a grid-tied solar system

EDIT - DSM State is the sensor the integration will continue to use. Do not rely on DSM Grid State as that is simply an alias for DSM State and could be removed in a future version of the integration.

[nathan-curtis]

You don't have to remove it it's entirely possible to provide both sensors. I have deterministic systems built on this. Fix the issue. Don't drop the info.

[cayossarian]

DSM State Sensor

The DSM State sensor (DSM_ON_GRID / DSM_OFF_GRID) is being restored in v2.1 with the same name and values. The DSM Grid State sensor from v2.0 will be
deprecated in favor of it.

The eBus MQTT schema does not expose the firmware's internal dsmState computation. The integration derives grid connectivity from four independent signals in
priority order:

Priority	Signal	Condition	Result	Rationale
1	Battery grid-state	BESS reports ON_GRID or OFF_GRID	Use directly	Grid-tie inverter has authoritative knowledge
2	Dominant power source	Value is GRID	DSM_ON_GRID	Grid is the primary source, must be connected
3	Upstream lugs power	Non-zero watts	DSM_ON_GRID	Power flowing to/from grid even if not dominant
4	Power-flows grid	Non-zero watts	DSM_ON_GRID	Independent grid exchange calculation, catches measurement timing gaps
5	All grid signals zero	Both lugs and power-flows read zero, grid not dominant	DSM_OFF_GRID	No grid exchange, panel is islanded

For panels without a battery, signals 2-5 provide the determination. For panels with a battery, signal 1 is authoritative.

Sensors

Sensor	Values	Use case
DSM State	DSM_ON_GRID / DSM_OFF_GRID	Grid connectivity
Dominant Power Source	GRID, BATTERY, PV, GENERATOR, NONE	What is providing the most power
Current Run Config	PANEL_ON_GRID / PANEL_OFF_GRID / PANEL_BACKUP	Panel operating mode

[dcj]

See: spanio/SPAN-API-Client-Docs#8
For a discussion of this migration from the perspective of SPAN API itself.