tinytuya
Python API and command line tool for Tuya WiFi smart devices using a direct local area network (LAN) connection or the cloud (TuyaCloud API).
File Explorer
Download Latest Version (.zip)- codeql-analysis.yml
- contrib.yml
- pylint.yml
- test.yml
- README.md
- TinyTuya-diagram.jpg
- TinyTuya-diagram.png
- TinyTuya-diagram.svg
- DoorbellDevice-example.py
- FloorFan-example.py
- IRRemoteControlDevice-basic-learning-example.py
- IRRemoteControlDevice-basic-sending-example.py
- IRRemoteControlDevice-ircode-converting-example.py
- PresenceDetectorDevice-example.py
- RFRemoteControlDevice-example.py
- SoriaInverterDevice-example.py
- ThermostatDevice-example.py
- TuyaSmartPlug-example.py
- XmCosyStringLight-example.py
- async_send_receive.py
- bulb-music.py
- bulb-scenes.py
- bulb.py
- cloud.py
- cloud_ir.py
- cloud_rgb_bulb.py
- cloudrequest.py
- devices.py
- Dockerfile
- entrypoint.sh
- galaxy_projector.py
- getstatus.py
- monitor.py
- monitor_example.py
- monitor_poll_example.py
- multi-select.py
- README.md
- send_raw_dps.py
- snapshot.py
- star_projector.py
- threading.py
- zigbee_gateway.py
- mqtt.json
- mqtt_gateway.py
- device.html
- device_dps.html
- index.html
- jquery-3.7.1.min.js
- tinytuya.css
- Dockerfile
- README.md
- server.py
- __init__.py
- AtorchTemperatureControllerDevice.py
- BlanketDevice.py
- ClimateDevice.py
- ColorfulX7Device.py
- DoorbellDevice.py
- FloorFanDevice.py
- InverterHeatPumpDevice.py
- IRRemoteControlDevice.py
- PresenceDetectorDevice.py
- README.md
- RFRemoteControlDevice.py
- SocketDevice.py
- SoriaInverterDevice.py
- ThermostatDevice.py
- TowelRailHeaterDevice.py
- WiFiDualMeterDevice.py
- __init__.py
- command_types.py
- const.py
- core.py
- crypto_helper.py
- Device.py
- error_helper.py
- exceptions.py
- header.py
- message_helper.py
- Monitor.py
- udp_helper.py
- XenonDevice.py
- __init__.py
- __main__.py
- BulbDevice.py
- cli.py
- Cloud.py
- CoverDevice.py
- OutletDevice.py
- scanner.py
- wizard.py
- broadcast-relay.py
- fake-v35-device.py
- pcap_parse.py
- README.md
- ttcorefunc.py
- .gitignore
- .pylintrc
- AGENTS.md
- API.md
- DESIGN.md
- DP_Mapping.md
- LICENSE
- PROTOCOL.md
- pyproject.toml
- README.md
- RELEASE.md
- requirements.txt
- SECURITY.md
- setup.cfg
- setup.py
- test.py
- testcontrib.py
- tests.py
# Installation Guide
1. Get the code
git clone https://github.com/jasonacox/tinytuya
Downloads the entire project code from GitHub to your computer.
cd tinytuya
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- pipx Installs Python-based CLI tools into isolated environments.
pipx install tinytuya
Installs the CLI tool into an isolated environment via pipx.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f server/Dockerfile -t tinytuya .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 tinytuya
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Python
EasyPrerequisites
python -m pip install tinytuya
Installs the Python libraries listed in requirements.txt (or similar).
python -m tinytuya scan
Runs the Python script (or module).
python -m tinytuya wizard # use -nocolor for non-ANSI-color terminals
Runs the Python script (or module).
wizard # Interactive setup wizard (run via: python -m tinytuya wizard)
Runs the Python script (or module).
python -m tinytuya
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)