jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-25 14:17:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow resetting an MQTT number (#57161)

Browse Source 
* Allow resetting an MQTT number

* Add abbreviation
This commit is contained in:
Erik Montnemery 2021-10-07 13:54:34 +02:00 committed by GitHub
parent a4d9019ffc
commit 7223c59e79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
homeassistant/components/mqtt/abbreviations.py
View File

@ -134,6 +134,7 @@ ABBREVIATIONS = {
"pl_osc_off": "payload_oscillation_off", "pl_osc_off": "payload_oscillation_off",
"pl_osc_on": "payload_oscillation_on", "pl_osc_on": "payload_oscillation_on",
"pl_paus": "payload_pause", "pl_paus": "payload_pause",
"pl_rst": "payload_reset",
"pl_rst_hum": "payload_reset_humidity", "pl_rst_hum": "payload_reset_humidity",
"pl_rst_mode": "payload_reset_mode", "pl_rst_mode": "payload_reset_mode",
"pl_rst_pct": "payload_reset_percentage", "pl_rst_pct": "payload_reset_percentage",

11
homeassistant/components/mqtt/number.py
View File

@ -35,10 +35,12 @@ _LOGGER = logging.getLogger(__name__)
CONF_MIN = "min" CONF_MIN = "min"
CONF_MAX = "max" CONF_MAX = "max"
CONF_PAYLOAD_RESET = "payload_reset"
CONF_STEP = "step" CONF_STEP = "step"
DEFAULT_NAME = "MQTT Number" DEFAULT_NAME = "MQTT Number"
DEFAULT_OPTIMISTIC = False DEFAULT_OPTIMISTIC = False
DEFAULT_PAYLOAD_RESET = "None"
MQTT_NUMBER_ATTRIBUTES_BLOCKED = frozenset( MQTT_NUMBER_ATTRIBUTES_BLOCKED = frozenset(
{ {
@ -64,6 +66,7 @@ PLATFORM_SCHEMA = vol.All(
vol.Optional(CONF_MIN, default=DEFAULT_MIN_VALUE): vol.Coerce(float), vol.Optional(CONF_MIN, default=DEFAULT_MIN_VALUE): vol.Coerce(float),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean, vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
vol.Optional(CONF_PAYLOAD_RESET, default=DEFAULT_PAYLOAD_RESET): cv.string,
vol.Optional(CONF_STEP, default=DEFAULT_STEP): vol.All( vol.Optional(CONF_STEP, default=DEFAULT_STEP): vol.All(
vol.Coerce(float), vol.Range(min=1e-3) vol.Coerce(float), vol.Range(min=1e-3)
), ),
@ -138,7 +141,9 @@ class MqttNumber(MqttEntity, NumberEntity, RestoreEntity):
if value_template is not None: if value_template is not None:
payload = value_template.async_render_with_possible_json_value(payload) payload = value_template.async_render_with_possible_json_value(payload)
try: try:
if payload.isnumeric(): if payload == self._config[CONF_PAYLOAD_RESET]:
num_value = None
elif payload.isnumeric():
num_value = int(payload) num_value = int(payload)
else: else:
num_value = float(payload) num_value = float(payload)
@ -146,7 +151,9 @@ class MqttNumber(MqttEntity, NumberEntity, RestoreEntity):
_LOGGER.warning("Payload '%s' is not a Number", msg.payload) _LOGGER.warning("Payload '%s' is not a Number", msg.payload)
return return
if num_value < self.min_value or num_value > self.max_value: if num_value is not None and (
num_value < self.min_value or num_value > self.max_value
):
_LOGGER.error( _LOGGER.error(
"Invalid value for %s: %s (range %s - %s)", "Invalid value for %s: %s (range %s - %s)",
self.entity_id, self.entity_id,

15
tests/components/mqtt/test_number.py
View File

@ -66,6 +66,7 @@ async def test_run_number_setup(hass, mqtt_mock):
"state_topic": topic, "state_topic": topic,
"command_topic": topic, "command_topic": topic,
"name": "Test Number", "name": "Test Number",
"payload_reset": "reset!",
} }
}, },
) )
@ -85,6 +86,13 @@ async def test_run_number_setup(hass, mqtt_mock):
state = hass.states.get("number.test_number") state = hass.states.get("number.test_number")
assert state.state == "20.5" assert state.state == "20.5"
async_fire_mqtt_message(hass, topic, "reset!")
await hass.async_block_till_done()
state = hass.states.get("number.test_number")
assert state.state == "unknown"
async def test_value_template(hass, mqtt_mock): async def test_value_template(hass, mqtt_mock):
"""Test that it fetches the given payload with a template.""" """Test that it fetches the given payload with a template."""
@ -118,6 +126,13 @@ async def test_value_template(hass, mqtt_mock):
state = hass.states.get("number.test_number") state = hass.states.get("number.test_number")
assert state.state == "20.5" assert state.state == "20.5"
async_fire_mqtt_message(hass, topic, '{"val":null}')
await hass.async_block_till_done()
state = hass.states.get("number.test_number")
assert state.state == "unknown"
async def test_run_number_service_optimistic(hass, mqtt_mock): async def test_run_number_service_optimistic(hass, mqtt_mock):
"""Test that set_value service works in optimistic mode.""" """Test that set_value service works in optimistic mode."""