mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 10:38:58 +00:00
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "Example sensor platform"
|
|
description: "Minimum implementation of a Home Assistant platform."
|
|
date: 2016-04-16 14:24 -07:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
This is a minimum implementation of a platform for the sensor component.
|
|
|
|
### {% linkable_title Installation %}
|
|
|
|
Copy the code below and create it as a file in `<config_dir>/custom_components/sensor/example.py`.
|
|
|
|
Add the following to your configuration.yaml:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
platform: example
|
|
```
|
|
|
|
### {% linkable_title Code %}
|
|
|
|
```python
|
|
from homeassistant.const import TEMP_CELSIUS
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Setup the sensor platform."""
|
|
add_devices([ExampleSensor()])
|
|
|
|
|
|
class ExampleSensor(Entity):
|
|
"""Representation of a Sensor."""
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return 'Example Temperature'
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return 23
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement."""
|
|
return TEMP_CELSIUS
|
|
```
|