Skip to main content

Control Tasmota devices via their web api

Project description

Tasmota Device Controller

This packag provides async wrappers for Tasmota's web request API.

Only very few requests are implemented so far! If you need other requests, please have a look at the section Contributing, or create an issue.

get methods return the value of the fetched item, set methods return the new set value (so what the get method would return after the set). However there are some exceptions like BLINK for setPower() which always returns True, but that should be mentioned in the methods description.

Since this package was created for a Home Assistant integration, you can check out that integration for other sample usage.

Example usage:

import asyncio
from tasmotadevicecontroller import TasmotaDevice
from tasmotadevicecontroller import tasmota_types as t

async def main():
    device = await TasmotaDevice.connect('192.168.10.21')

    # Get friendly name (of first output, which is the default output)
    nameResult = await device.getFriendlyName()
    print(nameResult)  # Returns 'My Tasmota Plug'

    # Get power of first output
    getResult = await device.getPower()
    print(getResult)  # Returns True (on)

    # Set power of first output to on
    setResult = await device.setPower(t.PowerType.TOGGLE)
    print(setResult)  # Returns True or False (depending if the device was switched on or off)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Contributing

If you want to add new requests, can implement these commands and create a merge request on GitHub.

Almost every command is implemented as one getter method and one setter method. Add your command if possible in the same way inside the TasmotaDevice class. Remember to add descriptions to each method. This description can usually be taken from the Tasmota wiki.
Also, remember to always use async await!

If the command takes values from a specific set of values, create an Enum inside tasmota_types.py for it.

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

tasmotadevicecontroller-0.0.8.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

tasmotadevicecontroller-0.0.8-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file tasmotadevicecontroller-0.0.8.tar.gz.

File metadata

  • Download URL: tasmotadevicecontroller-0.0.8.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for tasmotadevicecontroller-0.0.8.tar.gz
Algorithm Hash digest
SHA256 798758e148adb673f629f52578a6195ebde4b3aa8957f6697658cf794bfd80d6
MD5 7b167b30351fe19122deed8a0b3ff63e
BLAKE2b-256 decd277e5d6eae4d09175a189990f59cc3d36eb2a7a63abc2c4359bffc917b9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tasmotadevicecontroller-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for tasmotadevicecontroller-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0df2b71529e368032431310aa913b01a148bf20750c2124ec498c6498b7e0dcc
MD5 34d6550fdaa4c5498382407941e296d1
BLAKE2b-256 fcf0120f5eb897f34800e1a70146bd32a54933445a866b423e822fa654f39662

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