Smartschool Home Assistant custom component. This custom component was developed from scratch to integrate Smartschool data into Home Assistant, making it easier to stay on top of school-related tasks. It connects to the public Smartschool website and is designed specifically for use in Belgium; it has not been tested for other countries. So far, it has only been tested with a single school. Based on feedback I'll see if any optimisations would be desired to better support other schools.
While the official Smartschool mobile app offers more features and details, I personally found it challenging to keep track of my children's homework. That’s why I created this integration — to provide a simple checklist that allows me or my kids to tick off tasks as they’re completed. Multiple types of checklists will be created: for tracking homework due the next school day, packing schoolbag essentials, managing all upcoming assignments, and keeping track of all upcoming lessons to study. Item check-offs are handled locally within Home Assistant; completed actions are not synced back to Smartschool. Older homework and activities are automatically removed as soon as the due day has passed.
This integration is in no way affiliated with Smartschool.
Smartschool stopped the usage of the Smartschool "Agenda". Now, all schools need to use the "Planner" and "To-do's". The functionalities that were missing in the agenda (mark tasks as done) are now available in the Planner and Todo's of Smartschool. As a consequence, the added value of this integration seems currently very limited. I will evaluate over time if Planner and Todo integration in Home Assistant would be usefull.
This integration has been based on the python application of https://github.com/IntelCoreI6/smartschool_mcp (fork of https://github.com/svaningelgem/smartschool). This application has been forked and extended to support parallel sessions and to support authentication with Google Authenticator (2FA).
Instructions
- HACS: search for Smartschool in HACS integrations and install
- or add this repository as custom repository into your HACS
- or merge this repo 'custom components' folder into your local HA 'custom components' folder
- Restart Home Assistant
- Add 'Smartschool' integration via HA Settings > 'Devices and Services' > 'Integrations'
- Provide Smartschool credentials:
- smartschool domain: this should be the url used to login, eg 'school.smartschool.be'
- username: username, typically the first and last name of the child
- password: password of the child account or password of the parent account
- MFA:
- when using child account, this is by default the date of birth of the child, notation YYYY-MM-DD
- when using a parent account or if 2FA has been enabled, the Google Authenticator secret is to be set (see Smartschool > Profile > Login with 2 steps > Authenticator app). If the secret is not known, the Authenticator app will need to be re-linked. During setup of the authenticator app, the 2FA secret can be shown instead of the QR code)
After adding Smartschool account, sensors and todo lists will be added.
-
Tasks A sensor
sensor.smartschool_[username]_[school]_taskswill be added showing the number of tasks to be done for the next schoolday. The sensor also shows the last update from Smartschool in the attribut last_update. If desired, an automation can be setup to get notified if the number of tasks for the next schoolday would change. -
Messages A sensor
sensor.smartschool_[username]_[school]_messageswill be added showing the number of outstanding (unread) messages. The sensor also shows the number of read and total number of messages, as well as the last update from Smartschool in the attribut last_update. -
Results (untested) A sensor
sensor.smartschool_[username]_[school]_resultswill be added showing the total results. Since the results are not always available (some schools only make them available at specific intervals), this hasn't been tested yet. Extra results per course might be made availble later on, once tested. The sensor also shows the last update from Smartschool in the attribut last_update.
-
Separate Todo list for "Toetsen", "Taken", "Meebrengen", "Volgende" and "Schooltas"
-
When checking items in Home Assistant Todo list as completed, this will not be reflected into Smartschool.
-
Only future tasks are fetched from Smartschool but no updates from Home Assistant are sent towards Smartschool.
-
Only items left todo as of today are listed, past items of previous days will automatically be removed of all Todo lists.
-
Each Todo list will contain the username between brackets to distinct the list of different users (if multiple accounts are linked).
-
Some todo items may appear in multiple todo lists (eg list "toetsen" contains all planned tests, while the tests panned for next schoolday will also appear in the list "volgende"). If such item is ticked in one list, it will be marked as checked in the other todo lists as well.
-
Volgende (
todo.volgende_[username]):- overview of all "Taken", "Toetsen", "Meebrengen" for next planned schoolday (next day or next day after weekend/holiday)
-
Schooltas (
todo.schooltas_[username]):- overview of all "Meebrengen" for next planned schoolday (next day or next day after weekend/holiday)
- overview of all lessons that will take place the next planned schoolday (next day or next day after weekend/holiday)
- with this checklist, it's easy to validate all stuff that should be in the schoolbag
-
Meebrengen (
todo.meebrengen_[username]):- within list "Meebrengen", the title will be the item to bring, while the description will be the course info
- for other lists, the title contains the course name and the description contains the details of the action
-
Taken (
todo.taken_[username]):- All upcoming tasks to do, known for coming days
-
Toetsen (
todo.toetsen_[username]):- All upcoming tests scheduled, known for coming days
I recently discovered Smartschool allows to export lessons and tasks as a iCal calendar.
Home Assistant support importing iCal calendar using the default "Remote Calendar" integration. Add the url retrieved from Smartschool > Go To > Schoolagenda > Export.
Still testing the options of this calendar integration, will probably have to wait till september to get some usefull data into it.
Still some optimisations are planned, see Issues section in GitHub.
The main logic and API connection related code can be found within source code smartschool_ha/custom_components/smartschool_ha:
All other files just contain boilerplat code for the integration to work wtihin HA or to have some constants/strings/translations.
If you would encounter some issues with this custom component, you can enable extra debug logging by adding below into your configuration.yaml:
logger:
default: info
logs:
custom_components.smartschool_ha: debug
