Mseo test

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: CSH CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  ci:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libcurl4-openssl-dev libzmq3-dev libsocketcan-dev libpython3-dev 
+      - name: Install gcovr
+        run: pip3 install gcovr==8.3 meson==1.8.1
+      - name: Build
+        run: ./configure -Db_coverage=true && ninja -C builddir -v
+      - name: Run gcovr
+        run: ninja -C builddir test coverage-text && tail -n3 builddir/meson-logs/coverage.txt

.gitmodules

@@ -1,27 +1,21 @@
 [submodule "lib/libcsp"]
   path = lib/csp
   url = https://github.com/spaceinventor/libcsp
+  branch = master     
+[submodule "lib/libparam"]
+  path = lib/param
+  url = https://github.com/spaceinventor/libparam
   branch = master
 [submodule "lib/slash"]
   path = lib/slash
   url = https://github.com/spaceinventor/slash
   branch = master
-[submodule "lib/yaml"]
-	path = lib/yaml
-	url = https://github.com/yaml/libyaml.git
-[submodule "lib/csp_proc"]
-	path = lib/csp_proc
-	url = https://github.com/discosat/csp_proc.git
-[submodule "lib/param"]
-	path = lib/param
-	url = https://github.com/spaceinventor/libparam
-	branch = master
-[submodule "lib/csp_ippc"]
-	path = lib/csp_ippc
-	url = https://github.com/discosat/csp_ippc.git
 [submodule "lib/apm"]
 	path = lib/apm_csh
 	url = https://github.com/spaceinventor/libapm_csh
 [submodule "lib/pycsh_core"]
 	path = lib/pycsh_core
 	url = https://github.com/spaceinventor/pycsh_core.git
+[submodule "lib/ossi"]
+	path = lib/ossi
+	url = https://github.com/spaceinventor/libossi.git

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
 	"mesonbuild.buildFolder": "builddir",
 	"mesonbuild.configureOnOpen": false,
+	"mesonbuild.modifySettings": false,
 	"files.associations": {
 		"*.h": "c",
 		"*.c": "c",

README.md

@@ -17,22 +17,18 @@ Preferrably, you should use the provided Ubuntu Packages from Github's [Release
 
 ## Build
 
-Requirements: libcurl4-openssl-dev build-essential, libsocketcan-dev, can-utils, libzmq3-dev, libyaml-dev, meson, ninja, pkg-config, fonts-powerline, python3-pip, libelf-dev, libbsd-dev libprotobuf-c-dev
+![build.yml status](https://github.com/spaceinventor/csh/actions/workflows/build.yml/badge.svg)
 
-```
-sudo apt install libcurl4-openssl-dev git build-essential libsocketcan-dev can-utils libzmq3-dev libyaml-dev pkg-config fonts-powerline python3-pip libelf-dev libbsd-dev libprotobuf-c-dev
-sudo pip3 install meson ninja
-```
+Requirements: libcurl4-openssl-dev build-essential, libsocketcan-dev, can-utils, libzmq3-dev, libyaml-dev, meson, ninja, pkg-config, fonts-powerline, python3-pip, libelf-dev, libbsd-dev
 
-Sometimes needed:
 ```
-link /usr/sbin/ninja /usr/local/lib/python3.5/dist-packages/ninja
-export PATH=~/.local/bin:$PATH
+sudo apt install libcurl4-openssl-dev git build-essential libsocketcan-dev can-utils libzmq3-dev libyaml-dev pkg-config fonts-powerline pipx libelf-dev libbsd-dev python3-dev
+pipx install meson
 ```
 
 Build:
 ```
-git clone --recurse-submodules https://github.com/discosat/csh.git
+git clone --recurse-submodules https://github.com/spaceinventor/csh.git
 cd csh
 ./configure
 ./install
@@ -79,6 +75,28 @@ wsl --install
 After a reboot, you can then start the application WSL to get a virtual Ubuntu environment and follow the guidelines for installing CSH in Linux as above. Windows by default does not forward USB devices to WSL entities. To enable USB forwarding, follow the guide in https://learn.microsoft.com/en-us/windows/wsl/connect-usb.
 
 
+## Testing
+
+Host tests live in `tests/` and run through meson:
+
+```
+meson test -C builddir                  # whole suite
+meson test -C builddir hk_sniffer_tests # one test
+```
+
+`hk_sniffer_tests` is a regression for a `size_t` underflow in `hk_param_sniffer()`:
+a short packet on source port 13 (e.g. a DIPP `ring_size`/`observation_meta` RDP
+reply, which shares sport 13 with HK params) underflowed the param payload length
+and walked the mpack reader off the buffer, segfaulting the param sniffer under
+`prometheus start`. The test feeds the real function such packets and asserts they
+are skipped.
+
+Note: meson build directories are not relocatable. If the tree was first configured
+under a different absolute path (a moved or renamed checkout), `meson setup
+--reconfigure` fails with `FileNotFoundError` on a stale `meson-private` path.
+Recreate the build dir instead of reconfiguring: `rm -rf builddir && ./configure`.
+
+
 ## Extension support
 
 src/slash_apm.c defines a command, apm load, for loading a shared library as an APM, and a command, ap, info, for listing loaded APMs.

doc/MAN/APMs/csh_example.rst

@@ -0,0 +1 @@
+A new APM shall based on a fork of the repository https://github.com/spaceinventor/csh_example. This repository contains a simple APM that registers a custom slash command and a few example parameters, allowing the APM functionality to be remotely operated from other CSP nodes.

doc/MAN/APMs/csh_si.rst

@@ -0,0 +1,72 @@
+Space Inventor is relasing CSH together with an APM called CSH SI that provides commands to interface with Space Inventor hardware. The following documentation describes the commands provided by the CSH SI APM.
+
+**node add**
+
+When loading the APM, this command is extended to include a Space Inventor PDU-P4 node and channel number as arguments. When registering this additional information, CSH is able to power on and off the module by remote controlling the PDU.
+
+The following example shows how to add a Space Inventor OBC module having node 6, connected to channel 2 of a PDU-P4 with the hostname ``pdu1-a``.
+
+.. class:: table
+
+.. list-table::
+   :widths: 100
+   :header-rows: 0
+
+   * - 
+      .. csh-prompt:: host>6> node add -p pdu1-a -c 2 obc
+      .. csh-prompt:: host>obc@6> 
+
+**power on/off**
+
+Having a node registered with PDU information allows the user to power cycle the module remotely using the ``power on`` and ``power off`` commands as shown in the following example. The explicit obc reference can be excluded, but preselcting the node by using ``node obc`` before starting the operations.
+
+.. class:: table
+
+.. list-table::
+   :widths: 100
+   :header-rows: 0
+
+   * - 
+      .. csh-prompt:: host>> power on obc
+      .. csh-prompt:: host>> sleep 1000
+      .. csh-prompt:: host>> ping obc
+         | Ping node 6 size 1 timeout 1000: Reply in 1 [ms]
+      .. csh-prompt:: host>> power off obc
+
+**conf get**
+
+This command receives and stores all persistent configuration parameters from module compliant with Space Inventor Parameter System. Optionally, the command can reboot the module into each available firmware slot to record the firmware version, and perform a list download to create a complete representation of the module configuration.
+
+The command can retrieve the configuration from multiple modules by a single command, by providng a list of nodes separated by commas.
+
+.. class:: table
+
+.. list-table::
+   :widths: 100
+   :header-rows: 0
+
+   * - 
+      .. csh-prompt:: host>bat@8> conf get -r -l
+         |
+         | IDENT 8
+         | bat
+         | samc21 01]
+         | v1.0-32-g61cfbc9
+         | Apr 12 2024 16:04:12
+         |
+         | IDENT 8
+         | bat
+         | samc21 [1]
+         | v1.0-32-g61cfbc9
+         | Apr 12 2024 16:04:46
+         |
+         | Got param: temp:8[1]
+         | Got param: boot_cnt:8[1]
+         | Got param: boot_cur:8[1]
+         | ...
+         | Got param: heater_auto:8[1]
+         | Got param: cell_voltage:8[8]
+         | Got param: bus_current:8[1]
+         |
+         | Configuration is stored into ./configuration and ./paramdefs
+      .. csh-prompt:: host>bat@8>

doc/MAN/APMs/introduction.rst

@@ -0,0 +1,18 @@
+CSH can be extended via Extension Modules (APMs) using C code or python. These modules provide additional commands and features that are not part of the core CSH shell but can be loaded as needed. 
+
+Loading an APM is done by using the ``apm load`` slash command. The command enables the user to load all, or specific APMs available in the system.
+
+.. class:: table
+
+.. list-table::
+   :widths: 100
+   :header-rows: 0
+
+   * - 
+      .. csh-prompt:: host>> apm load
+         | Loaded: /home/tjessen/.local/lib/csh/libcsh_obc.so
+         | Slash command 'node save' is overriding an existing command
+         | Slash command 'node list' is overriding an existing command
+         | Slash command 'node add' is overriding an existing command
+         | Loaded: /home/tjessen/.local/lib/csh/libcsh_si.so
+      .. csh-prompt:: host>> 

doc/MAN/Installation/build.rst

@@ -0,0 +1,22 @@
+As an alternative to installing a released version, in case of required local modifications, or due to a need for features not yet released, the software is available as open source on github.
+
+.. class:: table
+
+.. list-table::
+   :widths: 100
+   :header-rows: 0
+
+   * -
+
+      .. csh-prompt:: >>$ git clone --recurse-submodules https://github.com/spaceinventor/csh.git
+
+      .. csh-prompt:: >>$ cd csh
+
+      .. csh-prompt:: >>$ ./configure
+
+      .. csh-prompt:: >>$ ./install
+
+.. class:: centered
+
+*Clone, configure, build and install software*
+

doc/MAN/Installation/init_config.rst

@@ -1,3 +1,3 @@
-In order to avoid configuring csp and interfaces on every launch an init.csh file can be created. CSH will look for one in your home directory or you can select one at launch with the -i argument. In the init folder, examples can be found for different interface configurations.
-
+In order to avoid configuring csp and interfaces on every launch, an init.csh file can be created. CSH will look for one in your home directory or you can select one at launch with the -i argument. In the init folder, examples can be found for different interface configurations.
 
+Loading the default init.csh file in the home directory can be omitted by providing the -i argument without any filename.

doc/MAN/Installation/install.rst

@@ -1,5 +1,4 @@
-
-The software is available as open source on github.
+The preferred way to aquire the application is by installing a release. Go to https://github.com/spaceinventor/csh/releases/, and download the .deb package matching your Ubuntu LTS OS version. Open a terminal in the folder containing the package, and execute the command
 
 .. class:: table
 
@@ -8,22 +7,9 @@ The software is available as open source on github.
    :header-rows: 0
 
    * -
-
-      .. csh-prompt:: >>$ git clone https://github.com/spaceinventor/csh.git
-
-      .. csh-prompt:: >>$ cd csh
-
-      .. csh-prompt:: >>$ git submodule update --init --recursive
-
-      .. csh-prompt:: >>$ ./configure
-
-      .. csh-prompt:: >>$ ./build
+
+      .. csh-prompt:: >>$ sudo apt install ./si-csh_<Ubuntu_version>_amd64_<CSH_version>.deb
 
 .. class:: centered
 
-*Clone, configure, build and install software*
-
-
-
-
-
+*Install CSH from release version*

doc/MAN/Installation/launch_sw.rst

@@ -11,14 +11,11 @@ In order to launch in shell / interactive mode, start csh without a command. Run
    * -
 
       .. csh-prompt:: >>$ csh -h
-         | usage: csh -i init.csh[command]
+         | usage: csh -i init.csh
+         | In CSH, type 'manual' to access CSH manuals
+         | 
+         | Copyright (c) 2016-2025 Space Inventor A/S <info@space-inventor.com>
       .. csh-prompt:: >>$ csh 
-      .. csh-prompt:: host>> csp init
-         | Version 2
-         | Hostname: lenovo
-         | Model: #36~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Fri   Feb 17 15:17:25 UTC 2
-         | Revision: 5.19.0-35-generic
-         | Deduplication: 3
       .. csh-prompt:: host>>csp add zmq -d 8 localhost
          | ZMQ init ZMQO: addr: 8, pub(tx): [tcp://localhost:6000], sub(rx): [tcp://localhost:7000]
 

doc/MAN/Introduction/description.rst

@@ -1,4 +1,4 @@
-CSH is a Linux program designed to interface to Space Inventor modules and satellites using a CSP interface. With a CAN dongle the PC will perform as a first-class citizen on the satellite bus and have full access to all systems.
+CSH is a Linux application designed to interface to Space Inventor modules and satellites using a CSP interface. With a CAN dongle the PC will perform as a first-class citizen on the satellite bus and have full access to all systems.
 
 After launch, CSH is also used to operate the satellite through the radio interface, utilising CSPs routing functionalities.
 

doc/MAN/Operating_Instructions/builtin_commands.csv

@@ -9,12 +9,9 @@ cmd add,<param>[offset] [value],Add a new parameter to a command
 cmd done,-,Exit cmd edit mode
 cmd new,<get/set> <cmd name>,Create a new command
 cmd run,-,-
-cmd server download,<name>,-
-cmd server list,-,-
-cmd server rm,<name>,-
-cmd server upload,-,-
 confirm,-,Block until user confirmation
 crc32,<address> <length>,Calculate CRC32 on a VMEM area
+csp add alias,-,Add a new Alias address
 csp add can,-,Add a new CAN interface
 csp add eth,-,Add a new Ethernet interface
 csp add kiss,-,Add a new KISS/UART interface
@@ -25,6 +22,7 @@ csp add zmq,-,Add a new ZMQ interface
 csp init,-,Initialize CSP
 csp scan,-,-
 download,<address> <length> <file>,Download from VMEM to FILE
+echo,[string],Display a line of text
 eth debug,-,Toggle ethernet debugging
 eth info,-,List devices
 exit,-,Exit application
@@ -44,7 +42,7 @@ list save,-,Save parameters
 loki start,-,Start Loki log push thread
 ls,[path],list files
 manual,[manual pdf],"Show CSH documentation, use with no parameter to get the list of available manuals."
-node,[node],Set global default node
+node,node,Set global default node
 node add,-,-
 node list,-,Save or print known nodes
 node save,-,Save or print known nodes
@@ -53,13 +51,19 @@ ping,[node],Ping a system
 poke,<address> <data>,Poke
 program,<slot>,Upload new firmware
 prometheus start,-,Start prometheus webserver
-pull,[OPTIONS],Pull all metrics from given CSP node(s)
+pull,-,Pull all metrics from given CSP node(s)
 pwd,-,Print current working directory
 python,[(-c <python_string>|<filename>) [args...]],"Starts an interactive Python interpreter in the current CSH process
 or execute the script in given file.
 This allows you to run pretty much any Python code, particularly code using PyCSH which allows for interacting
 with CSP nodes.
 
+Use ""Control-D"" to exit the interpreter and return to CSH."
+python3,[(-c <python_string>|<filename>) [args...]],"Starts an interactive Python interpreter in the current CSH process
+or execute the script in given file.
+This allows you to run pretty much any Python code, particularly code using PyCSH which allows for interacting
+with CSP nodes.
+
 Use ""Control-D"" to exit the interpreter and return to CSH."
 rdp opt,-,Set RDP options to use in stream and file transfers
 reboot,[node],Reboot a node
@@ -80,12 +84,6 @@ Sets the following environment variables during execution:
 
 - __FILE__ to the path and name of the executed file
 - __FILE_DIR__ to the directory containing the executed file, useful for running other files located relative to __FILE__"
-schedule cmd,-,-
-schedule list,-,-
-schedule push,-,-
-schedule reset,<server> <last id> [timeout],-
-schedule rm,<server> <id> [timeout],-
-schedule show,-,-
 set,<param> <value>,Set
 shutdown,[node],Shutdown a node
 sleep,<sleep ms>,Sleep the specified amount of milliseconds
@@ -107,5 +105,7 @@ version,-,Print CSH version (and date if verbose)
 vm start,-,Start Victoria Metrics push thread
 vm stop,-,Stop Victoria Metrics push thread
 vmem,-,List virtual memory
+vmem compress,<src_address> <dst_address> <length>,Perform compression from src into dst
+vmem decompress,<src_address> <dst_address> <length>,Perform decompression from src into dst
 vts init,-,Push data to VTS
 watch,<command...>,Repeat a command