From 1207d6840b5ea5e84dd0ef57dccea9a1362aca42 Mon Sep 17 00:00:00 2001 From: Jack Boswell Date: Sun, 8 Jan 2023 09:20:25 +1300 Subject: [PATCH] Add documentation for Starlink (#23993) Co-authored-by: J. Nick Koston Co-authored-by: Franck Nijhof --- source/_integrations/starlink.markdown | 32 ++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 source/_integrations/starlink.markdown diff --git a/source/_integrations/starlink.markdown b/source/_integrations/starlink.markdown new file mode 100644 index 00000000000..bc32b683baa --- /dev/null +++ b/source/_integrations/starlink.markdown @@ -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