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.

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.3.tar.gz (8.7 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.3-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyelectroluxgroup-0.2.3.tar.gz
Algorithm Hash digest
SHA256 827de0b81ec3fb5cecc04aa963970acc83050b1e7d85f5c3bc353b2a2b86b80a
MD5 cae0778d46bc6a14811bdf1141533d6a
BLAKE2b-256 12970d7dc5b11618f53210044371980c3a5ff848f50df077c59a7fe1a6412cd7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyelectroluxgroup-0.2.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pyelectroluxgroup-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a5c1e2a862657842e5ff571aa2f74b42093c798ca836a91863867d035b1d6f6b
MD5 a53019e18a8be213725b845a0075221f
BLAKE2b-256 f3a9786e3b30cc361777e99d5556ee9163ae4af22d3e8f65d0824f06a133cb3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyelectroluxgroup-0.2.3-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