meteocat 0.1.50 → 0.1.51

package/.github/workflows/hassfest.yaml

@@ -0,0 +1,14 @@
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v3"
+      - uses: home-assistant/actions/hassfest@master

package/.github/workflows/validate.yaml

@@ -0,0 +1,17 @@
+name: Validate
+
+on:
+  push: 
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+  validate-hacs:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: HACS validation
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.1.51](https://github.com/figorr/meteocat/compare/v0.1.50...v0.1.51) (2025-01-04)
+
+
+### Bug Fixes
+
+* 1.0.0 ([a1ec6cf](https://github.com/figorr/meteocat/commit/a1ec6cf411dcb208eeb153b00b73bf9f766d7f23))
+
 ## [0.1.50](https://github.com/figorr/meteocat/compare/v0.1.49...v0.1.50) (2025-01-04)
 
 

package/README.md

@@ -1,11 +1,15 @@
 # Meteocat for Home Assistant
-
+![Meteocat Banner](images/banner.png)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocat)](https://pypi.org/project/meteocat)
 [![pipeline status](https://gitlab.com/figorr/meteocat/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocat/commits/master)
 
 
-This is a project to obtain meteorological data from the Meteocat API.
+This is a project to obtain meteorological data from the Meteocat API inside the Home Assistant environment.
+
+All the data is property of Meteocat ("Servei Meteorològic de Catalunya"). This project is only a tool to offer an easy and secure access to the meteorological data provided by the "Servei Meteorològic de Catalunya" API, so you can use the data for your personal use.
+
+Commercial use of this project or the data obtained from the API is not allowed without prior permission from the author, in case of the project, or from the "Servei Meteorològic de Catalunya" in the case of the data provided by the API.
 
 **NOTE:** Meteocat API requires to use an API_KEY, you should ask to (https://apidocs.meteocat.gencat.cat/documentacio/acces-ciutada-i-administracio/)
 
@@ -16,6 +20,52 @@ This is a personal project.
 Authors:
 - Figorr
 
+## Installation
+
+#### HACS
+1. Go to `HACS`
+1. Search for `Meteocat` and add it to HACS
+1. Restart Home Assistant
+1. Go to `Settings > Devices & Services`
+1. Click `+ Add Integration`
+1. Search for `Meteocat` and follow the configuration instructions
+
+#### Manually
+Copy the `custom_components/meteocat` folder into the config folder.
+
+## Configuration
+To add a Meteocat Device, go to `Configuration > Integrations` in the UI. Then click the `+` button and from the list of integrations select Meteocat. You will then be prompted to enter your API Key.
+
+![Meteocat custom component login dialog](images/login.png)
+
+After submitting your API Key you will either be prompted to pick a town from the list as shown below.
+
+![Meteocat custom component town picker dialog](images/pick_town.png)
+
+Once you pick the town you will be prompted to pick a station from the list. These are the nearest stations to the picked town.
+
+![Meteocat component station picker dialog](images/pick_station.png)
+
+Then you will be asked to pick an area for the device.
+
+![Area](images/pick_area.png)
+
+If the device is added successfully it should appear as shown.
+
+![Device](images/devices.png)
+
+This device will then have the entities shown below. The sensors are translated to your system language (according to tranlation folder: en, es, ca). Or English by default.
+
+![Dynamic Sensors](images/dynamic_sensors.png)
+
+![Diagnostic Sensors](images/diagnostic_sensors.png)
+
+## Changing Units
+
+To change units select one of the entities and open the more info dialog and click the cog in the top right. This will bring up the settings for the entity. Then select `Unit of Measurement`, and a dropdown will appear where you can select the units you want.
+
+![Entity more info settings dialog](images/change_units.png)
+
 # Contributing
 
 1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocat/issues)

package/custom_components/meteocat/__init__.py

@@ -25,7 +25,7 @@ from .const import DOMAIN, PLATFORMS
 _LOGGER = logging.getLogger(__name__)
 
 # Versión
-__version__ = "0.1.50"
+__version__ = "1.0.0"
 
 def safe_remove(path: Path, is_folder: bool = False):
     """Elimina de forma segura un archivo o carpeta si existe."""

package/custom_components/meteocat/manifest.json

@@ -5,8 +5,9 @@
     "config_flow": true,
     "dependencies": ["persistent_notification", "http"],
     "iot_class": "cloud_polling",
-    "documentation": "https://gitlab.com/figorr/meteocat",
+    "documentation": "https://github.com/figorr/meteocat",
+    "issue_tracker": "https://github.com/figorr/meteocat/issues",
     "loggers": ["meteocatpy"],
     "requirements": ["meteocatpy==0.0.17", "packaging>=20.3", "wrapt>=1.14.0"],
-    "version": "0.1.50"
+    "version": "1.0.0"
 }

package/custom_components/meteocat/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.1.50"
+__version__ = "1.0.0"

package/filetree.txt

@@ -1,6 +1,8 @@
 └── .github/
     └── workflows/
+        ├── hassfest.yaml
         ├── release.yml
+        ├── validate.yaml
 ├── .gitignore
 ├── .gitlab-ci.yml
 ├── .pre-commit-config.yaml
@@ -32,6 +34,17 @@
 ├── filetree.py
 ├── filetree.txt
 ├── hacs.json
+└── images/
+    ├── banner.png
+    ├── change_units.png
+    ├── devices.png
+    ├── diagnostic_sensors.png
+    ├── dynamic_sensors.png
+    ├── login.png
+    ├── pick_area.png
+    ├── pick_station.png
+    ├── pick_town.png
+├── info.md
 ├── package-lock.json
 ├── package.json
 ├── poetry.lock

package/info.md

@@ -0,0 +1,11 @@
+# Meteocat
+
+Meteocat is a custom integration for Home Assistant that provides meteorological data from the Meteocat API (Servei Meteorològic de Catalunya).
+
+## Features
+- Hourly and daily weather forecasts
+- UV Index
+- Dynamic sensors based on selected station
+- Diagnostic sensors for town, station and data
+
+For more information, check the [README](https://github.com/figorr/meteocat).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "meteocat",
-  "version": "0.1.50",
+  "version": "0.1.51",
   "description": "[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\r [![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocat)](https://pypi.org/project/meteocat)\r [![pipeline status](https://gitlab.com/figorr/meteocat/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocat/commits/master)",
   "main": "index.js",
   "directories": {

package/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "meteocat"
-version = "0.1.50"
+version = "1.0.0"
 description = "Script para obtener datos meteorológicos de la API de Meteocat"
 authors = ["figorr <jdcuartero@yahoo.es>"]
 license = "Apache-2.0"