core-entity-a-m: apply sentence-style capitalization to headings (#2187)

- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)
This commit is contained in:
c0ffeeca7 2024-05-23 10:09:39 +02:00 committed by GitHub
parent 8942adbb4c
commit 8ce81001c3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 60 additions and 60 deletions

View File

@ -1,5 +1,5 @@
--- ---
title: "Fetching Bluetooth Data" title: "Fetching Bluetooth data"
--- ---
## Choosing a method to fetch data ## Choosing a method to fetch data

View File

@ -1,6 +1,6 @@
--- ---
title: Air Quality Entity title: Air quality entity
sidebar_label: Air Quality sidebar_label: Air quality
--- ---
## Properties ## Properties

View File

@ -1,6 +1,6 @@
--- ---
title: Alarm Control Panel Entity title: Alarm control panel entity
sidebar_label: Alarm Control Panel sidebar_label: Alarm control panel
--- ---
An alarm control panel entity controls an alarm. Derive a platform entity from [`homeassistant.components.alarm_control_panel.AlarmControlPanelEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/alarm_control_panel/__init__.py). An alarm control panel entity controls an alarm. Derive a platform entity from [`homeassistant.components.alarm_control_panel.AlarmControlPanelEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/alarm_control_panel/__init__.py).
@ -34,7 +34,7 @@ Properties should always only return information from memory and not do I/O (lik
| `disarming` | The alarm is disarming. | `disarming` | The alarm is disarming.
| `triggered` | The alarm is triggered. | `triggered` | The alarm is triggered.
## Supported Features ## Supported features
Supported features are defined by using values in the `AlarmControlPanelEntityFeature` enum Supported features are defined by using values in the `AlarmControlPanelEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -48,7 +48,7 @@ and are combined using the bitwise or (`|`) operator.
| `AlarmControlPanelEntityFeature.ARM_VACATION` | The alarm supports arming in vacation mode. | `AlarmControlPanelEntityFeature.ARM_VACATION` | The alarm supports arming in vacation mode.
| `AlarmControlPanelEntityFeature.TRIGGER` | The alarm can be triggered remotely. | `AlarmControlPanelEntityFeature.TRIGGER` | The alarm can be triggered remotely.
### Code Formats ### Code formats
Supported code formats are defined by using values in the `CodeFormat` enum. Supported code formats are defined by using values in the `CodeFormat` enum.
@ -75,7 +75,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send disarm command.""" """Send disarm command."""
``` ```
### Alarm Arm Home ### Alarm arm home
Send arm home command. Send arm home command.
@ -90,7 +90,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send arm home command.""" """Send arm home command."""
``` ```
### Alarm Arm Away ### Alarm arm away
Send arm away command. Send arm away command.
@ -105,7 +105,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send arm away command.""" """Send arm away command."""
``` ```
### Alarm Arm Night ### Alarm arm night
Send arm night command. Send arm night command.
@ -120,7 +120,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send arm night command.""" """Send arm night command."""
``` ```
### Alarm Arm Vacation ### Alarm arm vacation
Send arm vacation command. Send arm vacation command.
@ -135,7 +135,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send arm vacation command.""" """Send arm vacation command."""
``` ```
### Alarm Trigger ### Alarm trigger
Send alarm trigger command. Send alarm trigger command.
@ -150,7 +150,7 @@ class MyAlarm(AlarmControlPanelEntity):
"""Send alarm trigger command.""" """Send alarm trigger command."""
``` ```
### Alarm Custom Bypass ### Alarm custom bypass
Send arm custom bypass command. Send arm custom bypass command.

View File

@ -1,6 +1,6 @@
--- ---
title: Binary Sensor Entity title: Binary sensor entity
sidebar_label: Binary Sensor sidebar_label: Binary sensor
--- ---
A binary sensor is a sensor that can only have two states. Derive entity platforms from [`homeassistant.components.binary_sensor.BinarySensorEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/__init__.py) A binary sensor is a sensor that can only have two states. Derive entity platforms from [`homeassistant.components.binary_sensor.BinarySensorEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/__init__.py)

View File

@ -1,5 +1,5 @@
--- ---
title: Button Entity title: Button entity
sidebar_label: Button sidebar_label: Button
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Calendar Entity title: Calendar entity
sidebar_label: Calendar sidebar_label: Calendar
--- ---
@ -37,7 +37,7 @@ Assistant timezone. An entity should call `homeassistant.util.dt.now` to get the
current time which has a `tzinfo` value set to the HomeAssistant timezone or examine current time which has a `tzinfo` value set to the HomeAssistant timezone or examine
`homeassistant.components.util.dt.DEFAULT_TIMEZONE` `homeassistant.components.util.dt.DEFAULT_TIMEZONE`
## Supported Features ## Supported features
Supported features are defined by using values in the `CalendarEntityFeature` enum Supported features are defined by using values in the `CalendarEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -50,7 +50,7 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Get Events ### Get events
A calendar entity can return events that occur during a particular time range. Some notes for implementors: A calendar entity can return events that occur during a particular time range. Some notes for implementors:
@ -80,7 +80,7 @@ class MyCalendar(CalendarEntity):
"""Return calendar events within a datetime range.""" """Return calendar events within a datetime range."""
``` ```
### Create Events ### Create events
A calendar entity may support creating events by specifying the `CREATE_EVENT` supported feature. Integrations that support mutation must handle rfc5545 fields and best practices such as preserving any new unknown fields that are set and recurring events. A calendar entity may support creating events by specifying the `CREATE_EVENT` supported feature. Integrations that support mutation must handle rfc5545 fields and best practices such as preserving any new unknown fields that are set and recurring events.
@ -93,7 +93,7 @@ class MyCalendar(CalendarEntity):
"""Add a new event to calendar.""" """Add a new event to calendar."""
``` ```
### Delete Events ### Delete events
A calendar entity may support deleting events by specifying the `DELETE_EVENT` supported feature. Integrations that support mutation must support rfc5545 recurring events. A calendar entity may support deleting events by specifying the `DELETE_EVENT` supported feature. Integrations that support mutation must support rfc5545 recurring events.
@ -118,7 +118,7 @@ class MyCalendar(CalendarEntity):
"""Delete an event on the calendar.""" """Delete an event on the calendar."""
``` ```
### Update Events ### Update events
A calendar entity may support updating events by specifying the `UPDATE_EVENT` supported feature. Integrations that support mutation must support rfc5545 recurring events. A calendar entity may support updating events by specifying the `UPDATE_EVENT` supported feature. Integrations that support mutation must support rfc5545 recurring events.

View File

@ -1,5 +1,5 @@
--- ---
title: Camera Entity title: Camera entity
sidebar_label: Camera sidebar_label: Camera
--- ---
@ -23,7 +23,7 @@ Properties should always only return information from memory and not do I/O (lik
| motion_detection_enabled | `bool` | `False` | Indication of whether the camera has motion detection enabled. | | motion_detection_enabled | `bool` | `False` | Indication of whether the camera has motion detection enabled. |
| use_stream_for_stills | `bool` | `False` | Determines whether or not to use the `Stream` integration to generate still images | | use_stream_for_stills | `bool` | `False` | Determines whether or not to use the `Stream` integration to generate still images |
## Supported Features ## Supported features
Supported features are defined by using values in the `CameraEntityFeature` enum Supported features are defined by using values in the `CameraEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -35,7 +35,7 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Camera Image ### Camera image
When the width and height are passed, scaling should be done on a best-effort basis. The UI will fall back to scaling at the display layer if scaling cannot be done by the camera. When the width and height are passed, scaling should be done on a best-effort basis. The UI will fall back to scaling at the display layer if scaling cannot be done by the camera.
@ -64,7 +64,7 @@ class MyCamera(Camera):
``` ```
### Stream Source ### Stream source
The stream source should return a url that is usable by ffmpeg (e.g. an RTSP url). Requires `CameraEntityFeature.STREAM`. The stream source should return a url that is usable by ffmpeg (e.g. an RTSP url). Requires `CameraEntityFeature.STREAM`.
@ -80,7 +80,7 @@ class MyCamera(Camera):
A common way for a camera entity to render a camera still image is to pass the stream source to `async_get_image` in the `ffmpeg` component. A common way for a camera entity to render a camera still image is to pass the stream source to `async_get_image` in the `ffmpeg` component.
### WebRTC Streams ### WebRTC streams
WebRTC enabled cameras can be used by facilitating a direct connection with the home assistant frontend. This usage requires `CameraEntityFeature.STREAM` with `frontend_stream_type` set to `StreamType.WEB_RTC`. The integration should implement `async_handle_web_rtc_offer` which passes the frontend's SDP offer to the device and returns back the answer. WebRTC enabled cameras can be used by facilitating a direct connection with the home assistant frontend. This usage requires `CameraEntityFeature.STREAM` with `frontend_stream_type` set to `StreamType.WEB_RTC`. The integration should implement `async_handle_web_rtc_offer` which passes the frontend's SDP offer to the device and returns back the answer.

View File

@ -1,5 +1,5 @@
--- ---
title: Climate Entity title: Climate entity
sidebar_label: Climate sidebar_label: Climate
--- ---
@ -52,7 +52,7 @@ enum. If you want another mode, add a preset instead.
| `HVACMode.DRY` | The device is set to dry/humidity mode. | | `HVACMode.DRY` | The device is set to dry/humidity mode. |
| `HVACMode.FAN_ONLY` | The device only has the fan on. No heating or cooling taking place. | | `HVACMode.FAN_ONLY` | The device only has the fan on. No heating or cooling taking place. |
### HVAC Action ### HVAC action
The HVAC action describes the _current_ action. This is different from the mode, because if a device is set to heat, and the target temperature is already achieved, the device will not be actively heating anymore. It is only allowed to use the built-in HVAC actions, provided by the `HVACAction` enum. The HVAC action describes the _current_ action. This is different from the mode, because if a device is set to heat, and the target temperature is already achieved, the device will not be actively heating anymore. It is only allowed to use the built-in HVAC actions, provided by the `HVACAction` enum.
@ -109,7 +109,7 @@ The device fan can have different swing modes that it wants the user to know abo
| `SWING_HORIZONTAL` | The fan is swinging horizontal. | | `SWING_HORIZONTAL` | The fan is swinging horizontal. |
| `SWING_BOTH` | The fan is swinging both horizontal and vertical. | | `SWING_BOTH` | The fan is swinging both horizontal and vertical. |
## Supported Features ## Supported features
Supported features are defined by using values in the `ClimateEntityFeature` enum Supported features are defined by using values in the `ClimateEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Conversation Entity title: Conversation entity
sidebar_label: Conversation sidebar_label: Conversation
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Cover Entity title: Cover entity
sidebar_label: Cover sidebar_label: Cover
--- ---
@ -19,7 +19,7 @@ Properties should always only return information from memory and not do I/O (lik
| is_closing | <code>bool &#124; None</code> | `None` | If the cover is closing or not. Used to determine `state`. | is_closing | <code>bool &#124; None</code> | `None` | If the cover is closing or not. Used to determine `state`.
| is_opening | <code>bool &#124; None</code> | `None` | If the cover is opening or not. Used to determine `state`. | is_opening | <code>bool &#124; None</code> | `None` | If the cover is opening or not. Used to determine `state`.
### Device Classes ### Device classes
| Constant | Description | Constant | Description
|----------|-----------------------| |----------|-----------------------|
@ -43,7 +43,7 @@ Properties should always only return information from memory and not do I/O (lik
| `STATE_CLOSING` | The cover is in the process of closing to reach a set position. | `STATE_CLOSING` | The cover is in the process of closing to reach a set position.
| `STATE_CLOSED` | The cover has reach the closed position. | `STATE_CLOSED` | The cover has reach the closed position.
## Supported Features ## Supported features
Supported features are defined by using values in the `CoverEntityFeature` enum Supported features are defined by using values in the `CoverEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Date Entity title: Date entity
sidebar_label: Date sidebar_label: Date
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Date/Time Entity title: Date/Time entity
sidebar_label: Date/Time sidebar_label: Date/Time
--- ---

View File

@ -1,6 +1,6 @@
--- ---
title: Device Tracker Entity title: Device tracker entity
sidebar_label: Device Tracker sidebar_label: Device tracker
--- ---
A device tracker is a read-only entity that provides presence information. There are two types of device tracker entities, a ScannerEntity and a TrackerEntity. A device tracker is a read-only entity that provides presence information. There are two types of device tracker entities, a ScannerEntity and a TrackerEntity.

View File

@ -1,5 +1,5 @@
--- ---
title: Fan Entity title: Fan entity
sidebar_label: Fan sidebar_label: Fan
--- ---
@ -21,7 +21,7 @@ Properties should always only return information from memory and not do I/O (lik
| preset_modes | <code>list[str] &#124; None</code> | `None` | The list of supported preset_modes. This is an arbitrary list of str and should not contain any speeds. | | preset_modes | <code>list[str] &#124; None</code> | `None` | The list of supported preset_modes. This is an arbitrary list of str and should not contain any speeds. |
| speed_count | `int` | 100 | The number of speeds the fan supports. | | speed_count | `int` | 100 | The number of speeds the fan supports. |
### Preset Modes ### Preset modes
A fan may have preset modes that automatically control the percentage speed or other functionality. Common examples include `auto`, `smart`, `whoosh`, `eco`, and `breeze`. If no preset mode is set, the `preset_mode` property must be set to `None`. A fan may have preset modes that automatically control the percentage speed or other functionality. Common examples include `auto`, `smart`, `whoosh`, `eco`, and `breeze`. If no preset mode is set, the `preset_mode` property must be set to `None`.
@ -29,7 +29,7 @@ Preset modes should not include named (manual) speed settings as these should be
Manually setting a speed must disable any set preset mode. If it is possible to set a percentage speed manually without disabling the preset mode, create a switch or service to represent the mode. Manually setting a speed must disable any set preset mode. If it is possible to set a percentage speed manually without disabling the preset mode, create a switch or service to represent the mode.
## Supported Features ## Supported features
Supported features are defined by using values in the `FanEntityFeature` enum Supported features are defined by using values in the `FanEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Humidifier Entity title: Humidifier entity
sidebar_label: Humidifier sidebar_label: Humidifier
--- ---
@ -47,7 +47,7 @@ A device can have different modes of operation that it might want to show to the
| `MODE_AUTO` | Device is controlling humidity by itself | | `MODE_AUTO` | Device is controlling humidity by itself |
| `MODE_BABY` | Device is trying to optimize for babies | | `MODE_BABY` | Device is trying to optimize for babies |
## Supported Features ## Supported features
Supported features are defined by using values in the `HumidifierEntityFeature` enum Supported features are defined by using values in the `HumidifierEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Image Entity title: Image entity
sidebar_label: Image sidebar_label: Image
--- ---

View File

@ -1,6 +1,6 @@
--- ---
title: Lawn Mower Entity title: Lawn mower entity
sidebar_label: Lawn Mower sidebar_label: Lawn mower
--- ---
Derive entity platforms from [`homeassistant.components.lawn_mower.LawnMowerEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/lawn_mower/__init__.py) Derive entity platforms from [`homeassistant.components.lawn_mower.LawnMowerEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/lawn_mower/__init__.py)
@ -25,7 +25,7 @@ Properties should always only return information from memory and not do I/O (lik
| `PAUSED` | The lawn mower was active and is now paused. | `PAUSED` | The lawn mower was active and is now paused.
| `ERROR` | The lawn mower encountered an error while active and needs assistance. | `ERROR` | The lawn mower encountered an error while active and needs assistance.
## Supported Features ## Supported features
Supported features are defined by using values in the `LawnMowerEntityFeature` enum Supported features are defined by using values in the `LawnMowerEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Light Entity title: Light entity
sidebar_label: Light sidebar_label: Light
--- ---
@ -25,7 +25,7 @@ A light entity controls the brightness, hue and saturation color value, white va
| supported_color_modes | <code>set[ColorMode] &#124; None</code> | `None` | Flag supported color modes. | supported_color_modes | <code>set[ColorMode] &#124; None</code> | `None` | Flag supported color modes.
| xy_color | <code>tuple[float, float] &#124; None</code> | `None` | The xy color value (float, float). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.XY` and ignored otherwise. | xy_color | <code>tuple[float, float] &#124; None</code> | `None` | The xy color value (float, float). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.XY` and ignored otherwise.
## Color Modes ## Color modes
New integrations must implement both `color_mode` and `supported_color_modes`. If an integration is upgraded to support color mode, both `color_mode` and `supported_color_modes` should be implemented. New integrations must implement both `color_mode` and `supported_color_modes`. If an integration is upgraded to support color mode, both `color_mode` and `supported_color_modes` should be implemented.
@ -75,7 +75,7 @@ There are two white color modes, `ColorMode.COLOR_TEMP` and `ColorMode.WHITE`. T
A lamp with adjustable color temperature is typically implemented by at least two banks of LEDs, with different color temperature, typically one bank of warm-white LEDs and one bank of cold-white LEDs. A lamp with adjustable color temperature is typically implemented by at least two banks of LEDs, with different color temperature, typically one bank of warm-white LEDs and one bank of cold-white LEDs.
A light with non-adjustable color temperature typically only has a single bank of white LEDs. A light with non-adjustable color temperature typically only has a single bank of white LEDs.
### Color Mode when rendering effects ### Color mode when rendering effects
When rendering an effect, the `color_mode` should be set according to the adjustments supported by the When rendering an effect, the `color_mode` should be set according to the adjustments supported by the
effect. If the effect does not support any adjustments, the `color_mode` should be set to `ColorMode.ONOFF`. effect. If the effect does not support any adjustments, the `color_mode` should be set to `ColorMode.ONOFF`.
@ -86,7 +86,7 @@ indicated by the `supported_color_mode` property:
- A light which supports colors is allowed to set color_mode to `ColorMode.ONOFF` or `ColorMode.BRIGHTNESS` when controlled by an effect - A light which supports colors is allowed to set color_mode to `ColorMode.ONOFF` or `ColorMode.BRIGHTNESS` when controlled by an effect
- A light which supports brightness is allowed to set color_mode to `ColorMode.ONOFF` when controlled by an effect - A light which supports brightness is allowed to set color_mode to `ColorMode.ONOFF` when controlled by an effect
## Supported Features ## Supported features
Supported features are defined by using values in the `LightEntityFeature` enum Supported features are defined by using values in the `LightEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -99,7 +99,7 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Turn on Light Device ### Turn on light device
```python ```python
class MyLightEntity(LightEntity): class MyLightEntity(LightEntity):

View File

@ -1,5 +1,5 @@
--- ---
title: Lock Entity title: Lock entity
sidebar_label: Lock sidebar_label: Lock
--- ---
@ -22,7 +22,7 @@ Properties should always only return information from memory and not do I/O (lik
| is_opening | bool | None | Indication of whether the lock is currently opening. Used to determine `state`. | is_opening | bool | None | Indication of whether the lock is currently opening. Used to determine `state`.
| is_open | bool | None | Indication of whether the lock is currently open. Used to determine `state`. | is_open | bool | None | Indication of whether the lock is currently open. Used to determine `state`.
## Supported Features ## Supported features
Supported features are defined by using values in the `LockEntityFeature` enum Supported features are defined by using values in the `LockEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,6 +1,6 @@
--- ---
title: Media Player Entity title: Media player entity
sidebar_label: Media Player sidebar_label: Media player
--- ---
:::info Incomplete :::info Incomplete
@ -49,7 +49,7 @@ Properties should always only return information from memory and not do I/O (lik
| volume_level | <code>float &#124; None</code> | `None` | Volume level of the media player in the range (0..1). | volume_level | <code>float &#124; None</code> | `None` | Volume level of the media player in the range (0..1).
| volume_step | <code>float &#124; None</code> | 0.1 | Volume step to use for the `volume_up` and `volume_down` services. | volume_step | <code>float &#124; None</code> | 0.1 | Volume step to use for the `volume_up` and `volume_down` services.
## Supported Features ## Supported features
Supported features are defined by using values in the `MediaPlayerEntityFeature` enum Supported features are defined by using values in the `MediaPlayerEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -94,7 +94,7 @@ The state of a media player is defined by using values in the `MediaPlayerState`
## Methods ## Methods
### Play Media ### Play media
Tells the media player to play media. Implement it using the following: Tells the media player to play media. Implement it using the following:
@ -130,7 +130,7 @@ The `enqueue` attribute is a string enum `MediaPlayerEnqueue`:
When the `announce` boolean attribute is set to `true`, the media player should try to pause the current music, announce the media to the user and then resume the music. When the `announce` boolean attribute is set to `true`, the media player should try to pause the current music, announce the media to the user and then resume the music.
### Browse Media ### Browse media
If the media player supports browsing media, it should implement the following method: If the media player supports browsing media, it should implement the following method:

View File

@ -1,5 +1,5 @@
--- ---
title: Notify Entity title: Notify entity
sidebar_label: Notify sidebar_label: Notify
--- ---