jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge branch 'current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2018-01-26 00:49:00 -08:00
commit cc025a6a72
107 changed files with 293 additions and 181 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/developers/architecture.markdown
View file

@ -16,7 +16,7 @@ For more information about each part in this overview, <a href='/blog/2014/12/26
* Home Control is responsible for collecting information and controlling devices.
* Home Automation triggers commands based on user configurations.
* Smart Home triggers commands based on previous behaviour.
* Smart Home triggers commands based on previous behavior.
<p class='img'>
<a href='{{site_root}}/images/architecture/home_automation_landscape.png' name='landscape'>

4
source/developers/development_guidelines.markdown
View file

@ -25,9 +25,9 @@ The maximum line length comes directly from the [PEP8 style guide](https://www.p
Those points may require that you adjust your IDE or editor settings.
## {% linkable_title Our recommandations %}
## {% linkable_title Our recommendations %}
For some cases [PEPs](https://www.python.org/dev/peps/) don't make a statement. This section covers our recommendations about the code style. Those points were collected from the exisiting code and based on what contributors and developers were using the most. This is basically a majority decision, thus you may not agree with it. But we would like to encourage you follow those recommandations to keep the code unified.
For some cases [PEPs](https://www.python.org/dev/peps/) don't make a statement. This section covers our recommendations about the code style. Those points were collected from the existing code and based on what contributors and developers were using the most. This is basically a majority decision, thus you may not agree with it. But we would like to encourage you follow those recommendations to keep the code unified.
### {% linkable_title Quotes %}

2
source/developers/development_submitting.markdown
View file

@ -39,7 +39,7 @@ Submit your improvements, fixes, and new features to Home Assistant one at a tim
* On GitHub, navigate to the main page of the Home Assistant repository.
* In the "Branch" menu, choose the branch that contains your commits (from your fork).
* To the right of the Branch menu, click **New pull request**.
* Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. Make sure the Home Assistant branch matches with your forked branch (`dev`) else you will propose ALL committs between branches.
* Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. Make sure the Home Assistant branch matches with your forked branch (`dev`) else you will propose ALL commits between branches.
* Type a title and complete the provided description for your pull request.
* Click **Create pull request**.

2
source/developers/development_validation.markdown
View file

@ -11,7 +11,7 @@ footer: true
The `configuration.yaml` file contains the configuration options for components and platforms. We use [voluptuous](https://pypi.python.org/pypi/voluptuous) to make sure that the configuration provided by the user is valid. Some entries are optional or could be required to set up a platform or a component. Others must be a defined type or from an already-defined list.
We test the configuration to ensure that users have a great experience and minimise notifications if something is wrong with a platform or component setup before Home Assistant runs.
We test the configuration to ensure that users have a great experience and minimize notifications if something is wrong with a platform or component setup before Home Assistant runs.
Besides [voluptuous](https://pypi.python.org/pypi/voluptuous) default types, many custom types are available. For an overview, take a look at the [config_validation.py](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/config_validation.py) helper.

2
source/developers/documentation/standards.markdown
View file

@ -66,4 +66,4 @@ redirect_from: /getting-started/android/
---
```
Adding a redirect also applies if you move content around in the [documention](/docs/).
Adding a redirect also applies if you move content around in the [documentation](/docs/).

9
source/developers/hassio/addon_config.markdown
View file

@ -12,10 +12,15 @@ redirect_from: /hassio/addon_config/
Each add-on is stored in a folder. The file structure looks like this:
```
```text
addon_name/
Dockerfile
build.json
CHANGELOG.md
config.json
Dockerfile
icon.png
logo.png
README.md
run.sh
```

15
source/developers/hassio/addon_development.markdown
View file

@ -14,11 +14,10 @@ Add-ons for Hass.io allow the user to extend the functionality around Home Assis
Under the hood, add-ons are Docker images published in [Docker Hub](https://hub.docker.com/). Developers can create [GitHub](https://github.com) repositories that contain multiple references to add-ons for easy sharing with the community.
<ol>
<li><a href='/developers/hassio/addon_tutorial/'>Tutorial: Making your first add-on</a></li>
<li><a href='/developers/hassio/addon_config/'>Configuration</a></li>
<li><a href='/developers/hassio/addon_communication/'>Communication</a></li>
<li><a href='/developers/hassio/addon_testing/'>Local Testing</a></li>
<li><a href='/developers/hassio/addon_publishing/'>Publishing</a></li>
<li><a href='/developers/hassio/addon_repository/'>Repositories</a></li>
</ol>
1. [Tutorial: Making your first add-on](/developers/hassio/addon_tutorial/)
1. [Configuration](/developers/hassio/addon_config/)
1. [Communication](/developers/hassio/addon_communication/)
1. [Local Testing](/developers/hassio/addon_testing/)
1. [Publishing](/developers/hassio/addon_publishing/)
1. [Presentation](/developers/hassio/addon_presentation/)
1. [Repositories](/developers/hassio/addon_repository/)

49
source/developers/hassio/addon_presentation.markdown Normal file
View file

@ -0,0 +1,49 @@
---
layout: page
title: "Presenting your add-on"
description: "Details on how to present your Hass.io add-on."
date: 2018-01-24 22:15
sidebar: true
comments: false
sharing: true
footer: true
---
If you decide to share your add-on to the public, paying attention to details is recommended. Of course, your add-on should have a proper name and description, but Hass.io also gives you some other tools to present your add-on even nicer.
## {% linkable_title Adding documentation %}
Good documentation helps the consumer of your add-on to understand its usage, explains configuration options, points users in the right direction in the case they have questions or issues, and contains the license under which the add-on was published.
This file containing the documentation is usually referred to as the "README", which is generally published as the `README.md` file.
Take a look at other projects for inspiration. For example, see the `README.md` of the [Community Hass.io Add-ons: Homebridge](https://github.com/hassio-addons/addon-homebridge/blob/master/README.md) add-on.
In future versions of Hass.io, the `README.md` file will be displayed in the Home Assistant frontend.
## {% linkable_title Add-on icon & logo %}
A picture is worth a thousand words. Therefore, your add-on can be improved by adding a proper image icon and logo. Those images are used when showing your add-on in the Home Assistant Hass.io panel and which will significantly improve the visual representation of your add-on.
Requirements for the logo of your add-on:
- The logo must be in the Portable Network Graphics format (`.png`).
- The filename must be `logo.png`.
- It is recommended to keep the logo size around 250x100px. You may choose to use a different size or aspect ratio as you seem fit for your add-on.
Requirements for the icon of your add-on:
- The icon must be in the Portable Network Graphics format (`.png`).
- The filename must be `icon.png`.
- The aspect ratio of the icon must be 1x1 (square).
- It is recommended to use an icon size of 128x128px.
## {% linkable_title Keeping a changelog %}
It is likely you are going to release newer versions of your add-on in the future. In case that happens, the users of your add-on would see an upgrade notice and probably want to know what changes were made in the latest version.
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of your add-on and is generally published as the `CHANGELOG.md` file.
If you are in need of a guide on keeping a changelog, we would recommend checking the [keep a changelog](http://keepachangelog.com) website. They have developed a standard that is used by many opensource projects around the world.
In future versions of Hass.io, the `CHANGELOG.md` file will be displayed in the Home Assistant frontend.

2
source/developers/hassio/addon_repository.markdown
View file

@ -10,7 +10,7 @@ footer: true
redirect_from: /hassio/addon_repository/
---
An Add-on repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. To be indentified as a repository, the repository must contain a configuration file.
An add-on repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. To be indentified as a repository, the repository must contain a configuration file.
Check the [Example add-on repository](https://github.com/home-assistant/hassio-addons-example) for further details.

2
source/developers/multiple_instances.markdown
View file

@ -11,7 +11,7 @@ footer: true
# {% linkable_title This has been deprecated and is no longer supported. %}
Home Assistant supports running multiple synchronised instances using a master-slave model. Whenever `events.fire` or `states.set` is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.
Home Assistant supports running multiple synchronized instances using a master-slave model. Whenever `events.fire` or `states.set` is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.
<p class='img'>
<a href='/images/architecture/architecture-remote.png'>

2
source/developers/rest_api.markdown
View file

@ -517,7 +517,7 @@ Requires a JSON object that represents the API to cancel forwarding to.
}
```
It will return a message if event forwarding was cancelled successfully.
It will return a message if event forwarding was canceled successfully.
```json
{