Git Product home page Git Product logo

webuntis-alarm's Introduction

Webuntis alarm

This is a small little "middleware" / web server intended to connect to a webuntis timetable used in german schools which i wrote when i was bored in class.

Its purpose is to retrieve the next day's first lesson to automatically set my alarm accordingly.

Requirements

  • Rust (nightly)
  • Preferably an open port for remote use
  • Common sense

Usage

Getting the server to run

  1. Clone or download this project using git clone github.com/iraizo/webuntis-alarm
  2. run cargo build inside the directory
  3. create an .env file in the root of the project like below
    USER="USERNAME_TO_LOGIN"
    PASSWORD="PASSWORD_TO_LOGIN"
    URL="https://mese.webuntis.com/WebUntis/?school=WHATEVER"
    HOST="127.0.0.1:8080"
    CERT="PATH_TO_SSL_PEMFILE"
    KEY="PATH_TO_SSL_KEY_PEMFILE"
    To retrieve the url go onto untis and find your school, the url should match whats above other than school?=* being different.
    Username and password should be the one you use with untis
    HOST is in the IP:PORT format and is where the middleware is hosted (127.0.0.1:8080) would be running local only.
  4. run cargo run --release

Accessing the data

You can either manually get the data by accessing the routes listed below

GET /tomorrow => returns the first class for tomorrow (date, start, end)
GET /week => returns an array of the current classes for the current week (date, start, end)

or use my already done shortcut for iOS, you will be asked for the URL which would be YOUR_HOST_HERE/tomorrow

If you need any help setting it up or feature suggestions / bugs feel free to contact me / create an issue.

webuntis-alarm's People

Contributors

dependabot[bot] avatar iraizo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.