mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-01 16:57:34 +00:00
b39bd81c6e
* Spelling fixes * "It's" -> "its" fixes * Fix capitalization of "Pi" in "Raspberry Pi" "Pi", not "PI" or "pi".
37 lines
1.7 KiB
Markdown
37 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "Checklist for creating a component"
|
|
description: "A list of things to pay attention to when code reviewing a component."
|
|
date: 2017-01-15 14:09 -0800
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
A checklist of things to do when you're adding a new component.
|
|
|
|
<p class='note'>
|
|
Not all existing platforms follow the requirements in this checklist. This cannot be used as a reason to not follow them!
|
|
</p>
|
|
|
|
### {% linkable_title 1. Requirements %}
|
|
|
|
1. Requirement version pinned: `REQUIREMENTS = ['phue==0.8.1']`
|
|
2. We no longer want requirements hosted on GitHub. Please upload to PyPi.
|
|
3. Requirements should only be imported inside functions. This is necessary because requirements are installed on the fly.
|
|
|
|
### {% linkable_title 2. Configuration %}
|
|
|
|
1. Voluptuous schema present for config validation
|
|
2. Default parameters specified in voluptuous schema, not in `setup(…)`
|
|
3. Schema using as many generic config keys as possible from `homeassistant.const`
|
|
4. If your component has platforms, define a `PLATFORM_SCHEMA` instead of a `CONFIG_SCHEMA`.
|
|
5. If using a `PLATFORM_SCHEMA` to be used with `EntityComponent`, import base from `homeassistant.helpers.config_validation`
|
|
6. Never depend on users adding things to `customize` to configure behavior inside your component.
|
|
|
|
### {% linkable_title 3. Component/platform communication %}
|
|
|
|
1. If you need to share global data with platforms, use the dictionary `hass.data`. `hass.data[DATA_XY]` while `XY` is the component is preferred over `hass.data[DOMAIN]`.
|
|
2. If the component fetches data that causes its related platform entities to update, you can notify them using the dispatcher code in `homeassistant.helpers.dispatcher`.
|