Add documentation for ADS component #3777
Conversation
* remove ssl and port in configuration.yaml Make clear to remove SSL and port in configuration.yaml to avoid 502 errors * Update nginx_proxy.markdown * Minor change
* Update Arlo Control Panel with away mode variable Just a simple change to add a description about adding an away mode to the Arlo Control Panel. * Remove blank line
* Update recorder.markdown * It's a platform and not a component
Got distracted and typed before/after instead of below/above
Updating the navigation links for Z-Wave
* added note: type names differ from entity names * Minor changes
Add info in connection problem section
For greater clarity.
* Fixing Typo that was mentioned in home-assistant#3764 * Cleaning up some other things in glossary As I was making the other commit (home-assistant#3766) I noticed some other things in the glossary that could be changed. One of the main things is that each example read differently so there was a lot of jumping between how examples were written, I've made them a bit more unified. I also added a bit more explanatory text and added some links as suggested in home-assistant#3764. I made this a seperate pull because I figured it might be a bit more opinionated than the typo error. * Missed discovery. * Add quotes
Removed info about versions before 0.4x
Added link to the Hass.io Z-Wave docs, and a note that the pre-reqs don't apply to it.
fabaff
added
Hacktoberfest
fabaff
removed
the
Hacktoberfest
source/_components/ads.markdown
Outdated
| footer: true | ||
| logo: home-assistant.png | ||
| ha_category: Hub | ||
| ha_release: 0.55 |
There was a problem hiding this comment.
You might want to update the version number
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: home-assistant.png |
There was a problem hiding this comment.
Maybe add the TwinCAT or Backhoff logo?
source/_components/ads.markdown
Outdated
|
|
||
| Configuration parameters: | ||
|
|
||
| - **device** (*Required*): The AMS NetId that identifies the device. |
There was a problem hiding this comment.
Please use the configuration tags for listing configuration variables. For more information:
https://home-assistant.io/developers/documentation/create_page/#configuration
|
|
||
| Service parameters: | ||
|
|
||
| - **adsvar**: name of the variable on the ADS device. To access global variables |
There was a problem hiding this comment.
Please use the configuration tags for listing configuration variables. For more information:
https://home-assistant.io/developers/documentation/create_page/#configuration
| ``` | ||
|
|
||
| Configuration variables: | ||
| - **adsvar** (*Required*): The name of the variable which you want to access on |
There was a problem hiding this comment.
Please use the configuration tags for listing configuration variables. For more information:
https://home-assistant.io/developers/documentation/create_page/#configuration
|
|
||
| Configuration variables: | ||
|
|
||
| - **adsvar** (*Required*): The name of the variable which you want to access on |
There was a problem hiding this comment.
Please use the configuration tags for listing configuration variables. For more information:
https://home-assistant.io/developers/documentation/create_page/#configuration
| - **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. | ||
| - **use_notify** (*Optional*): Enable device notifications. Default: yes. | ||
| - **poll_interval** (*Optional*): If device notifications are disabled polling | ||
| is used. This parameter defines the pollint interval in milliseconds. Defaults |
| is used. This parameter defines the pollint interval in milliseconds. Defaults | ||
| to 1000. | ||
|
|
||
| If *device notifications* are enabled the *ADS* device will push a change |
There was a problem hiding this comment.
Missing comma: are enabled, the
Missing comma: Otherwise, the value
| - **factor** (*Optional*): Use a factor that divides the stored value before | ||
| displaying in Home Assistant. Default: 1. | ||
|
|
||
| If *device notifications* are enabled the *ADS* device will push a change |
There was a problem hiding this comment.
Missing comma: are enabled, the
Missing comma: Otherwise, the value
| If *device notifications* are enabled the *ADS* device will push a change | ||
| directly to Home Assistant. Otherwise the value will be polled regularly. | ||
|
|
||
| The *factor* can be used to implement fixed decimals. E.g. set *factor* to 100 |
|
@frenck Thank you for your review. I updated the version number to 0.59 and fixed the typos and commas. Also I added the components tags to all platforms. Concerning the logo I think I might need to ask the company for permission to use their logo. |
|
@MrLeeH Not sure what you have done at this point. Could you please take a look? |
|
@frenck Damn, after I made the changes you suggested I realized I was on the wrong branch. So I merged it in the |
|
I don't know where those conflicts are coming from. Maybe I just start a new PR? |
|
There are still some changes in the component going on. I will wait with the PR until all details have been clarified. Thank you for the review so far. I implemented them to the best of my knowledge and certain. |
Description:
Add documentation for ADS component.
Pull request in home-assistant (if applicable): home-assistant/home-assistant#