Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions source/_components/airvisual.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -35,44 +35,44 @@ sensor:
{% configuration %}
api_key:
description: Your AirVisual API key.
required: required
required: true
type: string
monitored_conditions:
description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)."
required: required
required: true
type: list
default: ['us', 'cn']
show_on_map:
description: "Whether to show a marker on the map at the specified location."
required: optional
required: false
type: boolean
default: true
scan_interval:
description: "The rate in seconds at which AirVisual should be polled for new data."
required: optional
required: false
type: integer
default: 600
latitude:
description: The latitude of the location to monitor.
required: optional
required: false
type: string
default: "The latitude defined under the `homeassistant` key in `configuration.yaml`."
longitude:
description: The longitude of the location to monitor.
required: optional
required: false
type: string
default: "The longitude defined under the `homeassistant` key in `configuration.yaml`."
city:
description: The city to monitor.
required: optional
required: false
type: string
state:
description: The state the city belongs to.
required: optional
required: false
type: string
country:
description: The country the state belongs to.
required: optional
required: false
type: string
{% endconfiguration %}

Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.mqtt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ device:
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
type: list, string
type: [list, string]
connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ repeat:
Number of minutes before the notification should be repeated.
Can be either a number or a list of numbers.
required: true
type: [int, list]
type: [integer, list]
can_acknowledge:
description: Allows the alert to be unacknowledgeable.
required: false
Expand Down
6 changes: 3 additions & 3 deletions source/_components/alpha_vantage.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ symbols:
default: USD
symbol:
description: The stock market symbol for the given company.
required: required
required: true
type: string
foreign_exchange:
description: List of currencies.
Expand All @@ -64,11 +64,11 @@ foreign_exchange:
type: string
from:
description: The source currency.
required: required
required: true
type: string
to:
description: The target currency.
required: required
required: true
type: string
{% endconfiguration %}

Expand Down
2 changes: 1 addition & 1 deletion source/_components/amazon_polly.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ profile_name:
region_name:
description: The region identifier to connect to.
required: false
type: string or list
type: [string, list]
default: us-east-1
name:
description: "Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`."
Expand Down
2 changes: 1 addition & 1 deletion source/_components/ambient_station.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ app_key:
type: string
monitored_conditions:
description: Weather conditions to track.
required: optional
required: false
type: list
keys:
24hourrainin:
Expand Down
1 change: 1 addition & 0 deletions source/_components/android_ip_webcam.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ motion_sensor:
description: Activate motion sensor if `auto_discovery` is disabled.
required: false
type: boolean
default: false
{% endconfiguration %}

<div class='note'>
Expand Down
4 changes: 2 additions & 2 deletions source/_components/androidtv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ adb_server_port:
description: The port for the ADB server.
required: false
default: 5037
type: port
type: integer
get_sources:
description: Whether or not to retrieve the running apps as the list of sources for Fire TV devices; not used for Android TV devices.
required: false
Expand All @@ -86,7 +86,7 @@ apps:
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below.
required: false
default: {}
type: dict
type: map
device_class:
description: "The type of device: `auto` (detect whether it is an Android TV or Fire TV device), `androidtv`, or `firetv`."
required: false
Expand Down
1 change: 1 addition & 0 deletions source/_components/apple_tv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ start_off:
description: Set to true if the device should start in fake standby.
required: false
type: boolean
default: false
credentials:
description: Credentials used for AirPlay playback.
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/aqualogic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ host:
port:
description: The port provided by the RS-485 to Ethernet adapter.
required: true
type: int
type: integer
{% endconfiguration %}

## Sensor
Expand Down
2 changes: 1 addition & 1 deletion source/_components/aquostv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ port:
description: The port of the Sharp Aquos TV.
required: false
default: 10002
type: int
type: integer
username:
description: The username of the Sharp Aquos TV.
required: false
Expand Down
8 changes: 4 additions & 4 deletions source/_components/arduino.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ pins:
type: map
keys:
name:
default: Name that will be used in the frontend for the pin.
description: Name that will be used in the frontend for the pin.
type: string
{% endconfiguration %}

Expand Down Expand Up @@ -129,16 +129,16 @@ pins:
type: map
keys:
name:
default: Name that will be used in the frontend for the pin.
description: Name that will be used in the frontend for the pin.
type: string
required: false
initial:
default: The initial value for this port.
description: The initial value for this port.
type: boolean
required: false
default: false
negate:
default: If this pin should be inverted.
description: If this pin should be inverted.
type: boolean
required: false
default: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/arest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ resource:
type: string
name:
description: Let you overwrite the name of the device. By default *name* from the device is used.
required: optional
required: false
type: string
pins:
description: An array with all used pins.
Expand Down
12 changes: 6 additions & 6 deletions source/_components/aws.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ name:
required: true
type: string
aws_access_key_id:
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
required: Required if aws_secret_access_key is provided
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. Required if `aws_secret_access_key` is provided.
required: false
type: string
aws_secret_access_key:
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
required: Required if aws_access_key_id is provided
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. Required if `aws_access_key_id` is provided.
required: false
type: string
profile_name:
description: A credentials profile name.
Expand Down Expand Up @@ -80,8 +80,8 @@ aws_access_key_id:
required: false
type: string
aws_secret_access_key:
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`.
required: Required if aws_access_key_id is provided
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`. Required if aws_access_key_id is provided.
required: false
type: string
profile_name:
description: A credentials profile name.
Expand Down
12 changes: 6 additions & 6 deletions source/_components/bayesian.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,12 @@ observations:
required: true
type: string
entity_id:
description: Name of the entity to monitor.
required: true (for `state` and `numeric_state`)
description: Name of the entity to monitor. Required for `state` and `numeric_state`.
required: false
type: string
value_template:
description: Defines the template to be used.
required: true (for `template`)
description: Defines the template to be used. Required for `template`.
required: false
type: template
prob_given_true:
description: The probability of the observation occurring, given the event is `true`.
Expand All @@ -79,8 +79,8 @@ observations:
type: float
default: "`1 - prob_given_true` if `prob_given_false` is not set"
to_state:
description: The target state.
required: true (for `state`)
description: The target state. Required (for `state`).
required: false
type: string
{% endconfiguration %}

Expand Down
4 changes: 2 additions & 2 deletions source/_components/binary_sensor.mqtt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,11 @@ device:
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false
type: list, string
type: [list, string]
connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
required: false
type: list, tuple
type: [list, map]
manufacturer:
description: The manufacturer of the device.
required: false
Expand Down
4 changes: 2 additions & 2 deletions source/_components/binary_sensor.rest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ verify_ssl:
timeout:
description: Defines max time to wait data from the endpoint.
required: false
type: positive integer
type: integer
default: 10
authentication:
description: "Type of the HTTP authentication. `basic` or `digest`."
Expand All @@ -105,7 +105,7 @@ password:
headers:
description: The headers for the requests.
required: false
type: list, string
type: [list, string]
{% endconfiguration %}

<div class='note warning'>
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.rflink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ devices:
off_delay:
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
required: false
type: int
type: integer
force_update:
description: Sends update events even if the value has not changed. Useful for sensors that only sends `On`.
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.template.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ sensors:
entity_id:
description: A list of entity IDs so the sensor only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities.
required: false
type: string, list
type: [string, list]
device_class:
description: Sets the [class of the device](/components/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/bitcoin.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ currency:
display_options:
description: Options to display in the frontend.
required: true
type: map
type: list
keys:
exchangerate:
description: Exchange rate of 1 BTC
Expand Down
10 changes: 6 additions & 4 deletions source/_components/blackbird.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,19 @@ host:
zones:
description: This is the list of zones available. Valid zones are 1, 2, 3, 4, 5, 6, 7, 8. Each zone must have a name assigned to it.
required: true
type: integer
type: map
keys:
name:
ZONE_NUMBER:
Comment thread
klaasnicolaas marked this conversation as resolved.
description: The name of the zone.
type: string
sources:
description: The list of sources available. Valid source numbers are 1, 2, 3, 4, 5, 6, 7, 8. Each source number corresponds to the input number on the Blackbird matrix switch. Similar to zones, each source must have a name assigned to it.
required: true
type: integer
type: map
keys:
name:
ZONE_NUMBER:
Comment thread
klaasnicolaas marked this conversation as resolved.
description: The name of the source.
type: string
{% endconfiguration %}

### Service `media_player.blackbird_set_all_zones`
Expand Down
2 changes: 1 addition & 1 deletion source/_components/blockchain.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ sensor:
addresses:
description: List of bitcoin wallet addresses to watch.
required: true
type: string, list
type: [string, list]
{% endconfiguration %}

4 changes: 2 additions & 2 deletions source/_components/bom.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ weather:
{% configuration %}
name:
description: The name you would like to give to the weather station.
required: optional
required: false
type: string
station:
description: "The station ID string. See the [`sensor.bom` docs](#sensor) for details on how to find the ID of a station."
required: optional
required: false
type: string
default: The closest station
{% endconfiguration %}
Expand Down
8 changes: 4 additions & 4 deletions source/_components/broadlink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ name:
description: Sensor name.
required: false
default: Broadlink sensor
type: String
type: string
scan_interval:
description: Time in seconds to fetch data from sensors.
required: false
Expand Down Expand Up @@ -155,12 +155,12 @@ friendly_name:
type: string
type:
description: "Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2`, `spminiplus` or `mp1`. `SC1` devices can be registered as `sp2`."
required: true/false
required: true
type: string
switches:
description: The array that contains all switches.
required: false
type: array
type: map
keys:
identifier:
description: Name of the command switch as slug. Multiple entries are possible.
Expand All @@ -182,7 +182,7 @@ switches:
slots:
description: Friendly names of 4 slots of MP1 power strip. If not configured, slot name will be `switch's friendly_name + 'slot {slot_index}'`. e.g 'MP1 slot 1'
required: false
type: array
type: map
keys:
slot_1:
description: Friendly names of slot 1
Expand Down
Loading