Documentation for new Hive Platform / Components #3577

Rendili · 2017-10-09T21:39:02Z

New documentation for new Hive platform / components

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

frenck

@Rendili, Thank you for submitting a PR. I've found some minor issues. Could you please take a look at those?

frenck · 2017-11-19T15:52:17Z

source/_components/climate.hive.markdown

+---
+
+
+The 'hive' climate component integrates your Hive thermostat and hot water in to Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.


Typo: in to -> into

frenck · 2017-11-19T15:52:39Z

source/_components/climate.hive.markdown

+footer: true
+logo: hive.png
+ha_category: Climate
+ha_release: 0.62


You might wanna update the version number (in all other files as well)

@frenck
Thanks for reviewing.
I did not know which version number the code PR for the Hive component / platform would actually be released in, so I put a prediction.

What version would you recommended to put here, I don't anticipate the code being accepted any time soon?

Aah ok, that makes sense I guess. We usually put in the next version (which will be 0.59)

I can update to 0.59 and hope for the best :)

frenck · 2017-11-19T15:54:39Z

source/_components/hive.markdown

+---
+
+
+This Hive component is the main component to setup and integrate all supported Hive devices.  Once configured with the minimum required details it will detect and add all your Hive devices in to Home Assistant, including support for multizone heating.


Double spaces detected: Hive devices. Once, remove one.
Typo: setup -> set up
Typo: in to-> into

frenck · 2017-11-19T15:55:12Z

source/_components/hive.markdown

+
+This Hive component is the main component to setup and integrate all supported Hive devices.  Once configured with the minimum required details it will detect and add all your Hive devices in to Home Assistant, including support for multizone heating.
+
+This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com) and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.


Missing comma: Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will

frenck · 2017-11-19T15:55:36Z

source/_components/hive.markdown

+
+This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com) and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.
+
+To add all your Hive devices in to your Home Assistant installation add the following to your 'configuration.yaml' file:


Typo: in to -> into

frenck · 2017-11-19T15:56:32Z

source/_components/hive.markdown

+
+Configuration variables:
+
+- **username** (*Required*): Username from [https://my.hivehome.com](https://my.hivehome.com).


Please use the configuration tags to list configuration variables. For more information please see:
https://home-assistant.io/developers/documentation/create_page/#configuration

I don't understand what needs changing here.
Please could you point me to an existing file which demonstrates this in use and what I am missing?

See for example this component: https://raw.githubusercontent.com/home-assistant/home-assistant.github.io/next/source/_components/device_tracker.hitron_coda.markdown

The configuration variables are listed using some code and then rendered. In your current version, they are simply markdown (which is the old way we did it).

great stuff, thanks.

I have updated, but a little unsure of what to do with the option variable scan_interval and any examples needed with and without it, as the configuration tags documentation webpage said only add required variables.

frenck · 2017-11-19T15:59:21Z

source/_components/hive.markdown

+- **scan_interval** (*Optional*): The default update frequency is once every 2 minutes, use this to specify a custom minutes between updates.
+
+
+To add all your Hive devices in to your Home Assistant installation, specifying the optional **devices** variable add the following to your 'configuration.yaml' file.  You can remove each of the options in the **devices** variable for the corresponding Hive device you would like not to be added to Home Assistant:


Typo: in to -> into
This sentence has reading/wording issues. Please review it, try reading it out loud and consider rewording it.

updated the typo
removed the sentence. It would have made more sense had this feature been allowed in the code :)

frenck · 2017-11-19T16:00:15Z

source/_components/sensor.hive.markdown

+---
+
+
+The 'hive' sensor component integrates your Hive sensors in to Home Assistant.


Typo: in to -> into

frenck · 2017-11-19T16:01:22Z

source/_components/light.hive.markdown

+---
+
+
+The 'hive' light component integrates your Hive lights in to Home Assistant, enabling control of various settings, depending on model light.


Typo: in to -> into
Missing determiner: on the model light.

frenck · 2017-11-19T20:56:01Z

I have updated, but a little unsure of what to do with the option variable scan_interval and any examples needed with and without it, as the configuration tags documentation webpage said only add required variables.

You only add required variables in the "example" yaml configuration partials. The configuration variables should be all documented of course.

Rendili · 2017-11-19T21:00:11Z

ok, I think I understand.

Does that document make sense and is it ok now? I documented the option variable in there, but not added to that new configuration sections

Rendili · 2017-11-21T23:06:01Z

@frenck All files updated as suggested

frenck · 2017-11-22T12:44:30Z

source/_components/hive.markdown

+  description: Your password from [https://my.hivehome.com](https://my.hivehome.com).
+  required: true
+  type: string
+{% endconfiguration %}


scan_interval is still missing in this list.

I thought the document on this said not to include optionals?
I can add it if you like of course.

The documentation states that example configurations should be kept minimal. This is not the example we are talking about here. This part is the actual options list.

Thanks for the clarification @frenck
Updated.

MartinHjelmare · 2017-11-22T22:00:48Z

source/_components/hive.markdown

+
+This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.
+
+To add your Hive devices into your Home Assistant installation, with an update frequency of every five minutes (the default is every two minutes if the scan_interval variable is not specified) add the following to your 'configuration.yaml' file:


Remove the reference to five minutes. The example doesn't include the scan interval option anymore.

MartinHjelmare · 2017-11-22T22:03:00Z

source/_components/sensor.hive.markdown

+---
+
+
+The 'hive' sensor component can expose as a sensor the current online status of your Hive Hub


Missing period.

MartinHjelmare · 2017-11-22T22:04:38Z

source/_components/switch.hive.markdown

+---
+
+
+The 'hive' switch component integrates your Hive plugs Home Assistant, enabling control of your devices.


Missing "into". "... integrates your Hive plugs into Home Assistant."

Rendili added 7 commits September 24, 2017 21:33

Documentation for Hive platform / components

24e795c

Documentation for Hive platform / components

052a707

Documentation for Hive platform / components

cde45b6

Documentation for Hive platform / components

d86aefb

Documentation for Hive platform / components

85c58db

Documentation for Hive platform / components

afca553

Documentation for Hive platform / components

88a8f35

fabaff added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-integration This PR adds documentation for a new Home Assistant integration labels Oct 9, 2017

Rendili mentioned this pull request Oct 13, 2017

New Hive Component / Platforms home-assistant/core#9804

Merged

6 tasks

fabaff removed the Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! label Nov 6, 2017

Rendili closed this Nov 10, 2017

Rendili reopened this Nov 13, 2017

Documentation for Hive platform / components

fcb4ed8

frenck requested changes Nov 19, 2017

View reviewed changes

Rendili added 3 commits November 19, 2017 20:35

Documentation for Hive Component / Platforms

67751b2

Documentation for Hive Component / Platforms

0be9d72

Documenation for Hive Component / Platforms

25a2eed

frenck self-assigned this Nov 20, 2017

Document for Hive Component / Platforms

d6029c1

frenck requested changes Nov 22, 2017

View reviewed changes

frenck removed their assignment Nov 22, 2017

Documentation for Hive Component / Platforms

e4acd88

MartinHjelmare requested changes Nov 22, 2017

View reviewed changes

Documentation for Hive Component / Platforms

cf86d5f

MartinHjelmare approved these changes Nov 22, 2017

View reviewed changes

frenck approved these changes Nov 23, 2017

View reviewed changes

frenck merged commit ee6bb09 into home-assistant:next Nov 23, 2017

Rendili deleted the next branch December 9, 2017 21:25

		---


		The 'hive' climate component integrates your Hive thermostat and hot water in to Home Assistant, enabling control of setting the mode and setting the target temperature.

		---


		This Hive component is the main component to setup and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices in to Home Assistant, including support for multizone heating.


		This Hive component is the main component to setup and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices in to Home Assistant, including support for multizone heating.

		This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com) and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.


		This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com) and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.

		To add all your Hive devices in to your Home Assistant installation add the following to your 'configuration.yaml' file:


		Configuration variables:

		- username (Required): Username from [https://my.hivehome.com](https://my.hivehome.com).

		- scan_interval (Optional): The default update frequency is once every 2 minutes, use this to specify a custom minutes between updates.


		To add all your Hive devices in to your Home Assistant installation, specifying the optional devices variable add the following to your 'configuration.yaml' file. You can remove each of the options in the devices variable for the corresponding Hive device you would like not to be added to Home Assistant:

		---


		The 'hive' sensor component integrates your Hive sensors in to Home Assistant.

		---


		The 'hive' light component integrates your Hive lights in to Home Assistant, enabling control of various settings, depending on model light.


		This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.

		To add your Hive devices into your Home Assistant installation, with an update frequency of every five minutes (the default is every two minutes if the scan_interval variable is not specified) add the following to your 'configuration.yaml' file:

		---


		The 'hive' sensor component can expose as a sensor the current online status of your Hive Hub

		---


		The 'hive' switch component integrates your Hive plugs Home Assistant, enabling control of your devices.

Uh oh!

Documentation for new Hive Platform / Components #3577

Documentation for new Hive Platform / Components #3577

Uh oh!

Conversation

Rendili commented Oct 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frenck commented Nov 19, 2017

Uh oh!

Rendili commented Nov 19, 2017

Uh oh!

Rendili commented Nov 21, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Rendili commented Oct 9, 2017 •

edited

Loading