Metadata-Version: 2.4
Name: afsapi
Version: 1.0.1
Summary: Asynchronous implementation of the Frontier Silicon API
Project-URL: Homepage, https://github.com/wlcrs/python-afsapi
Project-URL: Repository, https://github.com/wlcrs/python-afsapi
Project-URL: Issues, https://github.com/wlcrs/python-afsapi/issues
Project-URL: Changelog, https://github.com/wlcrs/python-afsapi/releases
Author-email: wlcrs <wlcrs@users.noreply.github.com>, Krasimir Zhelev <krasimir.zhelev@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Intended Audience :: Developers
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Requires-Dist: aiohttp<4,>=3.9
Requires-Dist: defusedxml>=0.7.1
Description-Content-Type: text/markdown

# python-afsapi

Asynchronous Python implementation of the Frontier Silicon API
- This project was started in order to embed Frontier Silicon devices in Home Assistant (https://home-assistant.io/)
- Inspired by:
 - https://github.com/flammy/fsapi/
 - https://github.com/tiwilliam/fsapi
 - https://github.com/p2baron/fsapi

Runtime dependency:

- aiohttp
- defusedxml

Development workflow (uv + ruff):

```bash
uv sync --group dev
uv run ruff check .
uv run pytest -q
```

Device recording tests (pytest-recording)
=========================================

The repository includes integration tests that can record and replay real
responses from the development radio.

- Tests are in `tests/test_device_recordings.py` (read calls) and
    `tests/test_device_recordings_write.py` (write calls with state restore).
- Cassettes are stored under `tests/cassettes/`.
- Device tests replay cassettes by default (`pytest` runs them with no live device access).
- Live/recording runs require both `AFSAPI_DEVICE_IP` and `AFSAPI_DEVICE_PIN`.

Set device IP + PIN and record fresh cassettes:

```bash
AFSAPI_DEVICE_IP="192.168.1.183" AFSAPI_DEVICE_PIN="1234" uv run pytest tests/test_device_recordings.py tests/test_device_recordings_write.py --run-device-tests --record-mode=once -q
```

Re-record all cassettes:

```bash
AFSAPI_DEVICE_IP="192.168.1.183" AFSAPI_DEVICE_PIN="1234" uv run pytest tests/test_device_recordings.py tests/test_device_recordings_write.py --run-device-tests --record-mode=all -q
```

Run default tests without touching the device:

```bash
uv run pytest -q
```

Usage
=====

```python
import asyncio
from afsapi import AFSAPI

URL = 'http://192.168.1.XYZ:80/device'
PIN = 1234
TIMEOUT = 1 # in seconds

async def test():
    afsapi = await AFSAPI.create(URL, PIN, TIMEOUT)

    print(f'Set power succeeded? - {await afsapi.set_power(True)}' )
    print(f'Power on: {await afsapi.get_power()}')
    print(f'Friendly name: {await afsapi.get_friendly_name()}')

    for mode in await afsapi.get_modes():
        print(f'Available Mode: {mode}')
    print(f'Current Mode: {await afsapi.get_mode()}')

    for equaliser in await afsapi.get_equalisers():
        print(f'Equaliser: {equaliser}')

    print(f'EQ Preset: {await afsapi.get_eq_preset()}' )

    for preset in await afsapi.get_presets():
        print(f"Preset: {preset}")

    print(f'Set power succeeded? - {await afsapi.set_power(False)}')
    print(f'Set sleep succeeded? - {await afsapi.set_sleep(10)}')
    print(f'Sleep: {await afsapi.get_sleep()}')
    print(f'Get power {await afsapi.get_power()}' )


loop = asyncio.new_event_loop()
loop.run_until_complete(test())

```