mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 04:16:48 +00:00
s-t integrations: apply sentence-style capitalization (#29864)
* s-t integrations: apply sentence-style capitalization * Fix capitalization errors in brand names I instroduced in previous commit.
This commit is contained in:
parent
05f8a073b7
commit
eb027142ab
@ -167,7 +167,7 @@ You need to pass a `scene_id` in lowercase and with underscores instead of space
|
||||
|
||||
If the scene was previously created by `scene.create`, it will be overwritten. If the scene was created by YAML, nothing happens but a warning in your log files.
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
This video tutorial explains how scenes work and how you can utilize scenes on the fly.
|
||||
|
||||
<lite-youtube videoid="JW9PC6ptXcM" videotitle="Scenes on Steroids in Home Assistant - How To - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||
|
@ -45,7 +45,7 @@ password:
|
||||
|
||||
Once Home Assistant is started, you will have access to any thermostats registered with your account.
|
||||
|
||||
### Supported Features
|
||||
### Supported features
|
||||
|
||||
Currently, this integration supports the following features:
|
||||
|
||||
|
@ -49,7 +49,7 @@ Sets the operation of any connected color-capable lights.
|
||||
|
||||
## Reference
|
||||
|
||||
### Color Modes
|
||||
### Color modes
|
||||
|
||||
| color_mode | Name | Description |
|
||||
| ------------ | ------------ | --------------------------------------------------------------------------------------------------------- |
|
||||
|
@ -122,12 +122,12 @@ sequence:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
This video tutorial explains how scripts work, how to use fields in scripts, and how to use response variables in scripts.
|
||||
|
||||
<lite-youtube videoid="vD_xckjQxRk" videotitle="Mastering Scripts in Home Assistant: A Comprehensive Guide" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
### Script Modes
|
||||
### Script modes
|
||||
|
||||
Mode | Description
|
||||
-|-
|
||||
@ -140,7 +140,7 @@ Mode | Description
|
||||
<img src='/images/integrations/script/script_modes.jpg'>
|
||||
</p>
|
||||
|
||||
### Full Configuration
|
||||
### Full configuration
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
@ -76,20 +76,20 @@ You can reset your filter check by using the button available on climate devices
|
||||
|
||||
By pressing the button, you tell your device that you have cleaned or replaced the filter.
|
||||
|
||||
## Number Entities
|
||||
## Number entities
|
||||
|
||||
By using the number entities you can calibrate the temperature and hunmidity of your device.
|
||||
|
||||
These entities are disabled by default.
|
||||
|
||||
## Select Entities
|
||||
## Select entities
|
||||
|
||||
For supported devices, this integration provides support to set the following modes by the select entity:
|
||||
|
||||
- Horizontal swing
|
||||
- Light
|
||||
|
||||
## Sensor Entities
|
||||
## Sensor entities
|
||||
|
||||
For all devices, these sensors are available:
|
||||
|
||||
@ -130,7 +130,7 @@ For climate devices, these sensors are available:
|
||||
- Climate React low temperature threshold
|
||||
- Climate React high temperature threshold
|
||||
|
||||
## Switch Entities
|
||||
## Switch entities
|
||||
|
||||
For climate devices, these switches are available:
|
||||
|
||||
@ -146,7 +146,7 @@ For Pure devices, this integration provides support to enable/disable Pure Boost
|
||||
|
||||
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` service. See [Pure Boost](#pure-boost)
|
||||
|
||||
## Custom Services
|
||||
## Custom services
|
||||
|
||||
### Full state
|
||||
|
||||
|
@ -15,7 +15,7 @@ Sensors are a basic integration in Home Assistant. They monitor the states and c
|
||||
|
||||
Some of these sensors are built-in to Home Assistant, some are created automatically when you add an integration (see this [list](/integrations/#sensor)), and some can be created manually. The [Statistics](/integrations/statistics) and [Template](/integrations/template) sensors are two examples of the last case.
|
||||
|
||||
## Device Class
|
||||
## Device class
|
||||
|
||||
The type of data a sensor returns impacts how it is displayed in the frontend. This is controlled by the sensor's device class designation. Built-in sensors 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 sensor the device class may be optionally assigned. A full list of available sensor device classes is below:
|
||||
|
||||
|
@ -37,9 +37,9 @@ Currently only the SkyBell HD is supported by this platform.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
### Binary Sensor
|
||||
### Binary sensor
|
||||
|
||||
Each added configuration entry will create the following binary sensors:
|
||||
|
||||
|
@ -110,7 +110,7 @@ notify_sms_user1:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Required Hardware
|
||||
## Required hardware
|
||||
|
||||
You will need a USB GSM stick modem or device like SIM800L v2 connected via USB UART.
|
||||
|
||||
|
@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
|
||||
</div>
|
||||
|
||||
## Presence Detection
|
||||
## Presence detection
|
||||
|
||||
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/integrations/device_tracker/) than desirable. It is recommended to use [Ping](/integrations/ping) or [Nmap](/integrations/nmap_tracker) instead.
|
||||
|
||||
|
@ -69,7 +69,7 @@ automation:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
The `spc` platform allows you to get data from your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) binary sensors from within Home Assistant.
|
||||
|
||||
|
@ -26,7 +26,7 @@ By default, a speed test will be run every hour. You can disable polling using s
|
||||
|
||||
{% include common-tasks/define_custom_polling.md %}
|
||||
|
||||
## Integration Sensors
|
||||
## Integration sensors
|
||||
|
||||
The following sensors are added by the integration:
|
||||
|
||||
|
@ -84,7 +84,7 @@ filter:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Configure Filter
|
||||
### Configure filter
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `Splunk`, you can use the `filter` parameter.
|
||||
|
||||
|
@ -146,6 +146,6 @@ script:
|
||||
|
||||
The `media_content_id` value can be obtained from the Spotify desktop app by clicking on the more options ("...") next to the album art picture, selecting "Share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app). Alternatively a Spotify URI string (e.g. `spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ`) can be supplied for the `media_content_id`.
|
||||
|
||||
## Unsupported Devices
|
||||
## Unsupported devices
|
||||
|
||||
- **Sonos**: Although Sonos is a Spotify Connect device, it is not supported by the official Spotify API.
|
||||
|
@ -23,7 +23,7 @@ This integration is by default enabled, unless you've disabled or removed the [`
|
||||
ssdp:
|
||||
```
|
||||
|
||||
## Discovered Integrations
|
||||
## Discovered integrations
|
||||
|
||||
The following integrations are automatically discovered by the SSDP integration:
|
||||
|
||||
|
@ -19,7 +19,7 @@ The Starling Bank sensor platform allows you to monitor your account balance dat
|
||||
|
||||
You can find more information about Starling Bank at [their website](https://www.starlingbank.com/). Information on their API can be found on their [developers site](https://developer.starlingbank.com/).
|
||||
|
||||
## Access Token
|
||||
## Access token
|
||||
|
||||
Once you have your own Starling bank account you will need to sign up for a Starling developer account [here](https://developer.starlingbank.com/signup). You won't need to do any development but you will need to get a "Personal Access Token" that will allow the integration to access your account balance.
|
||||
|
||||
|
@ -41,7 +41,7 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
|
||||
- Downlink throughput - The amount of data being downloaded through Starlink
|
||||
- Last boot time - The time Starlink was last turned on
|
||||
|
||||
### Binary Sensor
|
||||
### Binary sensor
|
||||
|
||||
- Update available - Whether there is an update pending install
|
||||
- Obstructed - Whether Dishy is currently obstructed
|
||||
@ -62,6 +62,6 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
|
||||
|
||||
- Stowed - Controls whether Dishy is stowed
|
||||
|
||||
### Device Tracker
|
||||
### Device tracker
|
||||
|
||||
- Device location - Tracks the location of Dishy. Note you need to allow location access on the local network via the Starlink app for this to work. This is disabled by default in the Starlink app and is thus disabled by default in Home Assistant.
|
||||
|
@ -19,7 +19,7 @@ ha_integration_type: integration
|
||||
|
||||
The Steamist will allow you to monitor the state of your [Steamist](https://steamist.com/digital-controls/) steam shower and turn on and off the steam generator.
|
||||
|
||||
## Supported Devices
|
||||
## Supported devices
|
||||
|
||||
- 450 Digital Control
|
||||
- 550 Digital Control
|
||||
|
@ -57,7 +57,7 @@ stream:
|
||||
```
|
||||
|
||||
|
||||
## Technical Details
|
||||
## Technical details
|
||||
|
||||
The integration currently supports proxying H.264 and H.265 source streams to the HLS (and LL-HLS) protocol.
|
||||
|
||||
|
@ -36,7 +36,7 @@ If that is the case, you can configure it as described in the next paragraphs.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
Alternatively, this integration can be configured and set up manually via YAML
|
||||
instead. To enable the sun integration in your installation, add the
|
||||
|
@ -20,7 +20,7 @@ Keeps track which switches are in your environment, their state and allows you t
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
||||
## Device Class
|
||||
## Device class
|
||||
|
||||
The way these switches are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for switches:
|
||||
|
||||
|
@ -47,7 +47,7 @@ Please note, device names configured in the SwitchBot app are not transferred in
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Supported Devices
|
||||
## Supported devices
|
||||
|
||||
- [Color Bulb (WoBulb)](https://switch-bot.com/pages/switchbot-color-bulb)
|
||||
- [Bot (WoHand)](https://switch-bot.com/pages/switchbot-bot)
|
||||
|
@ -29,7 +29,7 @@ the key on the right of the settings dialog.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
The Syncthing integration adds one sensor per syncing folder:
|
||||
|
||||
|
@ -24,10 +24,10 @@ ha_integration_type: device
|
||||
## Prerequisites
|
||||
### Version
|
||||
This integration requires System Bridge 3.1.1 and above. Any older version will not work.
|
||||
### API Key
|
||||
### API key
|
||||
You will need your API key. This can be found following the documentation [here](https://system-bridge.timmo.dev/docs/running).
|
||||
{% include integrations/config_flow.md %}
|
||||
## Binary Sensors
|
||||
## Binary sensors
|
||||
This integration provides the following binary sensors:
|
||||
| Name | Description |
|
||||
| --------------------- | ---------------------------------- |
|
||||
@ -78,7 +78,7 @@ The integration also provides a media player. This allows you control the curren
|
||||
|
||||
> This is currently only supported devices running System Bridge on Windows.
|
||||
|
||||
## Media Source
|
||||
## Media source
|
||||
|
||||
This integration is available as a media source to use with the media browser integration. You can browse and view media from your system to media players such as your web browser and other supported media players.
|
||||
|
||||
|
@ -44,7 +44,7 @@ The Tado thermostats are internet connected thermostats. There exists an unoffic
|
||||
|
||||
It currently supports presenting the current temperature, the setting temperature and the current operation mode. The operation mode can be set to manual, auto and off. If no user is at home anymore, all Tado zones show the away-state (Only with Tado assist mode). Manually switching between home-mode and away-mode is also supported. Manually switching to auto-mode is only supported with Tado assist mode. Any Tado climate card can be switched between these presence modes, this changes the setting for the entire home.
|
||||
|
||||
## Presence Detection
|
||||
## Presence detection
|
||||
|
||||
The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and its support for person presence detection based on smartphone location by geofencing.
|
||||
|
||||
|
@ -106,7 +106,7 @@ Happy printing!
|
||||
|
||||

|
||||
|
||||
## Tag Scanned events
|
||||
## Tag scanned events
|
||||
|
||||
When a tag is scanned, the `tag_scanned` event is fired. This event contains the values:
|
||||
|
||||
|
@ -34,7 +34,7 @@ This integration allows you to control [Tasmota](https://tasmota.github.io/docs/
|
||||
- Tasmota devices configured for native discovery (`SetOption19 0`).
|
||||
- Although the Tasmota integration supports custom fulltopic it is strongly suggested to leave fulltopic at its default, Tasmota does not prevent setting an invalid or non-unique fulltopic, for example a fulltopic without the `%prefix%` or `%topic%` tokens.
|
||||
|
||||
## Supported Features
|
||||
## Supported features
|
||||
|
||||
Tasmota Buttons, Fans, Lights, Relays, Sensors, Shutters and Switches are supported.
|
||||
|
||||
|
@ -151,7 +151,7 @@ sensor:
|
||||
{% endraw %}
|
||||
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
The TCP Binary Sensor is a type of [TCP Sensor](#sensor) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
|
||||
|
||||
|
@ -400,7 +400,7 @@ template:
|
||||
|
||||
[trigger-doc]: /docs/automation/trigger
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
This video tutorial explains how to set up a Trigger based template that makes use of an action to retrieve the weather forecast (precipitation).
|
||||
|
||||
<lite-youtube videoid="zrWqDjaRBf0" videotitle="How to create Action Template Sensors in Home Assistant" posterquality="maxresdefault"></lite-youtube>
|
||||
|
@ -33,7 +33,7 @@ Upper limit:
|
||||
description: The upper threshold which the observed value is compared against.
|
||||
{% 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
|
||||
|
@ -55,7 +55,7 @@ The `tibber` sensor provides the current electricity price if you are a [Tibber]
|
||||
You also get sensors for monthly consumption, monthly cost, and monthly peak hour
|
||||
If you have a Tibber Pulse it will also show the electricity consumption in real time.
|
||||
|
||||
## Available Sensors
|
||||
## Available sensors
|
||||
|
||||
- Accumulated cost since midnight (requires active Tibber power deal)
|
||||
- kWh consumed since midnight
|
||||
|
@ -66,7 +66,7 @@ timer:
|
||||
|
||||
Pick an icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) to use for your timer and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
|
||||
|
||||
## Possible States
|
||||
## Possible states
|
||||
|
||||
| State | Description |
|
||||
| ----- | ----------- |
|
||||
|
@ -26,7 +26,7 @@ Off time:
|
||||
description: The time when the sensor should turn off.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
Alternatlively, this integration can be configured and set up manually via YAML instead. This has some additional functionality over the UI version.
|
||||
|
||||
|
@ -91,7 +91,7 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
The Toon integration provides the following binary sensors:
|
||||
|
||||
|
@ -17,11 +17,11 @@ ha_integration_type: integration
|
||||
|
||||
`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on.
|
||||
|
||||
## Traccar Client
|
||||
## Traccar client
|
||||
|
||||
To configure Traccar Client, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration. This URL has to be set in the Traccar app.
|
||||
|
||||
## Traccar Server
|
||||
## Traccar server
|
||||
|
||||
To integrate Traccar Server in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
@ -30,7 +30,7 @@ To use the integration you must be a premium tractive client.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
The Tractive integration adds one device tracker and several sensors and switches per registered pet:
|
||||
|
||||
|
@ -26,7 +26,7 @@ Your Transmission client must first be configured to allow remote access. In you
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
The Transmission integration will add the following sensors and switches.
|
||||
|
||||
@ -44,7 +44,7 @@ The Transmission integration will add the following sensors and switches.
|
||||
- `switch.transmission_switch`: A switch to start/stop all torrents.
|
||||
- `switch.transmission_turtle_mode`: A switch to enable turtle mode (a.k.a. alternative speed limits).
|
||||
|
||||
## Event Automation
|
||||
## Event automation
|
||||
|
||||
The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus containing the torrent name and ID, which can be used with automations.
|
||||
|
||||
|
@ -174,7 +174,7 @@ If no devices show up in Home Assistant:
|
||||
|
||||
Tuya supports scenes in their app. These allow triggering some of the more complex modes of various devices such as light changing effects. Scenes created in the Tuya app will automatically appear in the Scenes list in Home Assistant the next time the integration updates.
|
||||
|
||||
## Related Documents
|
||||
## Related documents
|
||||
|
||||
- [Tuya Integration Documentation Page](https://github.com/tuya/tuya-home-assistant)
|
||||
- [Supported Tuya Device Category](https://github.com/tuya/tuya-home-assistant/blob/main/docs/supported_devices.md)
|
||||
|
Loading…
x
Reference in New Issue
Block a user