libnubiacare-py 0.1.0__tar.gz

libnubiacare_py-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

libnubiacare_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michał Żarłok
+
+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.

libnubiacare_py-0.1.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.5
+Name: libnubiacare-py
+Version: 0.1.0
+Summary: Async client library for the Nubia Care API
+Project-URL: Homepage, https://github.com/mishaaq/libnubiacare-py
+Project-URL: Repository, https://github.com/mishaaq/libnubiacare-py
+Project-URL: Issues, https://github.com/mishaaq/libnubiacare-py/issues
+Author: Michał Żarłok
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.10
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=42
+Description-Content-Type: text/markdown
+
+# libnubiacare-py
+
+An asynchronous Python client for the Nubia Care API used by ZTE Kids watches.
+The library handles request signing, password encryption, and the API's JSON
+responses. It leaves the `aiohttp.ClientSession` and authenticated session data
+under the caller's control, which makes it suitable for Home Assistant
+integrations.
+
+## Installation
+
+```console
+python -m pip install libnubiacare-py
+```
+
+## Usage
+
+```python
+import asyncio
+
+import aiohttp
+
+from nubia_care import NubiaAPI, NubiaAuth
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as http_session:
+        auth = NubiaAuth(http_session)
+        credentials = await auth.async_login("account@example.com", "password")
+
+        api = NubiaAPI(auth)
+        devices = await api.async_get_devices(credentials)
+        for device in devices:
+            details = await api.async_get_device(credentials, device.id)
+            print(details.id, details.name)
+            if details.location is not None:
+                print(details.location.latitude, details.location.longitude)
+
+            firmware = await api.async_get_device_firmware(credentials, device.id)
+            print(firmware.device_firmware, firmware.firmware)
+
+        # Store credentials.to_dict() in the application's own config entry
+        # or credential store. The library does not retain login credentials.
+
+
+asyncio.run(main())
+```
+
+`NubiaAuth` owns the built-in request signing and HTTP handling, while the
+caller provides the shared `aiohttp.ClientSession` and keeps the returned
+`NubiaSession` in their persistence layer. The API provides typed device and
+location views while retaining each response in `raw_data`. Use
+`NubiaDevice.id` as the identifier for device-details and firmware requests.
+JSON decimal numbers are decoded as `Decimal`, so numeric latitude and
+longitude values retain their reported precision; coordinate values returned
+as strings remain strings.
+
+The API host, mobile client description, and protocol keys can be supplied to
+`NubiaAuth` for compatible service variants. See the class documentation and
+type signatures for the supported options.
+
+`NubiaDevice` exposes device capabilities through `device.features.supports()`
+and `device.features.available_features()`. It also exposes parsed
+`battery_level`, `device_type`, `permissions`, `model`, and `model_name`
+properties; `battery_level` reads the `percent` value from the API's nested
+`battery` object and is `None` when that value is unavailable. The original API
+response remains available as `device.raw_data`.
+
+## CLI
+
+The repository includes a simple verification script for checking access to the
+Nubia Care API from a source checkout:
+
+```console
+PYTHONPATH=src .venv/bin/python scripts/nubia_care_cli.py
+```
+
+The script prompts for a Nubia Care login and password, then prints a JSON
+summary for each related device, including the latest device metadata and
+location information. It is intended for local validation and troubleshooting,
+and it is not part of the installed library API.
+
+## Development
+
+Run the test suite with:
+
+```console
+PYTHONPATH=src .venv/bin/python -m unittest discover -s tests
+```
+
+Releases are published to PyPI from GitHub Releases.

libnubiacare_py-0.1.0/README.md

@@ -0,0 +1,90 @@
+# libnubiacare-py
+
+An asynchronous Python client for the Nubia Care API used by ZTE Kids watches.
+The library handles request signing, password encryption, and the API's JSON
+responses. It leaves the `aiohttp.ClientSession` and authenticated session data
+under the caller's control, which makes it suitable for Home Assistant
+integrations.
+
+## Installation
+
+```console
+python -m pip install libnubiacare-py
+```
+
+## Usage
+
+```python
+import asyncio
+
+import aiohttp
+
+from nubia_care import NubiaAPI, NubiaAuth
+
+
+async def main() -> None:
+    async with aiohttp.ClientSession() as http_session:
+        auth = NubiaAuth(http_session)
+        credentials = await auth.async_login("account@example.com", "password")
+
+        api = NubiaAPI(auth)
+        devices = await api.async_get_devices(credentials)
+        for device in devices:
+            details = await api.async_get_device(credentials, device.id)
+            print(details.id, details.name)
+            if details.location is not None:
+                print(details.location.latitude, details.location.longitude)
+
+            firmware = await api.async_get_device_firmware(credentials, device.id)
+            print(firmware.device_firmware, firmware.firmware)
+
+        # Store credentials.to_dict() in the application's own config entry
+        # or credential store. The library does not retain login credentials.
+
+
+asyncio.run(main())
+```
+
+`NubiaAuth` owns the built-in request signing and HTTP handling, while the
+caller provides the shared `aiohttp.ClientSession` and keeps the returned
+`NubiaSession` in their persistence layer. The API provides typed device and
+location views while retaining each response in `raw_data`. Use
+`NubiaDevice.id` as the identifier for device-details and firmware requests.
+JSON decimal numbers are decoded as `Decimal`, so numeric latitude and
+longitude values retain their reported precision; coordinate values returned
+as strings remain strings.
+
+The API host, mobile client description, and protocol keys can be supplied to
+`NubiaAuth` for compatible service variants. See the class documentation and
+type signatures for the supported options.
+
+`NubiaDevice` exposes device capabilities through `device.features.supports()`
+and `device.features.available_features()`. It also exposes parsed
+`battery_level`, `device_type`, `permissions`, `model`, and `model_name`
+properties; `battery_level` reads the `percent` value from the API's nested
+`battery` object and is `None` when that value is unavailable. The original API
+response remains available as `device.raw_data`.
+
+## CLI
+
+The repository includes a simple verification script for checking access to the
+Nubia Care API from a source checkout:
+
+```console
+PYTHONPATH=src .venv/bin/python scripts/nubia_care_cli.py
+```
+
+The script prompts for a Nubia Care login and password, then prints a JSON
+summary for each related device, including the latest device metadata and
+location information. It is intended for local validation and troubleshooting,
+and it is not part of the installed library API.
+
+## Development
+
+Run the test suite with:
+
+```console
+PYTHONPATH=src .venv/bin/python -m unittest discover -s tests
+```
+
+Releases are published to PyPI from GitHub Releases.

libnubiacare_py-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "libnubiacare-py"
+version = "0.1.0"
+description = "Async client library for the Nubia Care API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Michał Żarłok" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+]
+dependencies = [
+    "aiohttp>=3.9",
+    "cryptography>=42",
+]
+
+[project.urls]
+Homepage = "https://github.com/mishaaq/libnubiacare-py"
+Repository = "https://github.com/mishaaq/libnubiacare-py"
+Issues = "https://github.com/mishaaq/libnubiacare-py/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nubia_care"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/pyproject.toml",
+]

libnubiacare_py-0.1.0/src/nubia_care/__init__.py

@@ -0,0 +1,35 @@
+"""Async client library for the Nubia Care API."""
+
+from .api import NubiaAPI
+from .auth import NubiaAuth
+from .exceptions import (
+    NubiaApiError,
+    NubiaAuthenticationError,
+    NubiaConnectionError,
+    NubiaDeviceNotFoundError,
+    NubiaError,
+    NubiaProtocolError,
+)
+from .models import (
+    DeviceFeatures,
+    NubiaDevice,
+    NubiaFirmware,
+    NubiaLocation,
+    NubiaSession,
+)
+
+__all__ = [
+    "NubiaAPI",
+    "NubiaApiError",
+    "NubiaAuthenticationError",
+    "NubiaAuth",
+    "NubiaConnectionError",
+    "NubiaDevice",
+    "NubiaDeviceNotFoundError",
+    "NubiaError",
+    "NubiaFirmware",
+    "NubiaLocation",
+    "NubiaProtocolError",
+    "NubiaSession",
+    "DeviceFeatures",
+]

libnubiacare_py-0.1.0/src/nubia_care/api.py

@@ -0,0 +1,89 @@
+"""Nubia Care API resources and endpoint methods."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+
+from .auth import NubiaAuth
+from .exceptions import NubiaApiError, NubiaDeviceNotFoundError, NubiaProtocolError
+from .models import NubiaDevice, NubiaFirmware, NubiaSession
+
+
+class NubiaAPI:
+    """Access Nubia Care resources using the authenticated request layer."""
+
+    def __init__(self, auth: NubiaAuth) -> None:
+        """Initialize the API resource facade with a NubiaAuth instance."""
+        self._auth = auth
+
+    async def async_get_devices(
+        self, session: NubiaSession
+    ) -> list[NubiaDevice]:
+        """Return the account's related devices."""
+        payload = await self._auth.async_request(
+            "GET",
+            f"getway/accounts/{session.openid}/related-device",
+            session=session,
+        )
+        data = payload.get("data", payload)
+        if not isinstance(data, Mapping):
+            raise NubiaProtocolError("related-device response is not an object")
+        devices: list[NubiaDevice] = []
+        entries = data.get("chatGroupDevices") or []
+        if not isinstance(entries, list):
+            raise NubiaProtocolError(
+                "related-device field chatGroupDevices is not a list"
+            )
+        for entry in entries:
+            if not isinstance(entry, Mapping):
+                raise NubiaProtocolError(
+                    "related-device field chatGroupDevices contains invalid data"
+                )
+            if not isinstance(entry.get("imei"), str):
+                raise NubiaProtocolError(
+                    "related-device entry in chatGroupDevices is missing imei"
+                )
+            devices.append(NubiaDevice(entry))
+        return devices
+
+    async def async_get_device(
+        self, session: NubiaSession, device_id: str
+    ) -> NubiaDevice:
+        """Return current details for one device by its API device ID."""
+        try:
+            payload = await self._auth.async_request(
+                "GET",
+                f"getway/devices/{device_id}",
+                session=session,
+            )
+        except NubiaApiError as err:
+            if err.status != 404:
+                raise
+            raise NubiaDeviceNotFoundError(
+                f"Nubia Care account has no device with ID {device_id!r}",
+                status=err.status,
+            ) from err
+        data = payload.get("data", payload)
+        if not isinstance(data, Mapping):
+            raise NubiaProtocolError("device detail response is not an object")
+        if not isinstance(data.get("imei"), str):
+            raise NubiaProtocolError("device detail response is missing imei")
+        return NubiaDevice(data)
+
+    async def async_get_device_firmware(
+        self, session: NubiaSession, device_id: str
+    ) -> NubiaFirmware:
+        """Return available and installed firmware versions for a device."""
+        payload = await self._auth.async_request(
+            "POST",
+            "api/device/upgrade",
+            auth_token=session.accesstoken,
+            json_body={
+                "deviceId": device_id,
+                "token": session.accesstoken,
+            },
+        )
+        data = payload.get("data")
+        if not isinstance(data, Mapping):
+            raise NubiaProtocolError("firmware response is missing its data object")
+        return NubiaFirmware(data)