Skip to main content

Asynchronous Python client for TSmart.

Project description

Python: TSmart

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage Code Smells

Asynchronous Python client for TSmart.

About

This package allows you to fetch data from your TSmart Immersion Heater.

Installation

pip install aiotsmart

Usage

from aiotsmart.tsmart import TSmartClient, TSmartDiscovery, Mode

# Discovery
discovery = TSmartDiscovery()
devices = await discovery.discover()
print(devices)

# Configuration
client = TSmartClient(YOUR_IP)
configuration = await client.configuration_read()
print(configuration)

# Status
client = TSmartClient(YOUR_IP)
status = await client.control_read()
print(status)

# Set
client = TSmartClient(YOUR_IP)
await client.control_write(power=True, mode=Mode.MANUAL, setpoint=30)

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the UV package manager. UV is a fast Python package manager that replaces pip, pip-tools, and virtualenv. It also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • UV

To install all packages, including all development requirements:

uv sync --all-extras

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

uv run pre-commit run --all-files

To run just the Python tests:

uv run pytest

Authors & contributors

The content is by Andrew Jackson.

For a full list of all authors and contributors, check the contributor's page.

Disclaimer

This library is in no way approved, endorsed or supported by Tesla UK Ltd.

Acknowledgements

This library builds upon the great work by Paul Warren MIT License
Copyright (c) 2023 Paul Warren

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

License

MIT License

Copyright (c) 2025 Andrew Jackson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

aiotsmart-1.1.1.tar.gz (162.7 kB view details)

Uploaded Source

Built Distribution

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

aiotsmart-1.1.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file aiotsmart-1.1.1.tar.gz.

File metadata

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

File hashes

Hashes for aiotsmart-1.1.1.tar.gz
Algorithm Hash digest
SHA256 8a7a35c6be9c16f8928fd829817bb9c754b4fa716ee5e1b1fb932f426d64b43f
MD5 6c3e4e91f9d85f7255bc666da994e395
BLAKE2b-256 0e1f613ee76e0f97dd40283a33e4e96113995e77e63a1a46bea13ad271870462

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiotsmart-1.1.1.tar.gz:

Publisher: release.yaml on andrew-codechimp/python-tsmart

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

File details

Details for the file aiotsmart-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: aiotsmart-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiotsmart-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf85bab754e64b5b424bdfc7c4788ea112581857973a4d4689abd18731103bfe
MD5 b315ccd5f801a288baf5646df0e42804
BLAKE2b-256 c6450076902e815c40c71ef3f6e6628d682725d6dd4df4b01c1f224fb083689f

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiotsmart-1.1.1-py3-none-any.whl:

Publisher: release.yaml on andrew-codechimp/python-tsmart

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