Add documentation for Starlink (#23993)

Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Jack Boswell 2023-01-08 09:20:25 +13:00 committed by GitHub
parent 1415381ba1
commit 1207d6840b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,32 @@
---
title: Starlink
description: Instructions on how to integrate Starlink into Home Assistant.
ha_category:
- Sensor
ha_release: 2023.2
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@boswelja'
ha_domain: starlink
ha_platforms:
- sensor
ha_integration_type: integration
---
The Starlink integration allows you to integrate your [Starlink](https://www.starlink.com/) into Home Assistant.
**Important:** Your Starlink must **not** be in bypass mode. In this mode, the local API is unavailable, and this integration will not work.
{% include integrations/config_flow.md %}
### Sensor
The following sensors are added for each Starlink system:
- Ping - The ping that Starlink has measured, in ms
- Azimuth - The direction Dishy is facing in degrees
- Elevation - Dishy's current elevation in degrees
- Uplink throughput - The amount of data being uploaded through Starlink in Mbit/s
- Downlink throughput - The amount of data being downloaded through Starlink in Mbit/s
- Last boot time - The time Starlink was last turned on