Skip to content

Commit

Permalink
Add usage example and requirements to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cjaliaga committed Jan 18, 2024
1 parent 4803491 commit 4fad5c2
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,63 @@ Aioaquarea

Asynchronous library to control Panasonic Aquarea devices

> :warning: This library is under development!
## Requirements

Requires Python >= 3.9 and uses asyncio and aiohttp.
This library requires:

- Python >= 3.9
- asyncio
- aiohttp

## Usage
The library supports the production environment of the Panasonic Aquarea Smart Cloud API and also the Demo environment. One of the main usages of this library is to integrate the Panasonic Aquarea Smart Cloud API with Home Assistant via [home-assistant-aquarea](https://github.com/cjaliaga/home-assistant-aquarea)

Here is a simple example of how to use the library via getting a device object to interact with it:

```python
from aioaquarea import (
Client,
AquareaEnvironment,
UpdateOperationMode
)

import aiohttp
import asyncio
import logging
from datetime import timedelta

async def main():
async with aiohttp.ClientSession() as session:
client = Client(
username="USERNAME",
password="PASSWORD",
session=session,
device_direct=True,
refresh_login=True,
environment=AquareaEnvironment.PRODUCTION,
)

# The library is designed to retrieve a device object and interact with it:
devices = await client.get_devices(include_long_id=True)

# Picking the first device associated with the account:
device_info = devices[0]

device = await client.get_device(
device_info=device_info, consumption_refresh_interval=timedelta(minutes=1)
)

# Or the device can also be retrieved by its long id if we know it:
device = await client.get_device(
device_id="LONG ID", consumption_refresh_interval=timedelta(minutes=1)
)

# Then we can interact with the device:
await device.set_mode(UpdateOperationMode.HEAT)

# The device can automatically refresh its data:
await device.refresh_data()
```

## Acknowledgements

Expand Down

0 comments on commit 4fad5c2

Please sign in to comment.