Restyle dashboard (#16)

* Add simple cover image to README.md

* Add docs for widget creation

* Restyle dashboard

README.md

@@ -1,3 +1,9 @@
 # WG Display
+
 [![Cargo test](https://github.com/eliabieri/wg_display/actions/workflows/cargo_test.yml/badge.svg)](https://github.com/eliabieri/wg_display/actions/workflows/cargo_test.yml)
-#### All that goes on in your city at one glance. Extensible, open-source and connected to the local community.
+
+## All that goes on in your city at one glance
+
+## Extensible, open-source and connected to the local community
+
+![WG Display image front](docs/images/wg_display.jpg)

app/src/renderer/mod.rs

@@ -71,12 +71,12 @@ impl Renderer {
         self.widgets.iter().for_each(|widget| {
             let name_widget = LinearLayout::horizontal().child(TextView::new(format!(
                 "{:width$}",
-                widget.get_name().as_str(),
+                widget.get_meta_data().name(),
                 width = self.name_column_width()
             )));
 
             let content_widget =
-                TextView::new(widget.get_content()).with_name(widget.get_name().as_str());
+                TextView::new(widget.get_content()).with_name(widget.get_meta_data().name());
 
             let padded_view = name_widget.child(content_widget);
             linear_layout.add_child(padded_view);
@@ -95,7 +95,7 @@ impl Renderer {
         ));
 
         self.widgets.iter_mut().for_each(|widget| {
-            siv.call_on_name(widget.get_name().as_str(), |view: &mut TextView| {
+            siv.call_on_name(widget.get_meta_data().name(), |view: &mut TextView| {
                 view.set_content(widget.get_content());
             });
         });
@@ -104,7 +104,7 @@ impl Renderer {
     fn name_column_width(&self) -> usize {
         self.widgets
             .iter()
-            .map(|widget| widget.get_name().as_str().len())
+            .map(|widget| widget.get_meta_data().name().len())
             .max()
             .unwrap()
             + 2

app/src/renderer/widgets/aare.rs

@@ -2,7 +2,7 @@ use std::time::{Duration, Instant};
 
 use super::base::Widget;
 use common::models::WidgetConfiguration;
-use common::widgets::WidgetName;
+use common::widget_meta_data::WidgetMetaData;
 use serde::Deserialize;
 
 #[derive(Deserialize)]
@@ -32,8 +32,8 @@ impl Widget for Aare {
         }
     }
 
-    fn get_name(&self) -> WidgetName {
-        WidgetName::Aare
+    fn get_meta_data(&self) -> common::widget_meta_data::WidgetMetaData {
+        WidgetMetaData::Aare
     }
 
     fn get_content(&self) -> &str {

app/src/renderer/widgets/base.rs

@@ -1,13 +1,13 @@
 use async_trait::async_trait;
 use common::models::WidgetConfiguration;
-use common::widgets::WidgetName;
+use common::widget_meta_data::WidgetMetaData;
 
 #[async_trait]
 pub trait Widget {
     fn new() -> Self
     where
         Self: Sized;
-    fn get_name(&self) -> WidgetName;
+    fn get_meta_data(&self) -> WidgetMetaData;
     fn get_content(&self) -> &str;
 
     async fn update(&mut self, config: &WidgetConfiguration);

app/src/renderer/widgets/bernaqua.rs

@@ -2,7 +2,7 @@ use std::time::{Duration, Instant};
 
 use super::base::Widget;
 use common::models::WidgetConfiguration;
-use common::widgets::WidgetName;
+use common::widget_meta_data::WidgetMetaData;
 use serde::Deserialize;
 
 #[derive(Deserialize)]
@@ -35,8 +35,8 @@ impl Widget for Bernaqua {
         }
     }
 
-    fn get_name(&self) -> WidgetName {
-        WidgetName::Bernaqua
+    fn get_meta_data(&self) -> common::widget_meta_data::WidgetMetaData {
+        WidgetMetaData::Bernaqua
     }
 
     fn get_content(&self) -> &str {

app/src/renderer/widgets/cafete.rs

@@ -2,7 +2,7 @@ use std::time::{Duration, Instant};
 
 use super::base::Widget;
 use common::models::WidgetConfiguration;
-use common::widgets::WidgetName;
+use common::widget_meta_data::WidgetMetaData;
 use serde::Deserialize;
 
 #[derive(Deserialize)]
@@ -37,8 +37,8 @@ impl Widget for Cafete {
         }
     }
 
-    fn get_name(&self) -> WidgetName {
-        WidgetName::Cafete
+    fn get_meta_data(&self) -> common::widget_meta_data::WidgetMetaData {
+        WidgetMetaData::Cafete
     }
 
     fn get_content(&self) -> &str {

app/src/renderer/widgets/public_transport.rs

@@ -1,6 +1,7 @@
 use std::time::{Duration, Instant};
 
-use common::{models::WidgetConfiguration, widgets::WidgetName};
+use common::models::WidgetConfiguration;
+use common::widget_meta_data::WidgetMetaData;
 use serde::Deserialize;
 use time::OffsetDateTime;
 use time_humanize::{Accuracy, HumanTime, Tense};
@@ -66,8 +67,8 @@ impl Widget for PublicTransport {
         }
     }
 
-    fn get_name(&self) -> common::widgets::WidgetName {
-        WidgetName::PublicTransport
+    fn get_meta_data(&self) -> common::widget_meta_data::WidgetMetaData {
+        WidgetMetaData::PublicTransport
     }
 
     fn get_content(&self) -> &str {

app/src/renderer/widgets/time.rs

@@ -1,6 +1,7 @@
 use super::base::Widget;
 use async_trait::async_trait;
-use common::{models::WidgetConfiguration, widgets::WidgetName};
+use common::models::WidgetConfiguration;
+use common::widget_meta_data::WidgetMetaData;
 
 extern crate chrono;
 use chrono::Local;
@@ -17,8 +18,8 @@ impl Widget for Time {
         }
     }
 
-    fn get_name(&self) -> WidgetName {
-        WidgetName::Time
+    fn get_meta_data(&self) -> common::widget_meta_data::WidgetMetaData {
+        WidgetMetaData::Time
     }
 
     fn get_content(&self) -> &str {

common/src/lib.rs

@@ -1,2 +1,2 @@
 pub mod models;
-pub mod widgets;
+pub mod widget_meta_data;

common/src/widget_meta_data.rs

@@ -0,0 +1,30 @@
+#[derive(PartialEq, Clone)]
+pub enum WidgetMetaData {
+    Cafete,
+    Aare,
+    Time,
+    Bernaqua,
+    PublicTransport,
+}
+
+impl WidgetMetaData {
+    pub fn name(&self) -> &'static str {
+        match self {
+            WidgetMetaData::Cafete => "Cafete",
+            WidgetMetaData::Aare => "Aare",
+            WidgetMetaData::Time => "Time",
+            WidgetMetaData::Bernaqua => "Bernaqua",
+            WidgetMetaData::PublicTransport => "Next departure",
+        }
+    }
+
+    pub fn description(&self) -> &'static str {
+        match self {
+            WidgetMetaData::Cafete => "Events happening at the Cafete Club in Bern",
+            WidgetMetaData::Aare => "The temperature of the Aare river in Bern",
+            WidgetMetaData::Time => "The current time",
+            WidgetMetaData::Bernaqua => "Occupancy of the Bernaqua facilities",
+            WidgetMetaData::PublicTransport => "Next public transport departures",
+        }
+    }
+}

docs/write_new_widget.md

@@ -0,0 +1,18 @@
+# Writing a new widget
+
+## What is a widget
+
+A widget represents an information displayed on the display.  
+It has a name and a corresponding value, that is updated dinamically.  
+Additionally, a widget consumes a configuration, that is entered by the user via the dashboard.  
+
+## What is needed to build a widget
+
+- A Yew component that visualizes the configuration options in the dashboard.
+- An implementation of the `Widget` trait. In here, the value of the widget is fetched or computed.
+
+```text
+💡 Simple widgets can use the DefaultWidgetConfig component, that only allows for the widget to be enabled or disabled
+```
+
+## Learning by example