Describe the new services added#5239
Describe the new services added#5239balloob merged 5 commits intohome-assistant:nextfrom teharris1:next
Conversation
frenck
left a comment
frenck
left a comment
There was a problem hiding this comment.
@teharris1, Thank you for your PR. I've reviewed it and left some comments. Could you please take a look? That would be awesome 😎
| --- | ||
| layout: page | ||
| title: "Insteon PLM" | ||
| description: "Instructions on how to setup an Insteon USB PLM locally within Home Assistant." |
There was a problem hiding this comment.
Incorrect, please leave it as it was.
| product_key: PRODUCT_KEY | ||
| ``` | ||
| Configuration variables: | ||
| - **port** (*Required*): The port for your device, e.g., `/dev/ttyUSB0` |
There was a problem hiding this comment.
Please do not change this, the previous version was actually correct.
| The only configuration item that is absolutely necessary is the port so that | ||
| Home Assistant can connect to the PLM. This will expose all the supported INSTEON | ||
| devices which exist in the modem's ALL-Link database. However, devices will | ||
| only be shown by their INSTEON hex address (e.g., "1A.2B.3C") which can be a bit |
There was a problem hiding this comment.
Please leave this intact, since it was perfectly fine.
| [Development Tools] service calls. The following services are available: | ||
|
|
||
| In order for any two Insteon devices to talk with one another, they must be | ||
| linked. For an overview of device linking please read the Insteon page on |
There was a problem hiding this comment.
Missing comma: linking please read -> linking, please read
| linked. For an overview of device linking please read the Insteon page on | ||
| [understanding linking]. The Insteon PLM module supports All-Linking through | ||
| [Development Tools] service calls. The following services are available: | ||
| - **insteon_plm.add_all_link**: Tells the Insteom Modem (IM) start All-Linking |
| is set to delete the link, press the link button on the corresponding device | ||
| to complete the process. | ||
| - **insteon_plm.load_all_link_database**: Load the All-Link Database for a | ||
| device. WARNING - Loading a device All-LInk database is very time consuming |
| to complete the process. | ||
| - **insteon_plm.load_all_link_database**: Load the All-Link Database for a | ||
| device. WARNING - Loading a device All-LInk database is very time consuming | ||
| and inconsistant. This may take a LONG time and may need to be repeated to |
| [insteonplm] Python module. Please see the documentation on the [insteonplm] | ||
| GitHub site. Alternatively, you can download [HouseLinc] which runs on any | ||
| Windows PC, or you can use [Insteon Terminal] which is open source and runs | ||
| on most platforms. HouseLinc is no longer supported by SmartHome but it still |
There was a problem hiding this comment.
More active voice suggestion (and missing comma):
SmartHome no longer supports HouseLinc, but it still
frenck
added
the
new-feature
|
@frenck Thanks for reviewing this PR. Hopefully my changes met your expectations. The associated code PR is still sitting out there after over a week. Any way you can help move the code review of the that PR forward? Thanks |
|
@teharris1 there has been a build error because of a change you made in this PR. From the netlify build:
|
|
Please address asap so it can be part of the release. |
|
@balloob Working on it right now. |
|
Looks like editting it in the GitHub online editor converts it to UTF-8, let's see if that worked. |
|
Thanks! Cherry-picking this for RC branch. |
* Describe the new services added * Edits per review * UTF-8 error * UTF-8 Error * Convert to utf-8
* Describe the new services added * Edits per review * UTF-8 error * UTF-8 Error * Convert to utf-8
3 participants
Description:
New services were added to support Insteon All-Linking.
Pull request in home-assistant (if applicable): home-assistant/core#14065
Checklist:
current. New documentation for platforms/components and features should go tonext.