diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index c00c004f6e8..68b42151b67 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -29,7 +29,7 @@ A device's actual operating mode can be tracked via its `device_state_attributes 'zoneId': '999999', 'temperatureStatus': { 'temperature': 21.5, - 'isAvailable': True + 'isAvailable': true }, 'activeFaults': [], 'setpointStatus': { diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown index 53fdaac2f01..15207b93552 100644 --- a/source/_components/climate.generic_thermostat.markdown +++ b/source/_components/climate.generic_thermostat.markdown @@ -104,7 +104,7 @@ climate: target_sensor: sensor.study_temperature min_temp: 15 max_temp: 21 - ac_mode: False + ac_mode: false target_temp: 17 cold_tolerance: 0.3 hot_tolerance: 0 diff --git a/source/_components/climate.radiotherm.markdown b/source/_components/climate.radiotherm.markdown index 8dcdd724931..d7ffe2141ca 100644 --- a/source/_components/climate.radiotherm.markdown +++ b/source/_components/climate.radiotherm.markdown @@ -62,7 +62,7 @@ hold_temp: type: boolean {% endconfiguration %} -Set `hold_temp: True` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes. +Set `hold_temp: true` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes. The away mode functions similarly to the away mode feature of the website and apps, but cannot detect if you set away mode outside of Home Assistant. diff --git a/source/_components/climate.venstar.markdown b/source/_components/climate.venstar.markdown index 7667b735434..7337e19f62e 100644 --- a/source/_components/climate.venstar.markdown +++ b/source/_components/climate.venstar.markdown @@ -61,7 +61,7 @@ ssl: description: Whether to use SSL or not when communicating. required: false type: boolean - default: False + default: false timeout: description: Number of seconds for API timeout. required: false @@ -81,9 +81,9 @@ humidifier: climate: - platform: venstar host: IP_OR_HOSTNAME_OF_THERMOSTAT - ssl: True/False + ssl: true username: OPTIONAL_AUTH_USER_HERE password: OPTIONAL_AUTH_PASS_HERE timeout: 5 - humidifier: False + humidifier: false ``` diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index 89638656559..dd0c1a7c24f 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -45,7 +45,7 @@ counter: description: Try to restore the last known value when Home Assistant starts. required: false type: boolean - default: True + default: true step: description: Incremental/step value for the counter. required: false @@ -61,9 +61,9 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `True` which is the default. To disable this feature, set `restore` to `False`. +This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`. -If `restore` is set to `False`, the `initial` value will only be used when no previous state is found or when the counter is reset. +If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset. ## {% linkable_title Services %} diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 768d1e20455..f977166bfe7 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -91,7 +91,7 @@ devices: fire_event: description: Fire a `button_pressed` event if this device is turned on or off. required: false - default: False + default: false type: boolean signal_repetitions: description: The number of times every Rflink command should repeat. @@ -100,7 +100,7 @@ devices: group: description: Allow light to respond to group commands (ALLON/ALLOFF). required: false - default: True + default: true type: boolean group_aliases: description: The `aliases` which only respond to group commands. @@ -118,7 +118,7 @@ device_defaults: fire_event: description: The default `fire_event` for Rflink cover devices. required: false - default: False + default: false type: boolean signal_repetitions: description: The default `signal_repetitions` for Rflink cover devices. diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown index 801d0644b6b..e68c6324b23 100644 --- a/source/_components/cover.rfxtrx.markdown +++ b/source/_components/cover.rfxtrx.markdown @@ -25,7 +25,7 @@ The easiest way to find your roller shutters is to add this to your `configurati ```yaml cover: - platform: rfxtrx - automatic_add: True + automatic_add: true ``` Launch your homeassistant and go the website (e.g http://localhost:8123). Push your remote and your device should be added. @@ -52,7 +52,7 @@ Example configuration: # Example configuration.yaml entry cover: - platform: rfxtrx - automatic_add: False + automatic_add: false signal_repetitions: 2 devices: 0b1100ce3213c7f210010f70: # Siemens/LightwaveRF diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 2026b7bc3b6..635502caeb3 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -44,7 +44,7 @@ relay_time: invert_relay: description: Invert the relay pin output so that it is active-high (True). required: false - default: False + default: false type: boolean state_pull_mode: description: The direction the State pin is pulling. It can be UP or DOWN. @@ -54,7 +54,7 @@ state_pull_mode: invert_state: description: Invert the value of the State pin so that 0 means closed. required: false - default: False + default: false type: boolean covers: description: List of your doors. @@ -82,9 +82,9 @@ covers: cover: - platform: rpi_gpio relay_time: 0.2 - invert_relay: False + invert_relay: false state_pull_mode: 'UP' - invert_state: True + invert_state: true covers: - relay_pin: 10 state_pin: 11 diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index b2257e80078..d0841b10a90 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -44,7 +44,7 @@ The following optional parameters can be used with any platform: | `new_device_defaults`| | Default values for new discovered devices. Available options `track_new_devices` (default: `true`), `hide_if_away` (default: `false`) |
- Note that setting `track_new_devices:false` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: no`). + Note that setting `track_new_devices: false` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: false`).
The extended example from above would look like the following sample: @@ -74,7 +74,7 @@ devicename: name: Friendly Name mac: EA:AA:55:E7:C6:94 picture: https://www.home-assistant.io/images/favicon-192x192.png - track: yes + track: true hide_if_away: false ``` @@ -105,7 +105,7 @@ USERNAME_DEVICE_ID: mac: EA:AA:55:E7:C6:94 picture: https://www.home-assistant.io/images/favicon-192x192.png gravatar: test@example.com - track: yes + track: true hide_if_away: false ``` diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index bb394f8c56b..2fd6c26ad59 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -49,7 +49,7 @@ ssl: type: boolean default: false verify_ssl: - description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `False` or `True` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`." + description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `false` or `true` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`." required: false type: [string, boolean] default: true diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 9edb7356213..7940b41e73c 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -57,9 +57,9 @@ api_key: required: true type: string hold_temp: - description: True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. + description: Whether or not to hold changes indefinitely (`true`) or until the next scheduled event. required: false - default: "`false`" + default: false type: boolean {% endconfiguration %} diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index b8f0b75396a..648b9d500e1 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -106,7 +106,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha host: YOUR_HOST username: YOUR_USERNAME password: YOUR_PASSWORD - report_server_enabled: True + report_server_enabled: true report_server_port: PORT_OF_EGARDIASERVER (optional, defaults to 52010) report_server_codes: arm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 74df0d234eb..a014716a649 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -43,7 +43,7 @@ password: description: Defines if you'd like to fetch data for both sides of the bed. required: false type: string - default: False + default: false {% endconfiguration %} ### {% linkable_title Supported features %} diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown index 189cad7ad79..a9f2420ec07 100644 --- a/source/_components/fan.template.markdown +++ b/source/_components/fan.template.markdown @@ -75,7 +75,7 @@ fan: required: false type: template oscillating_template: - description: "Defines a template to get the osc state of the fan. Valid value: True/False" + description: "Defines a template to get the osc state of the fan. Valid value: true/false" required: false type: template direction_template: diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 09941498172..2e98bef36ce 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -101,7 +101,7 @@ To enable "night mode": ```yaml automation: - alias: 'Set dark theme for the night' - initial_state: True + initial_state: true trigger: - platform: time at: '21:00' diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 443aaf14e6d..b6165599f75 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -132,7 +132,7 @@ allow_unlock: description: "When True, allows Google Assistant to unlock locks." required: false type: boolean - default: False + default: false api_key: description: Your Homegraph API key (for the `google_assistant.request_sync` service) required: false @@ -140,7 +140,7 @@ api_key: expose_by_default: description: "Expose devices in all supported domains by default. If set to false, you need to either expose domains or add the expose configuration option to each entity in `entity_config` and set it to true." required: false - default: True + default: true type: boolean exposed_domains: description: List of entity domains to expose to Google Assistant. diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 30d3bb01485..e52617c002b 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -61,7 +61,7 @@ name: required: false type: string view: - description: "If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: yes` cannot be used as entities in other views." + description: "If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: true` cannot be used as entities in other views." required: false type: boolean icon: diff --git a/source/_components/history.markdown b/source/_components/history.markdown index f372a33e4a8..c2829753734 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -134,7 +134,7 @@ you can set the flag `use_include_order` to true. ```yaml # Example configuration.yaml entry using specified entity display order history: - use_include_order: True + use_include_order: true include: entities: - sun.sun diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 10e9cc02e15..f2c388de1e5 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -180,7 +180,7 @@ A common situation might be if you decide to disable parts of the configuration ## {% linkable_title Disable Auto Start %} -Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: False`, you can call the service `homekit.start`. +Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`. If you have Z-Wave entities you want to be exposed to HomeKit, then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation. @@ -192,7 +192,7 @@ Please remember that you can only have a single `automation` entry. Add the auto ```yaml # Example for Z-Wave homekit: - auto_start: False + auto_start: false automation: - alias: 'Start HomeKit' @@ -214,7 +214,7 @@ For a general delay where your component doesn't generate an event, you can also ```yaml # Example using a delay after the start of Home Assistant homekit: - auto_start: False + auto_start: false automation: - alias: 'Start HomeKit' @@ -269,7 +269,7 @@ To use `safe_mode`, add the option to your `homekit` config: ```yaml homekit: - safe_mode: True + safe_mode: true ``` Restart your Home Assistant instance. If you don't see a `pincode`, follow the [guide](#deleting-the-homekitstate-file) here. Now you should be able to pair normally. diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index f5071fb05af..239df5790c6 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lutron.png ha_category: Hub -featured: False +featured: false ha_release: 0.85 ha_iot_class: "Local Push" redirect_from: diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 4f1b5b2c4a1..9b5f0038255 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -93,7 +93,7 @@ local_ip: ```yaml knx: - fire_event: True + fire_event: true fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] ``` diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown index 426feb16ae1..33efa06d021 100644 --- a/source/_components/light.flux_led.markdown +++ b/source/_components/light.flux_led.markdown @@ -80,7 +80,7 @@ Will automatically search and add all lights on start up: # Example configuration.yaml entry light: - platform: flux_led - automatic_add: True + automatic_add: true ``` Will add two lights with given name and create an automation rule to randomly set color each 45 seconds: diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 4afcd0da978..6ad68f8e898 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -588,7 +588,7 @@ light: name: mqtt_json_hs_light state_topic: "home/light" command_topic: "home/light/set" - hs: True + hs: true ``` Home Assistant expects the hue values to be in the range 0 to 360 and the saturation values to be scaled from 0 to 100. For example, the following is a blue color shade: diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index 6795a5a2e25..553ba93be33 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -22,7 +22,7 @@ The easiest way to find your lights is to add this to your `configuration.yaml`: ```yaml light: - platform: rfxtrx - automatic_add: True + automatic_add: true ``` Launch your Home Assistant and go the website. Push your remote and your device should be added: diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index 8cb205602e2..2de5f6f171b 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -66,12 +66,12 @@ devices: description: Enable music mode. required: false type: boolean - default: False + default: false save_on_change: description: Saves the bulb state in its nonvolatile memory when changed from Home Assistant. required: false type: boolean - default: False + default: false model: description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range." required: false @@ -141,8 +141,8 @@ light: 192.168.1.25: name: Living Room transition: 1000 - use_music_mode: True - save_on_change: True + use_music_mode: true + save_on_change: true ``` ### {% linkable_title Multiple bulbs %} diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 66960face43..3dbd590cb5c 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lutron.png ha_category: Hub -featured: False +featured: false ha_release: 0.37 ha_iot_class: "Local Polling" --- diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index 4a42d97b16f..64fc354a4f3 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lutron.png ha_category: Hub -featured: False +featured: false ha_release: 0.41 ha_iot_class: "Local Polling" --- diff --git a/source/_components/media_player.denonavr.markdown b/source/_components/media_player.denonavr.markdown index 8812ba598fb..5d5c95ead98 100644 --- a/source/_components/media_player.denonavr.markdown +++ b/source/_components/media_player.denonavr.markdown @@ -48,7 +48,7 @@ media_player: - platform: denonavr host: IP_ADDRESS name: NAME - show_all_sources: True / False + show_all_sources: true timeout: POSITIVE INTEGER zones: - zone: Zone2 / Zone3 diff --git a/source/_components/media_player.emby.markdown b/source/_components/media_player.emby.markdown index 5e1716de191..bb10654c680 100644 --- a/source/_components/media_player.emby.markdown +++ b/source/_components/media_player.emby.markdown @@ -37,7 +37,7 @@ api_key: required: true type: string ssl: - description: True if you want to connect with HTTPS/WSS. Your SSL certificate must be valid. + description: Connect with HTTPS/WSS. Your SSL certificate must be valid. required: false default: false type: boolean @@ -47,7 +47,7 @@ port: default: 8096 (No SSL), 8920 (SSL) type: integer auto_hide: - description: True if you want to automatically hide devices that are unavailable from the Home Assistant Interface. + description: Automatically hide devices that are unavailable from the Home Assistant Interface. required: false default: false type: boolean diff --git a/source/_components/notify.file.markdown b/source/_components/notify.file.markdown index 7b978d331fc..1fed47e1714 100644 --- a/source/_components/notify.file.markdown +++ b/source/_components/notify.file.markdown @@ -35,7 +35,7 @@ filename: required: true type: string timestamp: - description: Setting `timestamp` to `True` adds a timestamp to every entry. + description: Setting `timestamp` to `true` adds a timestamp to every entry. required: false default: false type: boolean diff --git a/source/_components/notify.homematic.markdown b/source/_components/notify.homematic.markdown index 5ba5dd3b362..3f7cd5f64e0 100644 --- a/source/_components/notify.homematic.markdown +++ b/source/_components/notify.homematic.markdown @@ -102,7 +102,7 @@ alert: name: Temperature too high done_message: Temperature OK entity_id: binary_sensor.temperature_too_high - can_acknowledge: True + can_acknowledge: true notifiers: - group_hm ``` diff --git a/source/_components/notify.lametric.markdown b/source/_components/notify.lametric.markdown index f68d978dba3..680b258278d 100644 --- a/source/_components/notify.lametric.markdown +++ b/source/_components/notify.lametric.markdown @@ -45,7 +45,7 @@ cycles: default: 1 priority: description: Defines the priority of the notification. - required: False + required: false type: string default: warning {% endconfiguration %} diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index debdfaec6cb..937062df83f 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -45,7 +45,7 @@ climate: type: float default: "`0.5` for Celsius and `1.0` for Fahrenheit." floor_temperature: - description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `True` to override Home Assistant and round to the lower value according to the configured `precision`." + description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `true` to override Home Assistant and round to the lower value according to the configured `precision`." required: false type: boolean default: false @@ -392,7 +392,7 @@ opentherm_gw: climate: name: Thermostat precision: 0.5 - floor_temperature: True + floor_temperature: true monitored_variables: - room_setpoint - room_temp diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown index 681476cff76..1b2f07dd3f5 100644 --- a/source/_components/owntracks.markdown +++ b/source/_components/owntracks.markdown @@ -176,6 +176,6 @@ USERNAME_DEVICE_ID: mac: EA:AA:55:E7:C6:94 picture: https://www.home-assistant.io/images/favicon-192x192.png gravatar: test@example.com - track: yes - hide_if_away: no + track: true + hide_if_away: false ``` diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown index 4d018dd3752..af8fde86c80 100644 --- a/source/_components/remote.xiaomi_miio.markdown +++ b/source/_components/remote.xiaomi_miio.markdown @@ -54,7 +54,7 @@ hidden: description: Hide the entity from UI. There is currently no reason to show the entity in UI as turning it off or on does nothing. required: false type: boolean - default: True + default: true commands: required: false type: map diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index ac0451e6523..7be07531702 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -68,7 +68,7 @@ reconnect_interval: # Example configuration.yaml entry rflink: port: /dev/serial/by-id/usb-id01234 - wait_for_ack: False + wait_for_ack: false ignore_devices: - newkaku_000001_01 - digitech_* @@ -131,7 +131,7 @@ For example: # Example configuration.yaml entry rflink: port: /dev/serial/by-id/usb-id01234 - wait_for_ack: False + wait_for_ack: false ignore_devices: - newkaku_000001_01 - digitech_* diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 8272e106476..4c8612ae2e1 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -23,7 +23,7 @@ rss_feed_template: # Accessible ondiff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 6f12abc4173..2fbb9dbaf24 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -21,7 +21,7 @@ The easiest way to find your sensors is to add this to your `configuration.yaml` # Example configuration.yaml entry sensor: platform: rfxtrx - automatic_add: True + automatic_add: true ``` Then when the sensor emits a signal it will be automatically added: @@ -76,11 +76,11 @@ Example configuration: # Example configuration.yaml entry sensor: platform: rfxtrx - automatic_add: True + automatic_add: true devices: 0a52080705020095220269: name: Lving - fire_event: True + fire_event: true 0a520802060100ff0e0269: name: Bath data_type: diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown index f25207d60bd..54b39da34f2 100644 --- a/source/_components/sensor.tellstick.markdown +++ b/source/_components/sensor.tellstick.markdown @@ -28,7 +28,7 @@ sensor: required: false type: string only_named: - description: Only show the named sensors. Set to `True` to hide sensors. + description: Only show the named sensors. Set to `true` to hide sensors. required: false default: false type: boolean @@ -56,7 +56,7 @@ sensor: - platform: tellstick 135: Outside 21: Inside - only_named: True + only_named: true temperature_scale: "°C" datatype_mask: 1 ``` diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index a6a61d7ae98..5b7d762d92b 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -29,7 +29,7 @@ switch: name: Fan 13: name: Switch - invert: True + invert: true ``` If you want to use custom functions, then add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.flux.markdown b/source/_components/switch.flux.markdown index dccaf1ba957..68e87e72f19 100644 --- a/source/_components/switch.flux.markdown +++ b/source/_components/switch.flux.markdown @@ -108,7 +108,7 @@ switch: sunset_colortemp: 3000 stop_colortemp: 1900 brightness: 200 - disable_brightness_adjust: True + disable_brightness_adjust: true mode: xy transition: 30 interval: 60 diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index 60ce92daadd..c6219ed3ee1 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -86,7 +86,7 @@ register: verify_state: description: Define if is possible to readback the status of the switch. required: false - default: True + default: true type: boolean verify_register: description: Register to readback. diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown index 02094e099d5..691bb654306 100644 --- a/source/_components/switch.rfxtrx.markdown +++ b/source/_components/switch.rfxtrx.markdown @@ -21,7 +21,7 @@ The easiest way to find your switches is to add this to your `configuration.yaml # Example configuration.yaml entry switch: platform: rfxtrx - automatic_add: True + automatic_add: true ``` Launch your Home Assistant and go the website. @@ -70,7 +70,7 @@ signal_repetitions: {% endconfiguration %}
-This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `False`. +This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
@@ -102,7 +102,7 @@ Basic configuration with 3 devices: # Example configuration.yaml entry switch: platform: rfxtrx - automatic_add: False + automatic_add: false signal_repetitions: 2 devices: 0b1100ce3213c7f210010f70: @@ -111,7 +111,7 @@ switch: name: Movment2 0b1111e003af16aa10000060: name: Door - fire_event: True + fire_event: true ``` Light hallway if doorbell is pressed (when is sun down): @@ -120,7 +120,7 @@ Light hallway if doorbell is pressed (when is sun down): # Example configuration.yaml entry switch: platform: rfxtrx - automatic_add: False + automatic_add: false devices: 0710014c440f0160: name: Hall @@ -154,7 +154,7 @@ Use remote to enable scene (using event_data): # Example configuration.yaml entry switch: platform: rfxtrx - automatic_add: False + automatic_add: false devices: 0b1100ce3213c7f210010f70: name: Light1 diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index bfc40f912d6..364a2af27ec 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -33,7 +33,7 @@ cache: description: Allow TTS to cache voice file to local storage. required: false type: boolean - default: True + default: true cache_dir: description: Folder name or path to a folder for caching files. required: false diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index a887470e06b..7e5d08687d6 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -97,5 +97,5 @@ automation: - service: water_heater.set_away_mode data: entity_id: water_heater.demo - away_mode: True + away_mode: true ``` diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index 505c84bae90..a6552408949 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -59,7 +59,7 @@ weather: # Force 'Meetstation Volkel' to be used: latitude: 51.65 longitude: 5.70 - forecast: True + forecast: true ```
diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index 5656606e472..3b4c3e1fe4e 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -105,7 +105,7 @@ Error sending local control request. Sending request online The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync. -You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API. +You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `true` states will be pulled from the devices controlling hub, not the online API. ## {% linkable_title Service `pull_newly_added_devices_from_wink` %} @@ -277,7 +277,7 @@ script: sequence: - service: wink.set_siren_strobe_enabled data: - enabled: False + enabled: false ``` ### {% linkable_title Service `set_chime_strobe_enabled` %} @@ -297,7 +297,7 @@ script: sequence: - service: wink.set_chime_strobe_enabled data: - enabled: False + enabled: false ``` ### {% linkable_title Service `set_nimbus_dial_state` %} diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index fe317fce810..decbd7437b8 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -37,7 +37,7 @@ path: type: string default: "`/zabbix/`" ssl: - description: Set to `True` if your Zabbix installation is using SSL. + description: Set to `true` if your Zabbix installation is using SSL. required: false type: boolean default: false @@ -58,7 +58,7 @@ password: zabbix: host: ZABBIX_HOST path: ZABBIX_PATH - ssl: False + ssl: false username: USERNAME password: PASSWORD ``` diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index cb059e9ebd9..0ef2263845c 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -42,17 +42,17 @@ hidden: description: Set to `true` to hide the entity. required: false type: boolean - default: False + default: false homebridge_hidden: description: Set to `true` to hide the entity from `HomeBridge`. required: false type: boolean - default: False + default: false emulated_hue_hidden: description: Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)). required: false type: boolean - default: False + default: false entity_picture: description: URL to use as picture for entity. required: false @@ -65,7 +65,7 @@ assumed_state: description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. required: false type: boolean - default: True + default: true device_class: description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`. required: false diff --git a/source/_docs/configuration/group_visibility.markdown b/source/_docs/configuration/group_visibility.markdown index cab429ce404..230ae78b11b 100644 --- a/source/_docs/configuration/group_visibility.markdown +++ b/source/_docs/configuration/group_visibility.markdown @@ -20,7 +20,7 @@ To change visibility of a group, use the service `group.set_visibility`, pass th service: group.set_visibility entity_id: group.basement data: - visible: False + visible: false ```
@@ -42,7 +42,7 @@ automation: service: group.set_visibility entity_id: group.basement data: - visible: False + visible: false automation 2: trigger: @@ -52,7 +52,7 @@ automation 2: service: group.set_visibility entity_id: group.basement data: - visible: True + visible: true ``` ## {% linkable_title Easier automations %} diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 0d61a87c3e1..c04bd04460c 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -101,7 +101,7 @@ Let's look at the `device_tracker.yaml` file from our example: hosts: 192.168.2.0/24 home_interval: 3 - track_new_devices: yes + track_new_devices: true interval_seconds: 40 consider_home: 120 ``` diff --git a/source/_docs/ecosystem/ios/notifications/actions.markdown b/source/_docs/ecosystem/ios/notifications/actions.markdown index 3112ae06a33..9f1493b3d72 100644 --- a/source/_docs/ecosystem/ios/notifications/actions.markdown +++ b/source/_docs/ecosystem/ios/notifications/actions.markdown @@ -58,7 +58,7 @@ When sending a notification: - **identifier** (*Required*): A unique identifier for this action. Must be uppercase and have no special characters or spaces. Only needs to be unique to the category, not unique globally. - **title** (*Required*): The text to display on the button. Keep it short. - **activationMode** (*Optional*): The mode in which to run the app when the action is performed. Setting this to `foreground` will make the app open after selecting. Default value is `background`. -- **authenticationRequired** (*Optional*): If a truthy value (`true`, `True`, `yes`, etc.) the user must unlock the device before the action is performed. +- **authenticationRequired** (*Optional*): If `true`, the user must unlock the device before the action is performed. - **destructive** (*Optional*): When the value of this property is a truthy value, the system displays the corresponding button differently to indicate that the action is destructive (text color is red). - **behavior** (*Optional*): When `textInput` the system provides a way for the user to enter a text response to be included with the notification. The entered text will be sent back to Home Assistant. Default value is `default`. - **textInputButtonTitle** (*Optional*): The button label. *Required* if `behavior` is `textInput`. @@ -76,14 +76,14 @@ ios: - identifier: 'SOUND_ALARM' title: 'Sound Alarm' activationMode: 'background' - authenticationRequired: yes - destructive: yes + authenticationRequired: true + destructive: true behavior: 'default' - identifier: 'SILENCE_ALARM' title: 'Silence Alarm' activationMode: 'background' - authenticationRequired: yes - destructive: no + authenticationRequired: true + destructive: false behavior: 'textInput' textInputButtonTitle: 'Silencio!' textInputPlaceholder: 'Placeholder' diff --git a/source/_docs/ecosystem/ios/notifications/content_extensions.markdown b/source/_docs/ecosystem/ios/notifications/content_extensions.markdown index 721386de2e3..29f0f5c0727 100644 --- a/source/_docs/ecosystem/ios/notifications/content_extensions.markdown +++ b/source/_docs/ecosystem/ios/notifications/content_extensions.markdown @@ -93,13 +93,13 @@ ios: - identifier: 'OPEN_COVER' title: 'Open Cover' activationMode: 'background' - authenticationRequired: yes + authenticationRequired: true destructive: no - identifier: 'CLOSE_COVER' title: 'Close Cover' activationMode: 'background' - authenticationRequired: yes - destructive: yes + authenticationRequired: true + destructive: true ``` # Troubleshooting diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index f1db0bf8d32..ad9d86339ba 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -71,7 +71,7 @@ autoheal: description: Allows disabling auto Z-Wave heal at midnight. required: false type: boolean - default: True + default: true polling_interval: description: The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems. required: false @@ -81,7 +81,7 @@ debug: description: Print verbose z-wave info to log. required: false type: boolean - default: False + default: false device_config / device_config_domain / device_config_glob: description: "This attribute contains node-specific override values. NOTE: This needs to be specified if you are going to use any of the following options. See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format." required: false @@ -91,7 +91,7 @@ device_config / device_config_domain / device_config_glob: description: Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it. required: false type: boolean - default: False + default: false polling_intensity: description: Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2=every other time, etc). If not specified then your device will not be polled. required: false @@ -101,7 +101,7 @@ device_config / device_config_domain / device_config_glob: description: Enable refreshing of the node value. Only the light component uses this. required: false type: boolean - default: False + default: false delay: description: Specify the delay for refreshing of node value. Only the light component uses this. required: false @@ -111,7 +111,7 @@ device_config / device_config_domain / device_config_glob: description: Inverts function of the open and close buttons for the cover domain. This will not invert the position and state reporting. required: false type: boolean - default: False + default: false {% endconfiguration %}
diff --git a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown index 2533a175c9d..92b9c96ce84 100644 --- a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown +++ b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown @@ -30,7 +30,7 @@ As you might have noticed, this release has been delayed by 5 days. This was due ### {% linkable_title Hide automation rules %} -Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#reload-automation-rules) can be reloaded directly from the frontend. By default all automation rules are shown. If you want to [hide an automation rule](/getting-started/automation-create-first/), use `hide_entity: True`. +Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#reload-automation-rules) can be reloaded directly from the frontend. By default all automation rules are shown. If you want to [hide an automation rule](/getting-started/automation-create-first/), use `hide_entity: true`. ### {% linkable_title All changes %} diff --git a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown index b1c417b1a35..747f8bff0f2 100644 --- a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown +++ b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown @@ -52,7 +52,7 @@ There are two ways to opt-out. The first way is by using the new `opt_out` optio ```yaml updater: - reporting: no + reporting: false ``` You can also disable the updater component entirely by removing `updater:` from your `configuration.yaml` although **we would not suggest you do this** as you would miss any critical updates. diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown index b91503b06d1..95250dd2ece 100644 --- a/source/_posts/2017-06-17-release-47.markdown +++ b/source/_posts/2017-06-17-release-47.markdown @@ -125,7 +125,7 @@ lutron: mailgun: domain: !secret mailgun_domain api_key: !secret mailgun_api_key - sandbox: False + sandbox: false notify: - name: mailgun diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown index 1cc48aad143..7120d061bcd 100644 --- a/source/_posts/2018-01-14-release-61.markdown +++ b/source/_posts/2018-01-14-release-61.markdown @@ -81,11 +81,11 @@ Experiencing issues introduced by this release? Please report them in our [issue - States now use lower snake case. - The "Play" and "Trade" states has been renamed to "looking_to_play" and "looking_to_trade". ([@frwickst] - [#11182]) ([sensor.steam_online docs]) (breaking change) -- The [`tile`][device_tracker.tile docs] platform now shows only active Tiles by default; to show all Tiles, including expired/inactive ones, `show_inactive` must be `True`. The following state attributes have been removed: `last_seen` and `last_updated`. ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change) +- The [`tile`][device_tracker.tile docs] platform now shows only active Tiles by default; to show all Tiles, including expired/inactive ones, `show_inactive` must be `true`. The following state attributes have been removed: `last_seen` and `last_updated`. ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change) - The `hidden_string` feature has been removed from the isy994 component. Previously, this allowed entities to be "hidden" in Home Assistant if a configured string was present in an ISY device's name or folder path. This was removed because hiding devices is now done via the customization feature. Note however, that this feature was replaced by a new ignore_string config option, which will now cause Home Assistant to completely ignore devices with the matching string so that they will not be imported as a Home Assistant device at all. This can be helpful if you have nodes in the ISY that aren't useful at all in Hass (IR transmitter nodes are a good example.) ([@OverloadUT] - [#11243]) ([isy994 docs]) ([binary_sensor.isy994 docs]) ([cover.isy994 docs]) ([fan.isy994 docs]) ([light.isy994 docs]) ([lock.isy994 docs]) ([sensor.isy994 docs]) ([switch.isy994 docs]) (breaking change) - The [`egardia` alarm panel][alarm_control_panel.egardia docs] platform no longer a need the users to run a separate Egardiaserver component. It can now also run on HASS.io. ([@jeroenterheerdt] - [#11344]) ([alarm_control_panel.egardia docs]) (breaking change) -- The binary sensor platform of the DoorBird integration has been deleted, so remove DoorBird from your `binary_sensor` configuration. Instead, set the `doorbell_events` option of the `doorbird` component to `True`. The `last_visitor` option has been removed from the camera component, as it is now always added as an entity. ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change) +- The binary sensor platform of the DoorBird integration has been deleted, so remove DoorBird from your `binary_sensor` configuration. Instead, set the `doorbell_events` option of the `doorbird` component to `true`. The `last_visitor` option has been removed from the camera component, as it is now always added as an entity. ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change) - The following attributes of the TP-Link switch and light platform have been renamed: - Light: `current_consumption` -> `current_power_w`, `daily_consumption` -> `daily_energy_kwh` and `monthly_consumption` -> `monthly_energy_kwh` - Switch: `current` -> `current_a`, `current_consumption` -> `current_power_w`, `total_consumption` -> `total_energy_kwh` and `daily_consumption` -> `today_energy_kwh` ([@DanNixon] - [#10979]) ([light.tplink docs]) ([switch.tplink docs]) (breaking change) diff --git a/source/getting-started/automation-2.markdown b/source/getting-started/automation-2.markdown index 6e179e7e37d..fd645b6ac7d 100644 --- a/source/getting-started/automation-2.markdown +++ b/source/getting-started/automation-2.markdown @@ -18,8 +18,8 @@ We are defining a [trigger](/docs/automation/trigger/) to track the sunset and t # Example configuration.yaml entry automation: alias: Turn on the lights when the sun sets - initial_state: True - hide_entity: False + initial_state: true + hide_entity: false trigger: platform: sun event: sunset @@ -27,7 +27,7 @@ automation: service: light.turn_on ``` -Starting with 0.28 automation rules can be reloaded from the [frontend](/components/automation/) and are shown by default. With [`hide_entity:`](/components/automation/) you can control this behavior. It's convenient if you are working on your rules, but when a rule is finished, and you don't want to see that rule in your frontend, you can set `hide_entity:` to `True`. To set an automation to be disabled when Home Assistant starts set `initial_state:` to `False`. +Starting with 0.28 automation rules can be reloaded from the [frontend](/components/automation/) and are shown by default. With [`hide_entity:`](/components/automation/) you can control this behavior. It's convenient if you are working on your rules, but when a rule is finished, and you don't want to see that rule in your frontend, you can set `hide_entity:` to `true`. To set an automation to be disabled when Home Assistant starts set `initial_state:` to `false`. After a few days of running this automation rule, you come to realize that this automation rule is not sufficient. It was already dark when the lights went on, and the one day you weren't home, the lights turned on anyway. Time for some tweaking. Let's add an offset to the sunset trigger and a [condition](/docs/automation/condition/) to only turn on the lights if anyone is home. @@ -91,7 +91,7 @@ group: automation: alias: Turn on the lights when the sun sets - hide_entity: True + hide_entity: true trigger: platform: sun event: sunset