jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-23 01:06:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename ClimateDevice to ClimateEntity (#475)

Browse Source
This commit is contained in:
Erik Montnemery 2020-04-26 21:53:13 +02:00 committed by GitHub
parent 4bdcabf241
commit 2486f366cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/entity_climate.md
View File

@ -3,7 +3,7 @@ title: Climate Entity
sidebar_label: Climate
---
A climate entity is a device that controls temperature, humidity, or fans, such as A/C systems and humidifiers. Derive entity platforms from [`homeassistant.components.climate.ClimateDevice`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/climate/__init__.py)
A climate entity controls temperature, humidity, or fans, such as A/C systems and humidifiers. Derive a platform entity from [`homeassistant.components.climate.ClimateEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/climate/__init__.py)
## Properties
@ -124,7 +124,7 @@ Supported features constants are combined using the bitwise or (`|`) operator.
### Set hvac mode
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_hvac_mode(self, hvac_mode):
@ -137,7 +137,7 @@ class MyClimateDevice(ClimateDevice):
### Set preset mode
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_preset_mode(self, preset_mode):
@ -150,7 +150,7 @@ class MyClimateDevice(ClimateDevice):
### Set fan mode
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_fan_mode(self, fan_mode):
@ -163,7 +163,7 @@ class MyClimateDevice(ClimateDevice):
### Set humidity
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_humidity(self, humidity):
@ -176,7 +176,7 @@ class MyClimateDevice(ClimateDevice):
### Set swing mode
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_swing_mode(self, swing_mode):
@ -189,7 +189,7 @@ class MyClimateDevice(ClimateDevice):
### Set temperature
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def set_temperature(self, **kwargs):
@ -202,7 +202,7 @@ class MyClimateDevice(ClimateDevice):
### Control auxiliary heater
```python
class MyClimateDevice(ClimateDevice):
class MyClimateEntity(ClimateEntity):
# Implement one of these methods.
def turn_aux_heat_on(self):