Skip to content

Commit

Permalink
doc/manual: add controller default TCP port list
Browse files Browse the repository at this point in the history
sbourdeauducq committed Nov 25, 2014
1 parent dc27c2e commit f12389c
Showing 2 changed files with 17 additions and 0 deletions.
16 changes: 16 additions & 0 deletions doc/manual/drivers_reference.rst
Original file line number Diff line number Diff line change
@@ -16,3 +16,19 @@ Each driver is run in a separate "controller" that exposes a RPC interface (base

.. automodule:: artiq.devices.pdq2
:members:


Default TCP port list
---------------------

When writing a new driver, choose a free TCP port and add it to this list.

+-----------+--------------+
| Component | Default port |
+===========+==============+
| Master | 8888 |
+-----------+--------------+
| PDQ2 | 8889 |
+-----------+--------------+
| LDA | 8890 |
+-----------+--------------+
1 change: 1 addition & 0 deletions doc/manual/writing_a_driver.rst
Original file line number Diff line number Diff line change
@@ -111,3 +111,4 @@ General guidelines
* The device identification (e.g. serial number) to attach to must be passed as a command-line parameter to the controller.
* Controllers must be able to operate in "simulation" mode, where they behave properly even if the associated hardware is not connected. For example, they can print the data to the console instead of sending it to the device, or dump it into a file.
* Keep command line parameters consistent across clients/controllers. When adding new command line options, look for a client/controller that does a similar thing and follow its use of ``argparse``. If the original client/controller could use ``argparse`` in a better way, improve it.
* Choose a free default TCP port and add it to the default port list in this manual.

0 comments on commit f12389c

Please sign in to comment.