Add Starlink Integration #77091

boswelja · 2022-08-21T06:18:58Z

Proposed change

Add support for loading data from a Starlink terminal. I have tested the integration with my square Dishy & new terminal, and the underlying python library starlink-grpc-core has been used for both (new) square Dishy and (old) round Dishy.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add documentation for Starlink home-assistant.io#23993

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

homeassistant · 2022-08-21T06:19:02Z

Hi @boswelja,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

boswelja · 2022-08-21T07:02:23Z

I am working on tests now, I'd appreciate review on the code that's there in case there's something significant I've missed :)

frenck

Hi there @boswelja 👋

Some initial comments to help on getting this PR moving 👍

../Frenck

homeassistant/components/starlink/__init__.py

homeassistant/components/starlink/binary_sensor.py

homeassistant/components/starlink/config_flow.py

homeassistant/components/starlink/coordinator.py

homeassistant/components/starlink/dish_status.py

homeassistant/components/starlink/strings.json

homeassistant/components/starlink/translations/en.json

homeassistant/components/starlink/sensor.py

boswelja · 2022-08-26T11:03:02Z

If we're happy with the state of the config flow and sensors, I will begin writing some tests

avee87

Sensors look good to me - see some comments though.
Not sure about config flow, I don't know much about it.

homeassistant/components/starlink/entity.py

homeassistant/components/starlink/coordinator.py

homeassistant/components/starlink/sensor.py

homeassistant/components/starlink/coordinator.py

Co-authored-by: J. Nick Koston <nick@koston.org>

bdraco · 2023-01-06T02:24:38Z

Looks like there is a test failure otherwise this looks good

I'll factory reset mine this weekend and try it out when I can afford to have it offline

boswelja · 2023-01-06T02:25:19Z

Thanks for your time! I have fixed the tests locally, CI should run fine now
Edit: and of course checks fail because I said that

Dismissing stale review as it appears all comments have been addressed

bdraco · 2023-01-07T20:12:14Z

Factory reset was a bit of a PITA but it works great!

2023-01-07 19:42:08.642 INFO (SyncWorker_6) [homeassistant.loader] Loaded starlink from homeassistant.components.starlink
2023-01-07 20:10:35.887 INFO (MainThread) [homeassistant.setup] Setting up starlink
2023-01-07 20:10:35.888 INFO (MainThread) [homeassistant.setup] Setup of domain starlink took 0.0 seconds
2023-01-07 20:10:35.907 INFO (MainThread) [homeassistant.components.sensor] Setting up sensor.starlink
2023-01-07 20:10:35.908 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_ping
2023-01-07 20:10:35.909 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_azimuth
2023-01-07 20:10:35.909 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_elevation
2023-01-07 20:10:35.910 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_uplink_throughput
2023-01-07 20:10:35.910 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_downlink_throughput
2023-01-07 20:10:35.911 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new sensor.starlink entity: sensor.starlink_last_boot_time

bdraco · 2023-01-07T20:14:42Z

Thanks @boswelja

lyricnz · 2023-01-08T01:13:37Z

Works for me (old dishy, no router). Glad polling is 5s and not 1s. Is bits/sec a good choice? Most people will think in mbit/sec

rossfisherkc · 2023-01-08T01:16:37Z

There's quite a few sensors that could be added, imo:

(from the other integration)

I rely on the location, for example, to set my HA home location.

Having access to, and tracking all of the metrics is pretty swank. Maybe some can be added to this integration?

lyricnz · 2023-01-08T01:20:16Z

Agree. I assume this merge is just the first step towards parity with the third-party repo https://github.com/archerne/hastarlink

https://community.home-assistant.io/t/starlink-dish-and-network-stats/297155

rossfisherkc · 2023-01-08T01:21:30Z

Agree. I assume this merge is just the first step towards parity with the third-party repo https://github.com/archerne/hastarlink

Right! Getting things merged into mainline is hard enough, not complaining ;)

Great work getting this merged!

boswelja · 2023-01-08T01:35:02Z

Most people will think in mbit/sec

That's what I had it at, but we're not supposed to be modifying data from the Py library/API

There's quite a few sensors that could be added

Guidelines say we can only add one platform at a time. You are showing binary sensors and buttons. I have a PR up for binary sensors now: #85409
I'll need to poke around in the response data to find fields for the remaining sensors (ping drop rate, lat/long etc), but again one thing at a time, I'd like to get binary sensors and buttons going first 🙂

lyricnz · 2023-01-08T01:46:07Z

Is scaling/unit conversion really modifying?

boswelja · 2023-01-08T02:04:13Z

Considering I was asked to stop doing that, yes

Edit: You're welcome to read the PR review comments, it's all covered there

homeassistant/components/starlink/entity.py

script/gen_requirements_all.py

MartinHjelmare

Please address the comments in a new PR. Thanks!

MartinHjelmare · 2023-01-16T09:19:00Z

homeassistant/components/starlink/sensor.py

+        icon="mdi:clock",
+        device_class=SensorDeviceClass.TIMESTAMP,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        value_fn=lambda data: datetime.now().astimezone()


Please use our dt utils as far as possible.

core/homeassistant/util/dt.py

Lines 108 to 109 in ccd8bc1

def now(time_zone: dt.tzinfo | None = None) -> dt.datetime:

"""Get now in specified time zone."""

MartinHjelmare · 2023-01-16T09:20:25Z

homeassistant/components/starlink/sensor.py

+        device_class=SensorDeviceClass.TIMESTAMP,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        value_fn=lambda data: datetime.now().astimezone()
+        - timedelta(seconds=data["uptime"]),


Is this calculation stable so that the timestamp state doesn't update spammily?

I haven't noticed any issues, but I also haven't run this for longer than maybe a minute at a time. I can leave it polling for a while and see if you suspect there might be an issue?

project-bot bot added this to Needs review in Dev Aug 21, 2022

homeassistant added the cla-needed label Aug 21, 2022

probot-home-assistant bot added has-tests integration: starlink new-integration integration: starlink_dishy_stats labels Aug 21, 2022

homeassistant added cla-signed and removed cla-needed labels Aug 21, 2022

frenck previously requested changes Aug 21, 2022

View reviewed changes

Dev automation moved this from Needs review to Review in progress Aug 21, 2022

avee87 suggested changes Aug 23, 2022

View reviewed changes

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

boswelja force-pushed the feature/starlink-integration branch from aa5a80a to c45cebb Compare August 25, 2022 12:16

boswelja requested review from frenck and avee87 and removed request for frenck August 25, 2022 13:17

avee87 reviewed Aug 25, 2022

View reviewed changes

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

avee87 reviewed Aug 25, 2022

View reviewed changes

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

boswelja requested review from frenck and avee87 and removed request for frenck August 26, 2022 11:02

avee87 reviewed Aug 26, 2022

View reviewed changes

homeassistant/components/starlink/sensor.py Outdated Show resolved Hide resolved

boswelja force-pushed the feature/starlink-integration branch from d4d8b04 to ec26e4d Compare August 26, 2022 23:59

boswelja mentioned this pull request Aug 28, 2022

Add Starlink images home-assistant/brands#3617

Merged

11 tasks

frenck added the docs-missing label Aug 29, 2022

boswelja force-pushed the feature/starlink-integration branch from cf42c4a to a0037af Compare September 2, 2022 07:53

boswelja requested a review from frenck September 2, 2022 08:46

bdraco reviewed Jan 6, 2023

View reviewed changes

homeassistant/components/starlink/coordinator.py Outdated Show resolved Hide resolved

boswelja and others added 4 commits January 6, 2023 14:42

Update homeassistant/components/starlink/coordinator.py

0252e14

Co-authored-by: J. Nick Koston <nick@koston.org>

Update homeassistant/components/starlink/config_flow.py

7ac4254

Co-authored-by: J. Nick Koston <nick@koston.org>

Fix indent

5f481a7

Add missing fields to patchers

11582a7

Merge branch 'dev' into feature/starlink-integration

eb34110

Dev automation moved this from Review in progress to Reviewer approved Jan 7, 2023

bdraco approved these changes Jan 7, 2023

View reviewed changes

bdraco merged commit 3ad4caa into home-assistant:dev Jan 7, 2023

Dev automation moved this from Reviewer approved to Done Jan 7, 2023

boswelja deleted the feature/starlink-integration branch January 7, 2023 23:13

bdraco reviewed Jan 8, 2023

View reviewed changes

homeassistant/components/starlink/entity.py Show resolved Hide resolved

github-actions bot locked and limited conversation to collaborators Jan 9, 2023

MartinHjelmare reviewed Jan 12, 2023

View reviewed changes

script/gen_requirements_all.py Show resolved Hide resolved

MartinHjelmare mentioned this pull request Jan 12, 2023

Fix gen_requirements_all script permissions #85745

Merged

19 tasks

MartinHjelmare reviewed Jan 16, 2023

View reviewed changes

home-assistant unlocked this conversation Jan 16, 2023

github-actions bot locked and limited conversation to collaborators Jan 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Starlink Integration #77091

Add Starlink Integration #77091

boswelja commented Aug 21, 2022 •

edited

homeassistant commented Aug 21, 2022

boswelja commented Aug 21, 2022

frenck left a comment

boswelja commented Aug 26, 2022

avee87 left a comment

bdraco commented Jan 6, 2023

boswelja commented Jan 6, 2023 •

edited

bdraco commented Jan 7, 2023

bdraco commented Jan 7, 2023

lyricnz commented Jan 8, 2023 •

edited

rossfisherkc commented Jan 8, 2023 •

edited

lyricnz commented Jan 8, 2023 •

edited

rossfisherkc commented Jan 8, 2023

boswelja commented Jan 8, 2023 •

edited

lyricnz commented Jan 8, 2023

boswelja commented Jan 8, 2023 •

edited

MartinHjelmare left a comment

MartinHjelmare Jan 16, 2023

MartinHjelmare Jan 16, 2023

boswelja Jan 16, 2023

	def now(time_zone: dt.tzinfo \| None = None) -> dt.datetime:
	"""Get now in specified time zone."""

Add Starlink Integration #77091

Add Starlink Integration #77091

Conversation

boswelja commented Aug 21, 2022 • edited

Proposed change

Type of change

Additional information

Checklist

homeassistant commented Aug 21, 2022

boswelja commented Aug 21, 2022

frenck left a comment

Choose a reason for hiding this comment

boswelja commented Aug 26, 2022

avee87 left a comment

Choose a reason for hiding this comment

bdraco commented Jan 6, 2023

boswelja commented Jan 6, 2023 • edited

bdraco commented Jan 7, 2023

bdraco commented Jan 7, 2023

lyricnz commented Jan 8, 2023 • edited

rossfisherkc commented Jan 8, 2023 • edited

lyricnz commented Jan 8, 2023 • edited

rossfisherkc commented Jan 8, 2023

boswelja commented Jan 8, 2023 • edited

lyricnz commented Jan 8, 2023

boswelja commented Jan 8, 2023 • edited

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare Jan 16, 2023

Choose a reason for hiding this comment

MartinHjelmare Jan 16, 2023

Choose a reason for hiding this comment

boswelja Jan 16, 2023

Choose a reason for hiding this comment

boswelja commented Aug 21, 2022 •

edited

boswelja commented Jan 6, 2023 •

edited

lyricnz commented Jan 8, 2023 •

edited

rossfisherkc commented Jan 8, 2023 •

edited

lyricnz commented Jan 8, 2023 •

edited

boswelja commented Jan 8, 2023 •

edited

boswelja commented Jan 8, 2023 •

edited