CLI Reference
equser provides a command-line interface for common operations.
Usage
equser <command> [options]
Commands
equser pmon acquire
Start power monitoring from an EQ Wave sensor. Requires [daq] extra and
physical sensor hardware.
equser pmon acquire -c config.yaml
| Option | Description |
|---|---|
-c, --config | Path to YAML configuration file |
Reads 10/12-cycle RMS measurements and writes Parquet files to the configured data directory. Runs continuously until interrupted (Ctrl+C).
equser pmon convert
Convert Avro data files to Parquet format. Requires [daq] extra.
equser pmon convert data/*.avro
equser pmon convert data/*.avro --remove
| Option | Description |
|---|---|
--remove | Delete source Avro files after successful conversion |
equser plot
Plot a PMon or CPOW data file. Requires [analysis] extra.
equser plot data.parquet
Automatically detects the file type (PMon vs. CPOW) and uses the appropriate plotter.
equser notebooks list
List the reference notebooks bundled in the equser package.
equser notebooks list
equser notebooks copy
Copy reference notebooks to a directory.
equser notebooks copy --dest ./notebooks
equser notebooks copy --dest ./notebooks --category tutorials
equser notebooks copy --dest ./notebooks --overwrite
| Option | Description |
|---|---|
--dest | Destination directory (default: current directory) |
--category | Only copy notebooks from this category (tutorials or analysis) |
--overwrite | Overwrite existing files |
equser snapshot
Capture live waveform data from a gateway and save to a Parquet file.
equser snapshot
equser snapshot --host 192.168.1.10 --duration 10 --output capture.parquet
| Option | Description |
|---|---|
--host | Gateway hostname or IP (default: localhost) |
--port | Gateway port (default: 8080) |
--duration | Capture duration in seconds (default: 5.0) |
--output | Output Parquet file path (auto-generated if omitted) |
Tab completion
Install tab completion with the [cli] extra:
pip install equser[cli]
eval "$(register-python-argcomplete equser)"
Add the eval line to your shell profile for persistent completion.