Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ads #4115

Merged
merged 13 commits into from
Dec 5, 2017
Merged

Ads #4115

merged 13 commits into from
Dec 5, 2017

Conversation

stlehmann
Copy link
Contributor

@stlehmann stlehmann commented Dec 1, 2017

Description:

Refers to closed PR #3777.

Add documentation for new ADS component.

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

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.

@frenck
Copy link
Member

frenck commented Dec 1, 2017

@MrLeeH Please specify the related parent PR in the start post.


{% configuration %}

- **device** (*Required*): The AMS NetId that identifies the device.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


{% configuration %}

- **adsvar** (*Required*): The name of the variable which you want to access on
Copy link
Member

Choose a reason for hiding this comment

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

Syntax.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


{% configuration %}

- **adsvar** (*Required*): The name of the boolean variable that switches the
Copy link
Member

Choose a reason for hiding this comment

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

Syntax.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


{% configuration %}

- **adsvar** (*Required*): The name of the variable which you want to access on
Copy link
Member

Choose a reason for hiding this comment

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

Syntax.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is there a default keyword for default values or should I just add the default value to the description?

Copy link
Member

@MartinHjelmare MartinHjelmare Dec 5, 2017

Choose a reason for hiding this comment

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

There is a default key, so use that, 👍.

Configuration variables:

{% configuration %}
- **adsvar** (*Required*): The name of the variable which you want to access on
Copy link
Member

Choose a reason for hiding this comment

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

Syntax.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

footer: true
logo: home-assistant.png
ha_category: Hub
ha_release: 0.59
Copy link
Member

Choose a reason for hiding this comment

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

"0.60"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_release: 0.59
Copy link
Member

Choose a reason for hiding this comment

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

"0.60"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

footer: true
logo: home-assistant.png
ha_category: Light
ha_release: 0.59
Copy link
Member

Choose a reason for hiding this comment

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

"0.60"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

footer: true
logo: home-assistant.png
ha_category: Sensor
ha_release: 0.59
Copy link
Member

Choose a reason for hiding this comment

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

"0.60"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

footer: true
logo: home-assistant.png
ha_category: Switch
ha_release: 0.59
Copy link
Member

Choose a reason for hiding this comment

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

"0.60"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

name:
required: false
description: An identifier for the sensor
factor:
Copy link
Member

Choose a reason for hiding this comment

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

name (the key above factor) is missing the type key-value pair.

factor:
required: false
description: A factor that divides the stored value before displaying in Home Assistant
default: 1
{% endconfiguration %}
Copy link
Member

Choose a reason for hiding this comment

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

No type here for factor either.

adsvar:
required: true
description: The name of the variable which you want to access on the ADS device
name:
Copy link
Member

Choose a reason for hiding this comment

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

Missing type for adsvar.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare merged commit 2eaaff4 into home-assistant:next Dec 5, 2017
@fabaff fabaff mentioned this pull request Dec 5, 2017
2 tasks
tschmidty69 pushed a commit to tschmidty69/home-assistant.github.io that referenced this pull request Dec 9, 2017
* add ads hub and switch

* add ads binary sensor

* add ADS sensor

* fix version numbers

* separate configuration tag

* remove device notification config

* fix configuration schema.

* replace tabs with spaces

* add type key-value-pairs
tschmidty69 pushed a commit to tschmidty69/home-assistant.github.io that referenced this pull request Dec 10, 2017
* add ads hub and switch

* add ads binary sensor

* add ADS sensor

* fix version numbers

* separate configuration tag

* remove device notification config

* fix configuration schema.

* replace tabs with spaces

* add type key-value-pairs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants