diff --git a/docs/Contributing/Contributing.md b/docs/Contributing/Contributing.md index 580623f9d..a36ad683a 100644 --- a/docs/Contributing/Contributing.md +++ b/docs/Contributing/Contributing.md @@ -5,3 +5,6 @@ Please take a moment to review this section for an easy and effective contributi Following these guidelines will help to communicate the issues or pull requests that you submit in a clear, concise, and effective manner. This increases the chances of getting a quick response from the maintainers, while also increasing the chance of having your code merged into the project. +This project uses [doxygen](https://www.doxygen.nl/manual/docblocks.html)-style comments for in-code documentation and *TODO: (replace with coding convention)* as the coding convention. + +Releases follow the [semantic versioning](https://semver.org/) sceheme. \ No newline at end of file diff --git a/docs/Usage/Summary/summary_of_states.md b/docs/Usage/Summary/summary_of_states.md new file mode 100644 index 000000000..587c77753 --- /dev/null +++ b/docs/Usage/Summary/summary_of_states.md @@ -0,0 +1,15 @@ +# Summary of ATOS test-states + +Once ATOS is running, the control-panel GUI can be used to issue commands to ATOS. Certain commands are legal only in specific states. States and the legal transitions between states are described in the standard [ISO 22133](https://www.iso.org/standard/78970.html). + +A normal sequence of events is described in the following table: + +| Step | Action | Description | Expected Response | +|------|------|------|------| +| 1 | Initialize the server | Press the `Init` button. | Scenario is loaded and trajectories are generated for each test object. If previously in `Idle` state, ATOS transitions to state: `Initialized` | +| 2 | Connect to all objects. | Press the `Connect` button. | The server will now try to connect to all objects in the scenario by establishing IP-connections. ATOS transitions to the state `Connected`. +| 3 | Arm the scenario. | Press the `Arm` button. | ATOS transitions to state `Armed` to indicate that all objects are armed and ready to start. | +| 4 | Start the scenario. | Press the `Start` button. | The test starts and ATOS transitions to state: `Running`. This means that the test is live, and both physical and virtual test participants, will start moving according to the scenario. | +| 5 | Abort the scenario. | Press the `Abort` button. | ATOS Aborts the scenario and transitions to state `Aborting`. | +| 6 | Reset the system. | Press the `Clear Abort` button. | ATOS transitions to the state `Connected`. | + diff --git a/mkdocs.yml b/mkdocs.yml index d94f7cee9..f2db3e733 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,13 +10,13 @@ nav: - ATOS Doxygen: html/index.html - About: - "About/index.md" - - "About/visionAndPurpose.md" + - "About/aboutATOS.md" + - "Usage/Summary/summary_of_states.md" - Installation: - "Installation/installation.md" + - Using ATOS: - "Installation/quickstart.md" - - Configuration: - "Usage/How-to/configuration.md" - - GUI: - "Usage/GUI/foxglove.md" - "Usage/GUI/controlpanel.md" - Modules: