home-assistant.io/source/_components/sensor.startca.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class
page	Start.ca	Instructions on how to integrate Start.ca data usage within Home Assistant.	2018-02-12 00:00	true	false	true	true	startca.png	Network	0.64	Cloud Polling

Integrate your Start.ca account information into Home Assistant.

{% linkable_title Setup %}

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

{% linkable_title 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 %} api_key: description: The Start.ca API key to access the service. required: true type: string total_bandwidth: description: Your bandwidth limit in gigabytes. Set to 0 for unlimited plans without a cap. required: true type: string monitored_conditions: description: Conditions to display in the frontend. required: true type: list keys: usage: description: Bandwidth usage (percentage). usage_gb: description: Bandwidth usage (gigabytes). limit: description: Monthly bandwidth limit (gigabytes). used_download: description: Bandwidth used by download outside the grace period (gigabytes). used_upload: description: Bandwidth used by upload outside the grace period (gigabytes). used_total: description: Total bandwidth (download and upload sum calculation) used outside the grace period (gigabytes). grace_download: description: Bandwidth used by download during the grace period (gigabytes). grace_upload: description: Bandwidth used by upload during the grace period (gigabytes). grace_total: description: Total bandwidth (download and upload sum calculation) used during the unlimited period (gigabytes). total_download: description: Total bandwidth download (Grace + Used) (gigabytes). total_download: description: Total bandwidth upload (Grace + Used) (gigabytes). used_remaining: description: Remaining bandwidth calucated from used and supplied total bandwidth (gigabytes). {% endconfiguration %}