Skip to main content

Python library for local control of Rabbit Air air purifiers

Project description

Rabbit Air Python library

This library can be used to control Rabbit Air air purifiers over a local network.

Usage

#! /usr/bin/env python3

import asyncio

from rabbitair import Mode, Speed, UdpClient


async def main():
    with UdpClient("ip", "token") as client:

        # Getting the current state of the air purifier

        state = await client.get_state()
        print(state)

        # Controlling the air purifier

        print("Power Off")
        await client.set_state(power=False)

        await asyncio.sleep(3)

        print("Power On")
        await client.set_state(power=True)

        await asyncio.sleep(3)

        print("Set Speed to High")
        await client.set_state(speed=Speed.High)

        await asyncio.sleep(3)

        print("Set Mode to Auto")
        await client.set_state(mode=Mode.Auto)


asyncio.run(main())

Retrieving the Access Token

To establish a connection, you need to know the address and access token of the device.

  1. Open the Rabbit Air mobile app. You will see a list of devices connected to your account.
  2. Tap the list item and the device control page will open.
  3. On the device page tap the Edit button. You will see a page with the device location and name settings.
  4. On this page, quickly tap on "Serial Number" several times until you see two more lines that were previously hidden. The first is the device ID, and the second is the access token.

Note that the device ID is used as an mDNS name of the device. So you can specify it as the host value by adding the suffix ".local" at the end.

For example, you got:

Screenshot: Access token on the "Edit device" screen

Then you can use abcdef1234_123456789012345678.local as the host and 0123456789ABCDEF0123456789ABCDEF as the token.

In some cases the access token may not be available right away, then you will see a "Tap for setup user key" message instead. To generate the access token, tap on this message and follow the instructions. If the app says "your device is not supported", it probably means that you are trying to connect to a first-generation MinusA2 model (an older hardware revision). It is not yet supported.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-rabbitair-0.0.8.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

python_rabbitair-0.0.8-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file python-rabbitair-0.0.8.tar.gz.

File metadata

  • Download URL: python-rabbitair-0.0.8.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for python-rabbitair-0.0.8.tar.gz
Algorithm Hash digest
SHA256 d5cab3a4cc26396fff831f036ab296e45377766da833e6e07902a7a711f7c6e7
MD5 5462e036028e29f3ea62ce9320ac4287
BLAKE2b-256 dde7cd2a8015258e86ec7295ce790b17fb8a042670a29db76865a920c8b5b609

See more details on using hashes here.

File details

Details for the file python_rabbitair-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: python_rabbitair-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for python_rabbitair-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ed56d4ca5df93103f3703d2a3cadec007a6ff389ba06be2ce5cd2cc474363f1f
MD5 3f77a1d7372a8f3711d639e56cceedca
BLAKE2b-256 53bcd882e078eb344f52cfab216905f26b78dee789bd7f4f12ebedd2d6bd0a93

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page