M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc/manual/writing_a_driver: use underscore in filenames

This commit is contained in:
Sebastien Bourdeauducq 2014-11-29 10:57:23 +08:00
parent 81ab801fe4
commit 8593ac85fd
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/manual/writing_a_driver.rst
View File

@ -32,13 +32,13 @@ The parameters ``::1`` and 7777 are respectively the address to bind the server
#!/usr/bin/env python3 #!/usr/bin/env python3
at the beginning of the file, save it to ``hello-controller.py`` and set its execution permissions: :: at the beginning of the file, save it to ``hello_controller.py`` and set its execution permissions: ::
$ chmod 755 hello-controller.py $ chmod 755 hello_controller.py
Run it as: :: Run it as: ::
$ ./hello-controller.py $ ./hello_controller.py
and verify that you can connect to the TCP port: :: and verify that you can connect to the TCP port: ::
@ -59,7 +59,7 @@ The client
Controller clients are small command-line utilities that expose certain functionalities of the drivers. They are optional, and not used very often - typically for debugging and testing. Controller clients are small command-line utilities that expose certain functionalities of the drivers. They are optional, and not used very often - typically for debugging and testing.
Create a ``hello-client.py`` file with the following contents: :: Create a ``hello_client.py`` file with the following contents: ::
#!/usr/bin/env python3 #!/usr/bin/env python3
@ -78,7 +78,7 @@ Create a ``hello-client.py`` file with the following contents: ::
Run it as before, while the controller is running. You should see the message appearing on the controller's terminal: :: Run it as before, while the controller is running. You should see the message appearing on the controller's terminal: ::
$ ./hello-controller.py $ ./hello_controller.py
message: Hello World! message: Hello World!
When using the driver in an experiment, for simple cases the ``Client`` instance can be returned by the :class:`artiq.language.core.AutoContext` mechanism and used normally as a device. When using the driver in an experiment, for simple cases the ``Client`` instance can be returned by the :class:`artiq.language.core.AutoContext` mechanism and used normally as a device.