add some docu, remove trailing spaces

This commit is contained in:
chrys 2018-09-05 23:11:42 +02:00
parent 76122a93ad
commit 3bb5425619

View File

@ -4,6 +4,29 @@
# Fenrir TTY screen reader # Fenrir TTY screen reader
# By Chrys, Storm Dragon, and contributers. # By Chrys, Storm Dragon, and contributers.
'''
Remote controll:
start delimiter = #<=>#
category=settings,command
setting actions:
- set (Parameter = settings)
- reset
command actions:
- exec (Parameter1 = Command, Parameter2 = Command Parameters)
- cancel
structure:
#<=>#category##action[##Parameter1##Parameter2]
settings:
#<=>#settings##set##section#setting=value[,section#setting=value]
#<=>#settings##set##speech#voice=de
#<=>#settings##reset
execute command:
#<=>#command##exec#say##this is a test
#<=>#command##cancel##say
'''
from fenrirscreenreader.core import debug from fenrirscreenreader.core import debug
from fenrirscreenreader.core.eventData import fenrirEventType from fenrirscreenreader.core.eventData import fenrirEventType
import time import time
@ -44,7 +67,7 @@ class remoteManager():
if len(r) > 0: if len(r) > 0:
rawdata = client_sock.recv(8129) rawdata = client_sock.recv(8129)
try: try:
data = rawdata.decode("utf-8").rstrip() data = rawdata.decode("utf-8").rstrip().lstrip()
if data.startswith('#<=>#'): if data.startswith('#<=>#'):
eventQueue.put({"Type":fenrirEventType.RemoteIncomming, eventQueue.put({"Type":fenrirEventType.RemoteIncomming,
"Data": data "Data": data
@ -74,7 +97,7 @@ class remoteManager():
if len(r) > 0: if len(r) > 0:
rawdata = client_sock.recv(8129) rawdata = client_sock.recv(8129)
try: try:
data = rawdata.decode("utf-8").rstrip() data = rawdata.decode("utf-8").rstrip().lstrip()
if data.startswith('#<=>#'): if data.startswith('#<=>#'):
eventQueue.put({"Type":fenrirEventType.RemoteIncomming, eventQueue.put({"Type":fenrirEventType.RemoteIncomming,
"Data": data "Data": data
@ -112,6 +135,7 @@ class remoteManager():
def handleRemoteIncomming(self, eventData): def handleRemoteIncomming(self, eventData):
if not eventData: if not eventData:
return return
# examples
# settings: # settings:
# #<=>#settings##set##section#setting=value[,section#setting=value] # #<=>#settings##set##section#setting=value[,section#setting=value]
# #<=>#settings##set##speech#voice=de # #<=>#settings##set##speech#voice=de