PyHolfuy 0.0__py3-none-any.whl

holfuy/__init__.py

@@ -0,0 +1,131 @@
+"""Library to handle connection with Holfuy Live API."""
+
+import asyncio
+import logging
+
+from typing import Any
+
+import aiohttp
+
+from .const import (
+    CONF_TEMPERATURE_UNIT_CELSUIS,
+    CONF_WIND_SPEED_UNIT_MS,
+    CONF_AVERAGING_NEWEST,
+    CONF_MODE_JSON,
+    STATIONS_ALL,
+)
+
+TIMEOUT = 30
+_LOGGER = logging.getLogger(__name__)
+
+API_URL = "http://api.holfuy.com/live/"
+
+# noqa: E501
+#### API Description
+# URL Format:  http://api.holfuy.com/live/?s=101&pw=pass&m=JSON&tu=C&su=m/s
+#
+# s: station(s) ID e.g. s=101 or you can get the data from more stations by one query as well (coma separated list) e.g. s=101,102,103 . If you would get all stations' data (to which you have access) by one single API call please use the "all" string -> s=all .
+# pw: password for the API access (it could be sent by a POST "pw" parameter also)
+# m:mode XML or CSV or JSON default: CSV
+# avg:averaging "0": newest data from the station, "1" newest quarter hourly average, "2" newest hourly average (default = 0)
+# su: wind speed unit: knots, km/h, m/s, mph, default: m/s
+# tu: temperature unit C:Celsius , F: Fahrenheit default: Celsius
+# batt: add this parameter to get the station's battery voltage (JSON only).
+# cam: add this parameter to the URL for timestamp of the last picture from the camera. (JSON only, only for stations with a camera)
+# daily: add this parameter to get daily Max-Min temperatures and precipitation since last midnight CE(S)T (JSON only, max 5 stations)
+# loc: add this parameter to the URL to get the station's location in reply too (JSON only)
+# utc: add this parameter to the URL for timestamps in UTC, otherwise times will be in CE(S)T
+# Data: DateTime: time of the last data / average in ".date('T')." (Central European Time) or in UTC if utc param is set.
+#####
+
+
+class HolfuyService:
+    """Representation of Holfuy weather data."""
+
+    def __init__(
+        self,
+        api_key: str,
+        websession=None,
+        temperature_unit=CONF_TEMPERATURE_UNIT_CELSUIS,
+        wind_speed_unit=CONF_WIND_SPEED_UNIT_MS,
+        timestamps_in_utc=False,
+    ) -> None:
+        """Initialize the Weather object."""
+
+        self._api_url = API_URL
+        self._api_key = api_key
+        self._wind_speed_unit = wind_speed_unit
+        self._temperature_unit = temperature_unit
+        self._timestamps_in_utc = timestamps_in_utc
+
+        if websession is None:
+
+            async def _create_session():
+                return aiohttp.ClientSession()
+
+            loop = asyncio.get_event_loop()
+            self._websession = loop.run_until_complete(_create_session())
+        else:
+            self._websession = websession
+
+    async def fetch_data(
+        self,
+        stations: list[str] | None = None,
+        averaging_mode=CONF_AVERAGING_NEWEST,
+        include_battery=False,
+        include_daily=False,
+        include_location=False,
+    ) -> dict[str, Any] | None:
+        """Get the latest data from Holfuy."""
+
+        params = {
+            "pw": self._api_key,
+            "m": CONF_MODE_JSON,
+            "tu": self._temperature_unit,
+            "su": self._wind_speed_unit,
+            "avg": averaging_mode,
+        }
+
+        if self._timestamps_in_utc:
+            params["utc"] = ""
+
+        if include_battery:
+            params["batt"] = ""
+
+        if include_daily:
+            params["daily"] = ""
+
+        if include_location:
+            params["loc"] = ""
+
+        if stations:
+            params["s"] = ",".join(map(str, stations))
+        else:
+            params["s"] = STATIONS_ALL
+
+        try:
+            async with asyncio.timeout(TIMEOUT):
+                resp = await self._websession.get(self._api_url, params=params)
+
+            if resp.status >= 400:
+                _LOGGER.error("%s returned %s", self._api_url, resp.status)
+                return None
+
+            result = await resp.json()
+
+            # Request for a single station is not enveloped in a list of
+            # measurements objects. Make data consistent for all request types before it
+            #  is returned.
+            if stations and len(stations) == 1:
+                result = {"measurements": result}
+
+            return result
+
+        except (TimeoutError, aiohttp.ClientError) as err:
+            _LOGGER.error(
+                "Access to %s returned error '%s'", self._api_url, type(err).__name__
+            )
+            return None
+        except ValueError:
+            _LOGGER.exception("Unable to parse json response from %s", self._api_url)
+            return None

holfuy/const.py

@@ -0,0 +1,20 @@
+CONF_MODE_JSON = "JSON"  # We only handle JSON from the api
+CONF_MODE_XML = "CSV"
+CONF_MODE_CSV = "XML"
+
+CONF_AVERAGING_NEWEST = 0
+CONF_AVERAGING_QUARTERLY = 1
+CONF_AVERAGING_HOURLY = 2
+
+CONF_WIND_SPEED_UNIT_KNOTS = "knots"
+CONF_WIND_SPEED_UNIT_KMH = "km/h"
+CONF_WIND_SPEED_UNIT_MS = "m/s"
+CONF_WIND_SPEED_UNIT_MPH = "mph"
+
+CONF_TEMPERATURE_UNIT_CELSUIS = "Celsius"
+CONF_TEMPERATURE_UNIT_FAHRENHEIT = "Fahrenheit"
+
+CONF_OPTION_BATT = "batt"
+CONF_OPTION_DAILY = "daily"
+
+STATIONS_ALL = "all"

pyholfuy-0.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: PyHolfuy
+Version: 0.0
+Summary: A Python library for interacting with Holfuy weather stations.
+Author-email: Håvard Dagenborg <haavardj@dagenborg.net>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/haavardj/PyHolfuy
+Keywords: weather,holfuy,api,python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9.4
+Provides-Extra: test
+Requires-Dist: aioresponses==0.7.8; extra == "test"
+Requires-Dist: coverage==7.8.0; extra == "test"
+Requires-Dist: mypy==1.15.0; extra == "test"
+Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
+Requires-Dist: pytest-cov==6.1.1; extra == "test"
+Requires-Dist: pytest-error-for-skips==2.0.2; extra == "test"
+Requires-Dist: pytest-timeout==2.3.1; extra == "test"
+Requires-Dist: pytest==8.3.5; extra == "test"
+Requires-Dist: ruff==0.11.7; extra == "test"
+Requires-Dist: syrupy==4.9.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pre-commit==4.2.0; extra == "dev"
+Dynamic: license-file
+
+![Holfy Logo](https://holfuy.com/image/logo/holfuy-logo.png)
+
+# PyHolfuy
+A Python library for talking to [Holfuy Weather Stations](https://holfuy.com/).
+
+You need an API key to access the service. To obtain one, please visit the [Holfuy API](https://api.holfuy.com/live/) pages.
+
+The Library only access live data.
+
+## Example Code
+Here is an example of how to use the library.
+
+```python
+import aiohttp
+import asyncio
+from holfuy import HolfuyService
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+    s = HolfuyService("", session)
+    data = await s.fetch_data(["101"])
+    print(data)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

pyholfuy-0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+holfuy/__init__.py,sha256=iNeZqVv_pWg1IMv-ezqn1NxCc8kYcGCekQ7o76ybiG8,4526
+holfuy/const.py,sha256=0PADMZ4XzkeLAHn_KNi5DNP7IVtICOYEbFiWjAMAFqk,491
+pyholfuy-0.0.dist-info/licenses/LICENSE,sha256=xF0ocSqx7NzvDH3jXBxEnf6xqOYWGB0_Xa1VLTZzl_A,1074
+pyholfuy-0.0.dist-info/METADATA,sha256=jbDAL4aqWFs4dWvhDjd7f-XReOFv17aKtAYfkKJMA_4,1794
+pyholfuy-0.0.dist-info/WHEEL,sha256=GHB6lJx2juba1wDgXDNlMTyM13ckjBMKf-OnwgKOCtA,91
+pyholfuy-0.0.dist-info/top_level.txt,sha256=uFdZ8sLqhc_bW4N7jQ5EMwHqcEqoab3D4sJG53CkR8U,7
+pyholfuy-0.0.dist-info/RECORD,,

pyholfuy-0.0.dist-info/WHEEL

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

pyholfuy-0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Håvard Dagenborg
+
+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
+SOFTWARE.

pyholfuy-0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+holfuy