We're using Crowdin to make translating our project easier for everyone. If you're fluent in another language and want to help, you can get started on Crowdin right away. Your contributions are welcome in any language! If you need help or want to add a new language, please let us know through a pull request or on Discord.
Help us:
custom_components/webuntis/
to custom_components/webuntis/
inside your Home Assistant config directory.If your Home Assistant is running in 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 the data source for the sensor. The final configuration field allows you to specify a name or class for data collection. The format for the student's full name must be <"first name"> <"middle name">, <"last name">. (This could vary from school to school)
Option | Description |
---|---|
filter_mode | The mode of the filter, e.g., Blacklist . |
filter_subjects | Subjects excluded 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 to show in event descriptions. | JSON |
Option | Description | Default |
---|---|---|
notify_entity_id | Home Assistant notification service to send lesson changes via, e.g., notify.telegram. | None |
notify_target | Object with additional notification service targets. | None |
notify_data | Object with additional notification service data. | None |
notify_options | Options that will trigger a notification. | None |
Option | Description | Default |
---|---|---|
keep_logged_in | Keep the client logged in. (Beta) | False |
generate_json | Generate JSON in sensor attributes. | False |
exclude_data | Set automatically if the user doesn't have rights, to prevent error spamming. | None |
extended_timetable | Request extended timetable, needed for filter_description and calendar_description (Lesson Info) . |
False |
The integration creates several 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_calendar |
calendar | Calendar entry |
Before you can use templates, you need to enable the option to generate JSON in the options flow (Backend - generate JSON).
Now you can copy this examples and don't forget to change the sensor names and start times. (Replace NAME with your name, and time without leading zero)
Create a template -> sensor configuration in your configuration.yaml:
- template:
- sensor:
- name: Webunits Weck Zeit
unique_id: "webuntis_wake_up_time"
icon: mdi:alarm
device_class: timestamp
state: >
{% set datetime = states('sensor.NAME_next_lesson_to_wake_up') %}
{% if datetime not in ["unknown", "unavailable", None] %}
{% set datetime = datetime | as_datetime | as_local %}
{% set time = datetime.hour|string + ":" + datetime.minute|string %}
{% if time == "8:0" %}
{% set wake_up_time = "6:25" %}
{% elif time == "9:14" %}
{% set wake_up_time = "7:30" %}
{% elif time == "10:45" %}
{% set wake_up_time = "8:45" %}
{% endif %}
{{ datetime.replace(hour=wake_up_time.split(":")[0]|int, minute=wake_up_time.split(":")[1]|int) }}
{% else %}
{{ None }}
{% endif %}
This creates a sensor that represents the wake-up time.
Now, you can use the following trigger in your automation:
platform: time
at: sensor.webuntis_weck_zeit
The automation will be triggered according to the time you defined in the sensor template
{% 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(', ') }}
for more examples feel free to check in #code-sharing on Discord