From 269ee7a967bfa6b87a5f6c52f411bc8f50e702f2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 30 Aug 2015 23:51:01 +0200 Subject: [PATCH 1/2] new layout --- source/components/index.markdown | 400 ++++++++++++++++++------------- 1 file changed, 237 insertions(+), 163 deletions(-) diff --git a/source/components/index.markdown b/source/components/index.markdown index 6ee4d4426eb..ac59c33b278 100644 --- a/source/components/index.markdown +++ b/source/components/index.markdown @@ -10,209 +10,265 @@ footer: true is_homepage: true --- -Components add support for devices, automation and much much more to Home Assistant. The following things are supported out-of-the-box. +Components add support for devices, automation, and much much more to Home Assistant. The following things are supported out-of-the-box. ## {% linkable_title Entities %} -Entities are things that you want to observe within Home Assistant. Support for these things are provided by the entity components [Light](/components/light.html), [Switch](/components/switch.html), [Thermostat](/components/thermostat.html), [Media player](/components/media_player.html), [Device tracker](/components/device_tracker.html), [Sun](/components/sun.html). +Entities are things that you want to observe within Home Assistant. Support for these things are provided by the entity components [Light](/components/light.html), [Switch](/components/switch.html), [Thermostat](/components/thermostat.html), [Media player](/components/media_player.html), [Device tracker](/components/device_tracker.html), and [Sun](/components/sun.html). + + + +
+
+
+
+ +
+

Light and environment

+

- - - - - - - - - - - - - - - - - - + - - + - - + - - - - - - - - + - - + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
Philips HueTurn lights on, control brightness and color.
SABnzbd clientsMonitor queue and download speeds.
System MonitorTrack CPU, memory and disk usage on the host machine.Philips Hue turns lights on, controls brightness, and color.
Nest thermostatsSee current temperature and control target temperature and away mode.Nest thermostats displays current temperature and control target temperature/away mode.
Heat ControlTurn home Assistant into your own thermostat by reading a temperature sensor and controlling a switch connected to a heater.Heat Control reads a temperature sensor and control a heater switch.
WeMo switchesControl WeMo switches and read the usage statistics from Insight switches.
MySensorsIntegrate MySensors sensors.WeMo switches controls and reads the usage statistics from Insight switches.
TEMPer sensorsIntegrate TEMPer sensors to get the current temperature.TEMPer sensors reads the current temperature.
LimitlessLED controls your LimitlessLED lights.
Edimax switches controls the state.
Efergy Engage hubs monitors home energy use.
DHTxx reads the temperature and humidity.
+
+
+
+ +
+
+ +
+

Devices

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MySensors integrates MySensors sensors.
Raspberry PI switch controls and sensor reads the values of GPIOs.
Insteon controls devices connected with the ISY994 controller.
X10 controls devices connected with the ISY994 controller.
Arduino controls digital pins and read from analog pins.
RFXtrx sensors monitors values from RFXtrx sensors.
+ +
+
+
+
+
+ + + +
+
+
+
+ +
+

Presence detection

+

Offers presence detection by looking at connected devices or by scanning the network.

+ + + + - - - - - - + + + + + - - - - - - +
Actiontec routers
ASUSWRT routersOffers presence detection by looking at connected devices.
DD-WRT routersOffers presence detection by looking at connected devices.
OpenWRT routersOffers presence detection by looking at connected devices.
Netgear routersOffers presence detection by looking at connected devices.
Tomato routersOffers presence detection by looking at connected devices.
TP-Link routersOffers presence detection by looking at connected devices.
Thomson routers
NMap network scanningOffers presence detection by scanning the network for connected devices.
- Transmission sensor
- Transmission switch - 		Monitor status and download speeds. Change the speed limits.
+ +
+
+
+ +
+
+ +
+

Media player

+

Controls your media player (Playback and Volume) and get details about the played track.

+ + - - - - - + - - - - - +
Google Cast devicesTrack what is being played and control playback (temporarely disabled awaiting protobuf 3 release).
KodiTrack what is being played and control playback.
Music Player Daemon (MPD)Track what is being played and control playback.
SqueezeboxTrack what is being played and control playback.Logitech Squeezebox
Command line SwitchSwitch that issues command line commands when turned on and off.
- - - LimitlessLED - Control your LimitlessLED lights. - +
+
+
+ +
+
+
+

Cameras and various other entities

+

Camera allows you to see what going in real-time. Other entities report the current state and/or let you control it.

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + + + + + + + + + + + + + + + + + + + +
HikvisionControl the motion detection setting on your Hikvision camera.
Edimax switchesControl the state of your Edimax switches.
Raspberry PI GPIOControl the GPIO of a Raspberry Pi.
Insteon DevicesInsteon devices can be controlled with the ISY994 controller.
X10 DevicesX10 devices can be controlled with the ISY994 controller.
Arduino boardsControls your Arduino's digital pins and read from the analog pins.
Efergy Engage hubsMonitors home energy use as measured by an Efergy engage hub.
RFXtrx sensorsMonitors values from RFXtrx sensors.Hikvision controls the motion detection setting.
Generic IP camerasIntegrate any IP camera or image url into a camera feed.IP camera integrates a generic IP camera or image url.
SABnzbd clients monitors queue and download speeds.
System Monitor tracks CPU, memory, and disk usage on the host machine.
+ Transmission monitors status/speeds and changes the speed limits. +
Command line issues command line commands.
+
+
+
+
+
+

Support for these devices is provided by the Home Assistant community and not the manufacturers of these devices. @@ -233,10 +289,8 @@ Home Assistant integrates with a variety of third party Home Automation hubs and [Vera](/components/vera.html) [Wink](/components/wink.html) [ISY994](/components/isy994.html) - [Modbus](/components/modbus.html) [Arduino](/components/arduino.html) -[Verisure](/components/verisure.html)

Support for these devices is provided by the Home Assistant community and not @@ -245,140 +299,160 @@ the manufacturers of these devices. ## {% linkable_title Services %} + +

+
+
+
+ +
+

Internals

+

Those services offers you a wide range of possibilities out-of-box.

+ - - + - - + - - + - - + + + + + + + + + + + + + + + + + + + + + +
HistoryTrack the state of entities and allow users to browse through history.History track the state of entities and allow users to browse through.
ConversationProcess textual commands like ones received by speech-to-text engines.Conversation process textual commands like ones received by speech-to-text engines.
DiscoveryScans the network for supported devices.Discovery scans the network for supported devices.
LogbookProvides a logbook-style view on the Entity history.Logbook provides a logbook-style view on the Entity history.
Browser opens URLs on the host machine.
Downloader allows downloading URLs to the host machine.
Keyboard simulate key presses on the host machine.
Time & Date displays the time and the date.
+ +
+
+
+ +
+
+ +
+

Notifications

+

Allows you to send customized messages to the given service.

+ + + - - - - - - - - - - - - - - +
FileAllow sending messages to a file.
Notify My Android (NMA)Allow sending messages using Notify My Android (NMA).
InstapushAllow sending messages using Instapush.
PushBulletAllow sending messages using PushBullet.
PushOverAllow sending messages using PushOver.
SlackAllow sending messages over Slack.
E-MailAllow sending e-mail messages.
SyslogAllow sending messages to a local syslog.
Jabber (XMPP)Allow sending messages using Jabber (XMPP).
BrowserOpen URLs on the host machine.
- - - Downloader - Allows downloading URLs to the host machine. - +
+
+
+ +
+
+
+

Web services

+

The web services displays data grabbed from an external source.

- - - Keyboard - Simulate key presses on the host machine. - + - - + - - + - - + - - + - - - - - - - - - - -
OpenWeatherMapDisplay current meteorological data from your location.OpenWeatherMap displays current meteorological data or weather forecast.
Forecast.ioDisplay current meteorological data from your location.Forecast.io displays current meteorological data.
BitcoinDisplay details about the Bitcoin Network and your Blockchain.info online wallet.Bitcoin displays details about the Bitcoin Network.
Swiss Public TransportDisplay timetable data for traveling in Switzerland.Swiss Public Transport displays Swiss timetable data for traveling.
Time & DateDisplays the time and the date.
MQTTAllow sending and recieving MQTT messages.
+
+
+
+
+
+ +

Support for these services is provided by the Home Assistant community and not the service providers. From 6e1c30b5515fb987f13e0966a2cb049c5174f79a Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 30 Aug 2015 23:57:15 +0200 Subject: [PATCH 2/2] add mqtt --- source/components/index.markdown | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/source/components/index.markdown b/source/components/index.markdown index ac59c33b278..e36a694cc30 100644 --- a/source/components/index.markdown +++ b/source/components/index.markdown @@ -78,12 +78,12 @@ Entities are things that you want to observe within Home Assistant. Support for - +

-

Devices

+

Devices and protocols

@@ -117,6 +117,11 @@ Entities are things that you want to observe within Home Assistant. Support for + + + + +
RFXtrx sensors monitors values from RFXtrx sensors.
MQTT allows sending and recieving MQTT messages.