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

Move content from CONTRIBUTING.md

Browse source
This commit is contained in:
Fabian Affolter 2016-07-02 00:09:50 +02:00
parent 579f2390a7
commit d8f1e22c64
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
2 changed files with 43 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
source/developers/component_states.markdown Normal file
View file

@ -0,0 +1,22 @@
---
layout: page
title: "Handling states"
description: "Instructions how to handle states with your component."
date: 2016-07-01 20:00
sidebar: true
comments: false
sharing: true
footer: true
---
It is the responsibility of the component to maintain the states of the devices in your domain. Each device should be a single state and, if possible, a group should be provided that tracks the combined state of the devices.
A state can have several attributes that will help the frontend in displaying your state:
- `friendly_name`: this name will be used as the name of the device
- `entity_picture`: this picture will be shown instead of the domain icon
- `unit_of_measurement`: this will be appended to the state in the interface
- `hidden`: This is a suggestion to the frontend on if the state should be hidden
These attributes are defined in [homeassistant.helpers.entity](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/entity.py#L180).