Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.greeneye_monitor Namespace Reference

Namespaces

 const
 
 sensor
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CHANNEL_SCHEMA
 
 CHANNELS_SCHEMA = vol.All(cv.ensure_list, [CHANNEL_SCHEMA])
 
 COMPONENT_SCHEMA
 
 CONFIG_SCHEMA = vol.Schema({DOMAIN: COMPONENT_SCHEMA}, extra=vol.ALLOW_EXTRA)
 
 MONITOR_SCHEMA
 
 MONITORS_SCHEMA = vol.All(cv.ensure_list, [MONITOR_SCHEMA])
 
 PULSE_COUNTER_SCHEMA
 
 PULSE_COUNTERS_SCHEMA = vol.All(cv.ensure_list, [PULSE_COUNTER_SCHEMA])
 
 TEMPERATURE_SENSOR_SCHEMA
 
 TEMPERATURE_SENSORS_SCHEMA
 
 VOLTAGE_SENSOR_SCHEMA
 
 VOLTAGE_SENSORS_SCHEMA = vol.All(cv.ensure_list, [VOLTAGE_SENSOR_SCHEMA])
 

Detailed Description

Support for monitoring a GreenEye Monitor energy monitor.

Function Documentation

◆ async_setup()

bool homeassistant.components.greeneye_monitor.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the GreenEye Monitor component.

Definition at line 119 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.greeneye_monitor._LOGGER = logging.getLogger(__name__)
private

Definition at line 41 of file __init__.py.

◆ CHANNEL_SCHEMA

homeassistant.components.greeneye_monitor.CHANNEL_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_NUMBER): vol.Range(1, 48),
4  vol.Required(CONF_NAME): cv.string,
5  vol.Optional(CONF_NET_METERING, default=False): cv.boolean,
6  }
7 )

Definition at line 76 of file __init__.py.

◆ CHANNELS_SCHEMA

homeassistant.components.greeneye_monitor.CHANNELS_SCHEMA = vol.All(cv.ensure_list, [CHANNEL_SCHEMA])

Definition at line 84 of file __init__.py.

◆ COMPONENT_SCHEMA

homeassistant.components.greeneye_monitor.COMPONENT_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(CONF_PORT): cv.port, vol.Required(CONF_MONITORS): MONITORS_SCHEMA}
3 )

Definition at line 112 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.greeneye_monitor.CONFIG_SCHEMA = vol.Schema({DOMAIN: COMPONENT_SCHEMA}, extra=vol.ALLOW_EXTRA)

Definition at line 116 of file __init__.py.

◆ MONITOR_SCHEMA

homeassistant.components.greeneye_monitor.MONITOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_SERIAL_NUMBER): vol.All(
4  cv.string,
5  vol.Length(
6  min=8,
7  max=8,
8  msg=(
9  "GEM serial number must be specified as an 8-character "
10  "string (including leading zeroes)."
11  ),
12  ),
13  vol.Coerce(int),
14  ),
15  vol.Optional(CONF_CHANNELS, default=[]): CHANNELS_SCHEMA,
16  vol.Optional(
17  CONF_TEMPERATURE_SENSORS,
18  default={CONF_TEMPERATURE_UNIT: TEMPERATURE_UNIT_CELSIUS, CONF_SENSORS: []},
19  ): TEMPERATURE_SENSORS_SCHEMA,
20  vol.Optional(CONF_PULSE_COUNTERS, default=[]): PULSE_COUNTERS_SCHEMA,
21  vol.Optional(CONF_VOLTAGE_SENSORS, default=[]): VOLTAGE_SENSORS_SCHEMA,
22  }
23 )

Definition at line 86 of file __init__.py.

◆ MONITORS_SCHEMA

homeassistant.components.greeneye_monitor.MONITORS_SCHEMA = vol.All(cv.ensure_list, [MONITOR_SCHEMA])

Definition at line 110 of file __init__.py.

◆ PULSE_COUNTER_SCHEMA

homeassistant.components.greeneye_monitor.PULSE_COUNTER_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_NUMBER): vol.Range(1, 4),
4  vol.Required(CONF_NAME): cv.string,
5  vol.Required(CONF_COUNTED_QUANTITY): cv.string,
6  vol.Optional(CONF_COUNTED_QUANTITY_PER_PULSE, default=1.0): vol.Coerce(float),
7  vol.Optional(CONF_TIME_UNIT, default=UnitOfTime.SECONDS): vol.Any(
8  UnitOfTime.SECONDS.value, UnitOfTime.MINUTES.value, UnitOfTime.HOURS.value
9  ),
10  }
11 )

Definition at line 62 of file __init__.py.

◆ PULSE_COUNTERS_SCHEMA

homeassistant.components.greeneye_monitor.PULSE_COUNTERS_SCHEMA = vol.All(cv.ensure_list, [PULSE_COUNTER_SCHEMA])

Definition at line 74 of file __init__.py.

◆ TEMPERATURE_SENSOR_SCHEMA

homeassistant.components.greeneye_monitor.TEMPERATURE_SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(CONF_NUMBER): vol.Range(1, 8), vol.Required(CONF_NAME): cv.string}
3 )

Definition at line 43 of file __init__.py.

◆ TEMPERATURE_SENSORS_SCHEMA

homeassistant.components.greeneye_monitor.TEMPERATURE_SENSORS_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_TEMPERATURE_UNIT): cv.temperature_unit,
4  vol.Required(CONF_SENSORS): vol.All(
5  cv.ensure_list, [TEMPERATURE_SENSOR_SCHEMA]
6  ),
7  }
8 )

Definition at line 47 of file __init__.py.

◆ VOLTAGE_SENSOR_SCHEMA

homeassistant.components.greeneye_monitor.VOLTAGE_SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(CONF_NUMBER): vol.Range(1, 48), vol.Required(CONF_NAME): cv.string}
3 )

Definition at line 56 of file __init__.py.

◆ VOLTAGE_SENSORS_SCHEMA

homeassistant.components.greeneye_monitor.VOLTAGE_SENSORS_SCHEMA = vol.All(cv.ensure_list, [VOLTAGE_SENSOR_SCHEMA])

Definition at line 60 of file __init__.py.