Release procedure - Revision history

Uwe: /* Observe RAM consumption */

2025-08-16T13:12:12Z

Observe RAM consumption

← Older revision		Revision as of 15:12, 16 August 2025
Line 77:		Line 77:
	Analyse the results with <code>heaptrack_print</code>.		Analyse the results with <code>heaptrack_print</code>.

	The command provides a overview summary at the end of the terminal output (example from running debug version):		The command provides a overview summary at the end of the terminal output (example from running debug version with simulator):
	<pre>		<pre>
	total runtime: 60.00s.		total runtime: 60.00s.
Line 88:		Line 88:

	Look out for excessive allocations of memory.		Look out for excessive allocations of memory.

			Repeat the heap track measurement running with real hardware:

			<pre>
			total runtime: 72.65s.
			bytes allocated in total (ignoring deallocations): 232.92MB (3.21MB/s)
			calls to allocation functions: 17988 (247/s)
			temporary memory allocations: 11873 (163/s)
			peak heap memory consumption: 92.70MB
			peak RSS (including heaptrack overhead): 404.26MB
			total memory leaked: 42.27MB
			</pre>

			Memory churn without simulator is lower because of missing high-frequency communication with simulator.

	== Compilation for production on target hardware and OS ==		== Compilation for production on target hardware and OS ==

Uwe at 13:06, 16 August 2025

2025-08-16T13:06:35Z

← Older revision		Revision as of 15:06, 16 August 2025
Line 68:		Line 68:

	Alternatively, use <code>htop -p [PID]</code> to get a more detailed view of RAM consumption.		Alternatively, use <code>htop -p [PID]</code> to get a more detailed view of RAM consumption.

			[[File:LinuxHTopOutput.png\|750px]]

	Execute a short (< 1 minute) session with heap tracking enabled:		Execute a short (< 1 minute) session with heap tracking enabled:

Uwe: /* Observe RAM consumption */

2025-08-16T12:38:14Z

Observe RAM consumption

← Older revision		Revision as of 14:38, 16 August 2025
Line 75:		Line 75:
	Analyse the results with <code>heaptrack_print</code>.		Analyse the results with <code>heaptrack_print</code>.

	The command provides a overview summary at the end of the terminal output:		The command provides a overview summary at the end of the terminal output (example from running debug version):
	<pre>		<pre>
	total runtime: 60.00s.		total runtime: 60.00s.

Uwe: /* Observe RAM consumption */

2025-08-16T12:37:48Z

Observe RAM consumption

← Older revision		Revision as of 14:37, 16 August 2025
Line 78:		Line 78:
	<pre>		<pre>
	total runtime: 60.00s.		total runtime: 60.00s.

	calls to allocation functions: 40764 (679/s)		calls to allocation functions: 40764 (679/s)

	temporary memory allocations: 29342 (489/s)		temporary memory allocations: 29342 (489/s)

	peak heap memory consumption: 92.81MB		peak heap memory consumption: 92.81MB

	peak RSS (including heaptrack overhead): 80.16MB		peak RSS (including heaptrack overhead): 80.16MB

	total memory leaked: 263.92KB		total memory leaked: 263.92KB
	</pre>		</pre>

Uwe: /* Observe RAM consumption */

2025-08-16T12:37:32Z

Observe RAM consumption

← Older revision		Revision as of 14:37, 16 August 2025
Line 76:		Line 76:

	The command provides a overview summary at the end of the terminal output:		The command provides a overview summary at the end of the terminal output:
	<~~code~~>		<pre>
	total runtime: 60.00s.		total runtime: 60.00s.

Line 88:		Line 88:

	total memory leaked: 263.92KB		total memory leaked: 263.92KB
	</~~code~~>		</pre>

	Look out for excessive allocations of memory.		Look out for excessive allocations of memory.

Uwe: /* Observe RAM consumption */

2025-08-16T12:36:32Z

Observe RAM consumption

← Older revision		Revision as of 14:36, 16 August 2025
Line 76:		Line 76:

	The command provides a overview summary at the end of the terminal output:		The command provides a overview summary at the end of the terminal output:
	<~~verbatim~~>		<code>
	total runtime: 60.00s.		total runtime: 60.00s.

	calls to allocation functions: 40764 (679/s)		calls to allocation functions: 40764 (679/s)

	temporary memory allocations: 29342 (489/s)		temporary memory allocations: 29342 (489/s)

	peak heap memory consumption: 92.81MB		peak heap memory consumption: 92.81MB

	peak RSS (including heaptrack overhead): 80.16MB		peak RSS (including heaptrack overhead): 80.16MB

	total memory leaked: 263.92KB		total memory leaked: 263.92KB
	</~~verbatim~~>		</code>

	Look out for excessive allocations of memory.		Look out for excessive allocations of memory.

Uwe at 12:35, 16 August 2025

2025-08-16T12:35:31Z

@@ Line 42: / Line 42: @@
 Execute the unit tests again and verify the result of platform specific test cases (e.g., messaging).
 == Unit-testing on target hardware and OS ==
@@ Line 71: / Line 68: @@
 Alternatively, use <code>htop -p [PID]</code> to get a more detailed view of RAM consumption.
 == Compilation for production on target hardware and OS ==

Uwe: /* Observe RAM consumption */

2025-08-16T10:49:09Z

Observe RAM consumption

← Older revision		Revision as of 12:49, 16 August 2025
Line 69:		Line 69:

	[[File:LinuxTopOutput.png\|500px]]		[[File:LinuxTopOutput.png\|500px]]

			Alternatively, use <code>htop -p [PID]</code> to get a more detailed view of RAM consumption.

	== Compilation for production on target hardware and OS ==		== Compilation for production on target hardware and OS ==

Uwe: /* Compilation for testing on target hardware and OS */

2025-08-16T10:48:05Z

Compilation for testing on target hardware and OS

← Older revision		Revision as of 12:48, 16 August 2025
Line 40:		Line 40:
	== Compilation for testing on target hardware and OS ==		== Compilation for testing on target hardware and OS ==
	Run <code>cargo build</code>		Run <code>cargo build</code>

			Execute the unit tests again and verify the result of platform specific test cases (e.g., messaging).

			Next, execute a short (< 1 minute) session with heap tracking enabled.
			Analyse the results with <code>heaptrack_print</code>. Look for excessive allocations of memory.

	== Unit-testing on target hardware and OS ==		== Unit-testing on target hardware and OS ==

Uwe at 20:40, 29 July 2025

2025-07-29T20:40:19Z

← Older revision		Revision as of 22:40, 29 July 2025
Line 2:		Line 2:
	=== Create lock file ===		=== Create lock file ===
	Create the path and the lockfile, e.g. <code>sudo touch /var/local/aquarium-ctrl.pid</code>, as per configuration file.		Create the path and the lockfile, e.g. <code>sudo touch /var/local/aquarium-ctrl.pid</code>, as per configuration file.

	Assign access rights using <code>chmod o+rw filename</code> so that non-root user (during testing) can use the resources as well.		Assign access rights using <code>chmod o+rw filename</code> so that non-root user (during testing) can use the resources as well.

	=== Create log file ===		=== Create log file ===
	Create the path and the logfile <code>sudo touch /var/log/aquarium.log</code>.		Create the path and the logfile <code>sudo touch /var/log/aquarium.log</code>.

	Assign access rights using <code>chmod o+rw filename</code> so that non-root user (during testing) can use the resources as well.		Assign access rights using <code>chmod o+rw filename</code> so that non-root user (during testing) can use the resources as well.

	=== Create output files on RAM disk ===		=== Create output files on RAM disk ===
	Create the path and the output files e.g., <code>sudo touch /var/local/aquarium-ctrl/aquarium-ctrl-ts</code> as stated in the .toml configuration file(s). Make sure the path yields to the RAM-disk.		Create the path and the output files e.g., <code>sudo touch /var/local/aquarium-ctrl/aquarium-ctrl-ts</code> as stated in the .toml configuration file(s). Make sure the path yields to the RAM-disk.

	Assign access rights using <code>chmod o+rw *</code> so that non-root user (during testing) can use the resources as well.		Assign access rights using <code>chmod o+rw *</code> so that non-root user (during testing) can use the resources as well.

	== Unit-testing on development machine ==		== Unit-testing on development machine ==
	Run the unit tests using <code>cargo test</code> and analyse the results.		Run the unit tests using <code>cargo test</code> and analyse the results.
	Currently there are more than 150 unit tests which run in multiple threads.
	Testing takes multiple minutes.		Currently there are more than 150 unit tests which run in multiple threads. Testing takes multiple minutes.
	If all tests pass, proceed to next step.		If all tests pass, proceed to next step.

Line 22:		Line 25:

	== Update database ==		== Update database ==
	The ~~update~~ version information needs to be inserted into the <code>version</code> table of the database together with the hash of the executable. You can obtain the hash by running <code>aquarium_control -v</code>.		The updated version information needs to be inserted into the <code>version</code> table of the database together with the hash of the executable.

			You can obtain the hash by running <code>aquarium_control -v</code>.

	[[File:ExecutableHash.png\|1000px]]		[[File:ExecutableHash.png\|1000px]]
Line 38:		Line 43:
	== Unit-testing on target hardware and OS ==		== Unit-testing on target hardware and OS ==
	Create message queues by running the script <code>create_mqueues.sh</code>.		Create message queues by running the script <code>create_mqueues.sh</code>.

	Executing the unit tests on Linux allows for additional tests to be executed which require the Linux operating system, e.g. testing the messaging subsystem.		Executing the unit tests on Linux allows for additional tests to be executed which require the Linux operating system, e.g. testing the messaging subsystem.

	Furthermore, different hardware specifications may impact the execution timing of test cases.		Furthermore, different hardware specifications may impact the execution timing of test cases.

	Executing the tests again on the combination of target hardware and target operating system is worthwhile. Execution duration is not significantly higher than on any development platform.		Executing the tests again on the combination of target hardware and target operating system is worthwhile. Execution duration is not significantly higher than on any development platform.

Line 46:		Line 54:

	[[File:StartupTerminalOutput.png\|1000px]]		[[File:StartupTerminalOutput.png\|1000px]]

			Read the log information either from terminal when executing directly or by studying the log file.

	=== Observe RAM consumption ===		=== Observe RAM consumption ===

	When running the application, start the tool <code>top</code> and study the RAM consumption.		When running the application, start the tool <code>top</code> and study the RAM consumption.

	RAM consumption varies depending on the available hardware and operating system setting.		RAM consumption varies depending on the available hardware and operating system setting.

Line 54:		Line 66:

	== Compilation for production on target hardware and OS ==		== Compilation for production on target hardware and OS ==
	Run <code>cargo build --features "target_hw" --release</code>. If you utilise the Controllino to actuate the relays, run <code>cargo build --features "target_hw, controllino_hw" --release</code>.		Run <code>cargo build --features "target_hw" --release</code>.

			If you utilise the Controllino to actuate the relays, run <code>cargo build --features "target_hw, controllino_hw" --release</code>.

	Note: The build takes several minutes on a Raspberry Pi.		Note: The build takes several minutes on a Raspberry Pi.

	== Update of production configuration file ==		== Update of production configuration file ==
	The default storage location of the configuration file is <code>/etc/aquarium_control/config/aquarium_control.toml</code>. If other command line parameter is provided, the program will default to this file. Ensure this file is updated with all entries as required by the control application. If any section or field is missing, the control application will not start up.		The default storage location of the configuration file is <code>/etc/aquarium_control/config/aquarium_control.toml</code>.

			If other command line parameter is provided, the program will default to this file.

			Ensure this file is updated with all entries as required by the control application.

			If any section or field is missing, the control application will not start up.

	== Transfer of binary and update of startup script ==		== Transfer of binary and update of startup script ==
	Transfer the binary from <code>target/release</code> to your desired installation location, e.g. <code>/usr/local/bin/</code>.		Transfer the binary from <code>target/release</code> to your desired installation location, e.g. <code>/usr/local/bin/</code>.

	Edit the startup script and consider to export the environment variable for correct [[Memory configuration\|memory configuration]].		Edit the startup script and consider to export the environment variable for correct [[Memory configuration\|memory configuration]].

	== Documentation of release in repository ==		== Documentation of release in repository ==
	Create a branch for the release using <code>git branch release/0.3.0</code> (adapt major, minor and build number accordingly.		Create a branch for the release using <code>git branch release/0.3.0</code> (adapt major, minor and build number accordingly.

	Upload the release using <code>git push origin release/0.3.0</code>.		Upload the release using <code>git push origin release/0.3.0</code>.