Metadata-Version: 2.3
Name: pyanova-nano
Version: 0.2.2
Summary: Python API to interact with the Anova Nano.
Project-URL: Homepage, https://github.com/filmkorn/pyanova-nano
Project-URL: Issues, https://github.com/filmkorn/pyanova-nano/issues
Author-email: Mitja Muller-Jend <mitja.muller-jend+github@gmail.com>
License-File: LICENSE
Keywords: anova,ble,bluetooth,nano,pyanova,sous-vide
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: bleak-retry-connector<4,>=3.5
Requires-Dist: bleak<1,>=0.19
Requires-Dist: protobuf<5,>=4
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Provides-Extra: release
Requires-Dist: hatch; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Description-Content-Type: text/markdown

# PyAnova-Nano

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)


Control the Anova Nano via BLE.

This is a rough translation of [dengelke/node-sous-vide](https://github.com/dengelke/node-sous-vide/).

### Notes:
- The code should be considered experimental at this point.
- Presumably this library is not compatible with any other Anova model!
- The PyAnova class is not compatible with [c3V6a2Vy/pyanova](https://github.com/c3V6a2Vy/pyanova).

# Installation

```shell
pip install pyanova-nano
```

# Examples

### Automatic discovery

The device should be found automatically based on the service uuid it provides.

#### Context manager: auto connect and disconnect

```python
import asyncio
from pyanova_nano import PyAnova

async def print_device_sensors():
    async with PyAnova() as client:
        print(await client.get_sensor_values())

asyncio.run(print_device_sensors())
```

#### No context manager

```python
import asyncio

from pyanova_nano import PyAnova


async def get_timer():
    client = PyAnova()
    await client.connect()

    print(await client.get_timer())

    await client.disconnect()


asyncio.run(get_timer())
```

### Manual connection

To use a custom address, first discover all relevant devices, then use `PyAnova.connect(device=my_anova)` with 
`my_anova` being the `bleak.BLEDevice` you want to connect to.

```python
import asyncio

from bleak import BLEDevice

from pyanova_nano import PyAnova


async def print_target_temp():
    client = PyAnova()
    devices: list[BLEDevice] = await client.discover(connect=False, list_all=True)
    # Select the device to use.
    my_anova = next(iter(devices))

    print(f"Found: {my_anova.address}")

    await client.connect(device=my_anova)

    temperature = await client.get_target_temperature()
    print(temperature)
    
    await client.disconnect()


asyncio.run(print_target_temp())
```

# Subscription to status updates

The Anova Nano deos not update the client on it's own. We have to ask it for updates.
This library allows you to poll the device for updates and subscribe to be notified.

```python
import asyncio

from pyanova_nano import PyAnova


async def main():
    async with PyAnova() as client:

        def handle_update():
            print(client.last_status)

        client.set_poll_interval(4)
        client.subscribe(handle_update)
        client.start_poll()

        # We should get 3 updates in 10 seconds before stopping the polling.
        await asyncio.sleep(10)
        await client.stop_poll()


asyncio.run(main())
```

# Troubleshooting

## Cannot connect to your Anova Nano.

1. The Anova Nano can only maintain a connection to a single client. Ensure that nothing else is connected to your Anova
Nano.
2. Try turning the device off and on by holding the start/stop button.

# Disclaimer

This software may harm your device. Use it at your own risk.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
