- Copy all files from custom_components/webuntis/ to custom_components/webuntis/ inside your config Home Assistant directory.
- Restart Home Assistant
- Add Integration via UI or click HERE
If your home assistant is running on a docker, you may need to set your local timezone in the docker configuration!
Visit https://webuntis.com and click on your school.
In the URL you should find the information you need:
https://demo.webuntis.com/WebUntis/?school=Demo-School#/basic/login
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^
Server School
Unfortunately, it is not possible to use the Untis API with an anonymous user.
You can ask the school administration to give you access, otherwise it won't work.
With the timetable source, you can select where the data for the sensor should come from. The final configuration field allows you to specify a name or class from which the data is pulled. The Format for the student's full name must be in the form <"first name"> <"middle name">, <"last name">.
| Option | Description |
|---|---|
| filter_mode | The mode of the filter. e.g. Blacklist |
| filter_subjects | Subjects that will be excludet from any data. |
| filter_description | Exclude all lessons with specific text in the lesson info |
| Option | Description | Default |
|---|---|---|
| calendar_long_name | Use the long subject name. | True |
| calendar_show_cancelled_lessons | Show cancelled lessons. | False |
| calendar_description | Pick what will be shown in events description. | JSON |
| Option | Description | Default |
|---|---|---|
| keep_loged_in | Keep the client logged in. (Beta) | False |
| generate_json | Generate JSON in sensor attributes. | False |
| exclude_data | Will be set automatic if user doesn't have rights to prevent logger from spamming errors. | None |
| extended_timetable | Request extended timetable. Is needed for filter_description and calendar_description(Lesson Info) |
False |
The integration creates multiple entities in the format sensor.NAME_entity.
| Sensor | Type | Description |
|---|---|---|
binary_sensor.NAME_class |
bool | indicates if a lesson is currently taking place. |
sensor.NAME_next_class |
datetime | the start time of the next lesson. |
sensor.NAME_next_lesson_to_wake_up |
datetime | the start of the next first lesson of the day. |
calendar.NAME_webuntis_calender |
calendar | Calendar entry |
Before you can use templates you need to enable the option generate JSON in the options flow. (Backend - generate JSON)
Now you can copy this examples and don't forget to change the sensor names. (Replace NAME with your name)
{% set json = state_attr("sensor.NAME_next_lesson_to_wake_up", "day") | from_json %}
{% for lesson in json -%}
{{ lesson.subjects.0.long_name + "\n" }}
{%- endfor %}
{% set lessonList = namespace(lesson=[]) %}
{% set lessons = state_attr("sensor.NAME_next_lesson_to_wake_up", "day") | from_json %}
{% for lesson in lessons -%}
{% set lessonList.lesson = lessonList.lesson + [lesson.subjects.0.long_name] %}
{%- endfor %}
{{ lessonList.lesson | unique | join(', ') }}