home-assistant.io/source/developers/code_review_component.markdown

layout, title, description, date, sidebar, comments, sharing, footer

layout	title	description	date	sidebar	comments	sharing	footer
page	Checklist for creating a component	A list of things to pay attention to when code reviewing a component.	2017-01-15 14:09 -0800	true	false	true	true

A checklist of things to do when you're adding a new component.

{% linkable_title Requirements %}

1. Requirement version pinned: REQUIREMENTS = ['phue==0.8.1']
2. If requirement hosted on GitHub:
   • Point at a zip archive of a release tag or commit SHA.
   • Add version found in zip-archive as hash to URL.

REQUIREMENTS = [
    'http://github.com/technicalpickles/python-nest'
    '/archive/e6c9d56a8df455d4d7746389811f2c1387e8cb33.zip'
    '#python-nest==3.0.3']

{% linkable_title Configuration %}

1. Voluptuous schema present for config validation
2. Default parameters specified in voluptuous schema, not in setup_platform(…)
3. Schema using as many generic config keys as possible from homeassistant.const
4. If having platforms, have a PLATFORM_SCHEMA, otherwise CONFIG_SCHEMA.
5. If PLATFORM_SCHEMA, import base from homeassistant.helpers.config_validation

{% linkable_title 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 it's related platform entities to update, you can notify them using the dispatcher code in homeassistant.helpers.dispatcher.