Rflink cover component #3145
Merged
Rflink cover component #3145
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
August 6, 2017 15:47
Landrash
requested changes
Aug 9, 2017
| footer: true | ||
| logo: rflink.png | ||
| ha_category: Cover | ||
| ha_release: 0.50 |
There was a problem hiding this comment.
Release will need to be updated before merge. Most likely to 0.52 since 0.51 is rather imminent.
| logo: rflink.png | ||
| ha_category: Cover | ||
| ha_release: 0.50 | ||
| ha_iot_class: "Local Polling" |
There was a problem hiding this comment.
Is this component really Polling?
| RTS_0100F2_0: | ||
| name: SunShade | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Configuration variables are missing.
There was a problem hiding this comment.
Configuration variables are added to the readme.
|
|
||
| The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). | ||
|
|
||
| First you have to set up your [rflink hub](/components/rflink/). |
There was a problem hiding this comment.
Markdown has very good support for list and nested lists. Suggest you look in to how that's formatted and apply that to increase the readability of this guide.
There was a problem hiding this comment.
Not sure what you mean by this comment, since it's a exact copy of readme from the rflink/light component.
I have rewritten some parts of the readme. So hopefully it's correct now.
There was a problem hiding this comment.
Example of a nested list 🙂
- Level 1
- Level 2
- Level 3
- Level 2
| --- | ||
|
|
||
| The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). | ||
|
|
There was a problem hiding this comment.
Suggest you add a header to this list called installation or setup.
Landrash
added
the
new-integration
Landrash
approved these changes
Aug 10, 2017
frenck
requested changes
Aug 30, 2017
| ha_release: 0.53 | ||
| --- | ||
|
|
||
| The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
example->for example, the Nodo RFLink
|
|
||
| The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). | ||
|
|
||
| First you have to set up your [rflink hub](/components/rflink/). |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
First->First, you have to
| The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). | ||
|
|
||
| First you have to set up your [rflink hub](/components/rflink/). | ||
| After configuring the RFLink hub covers will be automatically discovered and added. With the exeption of the Somfy RTS devices. |
There was a problem hiding this comment.
Spelling & Grammar:
exeption->exception.- Alternatively, you could replace
With the exception of the Somfy RTS devices.byExcept the Somfy RTS devices.
|
|
||
| After configuring the RFLink Somfy RTS you have to add the cover to the configuration like any other RFlink device. | ||
|
|
||
| RFLink cover ID's are composed of: protocol, id and gateway. For example: `RTS_0100F2_0`. |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
id->protocol, id, and gateway.
|
|
||
| RFLink cover ID's are composed of: protocol, id and gateway. For example: `RTS_0100F2_0`. | ||
|
|
||
| Once the ID of a cover is known it can be used to configure the cover in HA, for example to add it to a different group, hide it or configure a nice name. |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing comma after
known->cover is known, it can be used HA->Home Assistant- Missing comma after
example->in HA, for example, to add - Suggestion:
or configure a nice name.->set a nice name.
|
|
||
| Once the ID of a cover is known it can be used to configure the cover in HA, for example to add it to a different group, hide it or configure a nice name. | ||
|
|
||
| Assigning name to a cover: |
There was a problem hiding this comment.
Spelling & Grammar:
- Missing determiner for
name->Assigning a name to a cover
minor spelling & grammar issues
frenck
approved these changes
Sep 2, 2017
|
Thanks for fixing the issues @passie! 🥇 |
Merged
fabaff
approved these changes
Oct 9, 2017
fabaff
pushed a commit
that referenced
this pull request
Oct 9, 2017
* Markdown for rflink cover * . * Rewritten some parts based on the feedback from Landrash * Rewritten some parts based on the feedback from Landrash ( now saved the file :) ) * Update cover.rflink.markdown * bump version release * Fixed comments from frenck minor spelling & grammar issues * version bump * Update cover.rflink.markdown * version bump didn't made it in 0.54
This was referenced Mar 3, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New cover component for the rflink component.
Pull request in home-assistant (if applicable): home-assistant/core#9432