o-r integrations: apply sentence-style capitalization (#29863)

* o-r integrations: apply sentence-style capitalization * Fix search and replace error
2025-07-18 23:06:58 +00:00 · 2023-11-16 12:41:22 +01:00 · 2023-11-16 12:41:22 +01:00 · 7ce9eebe8f
commit 7ce9eebe8f
parent d35e999e6b
32 changed files with 48 additions and 48 deletions
--- a/source/_integrations/octoprint.markdown
+++ b/source/_integrations/octoprint.markdown
@ -57,11 +57,11 @@ verify ssl:
  default: false
 {% endconfiguration_basic %}

-### API Key
+### API key
 For the integration to work, please check that in Octoprint, the plugin Discovery is enabled and in the settings -> printer notifications menu pop-ups are enabled.
 The Octoprint integration will attempt to register itself via the [application keys plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt.

-## Binary Sensor
+## Binary sensor

 The OctoPrint integration provides the following binary sensors:

--- a/source/_integrations/oncue.markdown
+++ b/source/_integrations/oncue.markdown
@ -20,7 +20,7 @@ ha_integration_type: integration

 The Oncue by Kohler integration will allow you to monitor the state of your [Oncue enabled Kohler generator](https://api.kohler.com/oncueplus/#/auth).

-## Tested Devices
+## Tested devices

 - 20RESA
 - [24RCL](https://kohlerpower.com/en/residential/generators/product/24rcl)
--- a/source/_integrations/onvif.markdown
+++ b/source/_integrations/onvif.markdown
@ -33,7 +33,7 @@ The ONVIF camera integration allows you to use an [ONVIF](https://www.onvif.org/
 If running Home assistant Core in a venv, ensure that libxml2 and libxslt python interfaces are installed via your package manager.
 </div>

-### Configuration Notes
+### Configuration notes

 Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H.264. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI.

@ -55,7 +55,7 @@ By default, the integration will only enable the camera entity for the first H26
 - If additional camera entities are available for other profiles, try enabling those entities.
 - Set the `Extra FFmpeg arguments` to `-pred 1 -ss 00:00:05 -frames:v 1` to cause the snapshot to be taken 5 seconds into the stream.

-### Supported Sensors
+### Supported sensors

 This integration uses the ONVIF pullpoint subscription API to process events into sensors that will be automatically added to Home Assistant.  Below is a list of currently supported event topics along with the entities they create.

@ -101,7 +101,7 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca
 | `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` |
 | `continuous_duration` | Set ContinuousMove delay in seconds before stopping the move. Allowed values: floating point numbers or integer. Default : 0.5 |

-### Supported Switches
+### Supported switches

 This integration uses the ONVIF auxiliary command and imaging service to send certain settings and information to the camera via switch entities. Below is a list of currently supported switches.

--- a/source/_integrations/opensensemap.markdown
+++ b/source/_integrations/opensensemap.markdown
@ -17,7 +17,7 @@ The `opensensemap` air quality platform will query the open data API of [openSen

 To get the ID of a station you need to select it on the [openSense map](https://opensensemap.org/) and find it in the addressbar of your browser. It's the last part of the URL, e.g., `5b450e565dc1ec001bf7cd1d` [https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d](https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d).

-## Manual Configuration
+## Manual configuration

 To enable this platform, add the following lines to your `configuration.yaml` file:

--- a/source/_integrations/opentherm_gw.markdown
+++ b/source/_integrations/opentherm_gw.markdown
@ -414,7 +414,7 @@ Not all boilers and thermostats properly support all OpenTherm features, so not
  Solar storage unit temperature.


-## Binary Sensors
+## Binary sensors

 The following `binary_sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the data source (`boiler`, `gateway` or `thermostat`) and the `gateway_id` of the gateway to which it belongs. All `binary_sensor` entities are disabled by default.
 <p class='note'>
--- a/source/_integrations/openuv.markdown
+++ b/source/_integrations/openuv.markdown
@ -48,7 +48,7 @@ To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
 | Skin Type 5 Safe Exposure Time | Sensor        | the amount of time [Fitzpatrick skin type 5](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
 | Skin Type 6 Safe Exposure Time | Sensor        | the amount of time [Fitzpatrick skin type 6](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |

-## Updating Data
+## Updating data

 <div class='note warning'>
 OpenUV does _not_ automatically update data for its entities! Users must manually
@ -80,7 +80,7 @@ _all_ of these entities.
 To protect against possible API call waste, all calls to `homeassistant.update_entity`
 that reference an OpenUV entity are throttled to a minimum of 15 minutes between calls.

-### Protection Window
+### Protection window

 The Protection Window binary sensor will be `on` when sunblock protection should be used.

--- a/source/_integrations/pilight.markdown
+++ b/source/_integrations/pilight.markdown
@ -81,7 +81,7 @@ pilight:
      - 42
 ```

-## Binary Sensor
+## Binary sensor

 The `pilight` binary sensor platform implements the [pilight hub](#configuration) binary sensor functionality. There are two types of Pilight binary sensor configuration: a normal sensor which sends the on and off cyclical state and a trigger sensor which sends only a trigger when an event happened (for example lots of cheap PIR motion detectors).

--- a/source/_integrations/ping.markdown
+++ b/source/_integrations/ping.markdown
@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
 - [Binary Sensor](#binary-sensor)
 - [Presence Detection](#presence-detection)

-## Binary Sensor
+## Binary sensor

 The `ping` binary sensor platform allows you to use `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.

@ -75,7 +75,7 @@ binary_sensor:
 When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
 </div>

-## Presence Detection
+## Presence detection

 The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.

--- a/source/_integrations/plaato.markdown
+++ b/source/_integrations/plaato.markdown
@ -36,7 +36,7 @@ To configure a Plaato device, you must set it up via the integrations panel in t

 You have two options to choose from: webhook and `auth_token.` The webhook is only available for the Airlock at the moment.

-### Auth Token
+### Auth token

 To be able to query the API an `auth_token` is required which can be obtained by following [these](https://intercom.help/plaato/en/articles/5004720-auth_token) instructions.

--- a/source/_integrations/plant.markdown
+++ b/source/_integrations/plant.markdown
@ -114,7 +114,7 @@ Another good source of this data would be the [Mi Flora](/integrations/miflora)

 If the sensor data is within the min/max values the status will be `ok`, if not the status will be `problem`. You can use this to trigger a notification, if there is a problem with your plant. Of course you can only monitor attributes of your plant, where the sensor is configured and is providing the data.

-## Data Source
+## Data source

 The main sources of the data will usually be a [MiFlora sensor](/integrations/miflora) or a [MQTT sensor](/integrations/sensor.mqtt/) receiving the data from a [PlantGateway](https://github.com/ChristianKuehnel/plantgateway).

--- a/source/_integrations/plex.markdown
+++ b/source/_integrations/plex.markdown
@ -41,7 +41,7 @@ During setup, you will need to log in as a server administrator. The integration

 If your router enforces DNS rebind protection, connections to the local `plex.direct` hostname may fail (see [Plex documentation](https://support.plex.tv/articles/206225077-how-to-use-secure-server-connections/#dnsrebinding)). To avoid this, configure your router to allow DNS rebinding for `plex.direct` by following the instructions in the documentation link.

-### Integration Options
+### Integration options

 Several options are provided to adjust the behavior of `media_player` entities. These can be changed at **Plex** -> **Options** on the Integrations page.

@ -53,7 +53,7 @@ Several options are provided to adjust the behavior of `media_player` entities.

 **Ignore Plex Web clients**: Do not create `media_player` entities for Plex Web clients.

-### Manual Configuration
+### Manual configuration

 Alternatively, you can manually configure a Plex server connection by selecting the "Configure Plex server manually" when configuring a Plex integration. This option is only available to users in "Advanced Mode". This will allow you to specify the server connection options which will be validated before setup is completed. The available options are described below:

@ -146,7 +146,7 @@ Notifications of new releases of Plex Media Server are shown using an Update ent

 Automatic upgrades of Plex Media Server can be triggered for some installation types, such as Windows and certain NAS devices.

-## Media Player
+## Media player

 The Plex media player platform will create Media Player entities for each connected client device. These entities will display media information, playback progress, and playback controls (if supported by the streaming device).

@ -224,7 +224,7 @@ media_content_type: PLAYLIST
 media_content_id: '{ "playlist_name": "The Best of Disco", "shuffle": "1" }'
 ```

-#### TV Episode
+#### TV episode

 | Service data attribute | Description                                                                                                                                                                                                                                                                                                            |
 | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@ -276,7 +276,7 @@ media_content_type: movie
 media_content_id: '{ "library_name": "Adult Movies", "title": "Blade" }'
 ```

-#### Advanced Searches
+#### Advanced searches

 Instead of searching for a specific known piece of media, many additional parameters are available to run more powerful searches. This can also be used when a simple search for a title has multiple matches, such as with movie remakes.

@ -344,7 +344,7 @@ The search will attempt to guess the type of media based on the search parameter
 | Plex Desktop & Web | Controls are unavailable (as of June 2022) |
 | Plex HTPC          | None                                       |

-## Sonos Playback
+## Sonos playback

 To play Plex music directly to Sonos speakers, the following requirements must be met:

@ -372,7 +372,7 @@ media_content_type: playlist
 media_content_id: 'plex://{ "playlist_name": "Party Mix" }'
 ```

-## Additional Services
+## Additional services

 ### Service `plex.refresh_library`

--- a/source/_integrations/point.markdown
+++ b/source/_integrations/point.markdown
@ -73,7 +73,7 @@ The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is im

 </div>

-## Binary Sensor
+## Binary sensor

 Each Point exposes the following binary sensors:

--- a/source/_integrations/powerwall.markdown
+++ b/source/_integrations/powerwall.markdown
@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant:

 {% include integrations/config_flow.md %}

-### Binary Sensor
+### Binary sensor

 The following binary sensors are added for each Powerwall:

@ -75,7 +75,7 @@ The following switches are added for each Powerwall:

 - Off-Grid operation - Take your Powerwall off-grid (simulate a grid outage)

-### Device Info
+### Device info

 - Model Number
 - Firmware Revision
--- a/source/_integrations/progettihwsw.markdown
+++ b/source/_integrations/progettihwsw.markdown
@ -21,7 +21,7 @@ The `progettihwsw` integration brings the automation experience with ProgettiHWS

 {% include integrations/config_flow.md %}

-## Binary Sensor
+## Binary sensor

 The `progettihwsw` binary sensor platform allows you to read the input values of a [ProgettiHWSW Board](http://www.progetti-hw-sw.it/).

--- a/source/_integrations/proximity.markdown
+++ b/source/_integrations/proximity.markdown
@ -52,7 +52,7 @@ proximity:
    unit_of_measurement: mi
 ```

-### Video Tutorial
+### Video tutorial
 This video tutorial explains how to set up geofencing in Home Assistant using the proximity integration.

 <lite-youtube videoid="pjAyRN5UiBg" videotitle="Geofencing in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
--- a/source/_integrations/python_script.markdown
+++ b/source/_integrations/python_script.markdown
@ -105,7 +105,7 @@ context:
  user_id: null
 ```

-## Calling Services
+## Calling services

 The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`.

--- a/source/_integrations/qld_bushfire.markdown
+++ b/source/_integrations/qld_bushfire.markdown
@ -72,7 +72,7 @@ longitude:
 {% endconfiguration %}


-## State Attributes
+## State attributes

 The following state attributes are available for each entity in addition to 
 the standard ones:
@ -88,7 +88,7 @@ the standard ones:
 | updated_date     | Date and time when this alert was last updated. |
 | status           | Status of the alert, for example, "Patrolled", "Going", "Contained" |

-## Full Configuration
+## Full configuration

 ```yaml
 # Example configuration.yaml entry
--- a/source/_integrations/qnap_qsw.markdown
+++ b/source/_integrations/qnap_qsw.markdown
@ -35,7 +35,7 @@ Password:
  description: "Password"
 {% endconfiguration_basic %}

-## Binary Sensors
+## Binary sensors

 The following *binary sensors* are created:

--- a/source/_integrations/qwikswitch.markdown
+++ b/source/_integrations/qwikswitch.markdown
@ -121,7 +121,7 @@ The list of recognized commands can be extended for Keyfobs, door sensors, and P

 On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API

-### Qwikswitch Sensors
+### Qwikswitch sensors

 The sensor configuration is a list of sensors. Depending on the type of sensor, it will be a sensor or binary_sensor.

--- a/source/_integrations/radarr.markdown
+++ b/source/_integrations/radarr.markdown
@ -20,7 +20,7 @@ Your API key can be found in Settings > General in the Radarr Web UI.

 {% include integrations/config_flow.md %}

-## Integration Entities
+## Integration entities

 Each added configuration entry will create the following binary sensor:

--- a/source/_integrations/rainbird.markdown
+++ b/source/_integrations/rainbird.markdown
@ -34,12 +34,12 @@ There is currently support for the following device types within Home Assistant:

 {% include integrations/config_flow.md %}

-## Configuration Options
+## Configuration options

 The integration has a configuration option to change the default amount of time that the irrigation
 will run when turning on a zone switch (default is 6 minutes). This can be overridden with a service call (see below).

-## Binary Sensor
+## Binary sensor

 The `rainsensor` sensor will tell if you if the device has detected rain.

--- a/source/_integrations/raincloud.markdown
+++ b/source/_integrations/raincloud.markdown
@ -48,7 +48,7 @@ password:
  type: string
 {% endconfiguration %}

-## Binary Sensor
+## Binary sensor

 Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file:

--- a/source/_integrations/recorder.markdown
+++ b/source/_integrations/recorder.markdown
@ -119,7 +119,7 @@ recorder:
          type: list
 {% endconfiguration %}

-## Configure Filter
+## Configure filter

 By default, no entity will be excluded. To limit which entities are being exposed to `recorder`, you can use the `include` and `exclude` parameters.

--- a/source/_integrations/remote_rpi_gpio.markdown
+++ b/source/_integrations/remote_rpi_gpio.markdown
@ -22,7 +22,7 @@ Note that for virtual environments, you may need to set an environment variable

 `Environment = GPIOZERO_PIN_FACTORY=pigpio PIGPIO_ADDR=YOUR_RPi_IP_ADDRESS`

-## Binary Sensor
+## Binary sensor

 The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a remote [Raspberry Pi](https://www.raspberrypi.org/).

--- a/source/_integrations/reolink.markdown
+++ b/source/_integrations/reolink.markdown
@ -235,7 +235,7 @@ However, these cameras can work with this integration through an NVR in which th
 - E1
 - Reolink Lumus

-## Initial Setup
+## Initial setup

 A brand new Reolink camera first needs to be connected to the network and initialized. During initialization, the credentials for the camera need to be set.
 There are serveral ways to achieve this.
--- a/source/_integrations/rfxtrx.markdown
+++ b/source/_integrations/rfxtrx.markdown
@ -116,7 +116,7 @@ The RFXtrx integration support sensors that communicate in the frequency range o

 Also, several switches and other devices will also expose sensor entities with battery status as well as the signal level.

-#### Binary Sensors
+#### Binary sensors

 The RFXtrx integration support binary sensors that communicate in the frequency range of 433.92 MHz. The RFXtrx binary sensor integration provides support for them. Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol, but most of them are recognized under the *Lighting4* protocol. The RFXtrx binary sensor integration provides some special options for them, while other RFXtrx protocols should work too.

@ -174,7 +174,7 @@ To configure device options, select a device from the list under *Select device
 If a device is missing from the list, close the options window and either make sure the device sents a command or manually re-add the device by event code.
 </div>

-#### Off Delay
+#### Off delay

 Binary sensors have only two states - "on" and "off". Many door or window opening sensors will send a signal each time the door/window is open or closed. However, depending on their hardware or on their purpose, some sensors are only able to signal their "on" state:

--- a/source/_integrations/ridwell.markdown
+++ b/source/_integrations/ridwell.markdown
@ -21,7 +21,7 @@ The Ridwell integration allows users to track waste recycling pickups scheduled

 {% include integrations/config_flow.md %}

-## Pickup Types
+## Pickup types

 The pickup sensor contains a `pickup_types` state attribute, which contains:

--- a/source/_integrations/ring.markdown
+++ b/source/_integrations/ring.markdown
@ -38,7 +38,7 @@ This integration does NOT allow for live viewing of your Ring camera within Home

 {% include integrations/config_flow.md %}

-## Binary Sensor
+## Binary sensor

 Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Currently, it supports doorbell, external chimes and stickup cameras.

--- a/source/_integrations/risco.markdown
+++ b/source/_integrations/risco.markdown
@ -22,7 +22,7 @@ ha_integration_type: integration

 This integration connects with Risco Alarms, in one of two ways:

-## Risco Cloud (recommended)
+## Risco cloud (recommended)

 The integration will connect with your alarm over [Risco Cloud](https://riscocloud.com/).
 This is easiest to configure, and is widely supported, but is cloud based, and requires polling. 
@ -89,7 +89,7 @@ And in the reverse direction:
 | Arm Away | Arm |
 | Arm Home | Partial Arm |

-## Supported Platforms:
+## Supported platforms:

 - [Alarm Control Panel](/integrations/alarm_control_panel/)
 - [Binary Sensor](/integrations/binary_sensor/)
--- a/source/_integrations/roomba.markdown
+++ b/source/_integrations/roomba.markdown
@ -42,7 +42,7 @@ The Roomba's MQTT server only allows a single connection. Enabling continuous mo

 </div>

-## Integration Entities
+## Integration entities

 The Roomba Integration will add the following sensors.

--- a/source/_integrations/rtsp_to_webrtc.markdown
+++ b/source/_integrations/rtsp_to_webrtc.markdown
@ -22,7 +22,7 @@ The integration configuration requires the URL to your server (e.g. `http://exam

 {% include integrations/config_flow.md %}

-## Technical Details
+## Technical details

 RTSPtoWebRTC registers with the camera integration to override the camera attribute `frontend_stream_type` of `STREAM_TYPE_WEBRTC` to instruct the frontend to use WebRTC streams.

--- a/source/_integrations/rympro.markdown
+++ b/source/_integrations/rympro.markdown
@ -20,6 +20,6 @@ This integration connects with a [Read Your Meter Pro](https://rym-pro.com/) acc

 {% include integrations/config_flow.md %}

-## Supported Platforms:
+## Supported platforms:

 - [Sensor](/integrations/sensor/)