Skip to content

Commit

Permalink
Merge branch 'next' into docs_lcn_binary_sensor
Browse files Browse the repository at this point in the history
  • Loading branch information
alengwenus authored Mar 25, 2019
2 parents ba8b4da + 0009c9a commit 356a2d1
Show file tree
Hide file tree
Showing 14 changed files with 344 additions and 74 deletions.
14 changes: 12 additions & 2 deletions source/_components/androidtv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -97,22 +97,32 @@ device_class:
required: false
default: auto
type: string
turn_on_command:
description: An ADB shell command that will override the default `turn_on` command.
required: false
type: string
turn_off_command:
description: An ADB shell command that will override the default `turn_off` command.
required: false
type: string
{% endconfiguration %}

### {% linkable_title Full Configuration %}

```yaml
# Example configuration.yaml entry
media_player:
# Use an ADB server to setup an Android TV device
# and provide an app name
# Use an ADB server to setup an Android TV device, provide
# an app name, and override the default turn on/off commands
- platform: androidtv
name: Android TV
device_class: androidtv
host: 192.168.0.222
adb_server_ip: 127.0.0.1
apps:
com.amazon.tv.launcher: "Fire TV"
turn_on_command: "input keyevent 3"
turn_off_command: "input keyevent 223"
# Use the Python ADB implementation with authentication
# to setup a Fire TV device and don't get the running apps
Expand Down
34 changes: 34 additions & 0 deletions source/_components/climate.tfiac.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: page
title: "Tfiac AC"
description: "Instructions on how to integrate Tfiac AC devices with Home Assistant."
date: 2019-03-10 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tfiac.png
ha_category: Climate
ha_release: 0.91
ha_iot_class: Local Polling
---

The `tfiac` component integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398).

## {% linkable_title Configuration %}

To add your Tfiac device into your Home Assistant installation, add the following to your `configuration.yaml` file:

```yaml
# Full manual example configuration.yaml entry
climate:
- platform: tfiac
host: IP_ADDRESS
```
{% configuration %}
host:
description: The IP address of your AC device.
required: true
type: string
{% endconfiguration %}
6 changes: 2 additions & 4 deletions source/_components/daikin.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,8 @@ There is currently support for the following device types within Home Assistant:

## {% linkable_title Supported hardware %}

**Only** the European versions of Daikin AC (models BRP069A41, 42, 43, 45).

Some models do not support setting of fan speed or fan swing mode.

This component supports the European versions of Daikin AC (BRP069A[41,42,43,45]) and AU AirBase units (BRP15B61).
Some models do not support setting of fan speed or fan swing mode althogh it might show up in Home Assistant.
Please note that some AC devices may report outside temperature only when they are turned on.

## {% linkable_title Configuration %}
Expand Down
84 changes: 84 additions & 0 deletions source/_components/device_tracker.traccar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,79 @@ monitored_conditions:
description: Additional traccar computed attributes or device-related attributes to include in the scan.
required: false
type: list
event:
description: "Traccar events to include in the scan and fire within Home Assistant. *NOTE* For more info regarding Traccar events please refer to Traccar's documentation: https://www.traccar.org/documentation/events/."
required: false
type: list
keys:
device_moving:
description: "**deviceMoving** event."
required: false
type: string
command_result:
description: "**commandResult** event."
required: false
type: string
device_fuel_drop:
description: "**deviceFuelDrop** event."
required: false
type: string
geofence_enter:
description: "**geofenceEnter** event."
required: false
type: string
device_offline:
description: "**deviceOffline** event."
required: false
type: string
driver_changed:
description: "**driverChanged** event."
required: false
type: string
geofence_exit:
description: "**geofenceExit** event."
required: false
type: string
device_overspeed:
description: "**deviceOverspeed** event."
required: false
type: string
device_online:
description: "**deviceOnline** event."
required: false
type: string
device_stopped:
description: "**deviceStopped** event"
required: false
type: string
maintenance:
description: "**maintenance** event."
required: false
type: string
alarm:
description: "**alarm** event."
required: false
type: string
text_message:
description: "**textMessage** event."
required: false
type: string
device_unknown:
description: "**deviceUnknown** event."
required: false
type: string
ignition_off:
description: "**ignitionOff** event."
required: false
type: string
ignition_on:
description: "**ignitionOff** event."
required: false
type: string
all_events:
description: "**allEvents** catchall for all event types."
required: false
type: string
{% endconfiguration %}
The parameter `monitored_conditions` allows you to track non standard attributes from the traccar platform and use them in your Home Assistant. For example if you need to monitor the state of the non standard attribute `alarm` and a custom computed attribute `mycomputedattribute` just fill the configuration with:
Expand All @@ -74,3 +147,14 @@ device_tracker:
...
monitored_conditions: ['alarm', 'mycomputedattribute']
```

The parameter `event` allows you to import events from the traccar platform (https://www.traccar.org/documentation/events/) and fire them in your Home Assistant. It accepts a list of events to be monitored and imported and each event must be listed in lowercase snakecase. The events will be fired with the same event name defined in the abovementioned list preceded by the prefix `traccar_`. For example if you need to import the Traccar events `deviceOverspeed` and `deviceFuelDrop` in Home Assistant, you need to fill the `event` parameter with:

```yaml
device_tracker:
- platform: traccar
...
event: ['device_overspeed', 'device_fuel_drop']
```
and as soon as Home Assistant receives those events from the platform, they will be fired as `traccar_device_overspeed` and `traccar_device_fuel_drop`.
*NOTE* Specify `all_events` if you want to import all events.
12 changes: 10 additions & 2 deletions source/_components/ecobee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ auto, and off.
The following attributes are provided by the Ecobee Thermostat:
`name`, `temperature_unit`, `current_temperature`, `target_temperature`,
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
`fan`, `current_hold_mode`, `operation`, `operation_list`, `equipment_running`,
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
`is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`.
The attributes `min_temp` and `max_temp` are meaningless constant values.
Expand Down Expand Up @@ -229,7 +229,7 @@ Returns the current temperature hold, if any.
| ---------------| ----------- |
| String | 'temp', 'vacation', 'home', 'away', etc., None

### {% linkable_title Attribute `current_operation` %}
### {% linkable_title Attribute `operation` %}

Returns the current operation of the thermostat.

Expand All @@ -253,6 +253,14 @@ Returns the current operation mode of the thermostat.
| ---------------| ----------- |
| String | Currently active operation mode

### {% linkable_title Attribute `equipment_running` %}

Returns the list of equipment that is currently operating from the thermostat.

| Attribute type | Description |
| ---------------| ----------- |
| String | If no equipment is currently running empty string is returned. Possible values are a comma separated list of any of the following: heatPump, heatPump2, heatPump3, compCool1, compCool2, auxHeat1, auxHeat2, auxHeat3, fan, humidifier, dehumidifier, ventilator, economizer, compHotWater, auxHotWater.

### {% linkable_title Attribute `mode` %}

Returns the climate currently active on the thermostat. The mode
Expand Down
64 changes: 63 additions & 1 deletion source/_components/lcn.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ ha_category:
- Hub
- Cover
- Light
- Sensor
- Switch
ha_release: 0.85
ha_iot_class: Local Push
Expand All @@ -31,6 +32,7 @@ There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary_sensor)
- [Cover](#cover)
- [Light](#light)
- [Sensor](#sensor)
- [Switch](#switch)

## {% linkable_title Configuration %}
Expand Down Expand Up @@ -65,6 +67,12 @@ lcn:
dimmable: true
transition: 5

sensors:
- name: Temperature
address: myhome.s0.m7
source: var3
unit_of_measuremnt: °C

switches:
- name: Sprinkler switch
address: myhome.s0.m7
Expand All @@ -73,7 +81,7 @@ lcn:
{% configuration %}
connections:
description: List of your connections
description: List of your connections.
required: true
type: map
keys:
Expand Down Expand Up @@ -173,6 +181,29 @@ lights:
type: int
default: 0
sensors:
description: List of your sensors.
required: false
type: map
keys:
name:
description: "Name of the sensor."
required: true
type: string
address:
description: "[Address](/components/lcn#lcn-addresses) of the module/group."
required: true
type: string
source:
description: "Sensor source ([VARIABLE](/components/lcn#variables-and-units), [SETPOINT](/components/lcn#variables-and-units), [THRESHOLD](/components/lcn#variables-and-units), [S0_INPUT](/components/lcn#variables-and-units), [LED_PORT](/components/lcn#ports), [LOGICOP_PORT](/components/lcn#ports))."
required: true
type: string
unit_of_measurement:
description: "Measurement unit ([VAR_UNIT](/components/lcn#variables-and-units))."
required: false
type: string
default: 'native'
switches:
description: List of your switches.
required: false
Expand Down Expand Up @@ -236,6 +267,8 @@ The platforms and service calls use several predefined constants as parameters.
| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` |
| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4` |
| BINSENSOR_PORT | `binsensor1`, `binsensor2`, `binsensor3`, `binsensor4`, `binsensor5`, `binsensor6`, `binsensor7`, `binsensor8` |
| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` |
| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` |

The [MOTOR_PORT](/components/lcn#ports) values specify which hardware relay configuration will be used:

Expand All @@ -250,7 +283,18 @@ The [MOTOR_PORT](/components/lcn#ports) values specify which hardware relay conf

| Constant | Values |
| -------- | ------ |
| VARIABLE | `var1`, `var2`, `var3`, `var4`, `var5`, `var6`, `var7`, `var8`, `var9`, `var10`, `var11`, `var12`, `tvar`, `r1var`, `r2var` |
| SETPOINT | `r1varsetpoint`, `r2varsetpoint` |
| THRESHOLD | `thrs1`, `thrs2`, `thrs3`, `thrs4`, `thrs5`, `thrs2_1`, `thrs2_2`, `thrs2_3`, `thrs2_4`, `thrs3_1`, `thrs3_2`, `thrs3_3`, `thrs3_4`, `thrs4_1`, `thrs4_2`, `thrs4_3`, `thrs4_4` |
| S0_INPUT | `s0input1`, `s0input2`, `s0input3`, `s0input4` |
| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` |

### {% linkable_title States %}:

| Constant | Values |
| -------- | ------ |
| LED_STATE | `on`. `off`, `blink`, `flicker` |
| LOGICOP_STATE | `not`. `or`, `and` |

### {% linkable_title Keys %}:

Expand Down Expand Up @@ -280,6 +324,24 @@ The `lcn` light platform allows the control of the following [LCN](http://www.lc
- (Dimmable) output ports
- Relays

### {% linkable_title Sensor %}

The `lcn` sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) data sources:

- Variables
- Regulator setpoints
- Thresholds
- S0 inputs
- LED states
- Logic operation states

The sensor can be used in automation scripts or in conjunction with `template` platforms.

<p class='note'>
Ensure that the LCN module is configured properly to provide the requested value.
Otherwise the module might show unexpected behavior or return error messages.
</p>

### {% linkable_title Switch %}

The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/light.xiaomi_miio.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Supported models: `philips.light.moonlight`

* Power (on, off)
* Brightness
* Color (not implemented)
* Color
* Color temperature (153...588 mireds)
* Scene (1, 2, 3, 4, 5, 6)
* Attributes
Expand Down
5 changes: 5 additions & 0 deletions source/_components/media_player.panasonic_viera.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ mac:
description: The MAC address of your Panasonic Viera TV, e.g., `AA:BB:CC:DD:99:1A`.
required: false
type: string
app_power:
description: Set to `true` if your Panasonic Viera TV supports "Turn on via App".
required: false
default: false
type: boolean
name:
description: The name you would like to give to the Panasonic Viera TV.
required: false
Expand Down
13 changes: 9 additions & 4 deletions source/_components/notify.clicksend_tts.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ comments: false
sharing: true
footer: true
logo: clicksend.png
ha_category: Notifications
ha_category:
- Notifications
ha_release: 0.55
redirect_from: /components/notify.clicksendaudio/
redirect_from:
- /components/notify.clicksendaudio/
---

The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver text-to-speech (TTS) notifications from Home Assistant.
Expand All @@ -22,7 +24,6 @@ To add ClickSend to your installation, add the following to your Home Assistant
```yaml
notify:
- platform: clicksend_tts
name: ClickSend
username: CLICKSEND_USERNAME
api_key: CLICKSEND_API_KEY
recipient: PHONE_NO
Expand All @@ -43,9 +44,13 @@ api_key:
required: true
type: string
recipient:
description: Your phone number. This is where you want to send your notification SMS messages (e.g., `09171234567`).
description: Recipient phone number. This is the phone number that you want to call and notify via TTS (e.g., `09171234567`).
required: true
type: string
caller:
description: Caller phone number. This is the phone number that you want to be the TTS call originator (e.g., `09181234567`). If not defined the recipient number is used.
required: false
type: string
language:
description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages).
required: false
Expand Down
Loading

0 comments on commit 356a2d1

Please sign in to comment.