mirror of
https://github.com/esphome/esphome.git
synced 2024-12-02 11:44:13 +01:00
07c1cf7137
Co-authored-by: Paul Daumlechner <paul.daumlechner@live.de> Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Co-authored-by: Otto Winter <otto@otto-winter.com>
114 lines
3.3 KiB
Python
114 lines
3.3 KiB
Python
import esphome.codegen as cg
|
|
import esphome.config_validation as cv
|
|
from esphome import automation, pins
|
|
from esphome.components import sensor
|
|
from esphome.const import (
|
|
CONF_ID,
|
|
CONF_INTERNAL_FILTER,
|
|
CONF_INTERNAL_FILTER_MODE,
|
|
CONF_PIN,
|
|
CONF_NUMBER,
|
|
CONF_TIMEOUT,
|
|
CONF_TOTAL,
|
|
CONF_VALUE,
|
|
ICON_PULSE,
|
|
STATE_CLASS_MEASUREMENT,
|
|
STATE_CLASS_TOTAL_INCREASING,
|
|
UNIT_PULSES,
|
|
UNIT_PULSES_PER_MINUTE,
|
|
)
|
|
from esphome.core import CORE
|
|
|
|
CODEOWNERS = ["@stevebaxter", "@cstaahl"]
|
|
|
|
pulse_meter_ns = cg.esphome_ns.namespace("pulse_meter")
|
|
|
|
|
|
PulseMeterSensor = pulse_meter_ns.class_(
|
|
"PulseMeterSensor", sensor.Sensor, cg.Component
|
|
)
|
|
|
|
PulseMeterInternalFilterMode = PulseMeterSensor.enum("InternalFilterMode")
|
|
FILTER_MODES = {
|
|
"EDGE": PulseMeterInternalFilterMode.FILTER_EDGE,
|
|
"PULSE": PulseMeterInternalFilterMode.FILTER_PULSE,
|
|
}
|
|
|
|
SetTotalPulsesAction = pulse_meter_ns.class_("SetTotalPulsesAction", automation.Action)
|
|
|
|
|
|
def validate_internal_filter(value):
|
|
return cv.positive_time_period_microseconds(value)
|
|
|
|
|
|
def validate_timeout(value):
|
|
value = cv.positive_time_period_microseconds(value)
|
|
if value.total_minutes > 70:
|
|
raise cv.Invalid("Maximum timeout is 70 minutes")
|
|
return value
|
|
|
|
|
|
def validate_pulse_meter_pin(value):
|
|
value = pins.internal_gpio_input_pin_schema(value)
|
|
if CORE.is_esp8266 and value[CONF_NUMBER] >= 16:
|
|
raise cv.Invalid(
|
|
"Pins GPIO16 and GPIO17 cannot be used as pulse counters on ESP8266."
|
|
)
|
|
return value
|
|
|
|
|
|
CONFIG_SCHEMA = sensor.sensor_schema(
|
|
PulseMeterSensor,
|
|
unit_of_measurement=UNIT_PULSES_PER_MINUTE,
|
|
icon=ICON_PULSE,
|
|
accuracy_decimals=2,
|
|
state_class=STATE_CLASS_MEASUREMENT,
|
|
).extend(
|
|
{
|
|
cv.Required(CONF_PIN): validate_pulse_meter_pin,
|
|
cv.Optional(CONF_INTERNAL_FILTER, default="13us"): validate_internal_filter,
|
|
cv.Optional(CONF_TIMEOUT, default="5min"): validate_timeout,
|
|
cv.Optional(CONF_TOTAL): sensor.sensor_schema(
|
|
unit_of_measurement=UNIT_PULSES,
|
|
icon=ICON_PULSE,
|
|
accuracy_decimals=0,
|
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
|
),
|
|
cv.Optional(CONF_INTERNAL_FILTER_MODE, default="EDGE"): cv.enum(
|
|
FILTER_MODES, upper=True
|
|
),
|
|
}
|
|
)
|
|
|
|
|
|
async def to_code(config):
|
|
var = await sensor.new_sensor(config)
|
|
await cg.register_component(var, config)
|
|
|
|
pin = await cg.gpio_pin_expression(config[CONF_PIN])
|
|
cg.add(var.set_pin(pin))
|
|
cg.add(var.set_filter_us(config[CONF_INTERNAL_FILTER]))
|
|
cg.add(var.set_timeout_us(config[CONF_TIMEOUT]))
|
|
cg.add(var.set_filter_mode(config[CONF_INTERNAL_FILTER_MODE]))
|
|
|
|
if CONF_TOTAL in config:
|
|
sens = await sensor.new_sensor(config[CONF_TOTAL])
|
|
cg.add(var.set_total_sensor(sens))
|
|
|
|
|
|
@automation.register_action(
|
|
"pulse_meter.set_total_pulses",
|
|
SetTotalPulsesAction,
|
|
cv.Schema(
|
|
{
|
|
cv.Required(CONF_ID): cv.use_id(PulseMeterSensor),
|
|
cv.Required(CONF_VALUE): cv.templatable(cv.uint32_t),
|
|
}
|
|
),
|
|
)
|
|
async def set_total_action_to_code(config, action_id, template_arg, args):
|
|
paren = await cg.get_variable(config[CONF_ID])
|
|
var = cg.new_Pvariable(action_id, template_arg, paren)
|
|
template_ = await cg.templatable(config[CONF_VALUE], args, int)
|
|
cg.add(var.set_total_pulses(template_))
|
|
return var
|