New example: weather demo #5601

Justyna-JustCode · 2024-07-11T10:52:58Z

Hi,
Please let me know if something needs to be added.

I assumed that links like:
https://slint.dev/snapshots/master/demos/weather-demo/
or
https://slint.dev/snapshots/master/editor?load_url=https://raw.githubusercontent.com/slint-ui/slint/master/examples/weather-demo/ui/main.slint
would start working when the PR is merged into the master and the wasm is built with the GitHub actions.
Let me know if I'm wrong.
Anyway, the preview with slint-pad is not working because we're using changed callbacks in the demo (see here). Should I remove the link, then?

CLAassistant · 2024-07-11T10:53:04Z

All committers have signed the CLA.

tronical · 2024-07-11T11:06:47Z

Anyway, the preview with slint-pad is not working because we're using changed callbacks in the demo (see here). Should I remove the link, then?

While change callbacks are still experimental and not enabled by default, we'd like to avoid their use in examples and demos (that folks copy & paste from). Would it be possible to change the code to not use them?

tronical · 2024-07-11T11:07:33Z

I assumed that links like: https://slint.dev/snapshots/master/demos/weather-demo/ or https://slint.dev/snapshots/master/editor?load_url=https://raw.githubusercontent.com/slint-ui/slint/master/examples/weather-demo/ui/main.slint would start working when the PR is merged into the master and the wasm is built with the GitHub actions. Let me know if I'm wrong.

Yes, they should. I can help fix that up afterwards if necessary, no worries :)

tronical · 2024-07-11T11:08:20Z

examples/weather-demo/Cargo.toml

+# Using different Slint configuration on Windows to disable the accessibility feature (enabled by default).
+# The feature caused performance issues on Windows (see https://github.com/slint-ui/slint/issues/5338).
+# Note: might be fixed with v1.7


Since this is being built with "1.7", does this still apply?

I believe so since the ticket (the one that mine was a duplicate of) is still open. But I can double-check this.

Ok :). We can deal with this separately and leave this.

Ok, I checked and this is fixed now in master AFAICS.

I checked and can confirm that the issue is gone. Let me update the file.

EDIT: Done

tronical · 2024-07-11T11:08:59Z

examples/weather-demo/build.rs

+use std::env;
+
+fn main() {
+    env::set_var("SLINT_ENABLE_EXPERIMENTAL_FEATURES", "true");


I'm hesitant about the use of change callbacks in the demos/examples. @ogoffart what's your opinion?

Initially, we tried to avoid them. I believe there are at least one or two use cases where I could not find a workaround for not using them and still providing the functionality.
Maybe I'm missing something. Please let me know if you want me to examine this again and provide you with concrete examples.

Alright, let's keep the use of the change handlers as they are :-)

tronical · 2024-07-11T11:10:41Z

The demo looks great overall, btw! Thanks for contributing it.

Please see the message from GitHub about the mismatch between GitHub user and email address. You'll also see that our CI complains about copyright headers and SPDX license tags.

examples/weather-demo/Cargo.toml

tronical · 2024-07-11T12:22:15Z

examples/weather-demo/Cargo.toml

+[target.'cfg(all(not(target_os = "windows"), not(target_os = "android")))'.dependencies]
+slint = { path = "../../api/rs/slint" }
+
+# Using different Slint configuration on Windows to disable the accessibility feature (enabled by default).
+# The feature caused performance issues on Windows (see https://github.com/slint-ui/slint/issues/5338).
+# Note: might be fixed with v1.7
+[target.'cfg(target_os = "windows")'.dependencies]
+slint = { path = "../../api/rs/slint", default-features = false, features = [ "compat-1-2", "backend-winit", "renderer-femtovg" ] }
+
+[target.'cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))'.dependencies]
+env_logger = "0.11.3"
+
+[target.'cfg(target_os = "android")'.dependencies]
+android_logger = "0.14.1"
+openssl = { version = "0.10", features = ["vendored"] }
+slint = { path = "../../api/rs/slint", features = [ "backend-android-activity-06" ] }


Suggested change

[target.'cfg(all(not(target_os = "windows"), not(target_os = "android")))'.dependencies]

slint = { path = "../../api/rs/slint" }

# Using different Slint configuration on Windows to disable the accessibility feature (enabled by default).

# The feature caused performance issues on Windows (see https://github.com/slint-ui/slint/issues/5338).

# Note: might be fixed with v1.7

[target.'cfg(target_os = "windows")'.dependencies]

slint = { path = "../../api/rs/slint", default-features = false, features = [ "compat-1-2", "backend-winit", "renderer-femtovg" ] }

[target.'cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))'.dependencies]

env_logger = "0.11.3"

[target.'cfg(target_os = "android")'.dependencies]

android_logger = "0.14.1"

openssl = { version = "0.10", features = ["vendored"] }

slint = { path = "../../api/rs/slint", features = [ "backend-android-activity-06" ] }

slint = { path = "../../api/rs/slint", features = [ "backend-android-activity-06" ] }

[target.'cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))'.dependencies]

env_logger = "0.11.3"

[target.'cfg(target_os = "android")'.dependencies]

android_logger = "0.14.1"

openssl = { version = "0.10", features = ["vendored"] }

tronical · 2024-07-11T12:42:15Z

For the "reuse" tool failures in the CI:

Error: Project is not reuse compliant!
The following files have no copyright and licensing information:
* examples/weather-demo/android-res/mipmap-hdpi/ic_launcher.png
* examples/weather-demo/android-res/mipmap-ldpi/ic_launcher.png
* examples/weather-demo/android-res/mipmap-mdpi/ic_launcher.png
* examples/weather-demo/android-res/mipmap-xhdpi/ic_launcher.png
* examples/weather-demo/android-res/mipmap-xxhdpi/ic_launcher.png
* examples/weather-demo/android-res/mipmap-xxxhdpi/ic_launcher.png
* examples/weather-demo/docs/img/android-preview.png
* examples/weather-demo/docs/img/desktop-preview.png
* examples/weather-demo/ui/assets/busy-indicator.png
* examples/weather-demo/ui/assets/felgo-logo.svg
* examples/weather-demo/ui/assets/font-awesome.ttf
* examples/weather-demo/ui/assets/weathericons-font.ttf
* examples/weather-demo/wasm/index.html

For every file in the repo we need to know who the copyright holder is and under what license we're using the file(s). For our examples we typically record this in the file .reuse/dep5 in the top-level. If you look around there you can see what we use some wildcards for examples, etc.

tronical · 2024-07-11T12:43:45Z

examples/weather-demo/ui/assets/font-awesome.ttf

This file is rather large. Is this needed for some icons? Would it be possible to extract them as .svgs instead? We use icons from font-awesome in a few other place and opted into shipping smaller .svg files instead of the whole ttf.

Ok, I can change this. From what I remember, they are only a few usages.

examples/weather-demo/ui/assets/weathericons-font.ttf

tronical · 2024-07-11T13:28:03Z

examples/weather-demo/Cargo.toml

+
+[package]
+name = "rusty-weather"
+version = "1.0.0"


I think we usually match the version with the rest of Slint in the repo :)

Suggested change

version = "1.0.0"

version = "1.7.0"

tronical · 2024-07-11T13:30:57Z

examples/weather-demo/src/weather/openweathercontroller.rs

+
+const CITIES_STORED_FILE_NAME: &str = "cities_data.json";
+const ORGANIZATION_QUALIFIER: &str = "com"; // have to match android app name in cargo.toml
+const ORGANIZATION_NAME: &str = "felgo.demos"; // have to match android app name in cargo.toml


Maybe this needs changing/adapting? Just a drive-by thought.

I guess it makes sense, but let me double-check this and get back to you 🙂

Sorry for the delay. I was offline last week.
I changed this. Please let me know if the new version is okay with you.

tronical · 2024-07-11T13:34:06Z

examples/weather-demo/README.md

+</p>
+
+## Weather data
+To enable real weather data from the [OpenWeather](https://openweathermap.org/) API, you must provide the `RUSTY_WEATHER_API_KEY` environment variable with your API key at build time. The [OpenCall API](https://openweathermap.org/price#onecall) subscription is required.


This thought is beyond the scope of this PR: We have similar needs in the energy monitor demo, where we use weatherapi.com and we've got an API key in the CI set, so that the demos built have weather data support. It might make sense to unify these, i.e. either to switch the energy monitor over to use openweathermap.org or the other way around. The key from weatherapi.com is free.

That sounds like a good idea 🙂

Just so you know, the OpenWeather API is also mostly free. Only the OneCall API we used requires a paid subscription, and it is only paid for calls above 1000 per day.

The other APIs available for free keys can provide similar functionalities. We only switched to the OneCall version because we were facing issues. However, as we later discovered, those were issues in the crate we used rather than in the API itself.

Justyna-JustCode · 2024-07-12T12:16:24Z

Regarding the "reuse" specification, I'm still waiting for confirmation on our internal images licensing. Anything else should already be covered.

Justyna-JustCode · 2024-07-22T08:53:42Z

I think it's all done now; I synced with the latest master, and the CI is passing.
Please let me know if you need something else from our side 🙂

tronical

Awesome, thank you!

tronical reviewed Jul 11, 2024

View reviewed changes

examples/weather-demo/Cargo.toml Outdated Show resolved Hide resolved

Justyna-JustCode force-pushed the feature/weather-demo branch 3 times, most recently from ff5494a to 4a0ed30 Compare July 11, 2024 12:08

tronical reviewed Jul 11, 2024

View reviewed changes

examples/weather-demo/ui/assets/weathericons-font.ttf Outdated Show resolved Hide resolved

tronical reviewed Jul 11, 2024

View reviewed changes

Justyna-JustCode force-pushed the feature/weather-demo branch from 4a0ed30 to bb6af49 Compare July 12, 2024 12:12

Justyna-JustCode force-pushed the feature/weather-demo branch from bb6af49 to b2afa3a Compare July 12, 2024 12:23

Justyna-JustCode force-pushed the feature/weather-demo branch from b2afa3a to 4a8106c Compare July 22, 2024 07:57

weather-demo: initial commit

67a0990

Justyna-JustCode force-pushed the feature/weather-demo branch from 4a8106c to 67a0990 Compare July 22, 2024 08:34

tronical approved these changes Jul 22, 2024

View reviewed changes

tronical merged commit 33c84b6 into slint-ui:master Jul 22, 2024
35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New example: weather demo #5601

New example: weather demo #5601

Justyna-JustCode commented Jul 11, 2024

CLAassistant commented Jul 11, 2024 •

edited

Loading

tronical commented Jul 11, 2024

tronical commented Jul 11, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 11, 2024

tronical Jul 11, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 12, 2024 •

edited

Loading

tronical Jul 11, 2024

Justyna-JustCode Jul 11, 2024

tronical Jul 11, 2024

tronical commented Jul 11, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 12, 2024

tronical commented Jul 11, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 11, 2024

Justyna-JustCode Jul 12, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 12, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 12, 2024

Justyna-JustCode Jul 22, 2024

tronical Jul 11, 2024

Justyna-JustCode Jul 12, 2024

Justyna-JustCode commented Jul 12, 2024

Justyna-JustCode commented Jul 22, 2024

tronical left a comment

New example: weather demo #5601

New example: weather demo #5601

Conversation

Justyna-JustCode commented Jul 11, 2024

CLAassistant commented Jul 11, 2024 • edited Loading

tronical commented Jul 11, 2024

tronical commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Justyna-JustCode Jul 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tronical commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tronical commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Justyna-JustCode commented Jul 12, 2024

Justyna-JustCode commented Jul 22, 2024

tronical left a comment

Choose a reason for hiding this comment

CLAassistant commented Jul 11, 2024 •

edited

Loading

Justyna-JustCode Jul 12, 2024 •

edited

Loading