aioairctrl

https://pypi.org/project/aioairctrl/
Admin
Python library and CLI for controlling Philips air purifiers over the local network using the...
Tokens:1,928
Snippets:31
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install aioairctrl

Source: https://pypi.org/project/aioairctrl

Install the library using pip. Ensure you have Python 3.12 or newer.

```bash
pip install aioairctrl
```

--------------------------------

### Python API Usage Example

Source: https://pypi.org/project/aioairctrl

Example of using the aioairctrl Python API to connect, read status, observe updates, and send commands. Ensure the purifier's IP address is correct.

```python
import asyncio
from aioairctrl import CoAPClient

async def main():
    client = await CoAPClient.create(host="192.168.1.100")
    try:
        # Read status once
        status, max_age = await client.get_status()
        print(status)

        # Stream live updates
        async for status in client.observe_status():
            print(status)
            break  # stop after first update

        # Send a command
        await client.set_control_value("pwr", True)

        # Send multiple values at once
        await client.set_control_values({"om": 2, "rhset": 50})
    finally:
        await client.shutdown()

asyncio.run(main())
```

--------------------------------

### Set Multiple Values (CLI)

Source: https://pypi.org/project/aioairctrl

Set multiple control values simultaneously. This example sets power to true and odor level to 2. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set -I pwr=true om=2
```

--------------------------------

### Get Current Device Status (CLI)

Source: https://pypi.org/project/aioairctrl

Retrieve the current status of the air purifier from the command line. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 status
```

--------------------------------

### Get Current Device Status in JSON (CLI)

Source: https://pypi.org/project/aioairctrl

Retrieve the current status of the air purifier in JSON format from the command line. This is useful for machine-readable output.

```bash
aioairctrl -H 192.168.1.100 status --json
```

--------------------------------

### Watch for Live Updates (CLI)

Source: https://pypi.org/project/aioairctrl

Continuously monitor and display status updates from the air purifier as they occur. Press Ctrl+C to stop.

```bash
aioairctrl -H 192.168.1.100 status-observe
```

--------------------------------

### Watch for Live Updates in JSON (CLI)

Source: https://pypi.org/project/aioairctrl

Continuously monitor and display status updates from the air purifier in JSON format as they occur. Press Ctrl+C to stop.

```bash
aioairctrl -H 192.168.1.100 status-observe --json
```

--------------------------------

### Set Power State (CLI)

Source: https://pypi.org/project/aioairctrl

Control the power state of the air purifier. 'true' turns it on, 'false' turns it off. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set pwr=true
```

```bash
aioairctrl -H 192.168.1.100 set pwr=false
```

--------------------------------

### Turn on the air purifier

Source: https://pypi.org/project/aioairctrl/0.3.1

Turn on the air purifier by setting the 'pwr' value to true. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set pwr=true
```

--------------------------------

### Enable Debug Output (CLI)

Source: https://pypi.org/project/aioairctrl

Enable debug output to see raw CoAP traffic for any command. Add '-D' or '--debug' flag. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 --debug status
```

--------------------------------

### Set Mode (CLI)

Source: https://pypi.org/project/aioairctrl

Set the operating mode of the air purifier. Use 'AG' for auto-grand mode. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set mode=AG
```

--------------------------------

### Set Integer Value (CLI)

Source: https://pypi.org/project/aioairctrl

Set an integer value for a control parameter, such as the odor level ('om'). Use the '-I' or '--int' flag. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set -I om=2
```

--------------------------------

### Turn off the air purifier

Source: https://pypi.org/project/aioairctrl/0.3.1

Turn off the air purifier by setting the 'pwr' value to false. Replace '192.168.1.100' with your purifier's IP address.

```bash
aioairctrl -H 192.168.1.100 set pwr=false
```
Tokens:
Raw