eliabieri / wg_display

🦀 Hackable information display fully built in Rust

Hi, I'm Elia 🦦

I'm a 27-year-old self-taught programmer from Bern, CH.
Solving everyday problems is what I'm most passionate about.
I strongly believe in learning by doing.
What I love is to iterate fast, try unconventional approaches, and I'm not afraid of doing a deep dive into new technology.
Recently, I've finished by Bachelor in Computer Science at the Bern University of Applied Sciences.
I work as a Fullstack-Developer part-time and also do freelance work. I make apps for different platforms using Flutter.

You can read all about my current projects at eliabieri.dev

wg_display's Issues

Implement renderer class

An initial implementation of the renderer class shall be created.
The renderer has the following responsibilities:

• Read out the configuration and lay out the enabled widgets

• Refresh the enabled widgets

Implement widget base class

Implement the base class for all widgets.
Widgets are encapsulated piece of information that are rendered in the terminal and displayed on the DSI display.
They define their own refresh interval and consume a configuration which can be entered by the user through the web dashboard.

• Provide functionality for widgets to only update themselves once their update cycle duration is reached
• (Provide automatic error handling (writing error to content))

Implement public transport widget

A public transport widget (similar to the one developed for the wg_display2 project) shall be developed.

• User can configure departing station via dashboard
• User can configure arriving station via dashboard

Write user manuals

Write user manual on how to

• contribute to the project
• build hw setup
• install and run wg_display

Limit length of error text

• The length of the error messages shall be limited to a single line
• V1.0.0 shall be tagged

Implement publibike widget

Implement a widget that shows the number of ebikes at a preconfigured station.
The bikes shall be differentiated by normal- and ebikes.

• Implement widget
• Implement tests
• (implement displaying the bike with the most battery left)

Write project report

Scope

Around 20 - 25 pages (including attachements)

• Create sequence diagrams with mermaid
• Create component diagram with mermaid
• Write chapter about management: How is project management organized, how are PRs used
• Write chapter about CI
• Write about possible future extensions
• Attach usermanuals as attachements
• Attach "Erklärung"

Write rust docs

• Rust docs are written
• Instructions on how to generate docs are written

Implement buffet nord menu widget

A widget showing the menu of buffet nord shall be implemented

• Widget implemented
• Tests written

Alternate getting started

The getting started section should list how to download binaries from release, copying them to the target and adding them to .bashrc.

The current getting started section should be renamed to building the project.

Implement initial web dashboard

An initial web dashboard skeleton shall be implemented.

Widget configuration

• The user shall be able to enable and disable all the widgets.
• The number of widgets that can be enabled shall be limited, so they fit on the screen.

A way for the widget to defined which additional is needed from the used shall be defined