From ce1161c59c30677592ad2de10d376cf3bbbc9a11 Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 7 Oct 2021 22:07:33 +0200
Subject: [PATCH] L2SS-434: Improved boot description
---
docs/source/devices/devices.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/source/devices/devices.rst b/docs/source/devices/devices.rst
index 2957425d0..3b3f7ccc7 100644
--- a/docs/source/devices/devices.rst
+++ b/docs/source/devices/devices.rst
@@ -6,7 +6,7 @@ Devices
Boot
---------
-The ``boot == Device("LTS/Boot/1")`` device is responsible for starting and initialising the other devices. Devices which are not reachable, for example because their docker container is explicitly stopped, are skipped during initialisation. This device provides the following commands:
+The ``boot == Device("LTS/Boot/1")`` device is responsible for (re)starting and initialising the other devices. Devices which are not reachable, for example because their docker container is explicitly stopped, are skipped during initialisation. This device provides the following commands:
:initialise_station(): Stop and start the other devices in the correct order, set their default values, and command them to initialise their hardware. This procedure runs asynchronously, causing this command to return immediately. Initialisation is aborted if an error is encountered.
@@ -18,7 +18,7 @@ The initialisation process can subsequently be followed through monitoring the f
:type: ``bool``
-:initialisation_progresS_R: Percentage completeness of the initialisation procedure. Each succesfully configured device increments progress.
+:initialisation_progress_R: Percentage completeness of the initialisation procedure. Each succesfully configured device increments progress.
:type: ``int``
@@ -26,7 +26,7 @@ The initialisation process can subsequently be followed through monitoring the f
:type: ``str``
-If a device fails to initialise, most likely the :doc:`../interfaces/logs` will need to be consulted.
+A useful pattern is thus to call ``initialise_station()``, wait for ``initialising_R == False``, and then check whether the initalisation was succesful, if ``initialisation_progress_R == 100``. If a device fails to initialise, most likely the :doc:`../interfaces/logs` will need to be consulted.
Docker
---------
--
GitLab