CHANGELOG.md

@@ -6,6 +6,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+# [v0.2.0] 2024-05-02
+
+- Use released `sat-rs` version v0.2.0
+
+## Added
+
+- Taking an image now generates a metadata file.
+- Implemented a command to move all camera image related files to the `toGroundLP` folder.
+
+## Fixed
+
+- Various important bugfixes for stop handling and home path handling
+
 # [v0.1.1] 2024-04-26
 
 Various smaller improvements and tweaks.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ops-sat-rs"
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -17,17 +17,6 @@ You might need to set the [`CROSS_CONTAINER_ENGINE`](https://github.com/cross-rs
 and [`CROSS_ROOTLESS_CONTAINER_ENGINE`](https://github.com/cross-rs/cross/blob/main/docs/environment_variables.md#configuring-cross-with-environment-variables)
 variables manually before calling cross.
 
-The OPS-SAT software filesystem handling will determine a home path at the start of the software.
-This home path is used for various mechanisms inside the OPS-SAT infrastructure.
-
-Currently, there are 3 possible configurations:
-
-1. If the software is built with the `host` feature, the HOME path will be the current path the
-   software is run at.
-2. If the `host` feature is not set and the `/home/exp278` folder exists, that folder will be
-   the home directory.
-3. Otherwise, the default OS home directory will be the home directory.
-
 ### Debug Build
 
 ```sh
@@ -108,3 +97,28 @@ the following configuration:
 ```
 
 You can run `pyclient.py -T` or `pyclient.py -h` for more information on the client application.
+
+## Knowledge Base
+
+### Home Path Handling
+
+The OPS-SAT software filesystem handling will determine a home path at the start of the software.
+This home path is used for various mechanisms inside the OPS-SAT infrastructure.
+
+Currently, there are 3 possible configurations:
+
+1. If the software is built with the `host` feature, the HOME path will be the current path the
+   software is run at.
+2. If the `host` feature is not set and the `/home/exp278` folder exists, that folder will be
+   the home directory.
+3. Otherwise, the default OS home directory will be the home directory.
+
+### Application Shutdown Handling
+
+The application can be stopped by creating a `stop-experiment` file either in the home path
+specified in the previous section, or inside the temporary folder. There is also an action command
+available to stop the application.
+
+### Camera Handling
+
+TODO