# Tapo
[![License][license_badge]][license]
[![Crates][crates_badge]][crates]
[![Documentation][crates_documentation_badge]][crates_documentation]
[![Crates.io][crates_downloads_badge]][crates]
[![PyPI][pypi_badge]][pypi]
[![Python][pypi_versions_badge]][pypi]
[![PyPI][pypi_downloads_badge]][pypi]\
Unofficial Tapo API Client. Works with TP-Link Tapo smart devices. Tested with light bulbs (L510, L520, L530, L535, L610, L630), light strips (L900, L920, L930), plugs (P100, P105, P110, P110M, P115), power strips (P300, P304M, P306, P316M), hubs (H100), switches (S200B) and sensors (KE100, T100, T110, T300, T310, T315).
[license_badge]: https://img.shields.io/crates/l/tapo.svg
[license]: https://github.com/mihai-dinculescu/tapo/blob/main/LICENSE
[crates_badge]: https://img.shields.io/crates/v/tapo.svg?logo=rust&color=F75101
[crates]: https://crates.io/crates/tapo
[crates_documentation_badge]: https://img.shields.io/docsrs/tapo.svg?logo=rust&color=F75101
[crates_documentation]: https://docs.rs/tapo
[crates_downloads_badge]: https://img.shields.io/crates/d/tapo?logo=rust&label=downloads&color=F75101
[pypi_badge]: https://img.shields.io/pypi/v/tapo.svg?logo=pypi&color=00ADD4
[pypi]: https://pypi.org/project/tapo
[pypi_versions_badge]: https://img.shields.io/pypi/pyversions/tapo.svg?logo=python&color=00ADD4
[pypi_downloads_badge]: https://img.shields.io/pypi/dm/tapo?logo=python&color=00ADD4
## Device support
✓ - Rust only\
✅ - Rust and Python
| device_reset | | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | |
| get_child_device_component_list_json | | | | | | | | ✅ | ✅ | ✅ |
| get_child_device_list | | | | | | | | ✅ | ✅ | ✅ |
| get_child_device_list_json | | | | | | | | ✅ | ✅ | ✅ |
| get_current_power | | | | | | | ✅ | | | |
| get_device_info | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| get_device_info_json | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| get_device_usage | | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | |
| get_energy_data | | | | | | | ✅ | | | |
| get_energy_usage | | | | | | | ✅ | | | |
| get_supported_ringtone_list | | | | | | | | | | ✅ |
| off | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | |
| on | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | |
| play_alarm | | | | | | | | | | ✅ |
| refresh_session | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| set_brightness | | ✅ | ✅ | ✅ | ✅ | | | | | |
| set_color | | | ✅ | ✅ | ✅ | | | | | |
| set_color_temperature | | | ✅ | ✅ | ✅ | | | | | |
| set_hue_saturation | | | ✅ | ✅ | ✅ | | | | | |
| set_lighting_effect | | | | | ✅ | | | | | |
| set() API \* | | | ✅ | ✅ | ✅ | | | | | |
| stop_alarm | | | | | | | | | | ✅ |
\* The `set()` API allows multiple properties to be set in a single request.
## Hub (H100) Child Devices Support
✓ - Rust only\
✅ - Rust and Python
| get_device_info \* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| get_device_info_json | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| get_temperature_humidity_records | | | | | | ✅ |
| get_trigger_logs | | ✅ | ✅ | ✅ | ✅ | |
| set_child_protection | ✅ | | | | | |
| set_frost_protection | ✅ | | | | | |
| set_max_control_temperature | ✅ | | | | | |
| set_min_control_temperature | ✅ | | | | | |
| set_target_temperature | ✅ | | | | | |
| set_temperature_offset | ✅ | | | | | |
\* Obtained by calling `get_child_device_list` on the hub device or `get_device_info` on a child device handler.
## Rust
### Usage
> Cargo.toml
```toml
[dependencies]
tapo = "0.8"
```
> main.rs
```rust
let device = ApiClient::new("<tapo-username>", "tapo-password")
.p110("<device ip address>")
.await?;
device.on().await?;
```
### Examples
```bash
export TAPO_USERNAME=
export TAPO_PASSWORD=
export IP_ADDRESS=
cargo run --example tapo_l530
```
See all examples in [/tapo/examples][examples].
### Wrapper REST API
[tapo-rest][tapo_rest] is a REST wrapper of this library that can be deployed as a service or serve as an advanced example.
## Python
### Usage
```bash
pip install tapo
```
```python
client = ApiClient("<tapo-username>", "tapo-password")
device = await client.p110("<device ip address>")
await device.on()
```
### Examples
```bash
cd tapo-py
poetry install # On the initial run
poetry shell
maturin develop # On the initial run and whenever the Rust code is modified
export TAPO_USERNAME=
export TAPO_PASSWORD=
export IP_ADDRESS=
```
```bash
python examples/tapo_p110.py
```
See all examples in [/tapo-py/examples][examples-py].
## Contributing
Contributions are welcome and encouraged! See [/CONTRIBUTING.md][contributing].
## Credits
Inspired by [petretiandrea/plugp100][inspired_by].
[examples]: https://github.com/mihai-dinculescu/tapo/tree/main/tapo/examples
[examples-py]: https://github.com/mihai-dinculescu/tapo/tree/main/tapo-py/examples
[tapo_rest]: https://github.com/ClementNerma/tapo-rest
[contributing]: https://github.com/mihai-dinculescu/tapo/blob/main/CONTRIBUTING.md
[inspired_by]: https://github.com/petretiandrea/plugp100