Skip to content
Snippets Groups Projects
Commit ce1161c5 authored by Jan David Mol's avatar Jan David Mol
Browse files

L2SS-434: Improved boot description

parent e5139476
No related branches found
No related tags found
1 merge request!150L2SS-434: Add sphinx documentation content
...@@ -6,7 +6,7 @@ Devices ...@@ -6,7 +6,7 @@ Devices
Boot 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. :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 ...@@ -18,7 +18,7 @@ The initialisation process can subsequently be followed through monitoring the f
:type: ``bool`` :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`` :type: ``int``
...@@ -26,7 +26,7 @@ The initialisation process can subsequently be followed through monitoring the f ...@@ -26,7 +26,7 @@ The initialisation process can subsequently be followed through monitoring the f
:type: ``str`` :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 Docker
--------- ---------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment