gazagnaire.org
SpaceOS flight simulator with ISS orbit and telemetry
docs: add README.md for 18 packages missing documentation
Add READMEs for: ocaml-fdir, ocaml-initramfs, ocaml-jailhouse,
ocaml-linkedin, ocaml-openamp, ocaml-pid1, ocaml-rpmsg, ocaml-sbom,
ocaml-slack, ocaml-vz, ocaml-zephyr, space, space-block, space-ground,
space-net, space-sim, space-test, space-wire.
+44
+44
README.md
+44
README.md
···
1
+
# space-sim
2
+
3
+
SpaceOS flight simulator for two-partition demo.
4
+
5
+
`space-sim` is a minimal init process (PID 1) for the flight partition (P0)
6
+
in a SpaceOS two-partition VM setup. It mounts essential filesystems, opens
7
+
a virtio-serial IPC port, and streams continuous telemetry frames to the
8
+
SpaceOS partition. The simulator propagates ISS orbital position using SGP4
9
+
and generates a realistic mix of telemetry (TM), health (HEALTH), and event
10
+
(EVR) frames at approximately 1 Hz.
11
+
12
+
When run outside a VM (not as PID 1), it prints a description of what it
13
+
would do in a real environment.
14
+
15
+
## Installation
16
+
17
+
```
18
+
opam install space-sim
19
+
```
20
+
21
+
## Usage
22
+
23
+
The binary is designed to run as PID 1 inside a guest VM booted by
24
+
`space run`. It is not typically invoked directly.
25
+
26
+
Inside the VM, it:
27
+
28
+
1. Mounts `/proc`, `/sys`, `/dev` via `Pid1.setup_filesystems`
29
+
2. Waits for the `/dev/virtio-ports/ipc` device (5-second timeout)
30
+
3. Propagates the ISS orbit using an embedded TLE and SGP4
31
+
4. Streams a continuous mix of frames over the IPC port:
32
+
- `TM` (APID 0x101): orbital position (lat, lon, alt, velocity)
33
+
- `TM` (APID 0x100, 0x102, 0x103): heartbeat, sensor readings, status
34
+
- `HEALTH` (APID 0x100): CPU, memory, uptime
35
+
- `EVR` (APID 0x200): system events (orbit updates, command acks, watchdog)
36
+
37
+
## API
38
+
39
+
This package is a standalone binary with no public library. It depends on:
40
+
41
+
- **`space-wire`** -- frame encoding via `Space_wire.Msg`
42
+
- **`zephyr`** -- virtio-serial port I/O
43
+
- **`pid1`** -- PID 1 filesystem setup and signal handling
44
+
- **`sgp4`** (via `zephyr`) -- SGP4 orbit propagation