From f12389cdd4652b4ba733b38aa59967ccf7e526e3 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Tue, 25 Nov 2014 20:24:57 +0800 Subject: [PATCH] doc/manual: add controller default TCP port list --- doc/manual/drivers_reference.rst | 16 ++++++++++++++++ doc/manual/writing_a_driver.rst | 1 + 2 files changed, 17 insertions(+) diff --git a/doc/manual/drivers_reference.rst b/doc/manual/drivers_reference.rst index 15e74a009..5deb936f3 100644 --- a/doc/manual/drivers_reference.rst +++ b/doc/manual/drivers_reference.rst @@ -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 | ++-----------+--------------+ diff --git a/doc/manual/writing_a_driver.rst b/doc/manual/writing_a_driver.rst index eae802bbc..fae02284f 100644 --- a/doc/manual/writing_a_driver.rst +++ b/doc/manual/writing_a_driver.rst @@ -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.