jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8891 from home-assistant/components-improvements

Browse Source 
Components page improvements
This commit is contained in:
Robbie Trencheny 2019-03-10 00:54:17 -08:00 committed by GitHub
commit 54c7862783
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
152 changed files with 304 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Rakefile
View File

@ -92,7 +92,7 @@ task :preview, :listen do |t, args|
raise "### You haven't set anything up yet. First run `rake install` to set up an Octopress theme." unless File.directory?(source_dir)
puts "Starting to watch source with Jekyll and Compass. Starting Rack on port #{server_port}"
system "compass compile --css-dir #{source_dir}/stylesheets" unless File.exist?("#{source_dir}/stylesheets/screen.css")
jekyllPid = Process.spawn({"OCTOPRESS_ENV"=>"preview"}, "jekyll build --watch --incremental")
jekyllPid = Process.spawn({"OCTOPRESS_ENV"=>"preview"}, "jekyll build -t --watch --incremental")
compassPid = Process.spawn("compass watch")
rackupPid = Process.spawn("rackup --port #{server_port} --host #{listen_addr}")

57
plugins/filters.rb
View File

@ -70,6 +70,63 @@ module Jekyll
def canonical_url(input)
full_url(input).sub(/index\.\w+$/i, '')
end
# Sort an array of semvers
def group_components_by_release(input)
input.group_by { |v|
raise ArgumentError, "ha_release must be set in #{v.basename}" if v["ha_release"].nil?
release_str = v["ha_release"].to_s
if release_str == "pre 0.7"
release_str = "0.7"
end
release_str
}.map{ |v|
version = v[0]
begin
gem_ver = Gem::Version.new(version).to_s
rescue
raise ArgumentError, "Error when parsing ha_release #{version} in #{v.path}."
end
{ "label" => version, "new_components_count" => v[1].count, "sort_key" => gem_ver }
}.sort_by { |v| v["sort_key"] }.reverse.group_by { |v|
version = v["label"]
split_ver = version.split('.')
major = split_ver[0]
minor = split_ver[1]
if minor.length == 1
"#{major}.X"
else
"#{major}.#{minor[0]}X"
end
}.map { |v|
sort_key = v[1][-1]["sort_key"]
if v[0] == "0.X"
sort_key = "0.01" # Ensure 0.X is always sorted at bottom.
end
total_new_components = 0
v[1].each do |vers|
total_new_components += vers["new_components_count"]
end
{ "label" => v[0], "versions" => v[1], "new_components_count" => total_new_components, "sort_key" => sort_key }
}.sort_by { |v| v["sort_key"] }.reverse
end
# Get version N behind current
# input is output of group_components_by_release
def version_behind(input, n)
input.each do |group|
if group["versions"].length > n
return group["versions"][n]
end
end
end
end
end

28
sass/custom/_component_page.scss
View File

@ -1,11 +1,11 @@
#components-page{
.component-search{
margin-bottom: 24px;
input{
width: 100%;
padding: 10px;
background-color: #fefefe;
border-radius: 2px;
border: 1px solid;
@ -50,12 +50,12 @@
margin: 12px 0;
}
.added_in_current_version {
margin-top: 12px;
.version_select {
margin: 12px 0 12px 0;
}
.added_two_versions_ago {
margin-bottom: 12px;
.version_select > select {
width: 100%;
}
.btn {
@ -76,18 +76,18 @@
// styles for the cards
.hass-option-cards {
display: -ms-flexbox;
display: -webkit-box;
display: -webkit-flexbox;
display: -ms-flexbox;
display: -webkit-box;
display: -webkit-flexbox;
display: -webkit-flex;
display: flex;
display: flex;
flex-direction: row;
flex-wrap: wrap;
justify-content: flex-start;
align-items: flex-start;
margin: -4px; // grid trick, has to match option-card's margin
p.note{
width: 100%;
}
@ -139,7 +139,7 @@
color: #AAA;
}
}
// fade-in animation
&.show-items .option-card{
opacity:0;
@ -147,7 +147,7 @@
-o-animation:new-item-animation .2s linear forwards;
animation:new-item-animation .2s linear forwards;
}
// fade-out animation
&.remove-items .option-card{
-webkit-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards;

1
source/_components/air_quality.markdown
View File

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
redirect_from: /components/air_pollutants/
ha_release: 0.85
---
The `air_quality` gather information about the air quality and pollution details.

1
source/_components/alarm_control_panel.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.7.3
---
Home Assistant can give you an interface with is similar to a classic alarm system. There are several panels supported:

2
source/_components/alexa.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: amazon-echo.png
ha_category: Voice
featured: true
ha_release: '0.10'
ha_release: "0.10"
---
## {% linkable_title Automatic setup via Home Assistant Cloud %}

2
source/_components/ambient_station.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
logo: ambient_weather.png
ha_category: Weather
ha_release: "0.85"
ha_release: 0.85
ha_iot_class: "Cloud Push"
redirect_from:
- /components/sensor.ambient_station/

1
source/_components/api.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: "Other"
ha_qa_scale: internal
ha_release: 0.7
---
The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/).

4
source/_components/august.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Binary Sensor
- Camera
- Lock
ha_release: "0.64"
ha_release: 0.64
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.august/
@ -84,4 +84,4 @@ If you have August Smart Lock with DoorSense, once you have enabled the August c
### {% linkable_title Camera %}
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.

1
source/_components/automation.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Automation
ha_qa_scale: internal
ha_release: 0.7
---
Please see the [docs section](/docs/automation/) for in-depth

2
source/_components/axis.markdown
View File

@ -11,7 +11,7 @@ logo: axis.png
ha_category:
- Camera
- Binary Sensor
ha_release: "0.45"
ha_release: 0.45
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.axis/

1
source/_components/binary_sensor.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.9
---
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.

2
source/_components/binary_sensor.raincloud.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: raincloud.jpg
ha_category: Irrigation
ha_release: "0.55"
ha_release: 0.55
ha_iot_class: "Cloud Polling"
---

2
source/_components/binary_sensor.rflink.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: rflink.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.81"
ha_release: 0.81
---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).

1
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: rfxtrx.png
ha_category: Binary Sensor
ha_release: 0.48
---
The `rfxtrx` platform support binary sensors that

2
source/_components/binary_sensor.uptimerobot.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: uptimerobot.png
ha_category: System Monitor
ha_release: "0.72"
ha_release: 0.72
ha_iot_class: "Cloud Polling"
---

1
source/_components/browser.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Utility
ha_qa_scale: internal
ha_release: pre 0.7
---
The `browser` component provides a service to open URLs in the default browser on the host machine.

1
source/_components/calendar.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.33
---
The calendar component allows you to integrate your calendars into Home Assistant.

1
source/_components/camera.foscam.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: foscam.png
ha_category: Camera
ha_iot_class: "Local Polling"
ha_release: 0.7.3
---
The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.

1
source/_components/camera.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.7
---
The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use [USB cameras](/blog/2016/06/23/usb-webcams-and-home-assistant/) as well.

1
source/_components/climate.eq3btsmart.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: eq3.gif
ha_category: Climate
ha_iot_class: "Local Polling"
ha_release: 0.18
---
The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats.

1
source/_components/climate.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.19
---

1
source/_components/climate.radiotherm.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: radiotherm.png
ha_category: Climate
ha_iot_class: "Local Polling"
ha_release: 0.7.6
---

2
source/_components/climate.zhong_hong.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: zhong_hong.png
ha_category: Climate
ha_release: "0.72"
ha_release: 0.72
ha_iot_class: "Local Push"
---

2
source/_components/comfoconnect.markdown
View File

@ -11,7 +11,7 @@ logo: zehnder.png
ha_category:
- Fan
- Sensor
ha_release: "0.48"
ha_release: 0.48
redirect_from:
- /components/fan.comfoconnect/
- /components/sensor.comfoconnect/

1
source/_components/configurator.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Other
ha_qa_scale: internal
ha_release: 0.7
---
<p class='note'>

1
source/_components/conversation.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: "Voice"
ha_qa_scale: internal
ha_release: 0.7
---
The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.

1
source/_components/cover.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.27
---
Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors.

2
source/_components/danfoss_air.markdown
View File

@ -11,7 +11,7 @@ ha_category:
- Climate
- Binary Sensor
- Sensor
ha_release: "0.87"
ha_release: 0.87
logo: danfoss_air.png
ha_iot_class: "Local Polling"
redirect_from:

2
source/_components/deconz.markdown
View File

@ -16,7 +16,7 @@ ha_category:
- Scene
- Sensor
- Switch
ha_release: "0.61"
ha_release: 0.61
ha_iot_class: "Local Push"
ha_qa_scale: platinum
ha_config_flow: true

1
source/_components/demo.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Other
ha_qa_scale: internal
ha_release: 0.7
---

1
source/_components/device_sun_light_trigger.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Automation
ha_qa_scale: internal
ha_release: pre 0.7
---
Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will:

1
source/_components/device_tracker.actiontec.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: actiontec.png
ha_category: Presence Detection
ha_release: 0.7
---

2
source/_components/device_tracker.bbox.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: bbox.png
ha_category: Presence Detection
ha_release: "0.31"
ha_release: 0.31
ha_iot_class: "Local Polling"
---

1
source/_components/device_tracker.bt_home_hub_5.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: bt.png
ha_category: Presence Detection
ha_release: 0.22
---
This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router.

4
source/_components/device_tracker.bt_smarthub.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: bt.png
ha_category: Presence Detection
ha_release: "0.82"
ha_release: 0.82
ha_iot_class: "Local Polling"
---
@ -28,7 +28,7 @@ device_tracker:
{% configuration %}
host:
description: The IP address of your router
description: The IP address of your router
default: 192.168.1.254
required: false
type: string

1
source/_components/device_tracker.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.7
---
Home Assistant can get information from your wireless router or third party services like iCloud or OwnTracks to track which devices are connected and considered "in home". Please check the sidebar for a list of brands of supported wireless routers and services.

1
source/_components/device_tracker.mqtt.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: mqtt.png
ha_category: Presence Detection
ha_iot_class: depends
ha_release: 0.7.3
---

2
source/_components/device_tracker.mysensors.markdown
View File

@ -11,7 +11,7 @@ logo: mysensors.png
ha_category:
- DIY
- Presence Detection
ha_release: "0.38"
ha_release: 0.38
ha_iot_class: "Local Push"
---

1
source/_components/device_tracker.nmap_tracker.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: nmap.png
ha_category: Presence Detection
featured: false
ha_release: 0.7
---

1
source/_components/device_tracker.thomson.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: technicolor.png
ha_category: Presence Detection
ha_release: 0.7
---

37
source/_components/discoverable.markdown
View File

@ -1,37 +0,0 @@
---
layout: page
title: "Discoverable"
description: "Instructions on how to setup the discoverable component with Home Assistant."
date: 2016-03-01 07:00
sidebar: true
comments: false
sharing: true
footer: true
---
The Home Assistant discovery protocol is a lightweight feature that introduces support for Home Assistant servers to be discoverable. This will allow [Home Assistant instances](https://github.com/balloob/micropython-home-assistant) running with [MicroPython](https://micropython.org/) to get started without any required configuration (Example from the [MicroPython Home Assistant](https://github.com/balloob/micropython-home-assistant) documentation):
```python
from homeassistant.discovery import get_instance()
hass = get_instance()
for state in hass.states():
print(state)
```
To enable `discovery` in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
discoverable:
expose_password: true
```
{% configuration %}
expose_password:
description: It is up to the user to expose the password in the discovery response. If password not exposed, uHA instances will have to provide it (`get_instance('my password')`).
required: false
default: false
type: boolean
{% endconfiguration %}

1
source/_components/discovery.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Other
ha_qa_scale: internal
ha_release: 0.7
---
Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect:

4
source/_components/doorbird.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- Doorbell
- Camera
- Switch
ha_release: "0.54"
ha_release: 0.54
ha_iot_class: "Local Push"
redirect_from:
- /components/camera.doorbird/
@ -173,4 +173,4 @@ To enable this switch, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
switch:
- platform: doorbird
```
```

2
source/_components/ebusd.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: "0.88"
ha_release: 0.88
redirect_from:
- /components/sensor.ebusd/
---

2
source/_components/edp_redy.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- Hub
- Sensor
- Switch
ha_release: "0.79"
ha_release: 0.79
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/sensor.edp_redy/

2
source/_components/eight_sleep.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- Health
- Binary Sensor
- Sensor
ha_release: "0.44"
ha_release: 0.44
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.eight_sleep/

22
source/_components/emulated_roku.markdown
View File

@ -9,24 +9,24 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Hub
ha_release: 0.86.0
ha_release: 0.86
ha_iot_class: "Local Push"
---
This component integrates an emulated Roku API into Home Assistant,
so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player.
Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations.
Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries.
This component integrates an emulated Roku API into Home Assistant,
so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player.
Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations.
Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries.
<p class='note'>
<p class='note'>
Windows is not supported because Home Assistant uses `ProactorEventLoop` which does not support UDP sockets.
</p>
</p>
<p class='note warning'>
<p class='note warning'>
This component opens an unauthenticated API on the host, allowing anything on the local network to access
your Home Assistant instance through the automations you create with emulated Roku as the trigger.
Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)
</p>
</p>
## {% linkable_title Configuration %}
@ -83,7 +83,7 @@ Field | Description
`source_name` | Name of the emulated Roku instance that sent the event. Only required when using multiple instances to filter event sources.
`type` | The type of the event that was called on the API.
`key` | the code of the pressed key when the command `type` is `keypress`, `keyup` or `keydown`.
`app_id` | the id of the app that was launched when command `type` is `launch`.
`app_id` | the id of the app that was launched when command `type` is `launch`.
The available keys are listed here:
[Roku key codes](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues)
@ -120,6 +120,6 @@ Known limitations:
* Harmony uses UPnP discovery (UPnP is not needed after pairing), which might not work in Docker. You can:
* Change Docker to host networking temporarily, then revert after pairing.
* Run the `advertise.py` helper script from the emulated_roku library directly somewhere else and point it to the emulated Roku API.
* Harmony cannot launch apps as it uses IR instead of the WiFi API and will not display the custom dummy app list.
* Harmony cannot launch apps as it uses IR instead of the WiFi API and will not display the custom dummy app list.
* Home control buttons cannot be assigned to emulated Roku on the Harmony Hub Companion remote as they are limited to Hue (and possibly other APIs) within Harmony.
* Harmony will not set the name of the added emulated Roku device to the specified `name`.

1
source/_components/fan.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.27
---

1
source/_components/ffmpeg.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: ffmpeg.png
ha_category: Image Processing
ha_release: 0.29
---
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update.

2
source/_components/fibaro.markdown
View File

@ -16,7 +16,7 @@ ha_category:
- Sensor
- Scene
- Switch
ha_release: "0.83"
ha_release: 0.83
ha_iot_class: "Local Push"
redirect_from:
- /components/scene.fibaro/

2
source/_components/freebox.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- Network
- Presence Detection
- Sensor
ha_release: "0.85"
ha_release: 0.85
ha_iot_class: "Local Polling"
redirect_from:
- /components/device_tracker.freebox/

1
source/_components/frontend.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: "Other"
ha_qa_scale: internal
ha_release: 0.7
---
This offers the official frontend to control Home Assistant.

2
source/_components/geo_location.geo_json_events.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: geo_location.png
ha_category: Geolocation
ha_iot_class: "Cloud Polling"
ha_release: "0.79"
ha_release: 0.79
---
The `geo_json_events` platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location.

2
source/_components/geo_location.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: geo_location.png
ha_release: "0.78"
ha_release: 0.78
---
Geolocation aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes.

2
source/_components/geo_location.nsw_rural_fire_service_feed.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: nsw-rural-fire-service.png
ha_category: Geolocation
ha_iot_class: "Cloud Polling"
ha_release: "0.81"
ha_release: 0.81
---
The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location.

1
source/_components/group.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Organization
ha_qa_scale: internal
ha_release: pre 0.7
---
Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting `view: true` under the group definition. This will make the group available as a new tab in the frontend.

1
source/_components/habitica.markdown
View File

@ -15,6 +15,7 @@ ha_version: 0.78
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/sensor.habitica/
ha_release: 0.78
---
This component allows you to monitor and manage your Habitica profile. This component exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant.

8
source/_components/harmony.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: logitech.png
ha_category: Remote
ha_iot_class: "Local Push"
ha_release: "0.34"
ha_release: 0.34
redirect_from:
- /components/remote.harmony/
---
@ -41,7 +41,7 @@ You can override some default configuration values on a discovered hub (e.g., th
```yaml
# Example configuration.yaml entry with discovery
- platform: harmony
name: Living Room
name: Living Room
activity: Watch TV
```
@ -154,7 +154,7 @@ In the file 'harmony_REMOTENAME.conf' you can find the available devices and com
"Mute"
],
"id": "428297615"
}
}
}
}
```
@ -186,7 +186,7 @@ data:
### {% linkable_title Service `remote.harmony_change_channel` %}
Sends the change channel command to the Harmony HUB
Sends the change channel command to the Harmony HUB
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |

6
source/_components/history_graph.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
ha_category: History
logo: home-assistant.png
ha_release: "0.55"
ha_release: 0.55
ha_qa_scale: internal
---
@ -27,7 +27,7 @@ history_graph:
gr1:
entities:
- light.ceiling.lights
```
{% configuration %}
@ -40,7 +40,7 @@ name:
required: false
default: ID
type: string
hours_to_show:
hours_to_show:
description: Number of hours to show in the graph.
required: false
default: 24

1
source/_components/http.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: http.png
ha_category: "Other"
ha_release: pre 0.7
---
The `http` component serves all files and data required for the Home Assistant

1
source/_components/ifttt.markdown
View File

@ -11,6 +11,7 @@ logo: ifttt.png
ha_category: Automation
featured: true
ha_iot_class: "Cloud Push"
ha_release: 0.80
---
[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel).

6
source/_components/ihc.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: ihc.png
ha_category: Hub
ha_release: "0.62"
ha_release: 0.62
ha_iot_class: "Local Push"
---
@ -26,11 +26,11 @@ ihc:
- url: 'http://192.168.1.3'
username: YOUR_USERNAME
password: YOUR_PASSWORD
info: true
info: true
- url: 'http://192.168.1.4'
username: YOUR_USERNAME2
password: YOUR_PASSWORD2
info: true
info: true
```
{% configuration %}

1
source/_components/input_boolean.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Automation
ha_qa_scale: internal
ha_release: 0.11
---
The `input_boolean` component allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations.

1
source/_components/insteon.markdown
View File

@ -25,6 +25,7 @@ redirect_from:
- /components/light.insteon/
- /components/sensor.insteon/
- /components/switch.insteon/
ha_release: 0.39
---
This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant.

1
source/_components/introduction.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Other
ha_qa_scale: internal
ha_release: 0.7
---
The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up.

2
source/_components/joaoapps_join.markdown
View File

@ -11,7 +11,7 @@ logo: joaoapps_join.png
ha_category:
- Hub
- Notifications
ha_release: "0.24"
ha_release: 0.24
redirect_from:
- /components/notify.joaoapps_join/
---

1
source/_components/light.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: pre 0.7
---
This component allows you to track and control various light bulbs. Read the platform documentation for your particular light hardware to learn how to enable it.

1
source/_components/light.mqtt.markdown
View File

@ -13,6 +13,7 @@ ha_iot_class: depends
redirect_from:
- /components/light.mqtt_json/
- /components/light.mqtt_template/
ha_release: 0.8
---
The `mqtt` light platform with lets you control your MQTT enabled lights through one of the supported message schemas.

2
source/_components/lock.lockitron.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: lockitron.png
ha_category: Lock
ha_iot_class: "Cloud Polling"
ha_release: "0.42"
ha_release: 0.42
---
The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant.

1
source/_components/lock.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.9
---
Keeps track which locks are in your environment, their state and allows you to control them.

2
source/_components/lock.sesame.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: sesame.png
ha_category: Lock
ha_iot_class: "Cloud Polling"
ha_release: "0.47"
ha_release: 0.47
---
The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.

2
source/_components/lock.xiaomi_aqara.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: xiaomi.png
ha_category: Lock
ha_release: "0.71"
ha_release: 0.71
ha_iot_class: "Local Push"
---

1
source/_components/logbook.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: logbook.png
ha_category: "History"
ha_release: 0.7
---
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />

1
source/_components/logentries.markdown
View File

@ -9,6 +9,7 @@ sharing: true
logo: logentries.png
footer: true
ha_category: "History"
ha_release: 0.13
---
The `logentries` component makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint.

1
source/_components/logger.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: "Utility"
ha_qa_scale: internal
ha_release: 0.8
---
The `logger` component lets you define the level of logging activities in Home

1
source/_components/map.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: "Other"
ha_qa_scale: internal
ha_release: 0.56
---
This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/components/device_tracker/) documentation.

2
source/_components/media_player.channels.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: channels.png
ha_category: Media Player
ha_release: 0.65.0
ha_release: 0.65
ha_iot_class: "Local Polling"
---

2
source/_components/media_player.clementine.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: clementine.png
ha_category: Media Player
ha_iot_class: "Local Poll"
ha_release: "0.39"
ha_release: 0.39
ha_iot_class: "Local Polling"
---

1
source/_components/media_player.cmus.markdown
View File

@ -10,6 +10,7 @@ sharing: true
footer: true
ha_category: Media Player
ha_iot_class: "Local Polling"
ha_release: 0.23
---

2
source/_components/media_player.emby.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: emby.png
ha_category: Media Player
ha_release: "0.32"
ha_release: 0.32
ha_iot_class: "Local Push"
---

4
source/_components/media_player.harman_kardon_avr.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: harman_kardon.png
ha_category: Media Player
ha_iot_class: "Local Polling"
ha_release: 0.85.0
ha_release: 0.85
---
The `harman_kardon_avr` platform allows you to control Harman Kardon Network Receivers from Home Assistant.
@ -49,4 +49,4 @@ port:
A few notes:
- The newest firmware automatically shuts down the AVR after a certain amount of time. The AVR is then not available on the network anymore, so the 'on' command will not work.
- The AVR has no endpoints to determine the volume, muted, playing etc., so if the remote control is used, HA will not know the new states of the device.
- The AVR has no endpoints to determine the volume, muted, playing etc., so if the remote control is used, HA will not know the new states of the device.

1
source/_components/media_player.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.7
---
Interacts with media players on your network. Please check the right sidebar for a full list of supported devices.

4
source/_components/media_player.mediaroom.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mediaroom.png
ha_category: Media Player
ha_iot_class: "Local Polling"
ha_release: "0.63"
ha_release: 0.63
---
The `mediaroom` component allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant.
@ -47,7 +47,7 @@ Notice that all parameters are optional, and discovery should configure everythi
The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082.
In most cases (single STB) you just need to setup the *platform* and discovery will do the rest.
In most cases (single STB) you just need to setup the *platform* and discovery will do the rest.
If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable.

4
source/_components/media_player.soundtouch.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: soundtouch.png
ha_category: Media Player
ha_release: 0.34.0
ha_release: 0.34
ha_iot_class: "Local Polling"
---
@ -54,7 +54,7 @@ name:
default: Bose Soundtouch
type: string
port:
description: The port number.
description: The port number.
required: false
default: 8090
type: integer

1
source/_components/media_player.universal.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Media Player
ha_qa_scale: internal
ha_release: 0.11
---
Universal Media Players combine multiple existing entities in Home Assistant into one media player entity. This is used for creating a single entity that controls an entire media center.

2
source/_components/microsoft_face.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: microsoft.png
ha_category: Image Processing
ha_release: "0.37"
ha_release: 0.37
---
The `microsoft_face` component platform is the main component for Microsoft

1
source/_components/mysensors.markdown
View File

@ -11,6 +11,7 @@ logo: mysensors.png
ha_category: DIY
featured: false
ha_iot_class: "Local Push"
ha_release: 0.73
---
The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified.

1
source/_components/nest.markdown
View File

@ -21,6 +21,7 @@ redirect_from:
- /components/camera.nest/
- /components/climate.nest/
- /components/sensor.nest/
ha_release: 0.7
---
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.

2
source/_components/notify.hipchat.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: hipchat.png
ha_category: Notifications
ha_release: "0.52"
ha_release: 0.52
---
<p class='note'>

1
source/_components/notify.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.7
---
The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported.

2
source/_components/notify.mycroft.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: mycroft.png
ha_category: Notifications
ha_release: "0.53"
ha_release: 0.53
---
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).

1
source/_components/notify.pushbullet.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: pushbullet.png
ha_category: Notifications
featured: true
ha_release: 0.7
---
The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends.

1
source/_components/notify.sendgrid.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: sendgrid.png
ha_category: Notifications
ha_release: 0.14
---
The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.

4
source/_components/owlet.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: owlet.svg
ha_category:
ha_category:
- Health
- Binary Sensor
- Sensor
ha_release: "0.89"
ha_release: 0.89
ha_iot_class: "Cloud Polling"
---

4
source/_components/point.markdown
View File

@ -14,7 +14,7 @@ ha_category:
- Binary Sensor
- Sensor
featured: false
ha_release: "0.83"
ha_release: 0.83
ha_config_flow: true
ha_iot_class: "Cloud Polling"
ha_qa_scale: gold
@ -61,7 +61,7 @@ The integration supports the following device types within Home Assistant:
- [Sensor](#sensor)
<p class='note'>
The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.
The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.
</p>
## {% linkable_title Alarm %}

2
source/_components/remote.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_release: "0.34"
ha_release: 0.34
---
Keeps track which remotes are in your environment, their state and allows you to control them.

2
source/_components/route53.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: route53.png
ha_category: Network
ha_release: "0.81"
ha_release: 0.81
---
With the `route53` component can you keep your AWS Route53 DNS records up to date.

2
source/_components/scene.knx.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: knx.png
ha_category: Scene
ha_release: "0.63"
ha_release: 0.63
---
The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes.

1
source/_components/scene.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Organization
ha_qa_scale: internal
ha_release: 0.15
---
You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red.

Some files were not shown because too many files have changed in this diff Show More