MQTT Switch - Add configurable availability payload 8000 #8934

tim-devel · 2017-08-12T08:14:02Z

Description:

Add configurable availability payload

Breaking change: To enable support for Sonoff Tasmoto the command and availability payload are now no longer linked. Command and availability payload default to ON/OFF and must be configured individually if custom values are required.

Related issue (if applicable): fixes #8933

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#3170

Example entry for `configuration.yaml` (if applicable):

 -  platform: mqtt
    name: "Kitchen"
    state_topic: "stat/sonoff_1/POWER"
    command_topic: "cmnd/sonoff_1/POWER"
    availability_topic: "tele/sonoff_1/LWT"
    payload_available: "Online"
    payload_not_available: "Offline"
    retain: true

Checklist:

If user exposed functionality or configuration variables are added/changed:

[X ] Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2017-08-12T08:14:03Z

Hello @timstanley1985,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

48f0480fdb35362c24f4b62566ba457309730683 - This commit has something that looks like an email address (timstanley1985@gmail.com). Maybe try linking that to GitHub?.
b488e0b26df6ea0bab47701760eb497618cbe025 - This commit has something that looks like an email address (timstanley1985@gmail.com). Maybe try linking that to GitHub?.
c82e0512ca8f769195ae6140199fc7e55bf6f8fe - This commit has something that looks like an email address (timstanley1985@gmail.com). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <email@address.com>"
```
  (substituting Author Name and email@address.com for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

houndci-bot · 2017-08-12T08:14:12Z

homeassistant/components/switch/mqtt.py

@@ -81,6 +86,8 @@ def __init__(self, name, state_topic, command_topic, availability_topic,
        self._payload_off = payload_off
        self._optimistic = optimistic
        self._template = value_template
+        self._payload_available= payload_available


missing whitespace around operator

houndci-bot · 2017-08-12T08:14:12Z

homeassistant/components/switch/mqtt.py


 PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
    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_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
-    vol.Optional(CONF_AVAILABILITY_TOPIC): mqtt.valid_subscribe_topic,
+    vol.Optional(CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE): cv.string,
+    vol.Optional(CONF_PAYLOAD_NOT_AVAILABLE, default=DEFAULT_PAYLOAD_NOT_AVAILABLE): cv.string,


line too long (95 > 79 characters)

houndci-bot · 2017-08-12T08:14:12Z

homeassistant/components/switch/mqtt.py


 PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
    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_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
-    vol.Optional(CONF_AVAILABILITY_TOPIC): mqtt.valid_subscribe_topic,
+    vol.Optional(CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE): cv.string,


line too long (87 > 79 characters)

homeassistant · 2017-08-12T08:23:32Z

Hi @timstanley1985,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

balloob

Please add tests and please include add a paragraph to the description for the breaking change section of the release notes.

balloob · 2017-08-12T16:03:53Z

homeassistant/const.py

@@ -125,6 +125,8 @@
 CONF_PASSWORD = 'password'
 CONF_PATH = 'path'
 CONF_PAYLOAD = 'payload'
+CONF_PAYLOAD_AVAILABLE = 'payload_available'


Please don't add these to const, keep them in mqtt switch.

No problem, done

tim-devel · 2017-08-12T19:39:06Z

@balloob thanks for your comments. I am a bit lost when it comes to writing tests. I have tried my best to write a test for a custom availability payload based on an existing test. Will add breaking change description once tests approved

tim-devel · 2017-08-14T06:48:54Z

Breaking change release note added

balloob · 2017-08-16T06:05:10Z

Awesome, great job! 🎉 🐬

) * Add configurable availabilty payload * Fix * Fix * Lint fixes * Fix tests * Fix tests * Move from const.py to mqtt switch * New test * Fix flake*

tim-devel added 3 commits August 12, 2017 07:12

Add configurable availabilty payload

c82e051

Fix

b488e0b

Fix

48f0480

homeassistant added cla-error platform: switch.mqtt labels Aug 12, 2017

balloobbot added core platform labels Aug 12, 2017

houndci-bot reviewed Aug 12, 2017

View reviewed changes

Lint fixes

76f8e1b

homeassistant added cla-needed cla-signed and removed cla-needed labels Aug 12, 2017

Fix tests

f875bc1

homeassistant added the cla-signed label Aug 12, 2017

Fix tests

ad66ae1

balloob added breaking-change cla-recheck labels Aug 12, 2017

homeassistant added cla-signed and removed cla-recheck labels Aug 12, 2017

balloob added cla-recheck and removed cla-error labels Aug 12, 2017

homeassistant added cla-signed and removed cla-recheck labels Aug 12, 2017

balloob requested changes Aug 12, 2017

View reviewed changes

Move from const.py to mqtt switch

29fa9ba

balloobbot removed the core label Aug 12, 2017

New test

3ea02da

homeassistant added the cla-signed label Aug 12, 2017

Fix flake*

790e1ed

balloob approved these changes Aug 16, 2017

View reviewed changes

balloob added the cla-recheck label Aug 16, 2017

homeassistant added cla-signed and removed cla-recheck labels Aug 16, 2017

balloob merged commit 3342db3 into home-assistant:dev Aug 16, 2017

tim-devel deleted the payload_availability branch August 16, 2017 06:08

balloob mentioned this pull request Aug 25, 2017

0.52 #9131

Merged

shortbloke mentioned this pull request Aug 29, 2017

Check compatibility with breaking change to MQTT.Switch shortbloke/home_assistant_config#14

Closed

This was referenced Sep 16, 2017

MQTT Cover: Add availability topic and configurable payloads #9445

Merged

MQTT Binary Sensor - Add availability_topic for online/offline status #9507

Merged

home-assistant locked and limited conversation to collaborators Dec 11, 2017

ghost added integration: mqtt and removed platform: switch.mqtt labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

MQTT Switch - Add configurable availability payload 8000 #8934

MQTT Switch - Add configurable availability payload #8934

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MQTT Switch - Add configurable availability payload 8000 #8934

MQTT Switch - Add configurable availability payload #8934

Uh oh!

Conversation

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Example entry for `configuration.yaml` (if applicable):