Skip to content

HTTP binary sensor and sensor docs #191

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

Merged
merged 7 commits into from
Feb 6, 2016
Merged

HTTP binary sensor and sensor docs #191

merged 7 commits into from
Feb 6, 2016

Conversation

fabaff
Copy link
Member

@fabaff fabaff commented Feb 6, 2016

This PR contains some more details about the usage of the HA REST API. More information for sensors and binary sensors are provided.

Till now the only place to find information about this feature was embedded in the API docs. I hope that this could make the API more visible and stop me for doing stuff that is already there.

@fabaff
Copy link
Member Author

fabaff commented Feb 6, 2016

I'm open for suggestions and feedback :-D

@fabaff
Copy link
Member Author

fabaff commented Feb 6, 2016

I would be nice if someone could verify the stuff I wrote. Just be sure that it's complete rubbish. Thanks.

@balloob
Copy link
Member

balloob commented Feb 6, 2016

It looks good.

I think we should somehow be able to flag each page that we put out as a platform/component that is actually just a tutorial to use some other part of Home Assistant. There is sensor.http, binary_sensor.http, notify.mqtt and ifttt.manything.

Please be aware that this works for the sensor and binary_sensor platforms as the components do not provide any services to interact with the entities. This will not work for a light because services as light.turn_on etc will not work.

```

<p class='note'>
It's suggested that you choose an unique device name (DEVICE_NAME) to avoid clashes with other devices.
Copy link
Member

Choose a reason for hiding this comment

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

It's not only suggested, it's necessary. "You should choose a unique…"

@balloob
Copy link
Member

balloob commented Feb 6, 2016

You can merge it after fixing that 1 sentence. 🐬

@fabaff
Copy link
Member Author

fabaff commented Feb 6, 2016

I think we should somehow be able to flag each page that we put out as a platform/component that is actually just a tutorial to use some other part of Home Assistant. There is sensor.http, binary_sensor.http, notify.mqtt and ifttt.manything.

Agreed. I started to realize while creating the MQTT notification page that this kind of documentation doesn't fit in the existing categories. Due to the lack of better ideas I just placed them in the category which fits best from my point of view.

@balloob
Copy link
Member

balloob commented Feb 6, 2016

I think that is fine. That is the place people will look for it.

fabaff added a commit that referenced this pull request Feb 6, 2016
HTTP binary sensor and sensor docs
@fabaff fabaff merged commit 2d47cd7 into home-assistant:master Feb 6, 2016
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.

2 participants