linse/frappy
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve tutorial_helevel

Browse Source 
- fix indent of query method
- add remark about the CCU4 cid command
This commit is contained in:
l_samenv 2021-03-02 13:42:10 +01:00 committed by Markus Zolliker
parent e4748ef9c9
commit b1bf5e866d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/tutorial_helevel.rst
View File

@ -30,6 +30,7 @@ CCU4 luckily has a very simple and logical protocol:
# for completeness: (not needed, as it is the default) # for completeness: (not needed, as it is the default)
end_of_line = '\n' end_of_line = '\n'
# on connect, we send 'cid' and expect a reply starting with 'CCU4' # on connect, we send 'cid' and expect a reply starting with 'CCU4'
# 'cid' is a CCU4 command returning the current version prefixed with CCU4
identification = [('cid', r'CCU4.*')] identification = [('cid', r'CCU4.*')]
@ -144,16 +145,16 @@ which means it might be worth to create a *query* method, and then the
... ...
def query(self, cmd): def query(self, cmd):
"""send a query and get the response """send a query and get the response
:param cmd: the name of the parameter to query or '<parameter>=<value' :param cmd: the name of the parameter to query or '<parameter>=<value'
for changing a parameter for changing a parameter
:returns: the (new) value of the parameter :returns: the (new) value of the parameter
""" """
name, txtvalue = self._iodev.communicate(cmd).split('=') name, txtvalue = self._iodev.communicate(cmd).split('=')
assert name == cmd.split('=')[0] # check that we got a reply to our command assert name == cmd.split('=')[0] # check that we got a reply to our command
return txtvalue # Frappy will automatically convert the string to the needed data type return txtvalue # Frappy will automatically convert the string to the needed data type
def read_value(self): def read_value(self):
return self.query('h') return self.query('h')
@ -247,4 +248,4 @@ the parameters *empty_length* and *full_length* from the client by defining:
However, we do not put this here, as it is nice to try out changing parameters for a test! However, we do not put this here, as it is nice to try out changing parameters for a test!
*to be continued* *to be continued*