Skip to main content

Asynchronous Python library for Refoss smart devices

Project description

aiorefoss

Asynchronous Python library for Refoss smart devices, designed for Home Assistant integration.

Features

  • Async WebSocket connection
  • Device authentication support for new firmware (EM16P v3.1.11+)
  • Automatic auth challenge handling
  • Real-time status updates
  • Device configuration management
  • Cross-platform JSON support (orjson with stdlib fallback)

Installation

pip install aiorefoss

With faster JSON support:

pip install aiorefoss[fastjson]

Quick Start

import asyncio
from aiorefoss.rpc_device.device import RpcDevice
from aiorefoss.common import process_ip_or_options

async def main():
    options = await process_ip_or_options("192.168.1.100")
    device = await RpcDevice.create(None, options)
    await device.initialize()
    print(f"Device model: {device.model}")
    print(f"Firmware version: {device.firmware_version}")
    await device.shutdown()

asyncio.run(main())

Requirements

  • Python 3.12+
  • aiohttp
  • yarl
  • orjson (optional, for better performance)

License

MIT

Support

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiorefoss-1.0.2-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file aiorefoss-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: aiorefoss-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for aiorefoss-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 84b256d3cbfa7ff4b4cfa4a07e98d021ffb0d37ad4c4dc158d1d5bc6503f915c
MD5 0b03c84d1e74e4324e2814c3103780ad
BLAKE2b-256 ca8d7154b77df0d7197a9484a50c6ba12d06ee09a24c90865523d2a15b853fc0

See more details on using hashes here.

Supported by

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