lghorizon 0.9.0__py3-none-any.whl → 0.9.0b0__py3-none-any.whl

lghorizon-0.9.0.dist-info/METADATA

@@ -1,191 +0,0 @@
-Metadata-Version: 2.4
-Name: lghorizon
-Version: 0.9.0
-Summary: Python client for Liberty Global Horizon settop boxes
-Home-page: https://github.com/sholofly/LGHorizon-python
-Author: Rudolf Offereins
-Author-email: r.offereins@gmail.com
-License: MIT license
-Keywords: LG,Horizon,API,Settop box
-Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Natural Language :: English
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: paho-mqtt
-Requires-Dist: requests>=2.22.0
-Requires-Dist: backoff>=1.9.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# LG Horizon Api
-
-# LG Horizon API Python Library
-
-A Python library to interact with and control LG Horizon set-top boxes. This library provides functionalities for authentication, real-time device status monitoring via MQTT, and various control commands for your Horizon devices.
-
-## Features
-
-- **Authentication**: Supports authentication using username/password or a refresh token. The library automatically handles access token refreshing.
-- **Device Management**: Discover and manage multiple LG Horizon set-top boxes associated with your account.
-- **Real-time Status**: Monitor device status (online/running/standby) and current playback information (channel, show, VOD, recording, app) through MQTT.
-- **Channel Information**: Retrieve a list of available channels and profile-specific favorite channels.
-- **Recording Management**:
-  - Get a list of all recordings.
-  - Retrieve recordings for specific shows.
-  - Check recording quota and usage.
-- **Device Control**: Send various commands to your set-top box:
-  - Power on/off.
-  - Play, pause, stop, rewind, fast forward.
-  - Change channels (up/down, direct channel selection).
-  - Record current program.
-  - Set player position for VOD/recordings.
-  - Display custom messages on the TV screen.
-  - Send emulated remote control key presses.
-- **Robustness**: Includes automatic MQTT reconnection with exponential backoff and token refresh logic to maintain a stable connection.
-
-## Installation
-
-```bash
-pip install lghorizon-python # (Replace with actual package name if different)
-```
-
-## Usage
-
-Here's a basic example of how to use the library to connect to your LG Horizon devices and monitor their state:
-
-First, create a `secrets.json` file in the root of your project with your LG Horizon credentials:
-
-```json
-{
-  "username": "your_username",
-  "password": "your_password",
-  "country": "nl" // e.g., "nl" for Netherlands, "be" for Belgium
-}
-```
-
-Then, you can use the library as follows:
-
-```python
-import asyncio
-import json
-import logging
-import aiohttp
-
-from lghorizon.lghorizon_api import LGHorizonApi
-from lghorizon.lghorizon_models import LGHorizonAuth
-
-_LOGGER = logging.getLogger(__name__)
-
-async def main():
-    logging.basicConfig(level=logging.INFO) # Set to DEBUG for more verbose output
-
-    with open("secrets.json", encoding="utf-8") as f:
-        secrets = json.load(f)
-        username = secrets.get("username")
-        password = secrets.get("password")
-        country = secrets.get("country", "nl")
-
-    async with aiohttp.ClientSession() as session:
-        auth = LGHorizonAuth(session, country, username=username, password=password)
-        api = LGHorizonApi(auth)
-
-        async def device_state_changed_callback(device_id: str):
-            device = devices[device_id]
-            _LOGGER.info(
-                f"Device {device.device_friendly_name} ({device.device_id}) state changed:\n"
-                f"  State: {device.device_state.state.value}\n"
-                f"  UI State: {device.device_state.ui_state_type.value}\n"
-                f"  Source Type: {device.device_state.source_type.value}\n"
-                f"  Channel: {device.device_state.channel_name or 'N/A'} ({device.device_state.channel_id or 'N/A'})\n"
-                f"  Show: {device.device_state.show_title or 'N/A'}\n"
-                f"  Episode: {device.device_state.episode_title or 'N/A'}\n"
-                f"  Position: {device.device_state.position or 'N/A'} / {device.device_state.duration or 'N/A'}\n"
-            )
-
-        try:
-            _LOGGER.info("Initializing LG Horizon API...")
-            await api.initialize()
-            devices = await api.get_devices()
-
-            for device in devices.values():
-                _LOGGER.info(f"Registering callback for device: {device.device_friendly_name}")
-                await device.set_callback(device_state_changed_callback)
-
-            _LOGGER.info("API initialized. Monitoring device states. Press Ctrl+C to exit.")
-            # Keep the script running to receive MQTT updates
-            while True:
-                await asyncio.sleep(3600) # Sleep for a long time, MQTT callbacks will still fire
-
-        except Exception as e:
-            _LOGGER.error(f"An error occurred: {e}", exc_info=True)
-        finally:
-            _LOGGER.info("Disconnecting from LG Horizon API.")
-            await api.disconnect()
-            _LOGGER.info("Disconnected.")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-## Authentication
-
-The `LGHorizonAuth` class handles authentication. You can initialize it with a username and password, or directly with a refresh token if you have one. The library automatically refreshes access tokens as needed.
-
-```python
-# Using username and password
-auth = LGHorizonAuth(session, "nl", username="your_username", password="your_password")
-
-# Using a refresh token (e.g., if you've saved it from a previous session)
-# auth = LGHorizonAuth(session, "nl", refresh_token="your_refresh_token")
-```
-
-You can also set a callback to receive the updated refresh token when it's refreshed, allowing you to persist it for future sessions:
-
-```python
-def token_updated_callback(new_refresh_token: str):
-    print(f"New refresh token received: {new_refresh_token}")
-    # Here you would typically save this new_refresh_token
-    # to your secrets.json or other persistent storage.
-
-# After initializing LGHorizonApi:
-# api.set_token_refresh_callback(token_updated_callback)
-```
-
-## Error Handling
-
-The library defines custom exceptions for common error scenarios:
-
-- `LGHorizonApiError`: Base exception for all API-related errors.
-- `LGHorizonApiConnectionError`: Raised for network or connection issues.
-- `LGHorizonApiUnauthorizedError`: Raised when authentication fails (e.g., invalid credentials).
-- `LGHorizonApiLockedError`: A specific type of `LGHorizonApiUnauthorizedError` indicating a locked account.
-
-These exceptions allow for more granular error handling in your application.
-
-## Development
-
-To run the example script (`main.py`) from the repository:
-
-1.  Clone this repository.
-2.  Install dependencies: `pip install -r requirements.txt` (ensure `requirements.txt` is up-to-date).
-3.  Create a `secrets.json` file as described in the Usage section.
-4.  Run `python main.py`.

lghorizon-0.9.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-lghorizon/__init__.py,sha256=y44i_P6jsl3VV0R4UYIymXpRXIJVYPwb97uQK9pEfYA,1852
-lghorizon/const.py,sha256=HINlbyevEN9ZRnfIBbSGNc6i9J8WkIgpqkLZrwyqpGQ,5307
-lghorizon/exceptions.py,sha256=4cnnPRuKBtqXiTlOZK4xmP1WADikk5NvCsy293mijT8,500
-lghorizon/helpers.py,sha256=SGlEN6V0kh2vqw1qCKmM1KhfeO-UvPyyQmnThgFLFhs,272
-lghorizon/lghorizon_api.py,sha256=_yP7X3LIei3OPc_byPPZg22QrPkDQdRyMoR6GLg3c3M,12881
-lghorizon/lghorizon_device.py,sha256=HfpbOnmiN44Y0ObSj-lCP8vYQ85WBYU8rbBaqvDzri8,14767
-lghorizon/lghorizon_device_state_processor.py,sha256=LW_Gavhg7bSSeZJiprAi1YJqOcUhZcB-2GdHn9hMj-o,15380
-lghorizon/lghorizon_message_factory.py,sha256=BkJrVgcTsidcugrM9Pt5brvdw5_WI4PRAHvWQyHurz8,1435
-lghorizon/lghorizon_models.py,sha256=-xhTIz1UC5efR5HJtXf2a59EspDbZKGp967flYvhryM,46435
-lghorizon/lghorizon_mqtt_client.py,sha256=6BsZkRo3PBf62F2530_FdQ4OMr9w1jiewcv19Y8MWWo,12764
-lghorizon/lghorizon_recording_factory.py,sha256=JaFjmXWChp1jdFzkioe9K-MqzVU0AsOgdKGjm2Seyq0,2318
-lghorizon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lghorizon-0.9.0.dist-info/licenses/LICENSE,sha256=6Dh2tur1gMX3r3rITjVwUONBEJxyyPZDY8p6DZXtimE,1059
-lghorizon-0.9.0.dist-info/METADATA,sha256=HJvdaN47p25UvHdotYhrI5BIPUeTmqJbFqfad7rJRwY,7471
-lghorizon-0.9.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-lghorizon-0.9.0.dist-info/top_level.txt,sha256=usii76_AxGfPI6gjrrh-NyZxcQQuF1B8_Q9kd7sID8Q,10
-lghorizon-0.9.0.dist-info/RECORD,,