l-n integrations: apply sentence-style capitalization (#29862)

This commit is contained in:
c0ffeeca7 2023-11-16 12:33:24 +01:00 committed by GitHub
parent 4a0dbd9126
commit 39cc232bb3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 59 additions and 59 deletions

View File

@ -27,7 +27,7 @@ client ID from the URL. For example: `https://dashboard.justnimbus.com/my-instal
{% include integrations/config_flow.md %}
## Sensor Types
## Sensor types
When configured, the integration will create twelve sensors for each configured client ID:

View File

@ -16,7 +16,7 @@ ha_integration_type: device
The JVC Projector integration allows for the automation of [JVC Projectors](https://www.jvc.com/usa/projectors/).
## Supported Models
## Supported models
This integration is intended for the automation of any modern JVC Projector with a LAN network port.

View File

@ -29,7 +29,7 @@ Please note, that the devices cannot remain paired to the MicroBot application f
{% include integrations/config_flow.md %}
### Supported Devices
### Supported devices
This Integration is for the MicroBot Push only. The Keymitt lock is not supported.

View File

@ -34,7 +34,7 @@ kira:
Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. The process varies according to the module type. The documentation for each can be found on the [manufacturer's website](https://www.info.keene-electronics.co.uk).
### Configuration Options
### Configuration options
```yaml
# Example configuration.yaml entry
@ -99,7 +99,7 @@ Restart Home Assistant and you should now have an entity called `kira_remote` (o
<img src='/images/integrations/kira/kira_states.png' />
</p>
### IR Codes
### IR codes
The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory.
@ -236,7 +236,7 @@ Example automation using these IR codes to toggle a Sonoff plug.
type: turn_off
```
### Code Types
### Code types
When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used.

View File

@ -79,7 +79,7 @@ As a Home Assistant KNX user, you can start a FREE KNX online training and get a
{% include integrations/config_flow.md %}
## Basic Configuration
## Basic configuration
In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main `configuration.yaml` file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/).
@ -264,7 +264,7 @@ automation:
address: "0/4/21"
```
### Register Event
### Register event
The `knx.event_register` service can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events)
@ -284,7 +284,7 @@ type:
required: false
{% endconfiguration %}
### Register Exposure
### Register exposure
The `knx.exposure_register` service can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
@ -373,7 +373,7 @@ respond_to_read:
default: true
{% endconfiguration %}
## Binary Sensor
## Binary sensor
The KNX binary sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
@ -1664,7 +1664,7 @@ device_class:
type: string
{% endconfiguration %}
### Value Types
### Value types
| KNX DPT | type | size in byte | range | unit |
| ------: | ----------------------------- | -----------: | :------------------------: | -------------- |

View File

@ -30,7 +30,7 @@ Before you get started with this integration, please note that:
- Requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
## Rootless Setup
## Rootless setup
Normally accessing the Bluetooth stack is reserved for `root`, but running programs that are networked as `root` is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and `hcitool` the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](https://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).

View File

@ -13,7 +13,7 @@ ha_integration_type: integration
The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
## Tested Devices
## Tested devices
- Technoline TX 29 IT (temperature only)
- Technoline TX 29 DTH-IT (including humidity)

View File

@ -60,7 +60,7 @@ Further data that is read from the device is added as diagnostic entities:
- Settings and firmware
- Flow hours
## Energy Dashboard
## Energy dashboard
Either heat usage or volume usage can be used as "Gas" on the energy dashboard. If you want to supply a price per MWh, make sure to apply the conversion factor first.

View File

@ -332,7 +332,7 @@ switches:
type: string
{% endconfiguration %}
## LCN Addresses
## LCN addresses
LCN hardware devices connected to the LCN bus are called _modules_. LCN modules are addressed by their numeric id in the range (5..254).
@ -364,7 +364,7 @@ s0.g7
Leading zeroes in the segment id or module/group id can be omitted. If the `connection_id` is omitted, the first connection defined in the [configuration](#configuration) will be used.
## LCN Constants
## LCN constants
The platforms and service calls use several predefined constants as parameters.
@ -421,7 +421,7 @@ Examples: `a1`, `a5`, `d8`.
## Platforms
### Binary Sensor
### Binary sensor
The `lcn` binary sensor platform allows the monitoring of the following [LCN](https://www.lcn.eu/) binary data sources:
@ -497,7 +497,7 @@ The `lcn` switch platform allows the control of the following [LCN](https://www.
- Output ports
- Relays
## Additional Features
## Additional features
### Transponder, fingerprint sensor and code lock

View File

@ -25,7 +25,7 @@ You can currently configure the settings for motion/static triggers by USB with
(This integration may not work if you reconfigure the default password or the number of gates.)
## Sensors Provided
## Sensors provided
The following sensors are provided:

View File

@ -235,7 +235,7 @@ The LIFX integration currently has to poll the device every few seconds, as oppo
Discoveries from control protocols that are not desired can be ignored in the UI. LIFX devices that support HAP will be discovered by both methods if they have not been added to native HomeKit using an Apple iOS or macOS device. It is possible to set up control of the device in Home Assistant using both protocols simultaneously by configuring both the LIFX integration and the HomeKit Controller integration for the same device.
## LIFX Switch
## LIFX switch
The LIFX integration does not support the LIFX Switch. However, the [HomeKit Controller](/integrations/homekit_controller) integration can be used instead for
[LIFX Switch running firmware 3.90](https://support.lifx.com/en_us/switch-3-90-update-rk4zYiXVq) or higher. Follow the LIFX
@ -245,7 +245,7 @@ When using the [HomeKit Controller](/integrations/homekit_controller) integratio
[stateless switch](/integrations/homekit_controller#stateless-switches-and-sensors) and will not appear as an entity in Home Assistant.
Relays that are configured as wired to non-LIFX devices will appear as normal switches in Home Assistant.
## Troubleshooting Discovery
## Troubleshooting discovery
### Lights

View File

@ -775,7 +775,7 @@ mqtt:
supported_color_modes: ["brightness"]
```
### Brightness Scaled
### Brightness scaled
To enable a light using a brightness scale other than 8bit the `brightness_scale` option may be added to denote the "fully on" value:
@ -802,7 +802,7 @@ Home Assistant will then convert its 8bit value in the message to and from the d
}
```
### HS Color
### HS color
To use a light with hue+saturation as the color model, set `supported_color_modes` to `["hs"]` in the platform configuration:

View File

@ -98,7 +98,7 @@ bridges:
type: boolean
{% endconfiguration %}
### Night Effect
### Night effect
LimitlessLED has a `night` effect that can be used to dim the lights below `brightness: 1`. This night mode is meant to temporarily turn the lights into a nightlight. This mode can be especially helpful when wall switches are also being used. For example, when a light is using the `night` effect one way to return it to its previous brightness level (other than using Home Assistant) is to switch the lights off and then back on from the wall switch.

View File

@ -48,7 +48,7 @@ linode:
type: string
{% endconfiguration %}
## Binary Sensor
## Binary sensor
The `linode` binary sensor platform allows you to monitor your Linode nodes.

View File

@ -40,10 +40,10 @@ Please visit [LIVISI Community](https://community.livisi.de) for more informatio
{% include integrations/config_flow.md %}
### Extra Configuration
### Extra configuration
The current integration will not find your SHC automatically and needs to be configured manually. You will need to provide the IP address and the local password for the controller.
## Device Discovery
## Device discovery
All devices are automatically discovered and included by the integration. If you include a new device in LIVISI SmartHome, the device will automatically appear in Home Assistant after a few minutes.

View File

@ -110,7 +110,7 @@ lock:
{% endraw %}
### Optimistic Mode
### Optimistic mode
This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor.

View File

@ -65,7 +65,7 @@ include:
type: list
{% endconfiguration %}
## Configure Filter
## Configure filter
By default, the logbook will use the same filter as the recorder. To limit which entities are being exposed to `Logbook`, you can use the `include` and `exclude` parameters.
@ -136,7 +136,7 @@ logbook:
- sensor.weather_*
```
### Exclude Events
### Exclude events
If you have `sensor.date` to show the current date in the UI,
but you do not want a logbook entry for that sensor every day it can be excluded.
@ -151,7 +151,7 @@ for sun rise and sun set.
Excluded entities still take up space in the database. It may be advisable to
exclude them in `recorder` instead.
### Custom Entries
### Custom entries
It is possible to add custom entries to the logbook by using the script
integration to fire an event.

View File

@ -104,7 +104,7 @@ If you want to know the namespaces in your own environment then check your log f
You will see INFO log messages from homeassistant.loader stating `loaded <component> from <namespace>`.
Those are the namespaces available for you to set a `log level` against.
### Log Levels
### Log levels
Possible log severity levels, listed in order from most severe to least severe, are:
@ -117,7 +117,7 @@ Possible log severity levels, listed in order from most severe to least severe,
- debug
- notset
### Log Filters
### Log filters
Service-specific Regular Expression filters for logs. A message is omitted if it matches the Regular Expression.

View File

@ -93,11 +93,11 @@ The Lutron scene platform allows you to control scenes programmed into your SeeT
After setup, scenes will appear in Home Assistant using the area, keypad and button name.
## Occupancy Sensors
## Occupancy sensors
Any configured Powr Savr occupancy sensors will be added as occupancy binary sensors. Lutron reports occupancy for an area, rather than reporting individual sensors. Sensitivity and timeouts are controlled on the sensors themselves, not in software.
## Example Automations
## Example automations
``` yaml
- alias: "keypad button pressed notification"

View File

@ -193,7 +193,7 @@ alarm_control_panel:
Refer to the [Manual Alarm Control page](/integrations/manual#examples) for more real-life examples on how to use this panel.
## MQTT Control
## MQTT control
The state of this alarm can be controlled using [MQTT](/integrations/mqtt/). Ensure you've configured that before adding this component.

View File

@ -89,7 +89,7 @@ In order to prevent infinite loops when reacting to commands, you have to use a
</div>
### Event Data
### Event data
If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field.

View File

@ -32,7 +32,7 @@ Supported Devices:
- MAX! Window Sensor (tested)
- MAX! Wall Thermostat (tested)
### One Gateway
### One gateway
A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required:
@ -43,7 +43,7 @@ maxcube:
- host: 192.168.0.20
```
### Multiple Gateways
### Multiple gateways
```yaml
# Example configuration.yaml entry

View File

@ -28,7 +28,7 @@ The Medcom Bluetooth integration will automatically discover devices once the [B
To limit the load on the Bluetooth radio on the Home Assistant side, the integration only polls for a reading every 5 minutes, which should be adequate for ongoing background monitoring. An Inspector BLE battery should last several months with continuous use before needing replacement.
## Supported Devices
## Supported devices
- Medcom Inspector BLE

View File

@ -178,7 +178,7 @@ Allows to group media players together for synchronous playback. Only works on s
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Unjoin this media player from any player groups. |
### Device Class
### Device class
The way media players are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for media players:

View File

@ -28,7 +28,7 @@ to your configuration file:
media_source:
```
## Local Media
## Local media
By default, the integration looks for media in a specified folder.
If other `media_dirs` are not declared you need to use `/media/local` path for

View File

@ -24,10 +24,10 @@ The Met Éireann API will only provide data for Ireland, the UK and a small part
{% include integrations/config_flow.md %}
## Data License
## Data license
The data provided by Met Éireann is licensed under the Met Éireann Open Data Custom License (similar to a Creative Commons CC BY 4.0 license). A license summary and the full license are available [here](https://data.gov.ie/dataset/met-eireann-weather-forecast-api/resource/027da6d5-d819-48d1-9b16-331dba169bd1). In short, if you distribute, broadcast or make Met Éireann data available on the public internet you must give credit to Met Éireann and display their weather warnings.
## Data Changes
## Data changes
The only changes made to the data gathered from the API are the condition descriptions which are mapped to the weather conditions supported by Home Assistant.

View File

@ -35,7 +35,7 @@ Precision:
description: Round the calculated mean, median or sum value to at most N decimal places.
{% endconfiguration_basic %}
## YAML Configuration
## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the

View File

@ -121,7 +121,7 @@ automation:
{% endraw %}
## Platform Services
## Platform services
These services are provided:

View File

@ -26,7 +26,7 @@ If you are using an IP232 module instead of a direct serial connection, then use
Sources can also be later edited from the integration options (gear icon in the top right when selecting the integration). Note that editing sources will remove the snapshot you may have saved.
## Zone Management
## Zone management
Devices and entities are created for each of the possible 18 zones, and can be enabled, disabled and renamed through regular Home Assistant methods.
By default, the first 6 zones (11..16) are enabled, and there's an attempt to automatically detect the 12 extension zones (21..26, and 31..36) on the first run.

View File

@ -58,7 +58,7 @@ The following bridges are reported to work with this integration:
The 16 character API key needed to setup the Home Assistant integration needs to be retrieved by first connecting the blind/bridge to the official app of its respective brand.
In that app the key can often be found by clicking multiple times on specific places on the "About" page.
### Motion Blinds app
### Motion blinds app
The Motion Blinds API uses a 16 character key that can be retrieved from the official "Motion Blinds" app for [IOS](https://apps.apple.com/us/app/motion-blinds/id1437234324) or [Android](https://play.google.com/store/apps/details?id=com.coulisse.motion).

View File

@ -37,7 +37,7 @@ ignore_event:
type: list
{% endconfiguration %}
## Multiple Instances
## Multiple instances
Events from multiple instances can be aggregated to a single parent instance by subscribing to a wildcard topic from the parent instance.

View File

@ -74,7 +74,7 @@ include:
type: list
{% endconfiguration %}
### Configure Filter
### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `MQTT Statestream`, you can use the `include` and `exclude` parameters.

View File

@ -66,7 +66,7 @@ $ curl http://[IP_ADDRESS]/api/v1/device/[MAC_ADDRESS]
}
```
## Binary Sensor
## Binary sensor
The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern:

View File

@ -100,7 +100,7 @@ And a specific Platform Service:
- `neato.custom_cleaning`
### Platform Services
### Platform services
#### Service `neato.custom_cleaning`

View File

@ -131,7 +131,7 @@ resources:
default: false
{% endconfiguration %}
### Full Example
### Full example
```yaml
# Example configuration.yaml entry

View File

@ -37,7 +37,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 thermostat:

View File

@ -28,7 +28,7 @@ If you have a sensor session running, and you have enabled the Nightscout integr
The icon changes to indicate the direction or trend, of the glucose readings.
The state is the last reading from Nightscout, and you can see other information about the reading in the sensor's attributes.
### Example Automation
### Example automation
```yaml
- id: "1234567890123"

View File

@ -135,7 +135,7 @@ devices:
type: string
{% endconfiguration %}
## Binary Sensor
## Binary sensor
The `numato` binary_sensor platform allows you to operate the GPIOs of your
[Numato](https://numato.com) 32 port USB GPIO expander in binary input mode.
@ -168,7 +168,7 @@ state.
The `numato` switch platform allows you to operate the GPIOs of your
[Numato](https://numato.com) 32 port USB GPIO expander in output mode.
## IO Ports
## IO ports
The IO port numbers used in this configuration refer to the port numbers
printed on the PCB. Note that the Sensor platform can be configured on ports

View File

@ -18,7 +18,7 @@ Keeps track on `number` entities in your environment, their state, and allows yo
If you are looking for a way to create a number entity, please take a look at the [Number helper](/integrations/input_number).
## Device Class
## Device class
The type of data a number represents impacts how it is displayed in the frontend. This is controlled by the number's device class designation. Built-in numbers and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new number the device class may be optionally assigned. A full list of available number device classes is below:

View File

@ -35,7 +35,7 @@ This integration will create these sensors:
- `nzbget_size`: Amount of data downloaded since server start in MB.
- `nzbget_speed_limit`: Download queue speed limit in MB/s.
## Event Automation
## Event automation
The NZBGet integration continuously monitors nzbget's download history. When a download completes, an event usable for automation is triggered on the Home Assistant Bus.