Home Assistant Home Assistant

Start.ca

Integrate your Start.ca account information into Home Assistant.

Setup

You can get your API key from: Start.ca Usage API

Configuration

To use your Start.ca sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: startca
    api_key: API_KEY
    total_bandwidth: 400
    monitored_variables:
      - usage
      - usage_gb
      - limit
      - used_download
      - used_upload
      - used_total
      - grace_download
      - grace_upload
      - grace_total
      - total_download
      - total_upload
      - used_remaining

Configuration Variables

Looking for your configuration file?
api_key string Required

The Start.ca API key to access the service.

total_bandwidth string Required

Your bandwidth limit in gigabytes. Set to 0 for unlimited plans without a cap.

monitored_conditions list Required

Conditions to display in the frontend.

usage

Bandwidth usage (percentage).

usage_gb

Bandwidth usage (gigabytes).

limit

Monthly bandwidth limit (gigabytes).

used_download

Bandwidth used by download outside the grace period (gigabytes).

used_upload

Bandwidth used by upload outside the grace period (gigabytes).

used_total

Total bandwidth (download and upload sum calculation) used outside the grace period (gigabytes).

grace_download

Bandwidth used by download during the grace period (gigabytes).

grace_upload

Bandwidth used by upload during the grace period (gigabytes).

grace_total

Total bandwidth (download and upload sum calculation) used during the unlimited period (gigabytes).

total_download

Total bandwidth download (Grace + Used) (gigabytes).

total_upload

Total bandwidth upload (Grace + Used) (gigabytes).

used_remaining

Remaining bandwidth calculated from used and supplied total bandwidth (gigabytes).