Add a mission report example (#104)

* Made an initial mission report example

* Updated readme to document new example

* Added rx error plot

* Cleaned up mission report example and linted

* Updated pipenv

Author: evan-palmer

.devcontainer/Dockerfile

@@ -47,18 +47,40 @@ RUN pip3 install \
     pre-commit \
     tox
 
+# Install visualization tools
+RUN pip3 install \
+    matplotlib \
+    plotly \
+    kaleido
+
+# Configure a new non-root user
 ARG USERNAME=developer
 ARG USER_UID=1000
 ARG USER_GID=$USER_UID
 
-# Add non-root user
 RUN groupadd --gid $USER_GID $USERNAME \
     && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
     && apt-get update \
     && apt-get install -y sudo \
     && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
     && chmod 0440 /etc/sudoers.d/$USERNAME \
-    && rm -rf /var/lib/apt/lists/*
+    && rm -rf /var/lib/apt/lists/* \
+    && echo "source /usr/share/bash-completion/completions/git" >> /home/$USERNAME/.bashrc \
+    && echo "if [ -f /opt/ros/${ROS_DISTRO}/setup.bash ]; then source /opt/ros/${ROS_DISTRO}/setup.bash; fi" >> /home/$USERNAME/.bashrc
+
+# Install packages needed for enabling OpenGL and X11
+RUN apt-get update && apt-get install -y -qq --no-install-recommends \
+    libglvnd0 \
+    libgl1 \
+    libglx0 \
+    libegl1 \
+    libxext6 \
+    libx11-6
+
+# Configure environment variables needed
+ENV NVIDIA_VISIBLE_DEVICES all
+ENV NVIDIA_DRIVER_CAPABILITIES graphics,utility,compute
+ENV QT_X11_NO_MITSHM 1
 
 # Add the .local/bin directory to the path
 ENV PATH "${PATH}:/home/$USERNAME/.local/bin"

.devcontainer/devcontainer.json

@@ -12,6 +12,7 @@
     "--cap-add=SYS_PTRACE",
     "--security-opt=seccomp:unconfined",
     "--security-opt=apparmor:unconfined",
+    "--volume=/tmp/.X11-unix:/tmp/.X11-unix",
     "--volume=/dev:/dev",
     "--privileged"
   ],
@@ -25,9 +26,7 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 4,
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.rulers": [
-      88
-    ],
+    "editor.rulers": [88],
     "rewrap.autoWrap.enabled": true,
     "rewrap.wrappingColumn": 80,
     "rewrap.wholeComment": true,
@@ -54,19 +53,15 @@
       "pymavswarm"
     ],
     "[python]": {
-      "editor.rulers": [
-        88
-      ],
+      "editor.rulers": [88],
       "editor.tabSize": 4,
       "editor.defaultFormatter": "ms-python.python",
       "editor.codeActionsOnSave": {
         "source.organizeImports": true
       }
     },
     "[markdown]": {
-      "editor.rulers": [
-        80
-      ],
+      "editor.rulers": [80],
       "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
     },
     "[dockerfile]": {

.gitignore

@@ -133,3 +133,4 @@ dmypy.json
 
 # pymavlink files
 logs/
+mission_report/

Pipfile

@@ -20,6 +20,9 @@ bandit = "*"
 coverage = "*"
 pre-commit = "*"
 tox = "*"
+matplotlib = "*"
+plotly = "*"
+kaleido = "*"
 
 [requires]
 python_version = "3"

Pipfile.lock

@@ -3,44 +3,41 @@
 Several examples have been implemented to demonstrate how to use and extend the
 `pymavswarm` library. The implemented examples include:
 
-- `arming.py`: demonstrates how to arm and disarm swarm agents
+- `arming.py`: demonstrates how to arm and disarm swarm agents.
 - `check_state.py`: demonstrates how to check the state of swarm agents; also
-demonstrates how to log data to a [`tlog`](https://ardupilot.org/copter/docs/common-mission-planner-telemetry-logs.html)
-file
-- `companion_computer.py`: demonstrates how to send commands from a companion
-computer
-- `custom_observer.py`: demonstrates how to implement a callback for an agent
-state change
+  demonstrates how to log data to a log file.
+- `custom_observer.py`: demonstrates how to implement an observer for an agent
+state change event.
 - `goto.py`: demonstrates how to command an agent to fly to a specified location
 using a configuration file; an example configuration file is provided in
-`resources/goto.yaml`
-- `set_flight_mode.py`: demonstrates how to set the agents' flight mode
+`resources/goto.yaml`.
+- `mission_report.py`: demonstrates how to use the `parse_log_file` method to
+  create a simple mission report.
+- `set_flight_mode.py`: demonstrates how to set the agents' flight mode.
 - `set_home_position.py`: demonstrates how to set the swarm agents' home
-position
-- `set_parameter.py`: demonstrates how to set an agent's parameter
+position.
+- `set_parameter.py`: demonstrates how to set an agent's parameter.
 - `subclass_mavswarm.py`: demonstrates how to extend the functionality of
-`MavSwarm`
-- `takeoff_sequence.py`: demonstrates how to execute a full takeoff sequence
+`MavSwarm` through subclassing.
+- `takeoff_sequence.py`: demonstrates how to execute a full takeoff sequence.
 
 ## Running the examples
 
 Prior to running the examples, ensure that there is an active connection between
 a ground control station and the swarm agents. When these examples were first
 developed, the ground control station and the swarm agents utilized RFD900
-radios configured to use the multi-point radio setting. In the case of the
-`companion_computer.py` example, ensure that the script has been uploaded to the
-companion computer for execution.
+radios configured to use the multi-point radio setting.
 
 Once the network has been configured, the examples may be run using the
 following command:
 
 ```bash
-python3 <example_script.py> ...
+python3 <example_script.py> <args>
 ```
 
 where `<example_script.py>` is replaced with the name of the example script to
-run and `...` is replaced with the example's required arguments. To see the
-required arguments, run the following command:
+run and `<args>` is replaced with the example's arguments. To see the
+arguments, run the following command:
 
 ```bash
 python3 <example_script.py> -h