Skip to content
This repository has been archived by the owner on Sep 4, 2021. It is now read-only.

function state fix and mode scene added #36

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

function state fix and mode scene added #36

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc1fb0b
function state fix and mode scene added
tixi Sep 17, 2018
73a45bd
persistent socket
tixi Sep 23, 2018
7347fde
extract_payload bug fix
tixi Sep 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 181 additions & 64 deletions pytuya/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,25 +149,58 @@ def __init__(self, dev_id, address, local_key=None, dev_type=None, connection_ti

self.port = 6668 # default - do not expect caller to pass in

self.s = None # persistent socket
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this change does two things:

  1. persistent socket
  2. retry support

These are good additions :-). I would prefer to see them as configurable, possibly optional (I could be persuaded for these to be the new default behavior if we do a MAJOR version bump at the same time, see https://semver.org/ ).

Please add parms to XenonDevice.init(), e.g. something like

persistent_socket=False, retry=0  # requires MINOR version change
persistent_socket=True, retry=10  # requires MAJOR version change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, that part was not part of the pull request. You can see the state function of BulbDevice.
I am new to github and my mistake was to commit on the master branch instead of a new branch.

Concerning the persistent socket, in my opinion it is for testing purpose only to see if issue codetheweb/tuyapi#84 can be fix and it seems so.
But this implementation cause some side effects that's why retry is needed.

I can do this change if you think it is good enough or we can close the request. I think a wrapper on top of the core library will be a better choice. I starting something close to that for domoticz: https://github.com/tixi/Domoticz-Tuya-SmartPlug-Plugin

Let me know. In any case, i will not be available the coming week

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've done the same thing with commits myself, its easily done. I'd prefer we do these separately.

If you are feeling brave you could branch what you have (to save it) and then forcible remove the commits from history you don't want (I suspect but do not know if this will update the PR). A new PR is fine.

RE re-try, I've a preference for doing that outside too but I would be OK if it was added as an option.

I have my own version of the never-closed socket code too. I never had a need for it/benefit so I never ended up committing it. But it could be useful for diagnostics.


def __repr__(self):
return '%r' % ((self.id, self.address),) # FIXME can do better than this

def disconnect(self):
""" close the connection """
self.s.close()
self.s = None

def _send_receive(self, payload):
"""
Send single buffer `payload` and receive a single buffer.

Args:
payload(bytes): Data to send.
"""
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
s.settimeout(self.connection_timeout)
s.connect((self.address, self.port))
s.send(payload)
data = s.recv(1024)
s.close()
return data


if(self.s == None):
self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.s.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self.s.settimeout(self.connection_timeout)
try:
self.s.connect((self.address, self.port))
except:
pass

cpt_connect=0
while(cpt_connect<10): # guess 10 is enough
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hard coded 10 - please replace with parameter or self.retry, etc.

try:
self.s.send(payload)
data = self.s.recv(4096)
cpt_connect=10
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

break here instead? If not replace hard coded 10

except (ConnectionResetError, ConnectionRefusedError, BrokenPipeError) as e:
cpt_connect = cpt_connect+1
if(cpt_connect==10):
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hard coded 10 - please replace with parameter

raise e
self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.s.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self.s.settimeout(self.connection_timeout)
self.s.connect((self.address, self.port))
except socket.timeout as e:
cpt_connect = cpt_connect+1
if(cpt_connect==2):#stop after the first retry to avoid to long blocking time
raise e
self.s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.s.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self.s.settimeout(self.connection_timeout)
self.s.connect((self.address, self.port))

return data

def generate_payload(self, command, data=None):
"""
Generate the payload to send.
Expand Down Expand Up @@ -247,40 +280,68 @@ class Device(XenonDevice):
def __init__(self, dev_id, address, local_key=None, dev_type=None):
super(Device, self).__init__(dev_id, address, local_key, dev_type)

def status(self):
def extract_payload(self,data):
""" Return the dps status in json format in a tuple (bool,json)
if(bool): an error occur and the json is not relevant
else: no error detected and the status is in json format

Args:
data: The data received by _send_receive function
"""

#if non encrypted data
start=data.find(b'{"devId')
if(start!=-1):
result = data[start:] #in 2 steps to deal with the case where '}}' is present before {"devId'
end=result.find(b'}}')
if(end==-1):
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 nice! I've not encountered this but this is definitely a hole you've plugged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not surprise that you did not encountered that case. Without the persistent socket this case should not occur like that. You probably observe something related. I suspect that the encoded status payload you got is probably not a complete payload but just the dps with the first key. In my understanding, this is sometimes send by the device (part of the protocol) and you got that message instead of the status.

return (True,data)
else:
end=end+2
result = result[:end]

#log.debug('result=%r', result)
if not isinstance(result, str):
result = result.decode()
result = json.loads(result)
return (False,result)

#encrypted data: incomplete dps {'devId': 'NUM', 'dps': {'1': bool}, 't': NUM, 's': NUM}
return (True,data)

#start=data.find(PROTOCOL_VERSION_BYTES)
#if(start == -1): #if not found
# if(len(data)<=28):
# return (True,data) #no information from set command (data to small)
# else:
# log.debug('Unexpected status() payload=%r', data)
# return (True,data)
#else:
# result=data[start:-8]
# result = result[len(PROTOCOL_VERSION_BYTES):] # remove version header
# result = result[16:] # remove (what I'm guessing, but not confirmed is) 16-bytes of MD5 hexdigest of payload
# cipher = AESCipher(self.local_key)
# result = cipher.decrypt(result)
# if not isinstance(result, str):
# result = result.decode()
# result = json.loads(result)
# return (False,result)

def status(self,retry=0):
log.debug('status() entry')
# open device, send request, then close connection
payload = self.generate_payload('status')

data = self._send_receive(payload)
log.debug('status received data=%r', data)

result = data[20:-8] # hard coded offsets
log.debug('result=%r', result)
#result = data[data.find('{'):data.rfind('}')+1] # naive marker search, hope neither { nor } occur in header/footer
#print('result %r' % result)
if result.startswith(b'{'):
# this is the regular expected code path
if not isinstance(result, str):
result = result.decode()
result = json.loads(result)
elif result.startswith(PROTOCOL_VERSION_BYTES):
# got an encrypted payload, happens occasionally
# expect resulting json to look similar to:: {"devId":"ID","dps":{"1":true,"2":0},"t":EPOCH_SECS,"s":3_DIGIT_NUM}
# NOTE dps.2 may or may not be present
result = result[len(PROTOCOL_VERSION_BYTES):] # remove version header
result = result[16:] # remove (what I'm guessing, but not confirmed is) 16-bytes of MD5 hexdigest of payload
cipher = AESCipher(self.local_key)
result = cipher.decrypt(result)
log.debug('decrypted result=%r', result)
if not isinstance(result, str):
result = result.decode()
result = json.loads(result)
(error,result) = self.extract_payload(data)
if(error):
if(retry<=10):#10 retry should be enough (observed only 1 retry)
return self.status(retry+1)
else:
raise TypeError('Unexpected status() payload=%r', data)
else:
log.error('Unexpected status() payload=%r', result)

return result

return result

def set_status(self, on, switch=1):
"""
Set status of the device to 'on' or 'off'.
Expand All @@ -289,24 +350,30 @@ def set_status(self, on, switch=1):
on(bool): True for 'on', False for 'off'.
switch(int): The switch to set
"""
# open device, send request, then close connection

if isinstance(switch, int):
switch = str(switch) # index and payload is a string
payload = self.generate_payload(SET, {switch:on})
#print('payload %r' % payload)

data = self._send_receive(payload)
log.debug('set_status received data=%r', data)

return data
#(error,result) = self.extract_payload(data)
#if(not error):
# return result
#else:
# return ""
#else:
# return self.status()

def turn_on(self, switch=1):
"""Turn the device on"""
self.set_status(True, switch)
return self.set_status(True, switch)

def turn_off(self, switch=1):
"""Turn the device off"""
self.set_status(False, switch)
return self.set_status(False, switch)

def set_timer(self, num_secs):
"""
Expand Down Expand Up @@ -336,15 +403,26 @@ def __init__(self, dev_id, address, local_key=None):
super(OutletDevice, self).__init__(dev_id, address, local_key, dev_type)

class BulbDevice(Device):
DPS_INDEX_ON = '1'
DPS_INDEX_MODE = '2'
DPS_INDEX_BRIGHTNESS = '3'
DPS_INDEX_COLOURTEMP = '4'
DPS_INDEX_COLOUR = '5'

DPS = 'dps'
DPS_MODE_COLOUR = 'colour'
DPS_MODE_WHITE = 'white'
DPS_INDEX_ON = '1'
DPS_INDEX_MODE = '2'
DPS_INDEX_BRIGHTNESS = '3'
DPS_INDEX_COLOURTEMP = '4'
DPS_INDEX_COLOUR = '5'
DPS_INDEX_COLOUR_SCENE = '6'

DPS = 'dps'
DPS_MODE_COLOUR = 'colour'
DPS_MODE_COLOUR_SCENE = 'scene'
DPS_MODE_WHITE = 'white'

DPS_2_STATE = {
'1':'is_on',
'2':'mode',
'3':'brightness',
'4':'colourtemp',
'5':'colour',
'6':'colour_scene'
}

def __init__(self, dev_id, address, local_key=None):
dev_type = 'device'
Expand Down Expand Up @@ -437,16 +515,41 @@ def set_colour(self, r, g, b):
if not 0 <= b <= 255:
raise ValueError("The value for blue needs to be between 0 and 255.")

print(BulbDevice)
#print(BulbDevice)
hexvalue = BulbDevice._rgb_to_hexvalue(r, g, b)

payload = self.generate_payload(SET, {
self.DPS_INDEX_MODE: self.DPS_MODE_COLOUR,
self.DPS_INDEX_COLOUR: hexvalue})
data = self._send_receive(payload)
return data

def set_colour_scene(self, r, g, b):
"""
Set colour scene of an rgb bulb.

def set_white(self, brightness, colourtemp):
Args:
r(int): Value for the colour red as int from 0-255.
g(int): Value for the colour green as int from 0-255.
b(int): Value for the colour blue as int from 0-255.
"""
if not 0 <= r <= 255:
raise ValueError("The value for red needs to be between 0 and 255.")
if not 0 <= g <= 255:
raise ValueError("The value for green needs to be between 0 and 255.")
if not 0 <= b <= 255:
raise ValueError("The value for blue needs to be between 0 and 255.")

#print(BulbDevice)
hexvalue = BulbDevice._rgb_to_hexvalue(r, g, b)

payload = self.generate_payload(SET, {
self.DPS_INDEX_MODE: self.DPS_MODE_COLOUR_SCENE,
self.DPS_INDEX_COLOUR_SCENE: hexvalue})
data = self._send_receive(payload)
return data

def set_white(self, brightness, colourtemp=None):
"""
Set white coloured theme of an rgb bulb.

Expand All @@ -456,13 +559,18 @@ def set_white(self, brightness, colourtemp):
"""
if not 25 <= brightness <= 255:
raise ValueError("The brightness needs to be between 25 and 255.")
if not 0 <= colourtemp <= 255:
raise ValueError("The colour temperature needs to be between 0 and 255.")
if not colourtemp==None:
if not 0 <= colourtemp <= 255:
raise ValueError("The colour temperature needs to be between 0 and 255.")

payload = self.generate_payload(SET, {
data_payload = {
self.DPS_INDEX_MODE: self.DPS_MODE_WHITE,
self.DPS_INDEX_BRIGHTNESS: brightness,
self.DPS_INDEX_COLOURTEMP: colourtemp})
self.DPS_INDEX_BRIGHTNESS: brightness}

if not colourtemp==None:
data_payload[self.DPS_INDEX_COLOURTEMP]=colourtemp

payload = self.generate_payload(SET, data_payload)

data = self._send_receive(payload)
return data
Expand Down Expand Up @@ -507,19 +615,28 @@ def colour_rgb(self):
"""Return colour as RGB value"""
hexvalue = self.status()[self.DPS][self.DPS_INDEX_COLOUR]
return BulbDevice._hexvalue_to_rgb(hexvalue)

def colour_rgb_scene(self):
"""Return colour scene as RGB value"""
hexvalue = self.status()[self.DPS][self.DPS_INDEX_COLOUR_SCENE]
return BulbDevice._hexvalue_to_rgb(hexvalue)

def colour_hsv(self):
"""Return colour as HSV value"""
hexvalue = self.status()[self.DPS][self.DPS_INDEX_COLOUR]
return BulbDevice._hexvalue_to_hsv(hexvalue)

def colour_hsv_scene(self):
"""Return colour scene as HSV value"""
hexvalue = self.status()[self.DPS][self.DPS_INDEX_COLOUR_SCENE]
return BulbDevice._hexvalue_to_hsv(hexvalue)

def state(self):
status = self.status()
state = {
'is_on' : status[self.DPS][self.DPS_INDEX_ON],
'mode' : status[self.DPS][self.DPS_INDEX_MODE],
'brightness' : status[self.DPS][self.DPS_INDEX_BRIGHTNESS],
'colourtemp' : status[self.DPS][self.DPS_INDEX_COLOURTEMP],
'colour' : status[self.DPS][self.DPS_INDEX_COLOUR],
}
state = {}

for key in status[self.DPS].keys():
if(int(key)<=6):
state[self.DPS_2_STATE[key]]=status[self.DPS][key]

return state