Metadata-Version: 2.1
Name: pytuya
Version: 7.0.5
Summary: Python interface to ESP8266MOD WiFi smart devices from Shenzhen Xenon
Home-page: https://github.com/clach04/python-tuya
Author: clach04
Author-email: 
License: MIT
Description: # python-tuya

        

        [![Build Status](https://travis-ci.org/clach04/python-tuya.svg?branch=master)](https://travis-ci.org/clach04/python-tuya)

        

        NOTE I'm no longer using these devices so this is not actively maintained.

        

        Python 2.7 and Python 3.6.1 interface to ESP8266MOD WiFi smart devices from Shenzhen Xenon.

        If you are using the Jinvoo Smart App, this allows local control over the LAN.

        NOTE requires the devices to have already been **activated** by Jinvoo Smart App (or similar).

        

        ## Key extraction

        

        https://github.com/clach04/python-tuya/wiki has background information for how to get device id and local key.

        (the device id can be seen in Jinvoo Smart App, under "Device Info").

        

        Known to work with:

          * SKYROKU SM-PW701U Wi-Fi Plug Smart Plug - see https://wikidevi.com/wiki/Xenon_SM-PW701U

          * Wuudi SM-S0301-US - WIFI Smart Power Socket Multi Plug with 4 AC Outlets and 4 USB Charging

        

        

        Demo:

        

            import pytuya

        

            d = pytuya.OutletDevice('DEVICE_ID_HERE', 'IP_ADDRESS_HERE', 'LOCAL_KEY_HERE')

            data = d.status()  # NOTE this does NOT require a valid key

            print('Dictionary %r' % data)

            print('state (bool, true is ON) %r' % data['dps']['1'])  # Show status of first controlled switch on device

        

            # Toggle switch state

            switch_state = data['dps']['1']

            data = d.set_status(not switch_state)  # This requires a valid key

            if data:

                print('set_status() result %r' % data)

        

            # on a switch that has 4 controllable ports, turn the fourth OFF (1 is the first)

            data = d.set_status(False, 4)

            if data:

                print('set_status() result %r' % data)

                print('set_status() extrat %r' % data[20:-8])

        

        TODO demo timer (with comment not all devices support this, one way to check, is to check Jinvoo Smart App and see if there is a clock icon that is not dimmed out).

        

        ### Encryption notes

        

        These devices uses AES encryption, this is not available in Python standard library, there are three options:

        

         1) PyCrypto

         2) PyCryptodome

         3) pyaes (note Python 2.x support requires https://github.com/ricmoo/pyaes/pull/13)

        

        ### Related Projects

        

          * https://github.com/sean6541/tuyaapi Python API to the web api

          * https://github.com/codetheweb/tuyapi node.js

          * https://github.com/Marcus-L/m4rcus.TuyaCore - .NET

          * https://github.com/SDNick484/rectec_status/ - RecTec pellet smokers control (with Alexa skill)

        

        ### Acknowledgements

        

          * Major breakthroughs on protocol work came from https://github.com/codetheweb/tuyapi from the reverse engineering time and skills of codetheweb and blackrozes, additional protocol reverse engineering from jepsonrob and clach04.

          * nijave pycryptodome support and testing

          * Exilit for unittests and docstrings

          * mike-gracia for improved Python version support

          * samuscherer for RGB Bulb support

          * magneticflux- for improved Python version support

          * sean6541 - for initial PyPi package and Home Assistant support <https://github.com/sean6541/tuya-homeassistant>

        
Keywords: home automation
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Home Automation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Home Automation
Description-Content-Type: text/markdown
