GeekMagicWeatherClockAPI 0.1.0__py3-none-any.whl

GeekMagicWeatherClockAPI/__init__.py

@@ -0,0 +1,3 @@
+from .core import SmallTV
+
+__all__ = ["SmallTV"]

GeekMagicWeatherClockAPI/core.py

@@ -0,0 +1,199 @@
+import requests
+from pathlib import Path
+from urllib.parse import quote
+
+
+class SmallTV:
+    def __init__(self, ip: str):
+        self.ip = ip
+        self.base_url = f"http://{ip}"
+        self.THEMES = {
+            1: "Weather Clock Today",
+            2: "Weather Forecast",
+            3: "Photo Album",
+            4: "Time Style 1",
+            5: "Time Style 2",
+            6: "Time Style 3",
+            7: "Simple Weather Clock",
+        }
+
+    def upload(self, file_path, retries=3):
+        """
+        Upload a GIF/image to the SmallTV.
+        Retries on malformed header responses from SmallTV firmware.
+        """
+
+        file_path = Path(file_path)
+
+        if not file_path.exists():
+            raise FileNotFoundError(file_path)
+
+        filename = file_path.name
+
+        with open(file_path, "rb") as f:
+            gif_data = f.read()
+
+        headers = {
+            "X-Requested-With": "XMLHttpRequest"
+        }
+
+        for attempt in range(1, retries + 1):
+            # Delete any partial/failed upload before retrying
+            if attempt > 1:
+                print(f"Cleaning up failed upload, retrying... (attempt {attempt}/{retries})")
+                try:
+                    self.delete(filename)
+                except Exception:
+                    pass
+
+            files = {
+                "update": (filename, gif_data, "image/gif"),
+                "image": (filename, gif_data, "image/gif"),
+            }
+
+            try:
+                r = requests.post(
+                    f"{self.base_url}/doUpload?dir=/image/",
+                    files=files,
+                    headers=headers,
+                    timeout=30
+                )
+                print("Upload Status:", r.status_code)
+                return True
+
+            except requests.exceptions.InvalidHeader:
+                print(f"Upload failed (malformed headers from SmallTV firmware) — attempt {attempt}/{retries}")
+                if attempt == retries:
+                    try:
+                        self.delete(filename)
+                    except Exception:
+                        pass
+                    raise RuntimeError(
+                        f"Upload of '{filename}' failed after {retries} attempts."
+                    )
+
+        return False
+
+    def set_image(self, filename):
+        """
+        Set the currently displayed image.
+        """
+
+        encoded_filename = quote(filename)
+
+        r = requests.get(
+            f"{self.base_url}/set?img=/image/{encoded_filename}",
+            timeout=10
+        )
+
+        print("Set Status:", r.status_code)
+
+        return r
+    
+    def set_theme(self, theme):
+        """
+        Set the SmallTV theme.
+
+        Accepts:
+            1-7
+            or
+            "Weather Clock Today"
+            "Weather Forecast"
+            "Photo Album"
+            "Time Style 1"
+            "Time Style 2"
+            "Time Style 3"
+            "Simple Weather Clock"
+        """
+
+        if isinstance(theme, str):
+            theme_lookup = {
+                v.lower(): k
+                for k, v in self.THEMES.items()
+            }
+
+            theme_id = theme_lookup.get(theme.lower())
+
+            if theme_id is None:
+                raise ValueError(
+                    f"Unknown theme '{theme}'"
+                )
+        else:
+            theme_id = int(theme)
+
+        if theme_id not in self.THEMES:
+            raise ValueError(
+                f"Theme must be between 1 and 7"
+            )
+
+        r = requests.get(
+            f"{self.base_url}/set?theme={theme_id}",
+            timeout=10
+        )
+
+        print(
+            f"Theme set to {theme_id}: "
+            f"{self.THEMES[theme_id]}"
+        )
+        print("Status:", r.status_code)
+
+        return r
+    
+    def set_brightness(self, value):
+        """
+        Set SmallTV brightness (0–100).
+        """
+
+        value = int(value)
+
+        if value < 0 or value > 100:
+            raise ValueError("Brightness must be between 0 and 100")
+
+        r = requests.get(
+            f"{self.base_url}/set?brt={value}",
+            timeout=10
+        )
+
+        print(f"Brightness set to {value}")
+        print("Status:", r.status_code)
+
+        return r
+
+    def delete(self, filename):
+        """
+        Delete an image from the SmallTV.
+        """
+
+        encoded_filename = quote(filename)
+
+        r = requests.get(
+            f"{self.base_url}/delete?file=/image/{encoded_filename}",
+            timeout=10
+        )
+
+        print("Delete Status:", r.status_code)
+
+        return r
+
+    def upload_and_set(self, file_path):
+        """
+        Upload a file and immediately display it.
+        """
+
+        file_path = Path(file_path)
+
+        self.upload(file_path)
+
+        return self.set_image(file_path.name)
+
+    def replace(self, old_filename, new_file):
+        """
+        Delete an old image, upload a new one, and display it.
+        """
+
+        try:
+            self.delete(old_filename)
+        except Exception:
+            pass
+
+        return self.upload_and_set(new_file)

geekmagicweatherclockapi-0.1.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: GeekMagicWeatherClockAPI
+Version: 0.1.0
+Summary: Python wrapper for controlling the GeekMagic SmallTV
+Project-URL: Homepage, https://github.com/eman225511/GeekMagicWeatherClockAPI
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: license-file
+
+# GeekMagicWeatherClockAPI
+
+A simple Python wrapper for controlling the **GeekMagic SmallTV** over your local network. Supports uploading images/GIFs, switching themes, adjusting brightness, and managing files on the device.
+
+---
+
+## Installation
+
+```bash
+pip install GeekMagicWeatherClockAPI
+```
+
+## Requirements
+
+- Python 3.7+
+- [`requests`](https://pypi.org/project/requests/) (installed automatically)
+
+---
+
+## Setup
+
+Find your SmallTV's local IP address (check your router's device list or the SmallTV's settings menu), then:
+
+```python
+from GeekMagicWeatherClockAPI import SmallTV
+
+tv = SmallTV("192.168.1.85")
+```
+
+---
+
+## Usage
+
+### Upload an image
+
+```python
+tv.upload("my_animation.gif")
+tv.upload("my_animation.gif", retries=5)  # Custom retry count
+```
+
+### Display an image
+
+```python
+tv.set_image("my_animation.gif")
+```
+
+### Upload and immediately display
+
+```python
+tv.upload_and_set("my_animation.gif")
+```
+
+### Replace an image
+
+```python
+tv.replace("old_animation.gif", "new_animation.gif")
+```
+
+### Delete an image
+
+```python
+tv.delete("my_animation.gif")
+```
+
+### Set brightness
+
+Accepts a value from `0` to `100`.
+
+```python
+tv.set_brightness(75)
+```
+
+### Set theme
+
+Accepts either an integer (`1`–`7`) or the theme name as a string (case-insensitive).
+
+```python
+tv.set_theme(3)
+tv.set_theme("Photo Album")
+```
+
+| ID | Theme Name           |
+|----|----------------------|
+| 1  | Weather Clock Today  |
+| 2  | Weather Forecast     |
+| 3  | Photo Album          |
+| 4  | Time Style 1         |
+| 5  | Time Style 2         |
+| 6  | Time Style 3         |
+| 7  | Simple Weather Clock |
+
+---
+
+## Full Example
+
+```python
+from GeekMagicWeatherClockAPI import SmallTV
+
+tv = SmallTV("192.168.1.85")
+
+tv.upload_and_set("spaceman.gif")
+tv.set_brightness(30)
+tv.set_theme("Weather Clock Today")
+tv.replace("spaceman.gif", "new_image.gif")
+tv.delete("new_image.gif")
+```
+
+---
+
+## Notes
+
+- The SmallTV firmware occasionally returns malformed `Content-Length` headers on upload responses. The `upload` method treats this as a failure and retries automatically.
+- All methods can raise `requests.exceptions.ConnectionError` if the device is unreachable.
+- File management methods operate on the `/image/` directory on the device.

geekmagicweatherclockapi-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+GeekMagicWeatherClockAPI/__init__.py,sha256=sIM2Yj7PGpD0r8SrPGvoboz_USBJww7bQB-71qM7ZBc,49
+GeekMagicWeatherClockAPI/core.py,sha256=FdqOxePm5qN2xBwQ9iEpfRBtHXj7cJ_rnUvGbmeg7i8,5269
+geekmagicweatherclockapi-0.1.0.dist-info/licenses/LICENSE,sha256=Btzdu2kIoMbdSp6OyCLupB1aRgpTCJ_szMimgEnpkkE,1056
+geekmagicweatherclockapi-0.1.0.dist-info/METADATA,sha256=ZcW-myU1Gjf9_o6svNkow4z3GInKWe-9nr_PEe_fCak,2704
+geekmagicweatherclockapi-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+geekmagicweatherclockapi-0.1.0.dist-info/top_level.txt,sha256=3viXouZ_1SkVcqd-ChcYP3Nj1AoIoa2xFxm_XfsbPGQ,25
+geekmagicweatherclockapi-0.1.0.dist-info/RECORD,,

geekmagicweatherclockapi-0.1.0.dist-info/WHEEL

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

geekmagicweatherclockapi-0.1.0.dist-info/licenses/LICENSE

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

geekmagicweatherclockapi-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+GeekMagicWeatherClockAPI