Caodongying / home-assistant-core

Canvas integration in Home Assistant. Implemented by group 6 from Software Evolution Project course at Chalmers.

meta_note	title	description	ha_category	ha_config_flow	ha_release	ha_iot_class	ha_domain	ha_platforms	ha_codeowners	ha_integration_type
This should be in the home assistant documentation repository, but we will not merge it so it will be here as for now.	Canvas	Instructions on how to integrate the Canvas integration into Home Assistant.	Sensor Calendar Link	true	0.88	Cloud Polling	instructure	sensor	@theowiik @elias-carlson @erikwessman @Caodongying @F-MertGultekin @Lemi007	integration

The Canvas integrations allows you to get an overview of your courses, including assignments, announcements, grades, and more.

• Configuration
  • Personal Access Token
• Adding the Services
  • Sensors
  • Assignments Calendar
  • Quick Links

Configuration

1. Browse to your Home Assistant instance.
2. Go to Settings > Devices & Services.
3. In the bottom right corner, select the ⊕ Add Integration button.
4. From the list, select Canvas.
5. Follow the instructions on screen to complete the setup.

The host should be without the domain extension, e.g chalmers and not chalmers.se.

Personal Access Token

Your personal access token can be generated in Canvas > Account > Settings > Approved integrations by clicking the ⊕ New access token.

https://{host}.instructure.com/profile/settings

Adding the Services

Sensors

To add one of the assignments, announcements, inbox, or grades sensors to your dashboard, navigate to the integration in Settings > Devices & Services and click on Services. In the table of services, click on the one you want to add, and press Add to dashboard.

Assignments Calendar

To add the assignments calendar, go to your dashboard, click on the three dots in the top right and select Edit dashboard. Then, click on Add card in the bottom right and select the Calendar. Here, choose canvas calendar assignments as the entity and press Save

Quick Links

To add quick links to your dashboard, create a canvas.yaml file in your Home Assistant config/ folder. Example quick link configuration:

quick_links:
  - name:  'Course Schedule'
    url: 'https://chalmers.instructure.com/courses/25271/pages/course-schedule?module_item_id=386861'
  - name:  'Link 2'
    url: '{Link 2}'

Custom Card for Inbox Sensor

If you wish to enable filtering of Inbox messages (by All, Read, or Unread), we have a custom card which you can add to your Home Assistant configuration.

Instructions for adding a custom card can be found in the Home Assistant Frontend Docs and the code for our card can be found here: erikwessman/ha-inbox-card.