Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.amberelectric.coordinator Namespace Reference

Classes

class  AmberUpdateCoordinator
 

Functions

bool is_controlled_load (ActualInterval|CurrentInterval|ForecastInterval interval)
 
bool is_current (ActualInterval|CurrentInterval|ForecastInterval interval)
 
bool is_feed_in (ActualInterval|CurrentInterval|ForecastInterval interval)
 
bool is_forecast (ActualInterval|CurrentInterval|ForecastInterval interval)
 
bool is_general (ActualInterval|CurrentInterval|ForecastInterval interval)
 
str|None normalize_descriptor (PriceDescriptor|None descriptor)
 

Detailed Description

Amber Electric Coordinator.

Function Documentation

◆ is_controlled_load()

bool homeassistant.components.amberelectric.coordinator.is_controlled_load ( ActualInterval | CurrentInterval | ForecastInterval  interval)
Return true if the supplied interval is on the controlled load channel.

Definition at line 37 of file coordinator.py.

◆ is_current()

bool homeassistant.components.amberelectric.coordinator.is_current ( ActualInterval | CurrentInterval | ForecastInterval  interval)
Return true if the supplied interval is a CurrentInterval.

Definition at line 22 of file coordinator.py.

◆ is_feed_in()

bool homeassistant.components.amberelectric.coordinator.is_feed_in ( ActualInterval | CurrentInterval | ForecastInterval  interval)
Return true if the supplied interval is on the feed in channel.

Definition at line 44 of file coordinator.py.

◆ is_forecast()

bool homeassistant.components.amberelectric.coordinator.is_forecast ( ActualInterval | CurrentInterval | ForecastInterval  interval)
Return true if the supplied interval is a ForecastInterval.

Definition at line 27 of file coordinator.py.

◆ is_general()

bool homeassistant.components.amberelectric.coordinator.is_general ( ActualInterval | CurrentInterval | ForecastInterval  interval)
Return true if the supplied interval is on the general channel.

Definition at line 32 of file coordinator.py.

◆ normalize_descriptor()

str | None homeassistant.components.amberelectric.coordinator.normalize_descriptor ( PriceDescriptor | None  descriptor)
Return the snake case versions of descriptor names. Returns None if the name is not recognized.

Definition at line 49 of file coordinator.py.