homeassistant.components.enphase_envoy.sensor Namespace Reference

Classes
class	EnvoyConsumptionCTEntity
class	EnvoyConsumptionCTPhaseEntity
class	EnvoyConsumptionEntity
class	EnvoyConsumptionPhaseEntity
class	EnvoyConsumptionSensorEntityDescription
class	EnvoyCTSensorEntityDescription
class	EnvoyEnchargeAggregateEntity
class	EnvoyEnchargeAggregateRequiredKeysMixin
class	EnvoyEnchargeAggregateSensorEntityDescription
class	EnvoyEnchargeEntity
class	EnvoyEnchargeInventoryEntity
class	EnvoyEnchargePowerEntity
class	EnvoyEnchargePowerRequiredKeysMixin
class	EnvoyEnchargePowerSensorEntityDescription
class	EnvoyEnchargeSensorEntityDescription
class	EnvoyEnpowerEntity
class	EnvoyEnpowerSensorEntityDescription
class	EnvoyInverterEntity
class	EnvoyInverterSensorEntityDescription
class	EnvoyNetConsumptionEntity
class	EnvoyNetConsumptionPhaseEntity
class	EnvoyProductionCTEntity
class	EnvoyProductionCTPhaseEntity
class	EnvoyProductionEntity
class	EnvoyProductionPhaseEntity
class	EnvoyProductionSensorEntityDescription
class	EnvoySensorBaseEntity
class	EnvoyStorageCTEntity
class	EnvoyStorageCTPhaseEntity
class	EnvoySystemSensorEntity

Functions
None	async_setup_entry (HomeAssistant hass, EnphaseConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	CONSUMPTION_PHASE_SENSORS
tuple	CONSUMPTION_SENSORS
dictionary	CT_NET_CONSUMPTION_PHASE_SENSORS
tuple	CT_NET_CONSUMPTION_SENSORS
dictionary	CT_PRODUCTION_PHASE_SENSORS
tuple	CT_PRODUCTION_SENSORS
dictionary	CT_STORAGE_PHASE_SENSORS
tuple	CT_STORAGE_SENSORS
tuple	ENCHARGE_AGGREGATE_SENSORS
tuple	ENCHARGE_INVENTORY_SENSORS
tuple	ENCHARGE_POWER_SENSORS
tuple	ENPOWER_SENSORS
string	ICON = "mdi:flash"
tuple	INVERTER_SENSORS
string	INVERTERS_KEY = "inverters"
string	LAST_REPORTED_KEY = "last_reported"
dictionary	NET_CONSUMPTION_PHASE_SENSORS
tuple	NET_CONSUMPTION_SENSORS
dictionary	PRODUCTION_PHASE_SENSORS
tuple	PRODUCTION_SENSORS

Detailed Description

Support for Enphase Envoy solar energy monitor.

Function Documentation

async_setup_entry()

None homeassistant.components.enphase_envoy.sensor.async_setup_entry	(	HomeAssistant	hass,
		EnphaseConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up envoy sensor platform.

Definition at line 724 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.enphase_envoy.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 57 of file sensor.py.

CONSUMPTION_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.CONSUMPTION_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(CONSUMPTION_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 215 of file sensor.py.

CONSUMPTION_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.CONSUMPTION_SENSORS

Definition at line 168 of file sensor.py.

CT_NET_CONSUMPTION_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.CT_NET_CONSUMPTION_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(CT_NET_CONSUMPTION_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 385 of file sensor.py.

CT_NET_CONSUMPTION_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.CT_NET_CONSUMPTION_SENSORS

Definition at line 286 of file sensor.py.

CT_PRODUCTION_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.CT_PRODUCTION_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(CT_PRODUCTION_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 465 of file sensor.py.

CT_PRODUCTION_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.CT_PRODUCTION_SENSORS

Definition at line 400 of file sensor.py.

CT_STORAGE_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.CT_STORAGE_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(CT_STORAGE_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 579 of file sensor.py.

CT_STORAGE_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.CT_STORAGE_SENSORS

Definition at line 480 of file sensor.py.

ENCHARGE_AGGREGATE_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.ENCHARGE_AGGREGATE_SENSORS

Definition at line 686 of file sensor.py.

ENCHARGE_INVENTORY_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.ENCHARGE_INVENTORY_SENSORS

Initial value:

=  (
    EnvoyEnchargeSensorEntityDescription(
        key="temperature",
        native_unit_of_measurement=UnitOfTemperature.CELSIUS,
        device_class=SensorDeviceClass.TEMPERATURE,
        value_fn=attrgetter("temperature"),
    ),
    EnvoyEnchargeSensorEntityDescription(
        key=LAST_REPORTED_KEY,
        translation_key=LAST_REPORTED_KEY,
        native_unit_of_measurement=None,
        device_class=SensorDeviceClass.TIMESTAMP,
        value_fn=lambda encharge: dt_util.utc_from_timestamp(encharge.last_report_date),
    ),
)

Definition at line 614 of file sensor.py.

ENCHARGE_POWER_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.ENCHARGE_POWER_SENSORS

Initial value:

=  (
    EnvoyEnchargePowerSensorEntityDescription(
        key="soc",
        native_unit_of_measurement=PERCENTAGE,
        device_class=SensorDeviceClass.BATTERY,
        value_fn=attrgetter("soc"),
    ),
    EnvoyEnchargePowerSensorEntityDescription(
        key="apparent_power_mva",
        native_unit_of_measurement=UnitOfApparentPower.VOLT_AMPERE,
        device_class=SensorDeviceClass.APPARENT_POWER,
        value_fn=lambda encharge: encharge.apparent_power_mva * 0.001,
    ),
    EnvoyEnchargePowerSensorEntityDescription(
        key="real_power_mw",
        native_unit_of_measurement=UnitOfPower.WATT,
        device_class=SensorDeviceClass.POWER,
        value_fn=lambda encharge: encharge.real_power_mw * 0.001,
    ),
)

Definition at line 629 of file sensor.py.

ENPOWER_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.ENPOWER_SENSORS

Initial value:

=  (
    EnvoyEnpowerSensorEntityDescription(
        key="temperature",
        native_unit_of_measurement=UnitOfTemperature.FAHRENHEIT,
        device_class=SensorDeviceClass.TEMPERATURE,
        value_fn=attrgetter("temperature"),
    ),
    EnvoyEnpowerSensorEntityDescription(
        key=LAST_REPORTED_KEY,
        translation_key=LAST_REPORTED_KEY,
        device_class=SensorDeviceClass.TIMESTAMP,
        value_fn=lambda enpower: dt_util.utc_from_timestamp(enpower.last_report_date),
    ),
)

Definition at line 658 of file sensor.py.

ICON

string homeassistant.components.enphase_envoy.sensor.ICON = "mdi:flash"

Definition at line 56 of file sensor.py.

INVERTER_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.INVERTER_SENSORS

Initial value:

=  (
    EnvoyInverterSensorEntityDescription(
        key=INVERTERS_KEY,
        name=None,
        native_unit_of_measurement=UnitOfPower.WATT,
        state_class=SensorStateClass.MEASUREMENT,
        device_class=SensorDeviceClass.POWER,
        value_fn=attrgetter("last_report_watts"),
    ),
    EnvoyInverterSensorEntityDescription(
        key=LAST_REPORTED_KEY,
        translation_key=LAST_REPORTED_KEY,
        device_class=SensorDeviceClass.TIMESTAMP,
        entity_registry_enabled_default=False,
        value_fn=lambda inverter: dt_util.utc_from_timestamp(inverter.last_report_date),
    ),
)

Definition at line 70 of file sensor.py.

INVERTERS_KEY

string homeassistant.components.enphase_envoy.sensor.INVERTERS_KEY = "inverters"

Definition at line 59 of file sensor.py.

LAST_REPORTED_KEY

string homeassistant.components.enphase_envoy.sensor.LAST_REPORTED_KEY = "last_reported"

Definition at line 60 of file sensor.py.

NET_CONSUMPTION_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.NET_CONSUMPTION_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(NET_CONSUMPTION_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 259 of file sensor.py.

NET_CONSUMPTION_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.NET_CONSUMPTION_SENSORS

Initial value:

=  (
    EnvoyConsumptionSensorEntityDescription(
        key="balanced_net_consumption",
        translation_key="balanced_net_consumption",
        entity_registry_enabled_default=False,
        native_unit_of_measurement=UnitOfPower.WATT,
        state_class=SensorStateClass.MEASUREMENT,
        device_class=SensorDeviceClass.POWER,
        suggested_unit_of_measurement=UnitOfPower.KILO_WATT,
        suggested_display_precision=3,
        value_fn=attrgetter("watts_now"),
        on_phase=None,
    ),
    EnvoyConsumptionSensorEntityDescription(
        key="lifetime_balanced_net_consumption",
        translation_key="lifetime_balanced_net_consumption",
        entity_registry_enabled_default=False,
        native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
        state_class=SensorStateClass.TOTAL,
        device_class=SensorDeviceClass.ENERGY,
        suggested_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
        suggested_display_precision=3,
        value_fn=attrgetter("watt_hours_lifetime"),
        on_phase=None,
    ),
)

Definition at line 231 of file sensor.py.

PRODUCTION_PHASE_SENSORS

dictionary homeassistant.components.enphase_envoy.sensor.PRODUCTION_PHASE_SENSORS

Initial value:

=  {
    (on_phase := PHASENAMES[phase]): [
        replace(
            sensor,
            key=f"{sensor.key}_l{phase + 1}",
            translation_key=f"{sensor.translation_key}_phase",
            entity_registry_enabled_default=False,
            on_phase=on_phase,
            translation_placeholders={"phase_name": f"l{phase + 1}"},
        )
        for sensor in list(PRODUCTION_SENSORS)
    ]
    for phase in range(3)
}

Definition at line 144 of file sensor.py.

PRODUCTION_SENSORS

tuple homeassistant.components.enphase_envoy.sensor.PRODUCTION_SENSORS

Definition at line 97 of file sensor.py.