eliabieri / wg_display Goto Github PK

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

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"

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))

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

A widget showing the menu of buffet nord shall be implemented

• Widget implemented
• Tests written

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

Write user manual on how to

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

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

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 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)

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.