Skip to content

Updated aREST switch doc for invert#5377

Merged
frenck merged 4 commits into
home-assistant:nextfrom
w1ll1am23:arest_doc_update
May 18, 2018
Merged

Updated aREST switch doc for invert#5377
frenck merged 4 commits into
home-assistant:nextfrom
w1ll1am23:arest_doc_update

Conversation

@w1ll1am23
Copy link
Copy Markdown
Contributor

Description:

Pull request in home-assistant (if applicable): home-assistant/core#14467

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.
- **pins** array (*Optional*): An array with all used pins.
- **name** (*Required*): The name of the pin to use in the frontend.
- **invert** (*Optional*): If the logic for on/off should be inverted. 1 = off and 0 = on
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the default value. The type (bool) would be nice, too. A {% configuration %} block would be awesome. :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@w1ll1am23 @syssi
1 = off? So true, is not to invert?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No no, I was trying to call out a reference to the aREST code. (Arduino) 1 or HIGH is off and 0 or LOW is on.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah check

@w1ll1am23, are you planning on changing/updating this PR, based on the feedback by @syssi ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frenck yes, didn't get a chance yesterday. I'll try to get it done later today.

@fabaff fabaff added the new-feature This PR adds documentation for a new Home Assistant feature to an existing integration label May 16, 2018
type: string
invert:
description: If the logic for on/off should be inverted.
required: optional
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

required: false. Is optional also valid?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well valid as in "Does it work?"; yes. Matching our standards: no.

frenck
frenck previously approved these changes May 18, 2018
@frenck frenck merged commit b2c5eb7 into home-assistant:next May 18, 2018
Oro pushed a commit to Oro/home-assistant.github.io that referenced this pull request May 20, 2018
* Updated aREST switch doc for invert

* Updated to configuration block

* ✏️ Changed values of required configuration keys

* ✏️ Language tweak
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-feature This PR adds documentation for a new Home Assistant feature to an existing integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants