Allow MQTT Switch to have an optional state configuration (#15430)
Switches by default use the payload_on and payload_off configuration parameters to specify both the payload the switch should send for a state but also what will be returned for the current state - which isnt always the same As a toggle switch might always send an ON or TOGGLE to toggle the switch, but still receive an ON or an OFF for the state topic - This change allows for splitting them apart
This commit is contained in:
1 parent
7bc2362e33
commit
ee8a815e6b
2 files changed
+45
-5
No files matched your search
@@ -31,12 +31,16 @@ DEFAULT_PAYLOAD_ON = 'ON'
|
||||
DEFAULT_PAYLOAD_OFF = 'OFF'
|
||||
DEFAULT_OPTIMISTIC = False
|
||||
CONF_UNIQUE_ID = 'unique_id'
|
||||
CONF_STATE_ON = "state_on"
|
||||
CONF_STATE_OFF = "state_off"
|
||||
|
||||
PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_ICON): cv.icon,
|
||||
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
|
||||
vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
|
||||
vol.Optional(CONF_STATE_ON): cv.string,
|
||||
vol.Optional(CONF_STATE_OFF): cv.string,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
|
||||
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
|
||||
@@ -62,6 +66,8 @@ async def async_setup_platform(hass, config, async_add_devices,
|
||||
config.get(CONF_RETAIN),
|
||||
config.get(CONF_PAYLOAD_ON),
|
||||
config.get(CONF_PAYLOAD_OFF),
|
||||
config.get(CONF_STATE_ON),
|
||||
config.get(CONF_STATE_OFF),
|
||||
config.get(CONF_OPTIMISTIC),
|
||||
config.get(CONF_PAYLOAD_AVAILABLE),
|
||||
config.get(CONF_PAYLOAD_NOT_AVAILABLE),
|
||||
@@ -75,9 +81,10 @@ class MqttSwitch(MqttAvailability, SwitchDevice):
|
||||
|
||||
def __init__(self, name, icon,
|
||||
state_topic, command_topic, availability_topic,
|
||||
qos, retain, payload_on, payload_off, optimistic,
|
||||
payload_available, payload_not_available,
|
||||
unique_id: Optional[str], value_template):
|
||||
qos, retain, payload_on, payload_off, state_on,
|
||||
state_off, optimistic, payload_available,
|
||||
payload_not_available, unique_id: Optional[str],
|
||||
value_template):
|
||||
"""Initialize the MQTT switch."""
|
||||
super().__init__(availability_topic, qos, payload_available,
|
||||
payload_not_available)
|
||||
@@ -90,6 +97,8 @@ class MqttSwitch(MqttAvailability, SwitchDevice):
|
||||
self._retain = retain
|
||||
self._payload_on = payload_on
|
||||
self._payload_off = payload_off
|
||||
self._state_on = state_on if state_on else self._payload_on
|
||||
self._state_off = state_off if state_off else self._payload_off
|
||||
self._optimistic = optimistic
|
||||
self._template = value_template
|
||||
self._unique_id = unique_id
|
||||
@@ -104,9 +113,9 @@ class MqttSwitch(MqttAvailability, SwitchDevice):
|
||||
if self._template is not None:
|
||||
payload = self._template.async_render_with_possible_json_value(
|
||||
payload)
|
||||
if payload == self._payload_on:
|
||||
if payload == self._state_on:
|
||||
self._state = True
|
||||
elif payload == self._payload_off:
|
||||
elif payload == self._state_off:
|
||||
self._state = False
|
||||
|
||||
self.async_schedule_update_ha_state()
|
||||
|
||||
Reference in new issue
Block a user