Skip to content

Commit 8d305e3

Browse files
committedOct 28, 2014
doc: some precisions about controllers
1 parent d5a3f3e commit 8d305e3

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed
 

‎artiq/language/core.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def array(element, count):
8484

8585

8686
class AutoContext:
87-
"""Base class to automate device and parameter management.
87+
"""Base class to automate device and parameter discovery.
8888
8989
Drivers and experiments should in most cases overload this class to
9090
obtain the parameters and devices (including the core device) that they

‎doc/manual/core_drivers_reference.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
Core drivers reference
22
======================
33

4-
These drivers are for peripherals closely integrated into the core device, which do not
5-
follow the controller paradigm.
4+
These drivers are for peripherals closely integrated into the core device, which do not use the controller mechanism.
65

76
:mod:`artiq.coredevice.rtio` module
87
-----------------------------------

‎doc/manual/writing_a_driver.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Writing a driver
22
================
33

4-
These instructions cover writing a simple driver for a "slow" device, that uses the controller paradigm.
4+
These instructions cover writing a simple driver for a "slow" device, that uses the controller mechanism.
55

66
The controller
77
--------------
@@ -52,6 +52,8 @@ and verify that you can connect to the TCP port: ::
5252
The client
5353
----------
5454

55+
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.
56+
5557
Create a ``hello-client`` file with the following contents: ::
5658

5759
#!/usr/bin/env python3
@@ -74,6 +76,7 @@ Run it as before, while the controller is running. You should see the message ap
7476
$ ./hello-controller
7577
message: Hello World!
7678

79+
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.
7780

7881
Command-line arguments
7982
----------------------

0 commit comments

Comments
 (0)
Please sign in to comment.