From 75f16c1a563d4b5e7a9ec74a7d8f9244db18b33f Mon Sep 17 00:00:00 2001 From: Mike Langmayr <1809691+mikelangmayr@users.noreply.github.com> Date: Tue, 15 Sep 2026 15:05:14 -0700 Subject: [PATCH] Document INTERFACE_TYPE as the emulator selector --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 077484c..46fd110 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ If you encounter any problems or have questions about this project, please open $ cmake -DCONTROLLER=archon -DINSTRUMENT=hispec_tracking_camera .. ``` + `-DINTERFACE_TYPE=` is separate from `-DCONTROLLER=` and selects only which emulator is built. It defaults to `Archon`; `-DINTERFACE_TYPE=AstroCam` skips the emulator, since none is implemented for ARC. + To enable the shared-memory output (`SHM_ENABLED` in a `.cfg` file, see [Frame Outputs](#frame-outputs) below), add `-DENABLE_SHM_OUTPUT=ON -DImageStreamIO_DIR=/lib/cmake`: ```bash @@ -106,7 +108,7 @@ If you encounter any problems or have questions about this project, please open $ ../bin/emulator -i ``` - The emulator reads `EMULATOR_PORT` and `EMULATOR_SYSTEM` from the same `.cfg` the server uses, so point `ARCHON_IP`/`ARCHON_PORT` at it to run without hardware. `-i generic` suits the shipped test configs. It is built only for `-DCONTROLLER=archon`. + The emulator reads `EMULATOR_PORT` and `EMULATOR_SYSTEM` from the same `.cfg` the server uses, so point `ARCHON_IP`/`ARCHON_PORT` at it to run without hardware. `-i generic` suits the shipped test configs. 7. **(Optional) Run Unit Tests.** The tests are excluded from the default target, so build them first: