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

More tweaks to developer docs

Browse source
This commit is contained in:
Paulus Schoutsen 2016-04-16 23:00:45 -07:00
parent c5bc6c0cfb
commit d8c8cf4c8d
13 changed files with 272 additions and 149 deletions
Download patch file Download diff file Expand all files Collapse all files

26
source/developers/component_deps_and_reqs.markdown Normal file
View file

@ -0,0 +1,26 @@
---
layout: page
title: "Requirements & Dependencies"
description: "Instructions how to define requirements and dependencies."
date: 2016-04-16 13:32
sidebar: true
comments: false
sharing: true
footer: true
---
Home Assistant allows components and platforms to specify their dependencies and requirements using the variables `DEPENDENCIES` and `REQUIREMENTS`. Both are lists that contain strings.
Dependencies are other Home Assistant components that should be setup before the platform is loaded. An example is the MQTT sensor component, which requires an active connection to an MQTT broker. If Home Assistant is unable to load and setup the MQTT component, it will not setup the MQTT sensor component.
```python
DEPENDENCIES = ['mqtt']
```
Requirements are Python libraries that you would normally install using `pip`. If Home Assistant is unable to install the requirements or verify it is installed, the component will fail to load.
Requirements is a list of strings. Each entry is a pip compatible string. For example, the media player Cast platform depends on the Python package PyChromecast v0.6.12:
```python
REQUIREMENTS = ['pychromecast==0.6.12']
```