An open API service indexing awesome lists of open source software.

https://github.com/scaarup/aula

Fetches information from Aula about your children
https://github.com/scaarup/aula

custom-component hacs home-assistant homeassistant

Last synced: 3 months ago
JSON representation

Fetches information from Aula about your children

Awesome Lists containing this project

README

          

[![Current Release](https://img.shields.io/github/release/scaarup/aula/all.svg?style=plastic)](https://github.com/scaarup/aula/releases) [![Github All Releases](https://img.shields.io/github/downloads/scaarup/aula/total.svg?style=plastic)](https://github.com/scaarup/aula/releases) [![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=plastic)](https://github.com/hacs/integration)

# Aula

This is a custom component for Home Assistant to integrate Aula.

- Installable and updatable via HACS
- UI config flow
- School schedules as Home Assistant calendars
- "Ugeplaner/Ugenoter" from "Min Uddannelse", "Meebook" and "EasyIQ"
- "Opgaver" from "Min Uddannelse"
- Messages - if there are unread messages, we turn a binary sensor on and populate it with the message details.
- "Huskelisten" from "Systematic"
- Use the builtin service to interact directly with Aulas API.

"Ugeplaner/ugenoter/huskelisten" are stored as sensor attributes. Can be rendered like:

```yaml
{{ state_attr("sensor.hojelse_skole_emilie", "ugeplan") }}
```

And visualized in your dashboard with the markdown card:

```yaml
type: markdown
content: '{{ state_attr("sensor.hojelse_skole_emilie", "ugeplan") }}'
title: Ugeplan for Emilie
```

Another example using vertical-stack and collapsable-cards:

![image](https://user-images.githubusercontent.com/8055470/200306258-1c9e98ff-75d9-4111-994c-a69833e40c61.png)

```yaml
type: vertical-stack
cards:
- type: custom:collapsable-cards
title: Ugeplan Emilie
cards:
- type: markdown
content: '{{ state_attr("sensor.hojelse_skole_emilie", "ugeplan") }}'
- type: custom:collapsable-cards
title: Ugeplan Emilie, næste uge
cards:
- type: markdown
content: '{{ state_attr("sensor.hojelse_skole_emilie", "ugeplan_next") }}'
- type: custom:collapsable-cards
title: Ugeplan Rasmus
cards:
- type: markdown
content: '{{ state_attr("sensor.hojelse_skole_rasmus", "ugeplan") }}'
- type: custom:collapsable-cards
title: Ugeplan Rasmus, næste uge
cards:
- type: markdown
content: '{{ state_attr("sensor.hojelse_skole_rasmus", "ugeplan_next") }}'
```

![image](https://user-images.githubusercontent.com/8055470/199254249-3bf441bc-7dce-4f5d-a809-d119d20a7b2b.png)

- Lots of small fixes and optimizations

## Installation

#### HACS

- Ensure that HACS is installed.
- Search for and install the "Aula" integration.
- Restart Home Assistant.

#### Manual installation

- Download the latest release.
- Unpack the release and copy the custom_components/aula directory into the custom_components directory of your Home Assistant installation.
- Restart Home Assistant.

## Setup

Shortcut:

[![](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=aula)

- Go to Settings -> Integrations -> Add Integration
- Search for "Aula" and follow the instructions in the config flow.

### Known issues
- You must use the guardian MitID, childlogin is not supported.
- The config flow does not currently support a reconfiguration. Meaning when your password expires, the integration must be deleted and added again, in order to update the password.

## Support
Join our Discord https://discord.gg/SnfRg3DWG6 and feel free to ask in #homeassistant