juham-visualcrossing 0.1.1__py3-none-any.whl → 0.1.7__py3-none-any.whl

juham_visualcrossing/__init__.py

@@ -1,13 +1,16 @@
-"""
-Description
-===========
-
-VisualCrossing weather forecast.
-
-"""
-
-from .visualcrossing import VisualCrossing
-
-__all__ = [
-    "VisualCrossing",
-]
+"""
+Description
+===========
+
+VisualCrossing weather forecast.
+
+"""
+
+from .visualcrossing import VisualCrossing, VisualCrossingThread
+from .visualcrossing_plugin import VisualCrossingPlugin
+
+__all__ = [
+    "VisualCrossing",
+    "VisualCrossingThread",
+    "VisualCrossingPlugin",
+]

juham_visualcrossing/visualcrossing.py

@@ -1,194 +1,194 @@
-from datetime import datetime, timedelta, timezone
-import json
-from typing import Any, Optional, cast
-from typing_extensions import override
-from masterpiece.mqtt import MqttMsg, Mqtt
-from juham.core import RCloud, RCloudThread
-
-
-class VisualCrossingThread(RCloudThread):
-    """Asynchronous thread for acquiring forecast from the VisualCrossing
-    site."""
-
-    # class attributes
-    _forecast_topic: str = ""
-    _base_url: str = ""
-    _api_key: str = ""
-    _location: str = ""
-    _interval: float = 12 * 3600
-
-    def __init__(self, client: Optional[Mqtt] = None):
-        """Construct with the given mqtt client. Acquires data from the visual
-        crossing web service and publishes the forecast data to
-        forecast_topic.
-
-        Args:
-            client (object, optional): MQTT client. Defaults to None.
-        """
-        super().__init__(client)
-        self.mqtt_client: Optional[Mqtt] = client
-
-    @override
-    def update_interval(self) -> float:
-        return self._interval
-
-    @override
-    def make_weburl(self) -> str:
-        if not self._api_key:
-            self.error("Uninitialized api_key {self.get_class_id()}: {self._api_key}")
-            return ""
-        else:
-            now = datetime.now()
-            end = now + timedelta(days=1)
-            start = now.strftime("%Y-%m-%d")
-            stop = end.strftime("%Y-%m-%d")
-            url = f"{self._base_url}{self._location}/{start}/{stop}?unitGroup=metric&contentType=json&include=hours&key={self._api_key}"
-            self.debug(url)
-            return url
-
-    def init(
-        self, topic: str, base_url: str, interval: float, api_key: str, location: str
-    ) -> None:
-        """Initialize the  data acquisition thread
-
-        Args:
-            topic (str): mqtt topic to publish the acquired data
-            base_url (str): url of the web service
-            interval (float): update interval in seconds
-            api_key (str): api_key, as required by the web service
-            location (str): geographic location
-        """
-        self._forecast_topic = topic
-        self._base_url = base_url
-        self._interval = interval
-        self._api_key = api_key
-        self._location = location
-
-    @override
-    def process_data(self, data: Any) -> None:
-        self.info("VisualCrossing process_data()")
-        data = data.json()
-        forecast = []
-        self.info(f"VisualCrossing {data}")
-        for day in data["days"]:
-            for hour in day["hours"]:
-                ts = int(hour["datetimeEpoch"])
-                forecast.append(
-                    {
-                        "id": "visualcrossing",
-                        "ts": ts,
-                        "hour": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
-                            "%H"
-                        ),
-                        "day": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
-                            "%Y%m%d%H"
-                        ),
-                        "uvindex": hour["uvindex"],
-                        "solarradiation": hour["solarradiation"],
-                        "solarenergy": hour["solarenergy"],
-                        "cloudcover": hour["cloudcover"],
-                        "snow": hour["snow"],
-                        "snowdepth": hour["snowdepth"],
-                        "pressure": hour["pressure"],
-                        "temp": hour["temp"],
-                        "humidity": hour["humidity"],
-                        "windspeed": hour["windspeed"],
-                        "winddir": hour["winddir"],
-                        "dew": hour["dew"],
-                    }
-                )
-        msg = json.dumps(forecast)
-        self.publish(self._forecast_topic, msg, qos=1, retain=False)
-        self.info(f"VisualCrossing forecast published to {self._forecast_topic}")
-
-
-class VisualCrossing(RCloud):
-    """Constructs a data acquisition object for reading weather
-    forecasts from the VisualCrossing web service. Subscribes to the
-    forecast topic and writes hourly data such as solar energy, temperature,
-    and other attributes relevant to home automation into a time series
-    database.
-
-    Spawns an asynchronous thread to run queries at the specified
-    update_interval.
-    """
-
-    workerThreadId: str = VisualCrossingThread.get_class_id()
-    base_url: str = (
-        "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
-    )
-    update_interval: float = 12 * 3600
-    api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
-    location: str = "lahti,finland"
-
-    def __init__(self, name="visualcrossing") -> None:
-        """Constructs VisualCrossing automation object for acquiring and publishing
-        forecast data.
-
-        Args:
-            name (str, optional): name of the object. Defaults to "visualcrossing".
-        """
-        super().__init__(name)
-        self.worker: Optional[VisualCrossingThread] = None
-        self.forecast_topic: str = self.make_topic_name("forecast")
-        self.debug(f"VisualCrossing with name {name} created")
-
-    @override
-    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
-        super().on_connect(client, userdata, flags, rc)
-        if rc == 0:
-            self.subscribe(self.forecast_topic)
-            self.debug(f"VisualCrossing subscribed to topic {self.forecast_topic}")
-
-    @override
-    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
-        if msg.topic == self.forecast_topic:
-            em = json.loads(msg.payload.decode())
-            self.on_forecast(em)
-        else:
-            super().on_message(client, userdata, msg)
-
-    def on_forecast(self, em: dict) -> None:
-        """Handle weather forecast data.
-
-        Args:
-            em (dict): forecast
-        """
-        self.debug(f"VisualCrossing: got mqtt message {em}")
-
-    @override
-    def run(self) -> None:
-        # create, initialize and start the asynchronous thread for acquiring forecast
-
-        self.worker = cast(
-            VisualCrossingThread, self.instantiate(VisualCrossing.workerThreadId)
-        )
-        self.worker.init(
-            self.forecast_topic,
-            self.base_url,
-            self.update_interval,
-            self.api_key,
-            self.location,
-        )
-        self.debug(
-            f"VisualCrossing run: {self.base_url}, {self.update_interval}s, location is {self.location}"
-        )
-        super().run()
-
-    @override
-    def to_dict(self) -> dict:
-        data = super().to_dict()
-        data["_visualcrossing"] = {
-            "topic": self.forecast_topic,
-            "url": self.base_url,
-            "api_key": self.api_key,
-            "interval": self.update_interval,
-        }
-        return data
-
-    @override
-    def from_dict(self, data) -> None:
-        super().from_dict(data)
-        if "_visualcrossing" in data:
-            for key, value in data["_visualcrossing"].items():
-                setattr(self, key, value)
+from datetime import datetime, timedelta, timezone
+import json
+from typing_extensions import override
+from typing import Any, Optional, cast
+from masterpiece.mqtt import MqttMsg, Mqtt
+from juham_core import JuhamThread, JuhamCloudThread
+
+
+class VisualCrossingThread(JuhamCloudThread):
+    """Asynchronous thread for acquiring forecast from the VisualCrossing
+    site."""
+
+    # class attributes
+    _forecast_topic: str = ""
+    _base_url: str = ""
+    _api_key: str = ""
+    _location: str = ""
+    _interval: float = 12 * 3600
+
+    def __init__(self, client: Optional[Mqtt] = None):
+        """Construct with the given mqtt client. Acquires data from the visual
+        crossing web service and publishes the forecast data to
+        forecast_topic.
+
+        Args:
+            client (object, optional): MQTT client. Defaults to None.
+        """
+        super().__init__(client)
+        self.mqtt_client: Optional[Mqtt] = client
+
+    @override
+    def update_interval(self) -> float:
+        return self._interval
+
+    @override
+    def make_weburl(self) -> str:
+        if not self._api_key:
+            self.error("Uninitialized api_key {self.get_class_id()}: {self._api_key}")
+            return ""
+        else:
+            now = datetime.now()
+            end = now + timedelta(days=1)
+            start = now.strftime("%Y-%m-%d")
+            stop = end.strftime("%Y-%m-%d")
+            url = f"{self._base_url}{self._location}/{start}/{stop}?unitGroup=metric&contentType=json&include=hours&key={self._api_key}"
+            # self.debug(url)
+            return url
+
+    def init(
+        self, topic: str, base_url: str, interval: float, api_key: str, location: str
+    ) -> None:
+        """Initialize the  data acquisition thread
+
+        Args:
+            topic (str): mqtt topic to publish the acquired data
+            base_url (str): url of the web service
+            interval (float): update interval in seconds
+            api_key (str): api_key, as required by the web service
+            location (str): geographic location
+        """
+        self._forecast_topic = topic
+        self._base_url = base_url
+        self._interval = interval
+        self._api_key = api_key
+        self._location = location
+
+    @override
+    def process_data(self, data: Any) -> None:
+        self.info("VisualCrossing process_data()")
+        data = data.json()
+        forecast = []
+        self.info(f"VisualCrossing {data}")
+        for day in data["days"]:
+            for hour in day["hours"]:
+                ts = int(hour["datetimeEpoch"])
+                forecast.append(
+                    {
+                        "id": "visualcrossing",
+                        "ts": ts,
+                        "hour": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
+                            "%H"
+                        ),
+                        "day": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
+                            "%Y%m%d%H"
+                        ),
+                        "uvindex": hour["uvindex"],
+                        "solarradiation": hour["solarradiation"],
+                        "solarenergy": hour["solarenergy"],
+                        "cloudcover": hour["cloudcover"],
+                        "snow": hour["snow"],
+                        "snowdepth": hour["snowdepth"],
+                        "pressure": hour["pressure"],
+                        "temp": hour["temp"],
+                        "humidity": hour["humidity"],
+                        "windspeed": hour["windspeed"],
+                        "winddir": hour["winddir"],
+                        "dew": hour["dew"],
+                    }
+                )
+        msg = json.dumps(forecast)
+        self.publish(self._forecast_topic, msg, qos=1, retain=True)
+        self.info(f"VisualCrossing forecast published to {self._forecast_topic}")
+
+
+class VisualCrossing(JuhamThread):
+    """Constructs a data acquisition object for reading weather
+    forecasts from the VisualCrossing web service. Subscribes to the
+    forecast topic and writes hourly data such as solar energy, temperature,
+    and other attributes relevant to home automation into a time series
+    database.
+
+    Spawns an asynchronous thread to run queries at the specified
+    update_interval.
+    """
+
+    workerThreadId: str = VisualCrossingThread.get_class_id()
+    base_url: str = (
+        "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
+    )
+    update_interval: float = 12 * 3600
+    api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
+    location: str = "lahti,finland"
+
+    def __init__(self, name="visualcrossing") -> None:
+        """Constructs VisualCrossing automation object for acquiring and publishing
+        forecast data.
+
+        Args:
+            name (str, optional): name of the object. Defaults to "visualcrossing".
+        """
+        super().__init__(name)
+        self.worker: Optional[VisualCrossingThread] = None
+        self.forecast_topic: str = self.make_topic_name("forecast")
+        self.debug(f"VisualCrossing with name {name} created")
+
+    @override
+    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
+        super().on_connect(client, userdata, flags, rc)
+        if rc == 0:
+            self.subscribe(self.forecast_topic)
+            self.debug(f"VisualCrossing subscribed to topic {self.forecast_topic}")
+
+    @override
+    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
+        if msg.topic == self.forecast_topic:
+            em = json.loads(msg.payload.decode())
+            self.on_forecast(em)
+        else:
+            super().on_message(client, userdata, msg)
+
+    def on_forecast(self, em: dict) -> None:
+        """Handle weather forecast data.
+
+        Args:
+            em (dict): forecast
+        """
+        # self.debug(f"VisualCrossing: got mqtt message {em}")
+
+    @override
+    def run(self) -> None:
+        # create, initialize and start the asynchronous thread for acquiring forecast
+
+        self.worker = cast(
+            VisualCrossingThread, self.instantiate(VisualCrossing.workerThreadId)
+        )
+        self.worker.init(
+            self.forecast_topic,
+            self.base_url,
+            self.update_interval,
+            self.api_key,
+            self.location,
+        )
+        self.debug(
+            f"VisualCrossing run: {self.base_url}, {self.update_interval}s, location is {self.location}"
+        )
+        super().run()
+
+    @override
+    def to_dict(self) -> dict:
+        data = super().to_dict()
+        data["_visualcrossing"] = {
+            "topic": self.forecast_topic,
+            "url": self.base_url,
+            "api_key": self.api_key,
+            "interval": self.update_interval,
+        }
+        return data
+
+    @override
+    def from_dict(self, data) -> None:
+        super().from_dict(data)
+        if "_visualcrossing" in data:
+            for key, value in data["_visualcrossing"].items():
+                setattr(self, key, value)

juham_visualcrossing/visualcrossing_plugin.py

@@ -0,0 +1,18 @@
+from ast import Str
+from typing_extensions import override
+from masterpiece import Plugin, Composite
+from .visualcrossing import VisualCrossing
+
+
+class VisualCrossingPlugin(Plugin):
+    """Plugin class, for installing a visualcrossing specific features into the host application."""
+
+    def __init__(self, name: str = "visual_crossing") -> None:
+        """Create visualcrossing weather service."""
+        super().__init__(name)
+
+    @override
+    def install(self, app: Composite) -> None:
+        # Create and insert a VisualCrossing classes into the host application.
+        obj = VisualCrossing()
+        app.add(obj)

juham_visualcrossing-0.1.7.dist-info/LICENSE.rst

@@ -0,0 +1,22 @@
+MIT License
+===========
+
+Copyright (c) 2024, Juha Meskanen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+

juham_visualcrossing-0.1.7.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.2
+Name: juham-visualcrossing
+Version: 0.1.7
+Summary: A Weather forecast  plugin extending `Juham` applications
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+Project-URL: Homepage, https://meskanen.com
+Project-URL: Bug Reports, https://meskanen.com
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://meskanen.com
+Keywords: object-oriented,plugin,framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: juham-automation>=0.0.7
+Requires-Dist: pytz>=2024.1
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"

juham_visualcrossing-0.1.7.dist-info/RECORD

@@ -0,0 +1,10 @@
+juham_visualcrossing/__init__.py,sha256=7Xv5LN6-LEd9cpYZBrQqQshEScEkoMyWrTcZE9IkE8o,282
+juham_visualcrossing/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+juham_visualcrossing/visualcrossing.py,sha256=N0z3UZAlelHXXg0z9OFMvkWQO6pgZBGPmS7AU_ZTxrc,7017
+juham_visualcrossing/visualcrossing_plugin.py,sha256=Qj9On-gcobpErjBJ4jEvSnAAaQor7sbPCUFq-XxIalA,625
+juham_visualcrossing-0.1.7.dist-info/LICENSE.rst,sha256=xCUTZIYDotncT_ibKn8nNVkUGiK05hJyOWypG8G7Evk,1074
+juham_visualcrossing-0.1.7.dist-info/METADATA,sha256=KkKLoCM8Qoa2TbKE011uOmrr_ixFXKgOaej3hpMo10c,947
+juham_visualcrossing-0.1.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+juham_visualcrossing-0.1.7.dist-info/entry_points.txt,sha256=BMRgZy0x03nSQfh37apI68H1nlgU0bGsvkV6LrnF1eI,82
+juham_visualcrossing-0.1.7.dist-info/top_level.txt,sha256=7yWaUHZo-Ng96VJBzUFhaFCBamL71PUjIxZISxMBjSM,21
+juham_visualcrossing-0.1.7.dist-info/RECORD,,

{juham_visualcrossing-0.1.1.dist-info → juham_visualcrossing-0.1.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

juham_visualcrossing-0.1.7.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[juham.plugins]
+visualcrossing_plugin = juham_visualcrossing:VisualCrossingPlugin

juham_visualcrossing-0.1.1.dist-info/METADATA

@@ -1,88 +0,0 @@
-Metadata-Version: 2.1
-Name: juham_visualcrossing
-Version: 0.1.1
-Summary: A Weather forecast  plugin extending `Juham` applications
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-License: MIT License
-        ===========
-        
-        Copyright (c) 2024, Juha Meskanen
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        
-        
-Project-URL: Homepage, https://meskanen.com
-Project-URL: Bug Reports, https://meskanen.com
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://meskanen.com
-Keywords: object-oriented,plugin,framework
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: juham>=0.0.17
-Requires-Dist: pytz>=2024.1
-Requires-Dist: importlib-metadata
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"
-
-juham_visualcrossing
-====================
-
-`juham_visualcrossing` plugs VisualCrossing weather forecast service to Juham - Juha's Ultimate
-Home Automation Masterpiece application.
-
-
-
-Features
---------
-
-The main purpose is to acquire solar energy forecast, for optimizing energy management in
-homes with solar panels. 
-
-
-Installation
-------------
-
-The installation is two stage process
-
-1. To install:
-
-.. code-block:: python
-
-    pip install juham_visualcrossing
-
-
-2. Configure
-
-   VisualCrossing requires you to register and obtain web key, through which you can
-   access their forecast services. So sign in to visualcrossing.com to obtain the key,
-   and then add the web key to the '~/.[app]/config/VisualCrossing.json' configuration
-   file.
-
-
-
-License
--------
-
-This project is licensed under the MIT License - see the `LICENSE` file for details.

juham_visualcrossing-0.1.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-juham_visualcrossing/__init__.py,sha256=qsVRSTeJW8jgBtLviUjq5JiJ8Z6eYkBQn6zMWgS0okY,161
-juham_visualcrossing/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-juham_visualcrossing/visualcrossing.py,sha256=yv0SlqAliI97Y10J720KAZpGnE6I8vkdGjzna1pgVg4,7190
-juham_visualcrossing-0.1.1.dist-info/METADATA,sha256=d7r85HPtikXDKnixH2PsTJE6kFCv1XLrMdTZ2u8mRDQ,3153
-juham_visualcrossing-0.1.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-juham_visualcrossing-0.1.1.dist-info/entry_points.txt,sha256=A-NSi2RN5KSKwpbKG592v5qnWnGHmIjPktubd5PQ80M,76
-juham_visualcrossing-0.1.1.dist-info/top_level.txt,sha256=7yWaUHZo-Ng96VJBzUFhaFCBamL71PUjIxZISxMBjSM,21
-juham_visualcrossing-0.1.1.dist-info/RECORD,,

juham_visualcrossing-0.1.1.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[juham.plugins]
-visualcrossing_plugin = juham_visualcrossing:VisualCrossing