Merge pull request #12 from mt-empty/feature/wind-speed-unit

Feature/wind speed unit

Author: mt-empty

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pi-inky-weather-epd"
-version = "0.6.1"
+version = "0.7.0"
 edition = "2021"
 authors = ["MT"]
 description = "A weather display application for the Raspberry Pi using an EPD (e-paper display)."

config/default.toml

@@ -1,17 +1,28 @@
 [release]
 release_info_url = "https://api.github.com/repos/mt-empty/pi-inky-weather-epd/releases/latest"
 download_base_url = "https://github.com/mt-empty/pi-inky-weather-epd/releases/download"
-# set to 0 to disable auto-updating
-update_interval_days = 7
+update_interval_days = 0  # Set to 0 to disable auto-updating
 
 [api]
-provider = "open_meteo"    # bom or open_meteo
-latitude = -37.8136
+# Note: The weather data reflects the selected location’s conditions, but all times are displayed
+# according to your device’s (local) timezone. this should be fine for almost all users.
+latitude = -37.8136      # Melbourne, Australia
 longitude = 144.9631
+provider = "open_meteo"  # Options: bom, open_meteo
 
-# supported colours for 7.3 inky display
-# [black, white, green, blue, red, yellow, orange]
 [colours]
+# Supported colours for 7.3" Inky Impression display:
+# [black, white, green, blue, red, yellow, orange]
+background_colour = "white"
+text_colour = "black"
+x_axis_colour = "black"
+y_left_axis_colour = "red"    # Temperature axis
+y_right_axis_colour = "blue"  # Rain scale
+actual_temp_colour = "red"
+feels_like_colour = "green"
+rain_colour = "blue"
+
+## Dark Mode Example
 # background_colour   = "black"    # solid black – no dithering
 # text_colour         = "white"    # bright white for max legibility
 
@@ -23,21 +34,12 @@ longitude = 144.9631
 # feels_like_colour   = "green"    # dashed “feels-like” line
 # rain_colour         = "blue"     # shaded rain bars
 
-background_colour = "white"
-text_colour = "black"
-x_axis_colour = "black"
-y_left_axis_colour = "red"
-y_right_axis_colour = "blue"
-actual_temp_colour = "red"
-feels_like_colour = "green"
-rain_colour = "blue"
 
 [render_options]
-temp_unit = "C"
-# When the sky is clear, the moon phase icon will be used instead of the clear night icon
-use_moon_phase_instead_of_clear_night = true
-# this controls the placement of the x-axis when the temperature is below zero
-x_axis_always_at_min = true
+temp_unit = "C"                                 # Options: C, F
+wind_speed_unit = "km/h"                        # Options: km/h, mph, knots
+use_moon_phase_instead_of_clear_night = true    # When the sky is clear, the moon phase icon will be used instead of the clear night icon
+x_axis_always_at_min = true                     # Controls x-axis placement when temp is below zero
 use_gust_instead_of_wind = false
 
 [misc]
@@ -48,6 +50,6 @@ generated_png_name = "dashboard.png"
 svg_icons_directory = "static/fill-svg-static/"
 
 [debugging]
-disable_weather_api_requests = false # if true, the weather data will be loaded from a cached file instead of the API, make you ran the application at least once with this set to false
+disable_weather_api_requests = false # Load cached data instead of making API requests (requires at least one successful run first)
 disable_png_output = false
 allow_pre_release_version = false

config/development.toml

@@ -1,17 +1,28 @@
 [release]
 release_info_url = "https://api.github.com/repos/mt-empty/pi-inky-weather-epd/releases/latest"
 download_base_url = "https://github.com/mt-empty/pi-inky-weather-epd/releases/download"
-# set to 0 to disable auto-updating
-update_interval_days = 0
+update_interval_days = 0  # Set to 0 to disable auto-updating
 
 [api]
-provider = "open_meteo"    # bom or open_meteo
-latitude = -37.8136
+# Note: The weather data reflects the selected location’s conditions, but all times are displayed
+# according to your device’s (local) timezone. this should be fine for almost all users.
+latitude = -37.8136      # Melbourne, Australia
 longitude = 144.9631
+provider = "open_meteo"  # Options: bom, open_meteo
 
-# supported colours for 7.3 inky display
-# [black, white, green, blue, red, yellow, orange]
 [colours]
+# Supported colours for 7.3" Inky Impression display:
+# [black, white, green, blue, red, yellow, orange]
+background_colour = "white"
+text_colour = "black"
+x_axis_colour = "black"
+y_left_axis_colour = "red"    # Temperature axis
+y_right_axis_colour = "blue"  # Rain scale
+actual_temp_colour = "red"
+feels_like_colour = "green"
+rain_colour = "blue"
+
+## Dark Mode Example
 # background_colour   = "black"    # solid black – no dithering
 # text_colour         = "white"    # bright white for max legibility
 
@@ -23,21 +34,12 @@ longitude = 144.9631
 # feels_like_colour   = "green"    # dashed “feels-like” line
 # rain_colour         = "blue"     # shaded rain bars
 
-background_colour = "white"
-text_colour = "black"
-x_axis_colour = "black"
-y_left_axis_colour = "red"
-y_right_axis_colour = "blue"
-actual_temp_colour = "red"
-feels_like_colour = "green"
-rain_colour = "blue"
 
 [render_options]
-temp_unit = "C"
-# When the sky is clear, the moon phase icon will be used instead of the clear night icon
-use_moon_phase_instead_of_clear_night = true
-# this controls the placement of the x-axis when the temperature is below zero
-x_axis_always_at_min = true
+temp_unit = "C"                                 # Options: C, F
+wind_speed_unit = "km/h"                        # Options: km/h, mph, knots
+use_moon_phase_instead_of_clear_night = true    # When the sky is clear, the moon phase icon will be used instead of the clear night icon
+x_axis_always_at_min = true                     # Controls x-axis placement when temp is below zero
 use_gust_instead_of_wind = false
 
 [misc]
@@ -48,53 +50,58 @@ generated_png_name = "dashboard.png"
 svg_icons_directory = "static/fill-svg-static/"
 
 [debugging]
-disable_weather_api_requests = false # if true, the weather data will be loaded from a cached file instead of the API, make you ran the application at least once with this set to false
+disable_weather_api_requests = false # Load cached data instead of making API requests (requires at least one successful run first)
 disable_png_output = false
 allow_pre_release_version = true
 
+# ============================================================================
+# Alternative Locations (for testing)
+# ============================================================================
 
-### Extreme
-## Babinda, QLD
+# Extreme Weather Locations
+# -------------------------
+# Babinda, QLD (high rainfall)
 # latitude = -17.3447
 # longitude = 145.9259
 
-## Marble Bar, NSW
-# latitude = -27.2983
-# longitude = 133.6212
+# Marble Bar, WA (extreme heat)
+# latitude = -21.1767
+# longitude = 119.7491
 
-## Tasmanian heights, TAS
+# Tasmanian Highlands (cold)
 # latitude = -41.9101
 # longitude = 146.8158
 
-## Major Cities
-## Darwin
+# Major Australian Cities
+# -----------------------
+# Darwin
 # latitude = -12.4612
 # longitude = 130.8417
 
-## Sydney
+# Sydney
 # latitude = -33.8681
 # longitude = 151.2103
 
-## Melbourne
+# Melbourne
 # latitude = -37.8122
 # longitude = 144.9591
 
-## Brisbane
+# Brisbane
 # latitude = -27.4960
 # longitude = 153.0341
 
-## Perth
-# latitude = -41.5750
-# longitude = 147.1674
+# Perth
+# latitude = -31.9523
+# longitude = 115.8614
 
-## Adelaide
+# Adelaide
 # latitude = -34.9283
 # longitude = 138.5980
 
-## Hobart
+# Hobart
 # latitude = -42.8769
 # longitude = 147.3322
 
-## Canberra
+# Canberra
 # latitude = -35.2853
 # longitude = 149.1229

dashboard-template-min.svg

@@ -12,6 +12,12 @@
         "[rust]": {
             "editor.defaultFormatter": "rust-lang.rust-analyzer"
         },
+        "[svg]": {
+            "editor.formatOnSave": false
+        },
+        "workbench.editorAssociations": {
+            "*.svg": "default"
+        },
         "files.trimTrailingWhitespace": true,
         "files.insertFinalNewline": true,
         "files.trimFinalNewlines": true,
@@ -25,6 +31,7 @@
         "rust-analyzer.check.command": "clippy",
         "rust-analyzer.cargo.features": "all",
         // Spell Check
+        "cSpell.language": "en-au",
         "cSpell.words": [
             "meteo",
             "aarch",

pi-inky-weather-epd.code-workspace

@@ -47,9 +47,9 @@ Note, the gif and images are a bit outdated, specifically UV icon colour changes
    mkdir -p ~/.config
    cat > ~/.config/pi-inky-weather-epd.toml << EOF
    [api]
-   provider = "open_meteo"    # "open_meteo" (worldwide) or "bom" (Australia only)
    latitude = YOUR_LATITUDE   # e.g., -33.8727 # Sydney
    longitude = YOUR_LONGITUDE # e.g., 151.2057
+   provider = "open_meteo"    # "open_meteo" (worldwide) or "bom" (Australia only)
    EOF
    ```
 
@@ -89,6 +89,13 @@ Here are example configurations. Note: some of these images are slightly outdate
 
 <img src="./misc/dashboard-default.png" alt="Default configuration" width="600"/>
 
+### Imperial Units
+```toml
+[render_options]
+temp_unit = "F"
+wind_speed_unit = "mph"
+```
+
 ### Use Clear night Icon instead of Moon Phase icon when Time=night and Weather=clear
 
 <img src="./misc/dashboard-without-moon-phase.png" alt="Moon phase configuration" width="600"/>

readme.md

@@ -25,6 +25,19 @@ pub enum TemperatureUnit {
     F,
 }
 
+#[derive(Debug, Deserialize, PartialOrd, PartialEq, Clone, Copy, Display)]
+pub enum WindSpeedUnit {
+    #[serde(rename = "km/h")]
+    #[strum(serialize = "km/h")]
+    KmH,
+    #[serde(rename = "mph")]
+    #[strum(serialize = "mph")]
+    Mph,
+    #[serde(rename = "knots")]
+    #[strum(serialize = "knots")]
+    Knots,
+}
+
 #[nutype(
     sanitize(trim),
     validate(with = is_valid_colour, error = ValidationError),
@@ -129,6 +142,7 @@ pub struct Misc {
 #[derive(Debug, Deserialize, Clone)]
 pub struct RenderOptions {
     pub temp_unit: TemperatureUnit,
+    pub wind_speed_unit: WindSpeedUnit,
     pub use_moon_phase_instead_of_clear_night: bool,
     pub x_axis_always_at_min: bool,
     pub use_gust_instead_of_wind: bool,

src/configs/settings.rs

@@ -33,6 +33,7 @@ pub struct Context {
     pub max_relative_humidity_font_style: String,
     pub total_rain_today: String,
     pub temp_unit: String,
+    pub current_wind_speed_unit: String,
     pub current_hour_actual_temp: String,
     pub current_hour_weather_icon: String,
     pub current_hour_feels_like: String,
@@ -121,6 +122,7 @@ impl Default for Context {
             max_relative_humidity_font_style: FontStyle::Normal.to_string(),
             total_rain_today: na.clone(),
             temp_unit: render_options.temp_unit.to_string(),
+            current_wind_speed_unit: render_options.wind_speed_unit.to_string(),
             current_hour_actual_temp: na.clone(),
             current_hour_weather_icon: not_available_icon_path.clone(),
             current_hour_feels_like: na.clone(),
@@ -567,7 +569,10 @@ impl ContextBuilder {
     fn set_now_values_for_table(&mut self, current_hour: &HourlyForecast) {
         self.context.current_hour_wind_speed = current_hour
             .wind
-            .get_speed(CONFIG.render_options.use_gust_instead_of_wind)
+            .get_speed_in_unit(
+                CONFIG.render_options.use_gust_instead_of_wind,
+                CONFIG.render_options.wind_speed_unit,
+            )
             .to_string();
         self.context.current_hour_wind_icon = current_hour.wind.get_icon_path();
         self.context.current_hour_uv_index = current_hour.uv_index.to_string();
@@ -625,10 +630,20 @@ impl ContextBuilder {
             .wind
             .get_speed(CONFIG.render_options.use_gust_instead_of_wind));
 
+        // Convert wind speed to configured unit
+        let max_wind_today_converted = crate::domain::models::Wind::convert_speed(
+            max_wind_today,
+            CONFIG.render_options.wind_speed_unit,
+        );
+        let max_wind_tomorrow_converted = crate::domain::models::Wind::convert_speed(
+            max_wind_tomorrow,
+            CONFIG.render_options.wind_speed_unit,
+        );
+
         if max_wind_today > max_wind_tomorrow {
-            self.context.max_gust_speed = max_wind_today.to_string();
+            self.context.max_gust_speed = max_wind_today_converted.to_string();
         } else {
-            self.context.max_gust_speed = max_wind_tomorrow.to_string();
+            self.context.max_gust_speed = max_wind_tomorrow_converted.to_string();
             self.context.max_gust_speed_font_style = FontStyle::Italic.to_string();
         }
 

src/dashboard/context.rs

@@ -106,6 +106,26 @@ impl Wind {
             self.speed_kmh
         }
     }
+
+    /// Convert wind speed from km/h to the specified unit
+    pub fn convert_speed(speed_kmh: u16, unit: crate::configs::settings::WindSpeedUnit) -> u16 {
+        use crate::configs::settings::WindSpeedUnit;
+        match unit {
+            WindSpeedUnit::KmH => speed_kmh,
+            WindSpeedUnit::Mph => (speed_kmh as f64 * 0.621371).round() as u16,
+            WindSpeedUnit::Knots => (speed_kmh as f64 * 0.539957).round() as u16,
+        }
+    }
+
+    /// Get the wind speed in the configured unit
+    pub fn get_speed_in_unit(
+        &self,
+        use_gust: bool,
+        unit: crate::configs::settings::WindSpeedUnit,
+    ) -> u16 {
+        let speed_kmh = self.get_speed(use_gust);
+        Self::convert_speed(speed_kmh, unit)
+    }
 }
 
 /// Domain model for precipitation information