occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

doc/manual: add controller default TCP port list

This commit is contained in:
Sebastien Bourdeauducq 2014-11-25 20:24:57 +08:00
parent dc27c2e3ad
commit f12389cdd4
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/manual/drivers_reference.rst
View File

@ -16,3 +16,19 @@ Each driver is run in a separate "controller" that exposes a RPC interface (base
.. automodule:: artiq.devices.pdq2 .. automodule:: artiq.devices.pdq2
:members: :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
doc/manual/writing_a_driver.rst
View File

@ -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. * 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. * 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. * 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.