2024.12.5
Home ▸ Integrations ▸

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 integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# 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 data limit in gigabytes. Set to 0 for unlimited plans without a cap.

monitored_conditions list Required

Conditions to display in the frontend.

usage

Data usage (percentage). This sensor is not supported for unlimited plans.

usage_gb

Data usage (gigabytes).

limit

Monthly data limit (gigabytes). This sensor is not supported for unlimited plans.

used_download

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

used_upload

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

used_total

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

grace_download

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

grace_upload

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

grace_total

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

total_download

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

total_upload

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

used_remaining

Remaining bandwidth calculated from used and supplied total bandwidth (gigabytes). This sensor is not supported for unlimited plans.

Related topics