+ + Checklist for Creating a Component +
++ + +
A checklist of things to do when you’re adding a new component.
+ +Requirements
+ +-
+
- Requirement version pinned:
REQUIREMENTS = ['phue==0.8.1']
+ - 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']
+Configuration
+ +-
+
- Volutpuous schema present for config validation +
- Default parameters specified in voluptuous schema, not in
setup_platform(…)
+ - Schema using as many generic config keys as possible from
homeassistant.const
+ - If having platforms, have a
PLATFORM_SCHEMA, otherwiseCONFIG_SCHEMA.
+ - If
PLATFORM_SCHEMA, import base fromhomeassistant.helpers.config_validation
+
Component/platform communication
+ +-
+
- If you need to share global data with platforms, use the dictionary
hass.data.
+ - If the component fetches data that causes related platform entities to update, +