https://github.com/eddytheco/omclient
https://github.com/eddytheco/omclient
openmeteo qml qt6
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eddytheco/omclient
- Owner: EddyTheCo
- License: gpl-3.0
- Created: 2023-09-29T15:45:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-25T18:29:00.000Z (about 1 year ago)
- Last Synced: 2024-04-26T10:46:41.045Z (about 1 year ago)
- Topics: openmeteo, qml, qt6
- Language: GLSL
- Homepage: https://eddytheco.github.io/OMClient/
- Size: 411 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open-Meteo Client Implementation
[TOC]
Implements a client to communicate with the Open-Meteo REST API.
The repo creates a custom QML module and types related with weather conditions.
## Installing the library
### From source code
```
git clone https://github.com/EddyTheCo/OMClient.git
mkdir build
cd build
qt-cmake -G Ninja -DCMAKE_INSTALL_PREFIX=installDir -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=OFF -DUSE_QML=OFF -DBUILD_DOCS=OFF ../OMClient
cmake --build .
cmake --install .
```
where `installDir` is the installation path.
Setting the `USE_QML` variable produce or not the QML module.
One can choose to build or not the examples and the documentation with the `BUILD_EXAMPLES` and `BUILD_DOCS` variables.
### From GitHub releases
Download the releases from this repo.
## Use it in your project
Just add to your project CMakeLists.txt
```
FetchContent_Declare(
openMeteo
GIT_REPOSITORY https://github.com/EddyTheCo/OMClient.git
GIT_TAG vMAJOR.MINOR.PATCH
FIND_PACKAGE_ARGS MAJOR.MINOR CONFIG
)
FetchContent_MakeAvailable(openMeteo)
target_link_libraries( openMeteo::OMClient)
```
If want to use the QML module also add
```
$<$,STATIC_LIBRARY>:openMeteo::OMClientplugin>
```
## Using the QML modules
One needs to make available to the QML engine the different modules by setting the [QML import path](https://doc.qt.io/qt-6/qtqml-syntax-imports.html#qml-import-path).
1. In your main function `engine.addImportPath("qrc:/esterVtech.com/imports");` to use the resource file.
2. Set the environment variable like `export QML_IMPORT_PATH=installDir/CMAKE_INSTALL_LIBDIR` where `CMAKE_INSTALL_LIBDIR` is where `Esterv` folder was created.
You can play with the QML element [here](https://eddytheco.github.io/qmlonline/?example_url=omclient).
## API reference
You can read the [API reference](https://eddytheco.github.io/OMClient/) here, or generate it yourself like
```
cmake -DBUILD_DOCS=ON ../
cmake --build . --target doxygen_docs
```
## Contributing
We appreciate any contribution!
Currently not all the weather codes are implemented, contribution to the shaders are highly appreciated.
I find shaders very customizable, you can test your new shaders contribution [here](https://www.shadertoy.com/view/csKyDz)
You can open an issue or request a feature also.
You can open a PR to the development branch and the CI/CD will take care of the rest.
Make sure to acknowledge your work, ideas when contributing.