ThomasLomas / ha-starlinghomehub

Integrating Starling Developer Connect API to Home Assistant
MIT License
20 stars 2 forks source link
home-assistant home-automation homeassistant starling

Starling Home Hub Integration

NOTE: As of v1.0.0 this integration requires v2 of the Starling Home Hub API. You will need to add the v2 URL to this integration for it to work. If you must use v1 then remain on v0. This isn't backwards compatible.

ThomasLomas - ha-starlinghomehub stars - ha-starlinghomehub forks - ha-starlinghomehub

Validate GitHub tag License issues - ha-starlinghomehub

This is a custom integration for Home Assistant for accessing the Starling Home Hub via the Starling Developer Connect API. My work is unaffiliated with Starling LLC. This is for use at your own risk. I don't provide any warranties whatsoever.

Current Support

Since v2 of the Starling Home Hub API there is now more widespread support for devices, and as such this may now also include non-Nest devices.

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called starling_home_hub.
  4. Download all the files from the custom_components/starling_home_hub/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Starling Home Hub Integration"

Hub Setup

Ensure you are using the latest firmware (2024.43 or above)

The SDC API is disabled by default. To enable the API, go to the Starling app, then:

  1. Open the Starling Developer Connect section in the app.
  2. If not already active, you will be prompted to enable Password Security to set an access password for your hub.
  3. Select the Enable HTTP Access and/or Enable HTTPS Access checkboxes.

Access to the API requires creating an API key - one per app - with specific permissions that you set. To create an API key for your application:

  1. In the My API Keys section, press Create New API Key.
  2. Enter a name for your app/API key, and choose the permissions appropriate for your use case.
  3. Press Create API Key. Your API key (a 12-character opaque alphanumeric string) will then appear under My API Keys.

To modify an existing API key's permissions or name, hover over the key in My API Keys, then press the edit button.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines