CLI Usage¶
Refer to the following page for details regarding stream_daq device config files.
mio¶
Miniscope IO CLI Interface
mio [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
stream¶
Command group for StreamDaq
mio stream [OPTIONS] COMMAND [ARGS]...
capture¶
Capture video from a StreamDaq device, optionally saving as an encoded video or as raw binary
mio stream capture [OPTIONS]
Options
- -c, --device_config <device_config>¶
Required Path to device config YAML file for streamDaq (see models.stream.StreamDevConfig)
- -m, --metadata_display¶
Display metadata in real time. WARNING: This is still an EXPERIMENTAL feature and is UNSTABLE.
- -b, --binary_export¶
Save binary to a .bin file
- --no-display¶
Don’t show video in real time
- -ok, --output-kwarg <okwarg>¶
Output kwargs (passed to StreamDaq.init_video). passed as (potentially multiple) calls like
mio stream capture -ok key1 val1 -ok key2 val2
- -o, --output <output>¶
Output file basename for video, metadata, and binary exports
test¶
Run StreamDaq in testing mode, using the okDevMock rather than the actual device
mio stream test [OPTIONS]
Options
- -c, --device_config <device_config>¶
Required Path to device config YAML file for streamDaq (see models.stream.StreamDevConfig)
- -s, --source <source>¶
Required Path to RAW FPGA data to plug into okDevMock
- -p, --profile¶
Run with profiler (not implemented yet)
- -m, --metadata_display¶
Display metadata in real time. WARNING: This is still an EXPERIMENTAL feature and is UNSTABLE.
- -b, --binary_export¶
Save binary to a .bin file
- --no-display¶
Don’t show video in real time
- -ok, --output-kwarg <okwarg>¶
Output kwargs (passed to StreamDaq.init_video). passed as (potentially multiple) calls like
mio stream capture -ok key1 val1 -ok key2 val2
- -o, --output <output>¶
Output file basename for video, metadata, and binary exports