Jack Boswell 8a4e45b112
Add documentation for Ping drop rate & fix missing sensors (#27015)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2023-04-16 08:25:44 -10:00

2.2 KiB

title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_platforms ha_integration_type ha_quality_scale
Starlink Instructions on how to integrate Starlink into Home Assistant.
Binary Sensor
Button
Network
Sensor
Switch
2023.2 Local Polling true
@boswelja
starlink
binary_sensor
button
diagnostics
sensor
switch
integration silver

The Starlink integration allows you to integrate your Starlink into Home Assistant.

Important: If your Starlink is in bypass mode, you will need to open a route to it so that the local API can be accessed. Otherwise this integration will not work.

{% include integrations/config_flow.md %}

Sensor

  • Ping - The ping that Starlink has measured, in ms
  • Ping drop rate - The percentage of failed ping requests (aka "dropped"). This is the inverse of "Uptime" in the Starlink app.
  • 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
  • Downlink throughput - The amount of data being downloaded through Starlink
  • Last boot time - The time Starlink was last turned on

Binary Sensor

  • Update available - Whether there is an update pending install
  • Obstructed - Whether Dishy is currently obstructed
  • Roaming mode - Whether Starlink is "roaming". Roaming is an optional upgrade that allows you to use your Starlink outside of your home address. It is also known as "portability mode"
  • Heating - Whether Dishy is currently heating. This may be due to cold temperatures, or an attempt to thaw snow and ice
  • Idle - Whether Starlink is "sleeping", as per the schedule defined in the Starlink app
  • Mast near vertical - Whether Dishy is mounted straight
  • Motors stuck - Whether Dishy is unable to move
  • Slow ethernet - Whether the Ethernet link is at max (gigabit) speed
  • Thermal throttle - Whether Starlink has reduced performance to avoid overheating
  • Unexpected location - Whether Starlink has detected operation outside of its designated area

Button

  • Reboot - Reboots your Starlink system

Switch

  • Stowed - Controls whether Dishy is stowed