Skip to main content

This is a Python client for the Electrolux Group API. It is a simple wrapper around the API.

Project description

Work in progress

Electrolux Group API Client

This is a Python client for the Electrolux Group API. It is a simple wrapper around the API, which allows you to interact with the API in a more Pythonic way.

Installation

Use poetry install --extras cli to install dependencies for CLI and the library itself.

Documentation

See the API Usage Guide for information on how to interact with the API, fetch appliances, and consume the Server-Sent Events (SSE) live stream.

Usage

usage: cli.py [-h] -k API_KEY -t ACCESS_TOKEN -r REFRESH_TOKEN {list,command} ...

positional arguments:
  {login,list,command}

options:
  -h, --help        show this help message and exit

Authentication

Before being able to use the CLI, you'll need to provide access token, refresh token and API key. All of these can be obtained using the developer dashboard.

To store credentials locally, use the login command:

poetry run python3 src/cli.py login -k $API_KEY -t $ACCESS_TOKEN -r $REFRESH_TOKEN

Listing devices

To list all devices, use the list command:

poetry run python3 src/cli.py list

Sending commands

Commands to be sent must be proper JSON. You can use the list command described above to find appliance IDs and commands that will be accepted by the appliance.

For example, to change the fan speed for an air purifier you can use the following commands:

poetry run python3 src/cli.py command -d $APPLIANCE_ID -c '{"Workmode": "Manual"}'
poetry run python3 src/cli.py command -d $APPLIANCE_ID -c '{"Fanspeed": 3}'

and to switch it to automatic mode you can use

poetry run python3 src/cli.py command -d $APPLIANCE_ID -c '{"Workmode": "Auto"}'

Disclaimer

This client is not officially supported by Electrolux Group. It is a community project, and it is not guaranteed to be up-to-date with the latest changes in the API.

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

pyelectroluxgroup-0.2.5.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

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

pyelectroluxgroup-0.2.5-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file pyelectroluxgroup-0.2.5.tar.gz.

File metadata

  • Download URL: pyelectroluxgroup-0.2.5.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyelectroluxgroup-0.2.5.tar.gz
Algorithm Hash digest
SHA256 a0eca9273f1f3f83d5a31a82d41394e1c26edaee7515fb0710fb6ebfa1c2da3d
MD5 ace97ce09287e24f14b1efc7d87934a0
BLAKE2b-256 eebbaccb7d90d7ac6b285b76d0dc2d32a6fc748cdda2b4b1f0ae947c947b806e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyelectroluxgroup-0.2.5.tar.gz:

Publisher: publish.yml on JohNan/pyelectroluxgroup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyelectroluxgroup-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for pyelectroluxgroup-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 df8486c9ae235f46e36a3d4e5e1e77a3a624941b787729abd0da34f35f41665b
MD5 7440d5db4a34618ce9c3da5e451c92d9
BLAKE2b-256 cccc2860fa86be274ef995d1bf8cbc505de3658252d29bb5398a9674dc85d24c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyelectroluxgroup-0.2.5-py3-none-any.whl:

Publisher: publish.yml on JohNan/pyelectroluxgroup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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