125 lines
4.6 KiB
Plaintext
125 lines
4.6 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: pytapo
|
||
|
|
Version: 2.9.1
|
||
|
|
Summary: Python library for communication with Tapo Cameras
|
||
|
|
Home-page: https://github.com/JurajNyiri/pytapo
|
||
|
|
Author: Juraj Nyíri
|
||
|
|
Author-email: juraj.nyiri@gmail.com
|
||
|
|
License: MIT
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
License-File: LICENSE
|
||
|
|
Requires-Dist: requests
|
||
|
|
Requires-Dist: urllib3
|
||
|
|
Requires-Dist: pycryptodome
|
||
|
|
|
||
|
|
# PyTapo
|
||
|
|
|
||
|
|
Python library for communication with Tapo Cameras
|
||
|
|
|
||
|
|
## Install:
|
||
|
|
|
||
|
|
```
|
||
|
|
python3 -m pip install pytapo
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage examples:
|
||
|
|
|
||
|
|
### Initiate library:
|
||
|
|
|
||
|
|
```
|
||
|
|
from pytapo import Tapo
|
||
|
|
|
||
|
|
user = "" # user you set in Advanced Settings -> Camera Account
|
||
|
|
password = "" # password you set in Advanced Settings -> Camera Account
|
||
|
|
host = "" # ip of the camera, example: 192.168.1.52
|
||
|
|
|
||
|
|
tapo = Tapo(host, user, password)
|
||
|
|
|
||
|
|
print(tapo.getBasicInfo())
|
||
|
|
```
|
||
|
|
|
||
|
|
## Authentication
|
||
|
|
|
||
|
|
Depending on your camera model and firmware version, the authentication method varies.
|
||
|
|
|
||
|
|
Normally you should be able to authenticate using the "camera account" created via the Tapo App (Settings > Advanced settings > Camera account).
|
||
|
|
|
||
|
|
In case of a similar stack trace:
|
||
|
|
|
||
|
|
```
|
||
|
|
Traceback (most recent call last):
|
||
|
|
File "/home/user/Projects/pytapo/pytapo/__init__.py", line 41, in __init__
|
||
|
|
self.basicInfo = self.getBasicInfo()
|
||
|
|
File "/home/user/Projects/pytapo/pytapo/__init__.py", line 232, in getBasicInfo
|
||
|
|
return self.performRequest(
|
||
|
|
File "/home/user/Projects/pytapo/pytapo/__init__.py", line 95, in performRequest
|
||
|
|
self.ensureAuthenticated()
|
||
|
|
File "/home/user/Projects/pytapo/pytapo/__init__.py", line 61, in ensureAuthenticated
|
||
|
|
return self.refreshStok()
|
||
|
|
File "/home/user/Projects/pytapo/pytapo/__init__.py", line 80, in refreshStok
|
||
|
|
raise Exception("Invalid authentication data")
|
||
|
|
Exception: Invalid authentication data
|
||
|
|
```
|
||
|
|
|
||
|
|
Attempt to authenticate using `admin` as `user` and your TP-Link cloud account password as `password`.
|
||
|
|
|
||
|
|
## Contributions:
|
||
|
|
|
||
|
|
Contributions to pytapo are welcomed.
|
||
|
|
|
||
|
|
By creating a PR you acknowledge and agree that you are not breaking any TOS, law and/or have a permission to provide and share the code changes.
|
||
|
|
|
||
|
|
Owner of this repository is not legally responsible for any PRs or code changes to this project created by 3rd parties.
|
||
|
|
|
||
|
|
When you make a new change to the code base, make sure to have 100% unit test coverage, see below for more information about tests.
|
||
|
|
|
||
|
|
### Test instructions
|
||
|
|
|
||
|
|
Set the following environment variables:
|
||
|
|
|
||
|
|
`PYTAPO_USER` - user you set in Advanced Settings -> Camera Account
|
||
|
|
|
||
|
|
`PYTAPO_PASSWORD` - password you set in Advanced Settings -> Camera Account
|
||
|
|
|
||
|
|
`PYTAPO_IP` - ip of the camera, example: 192.168.1.52
|
||
|
|
|
||
|
|
Install `pre-commit` and `tox` from pip.
|
||
|
|
|
||
|
|
Run `pre-commit install` and `pre-commit install -t pre-push`.
|
||
|
|
|
||
|
|
Then run `tox` to run all the tests.
|
||
|
|
|
||
|
|
Linters are ran on every commit.
|
||
|
|
|
||
|
|
Tests are ran on push.
|
||
|
|
|
||
|
|
Your camera may do all the actions supported by this library, including, but not limited to, move, change privacy mode and reboot while tests are running. Camera does not format SD card during tests.
|
||
|
|
|
||
|
|
After the tests are done, your camera should be in the initial state.
|
||
|
|
|
||
|
|
## Thank you
|
||
|
|
|
||
|
|
- [Dale Pavey](https://research.nccgroup.com/2020/07/31/lights-camera-hacked-an-insight-into-the-world-of-popular-ip-cameras/) from NCC Group for the initial research on the Tapo C200
|
||
|
|
- [likaci](https://github.com/likaci) and [his github repository](https://github.com/likaci/mercury-ipc-control) for the research on the Mercury camera on which tapo is based
|
||
|
|
- [Tim Zhang](https://github.com/ttimasdf) for additional research for Mercury camera on [his github repository](https://github.com/ttimasdf/mercury-ipc-control)
|
||
|
|
- [Gábor Szabados](https://github.com/GSzabados) for doing research and gathering all the information above in [Home Assistant Community forum](https://community.home-assistant.io/t/use-pan-tilt-function-for-tp-link-tapo-c200-from-home-assistant/170143/18)
|
||
|
|
- [Davide Depau](https://github.com/Depau) for additional [research](https://md.depau.eu/s/r1Ys_oWoP) of the cameras and work on pytapo library
|
||
|
|
|
||
|
|
# Disclaimer
|
||
|
|
|
||
|
|
Pytapo is an unofficial module for achieving interoperability with Tapo cameras.
|
||
|
|
|
||
|
|
Author is in no way affiliated with Tp-Link or Tapo.
|
||
|
|
|
||
|
|
All the api requests used within the library are available and published on the internet (examples linked above) and this module is purely just a wrapper around those https requests.
|
||
|
|
|
||
|
|
Author does not guarantee functionality of this library and is not responsible for any damage.
|
||
|
|
|
||
|
|
All product names, trademarks and registered trademarks in this repository, are property of their respective owners.
|
||
|
|
|
||
|
|
|