From f607f76c8ee54d77b5a10f29a93e45775b8248ff Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 2 Dec 2021 10:14:58 +0100
Subject: [PATCH] L2SS-478: Descibe what steps are needed to add a device

---
 .../tangostationcontrol/devices/README.md         | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 tangostationcontrol/tangostationcontrol/devices/README.md

diff --git a/tangostationcontrol/tangostationcontrol/devices/README.md b/tangostationcontrol/tangostationcontrol/devices/README.md
new file mode 100644
index 000000000..0c87cc56c
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/devices/README.md
@@ -0,0 +1,15 @@
+# Devices
+
+This directory contains the sources for our custom Tango devices.
+
+## Adding a new device
+
+If a new device is added, it will (likely) need to be referenced in several places. Adjust or add the following files (referenced from the repository root), following the pattern shown by the devices already there:
+
+- Adjust `CDB/LOFAR_ConfigDb.json` to create the device in the Tango device database,
+- Adjust `docker-compose/jupyter/ipython-profiles/stationcontrol-jupyter/startup/01-devices.py` to make an alias for it available in Jupyter,
+- Adjust `tangostationcontrol/tangostationcontrol/devices/boot.py` to add the device to the station initialisation sequence,
+- Add to `docker-compose/` to create a YaML file to start the device in a docker container. NOTE: it needs a unique 57xx port assigned,
+- Add to `tangostationcontrol/tangostationcontrol/integration_test/devices/` to add an integration test,
+- Adjust `sbin/run_integration_test.sh` to have the device started when running the integration tests,
+- Add to `docs/source/devices/` to mention the device in the end-user documentation.
-- 
GitLab