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
equser plot data.parquet --cpow -o ./plots
| Option | Description |
|---|---|
--pmon | Force interpretation as PMon data |
--cpow | Force interpretation as CPOW waveform data |
-o, --output | Output directory for the generated SVG file(s) (default: alongside the input file) |
Automatically detects the file type from the Parquet schema if --pmon or
--cpow is not specified. Writes one or more SVG files (voltage, current,
power, frequency for PMon; a waveform plot for CPOW).
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 notebooks path
Print the install location of the bundled notebooks directory, or the path to a
single notebook. Useful for locating the notebooks inside site-packages after
pip install.
equser notebooks path
equser notebooks path tutorials/01-parquet-files.ipynb
The in-code equivalent is equser.notebooks.get_notebooks_dir().
equser notebooks launch
Copy the bundled notebooks to a directory and open JupyterLab there. Requires
the [jupyter] extra.
equser notebooks launch
equser notebooks launch --dest ./equser-notebooks --overwrite
| Option | Description |
|---|---|
--dest | Destination directory (default: ./equser-notebooks) |
--overwrite | Overwrite existing files |
--no-browser | Do not open a browser window |
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: 80) |
--duration | Capture duration in seconds (default: 5.0) |
--output | Output Parquet file path (auto-generated if omitted) |
Tab completion
Tab completion is available via argcomplete (included in the base install):
eval "$(register-python-argcomplete equser)"
Add the eval line to your shell profile (e.g. ~/.bashrc) for persistent
completion.