CLI Reference

This page provides documentation for our command line tools.

cli

OpenSAMPL data collection tools.

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

microchip

Microchip device collection tools.

Usage:

cli microchip [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

tp4100

Collect time data from Microchip TimeProvider 4100 devices.

This tool connects to TP4100 devices via their web interface and collects performance metrics and time data.

Usage:

cli microchip tp4100 [OPTIONS]

Options:

  -h, --host TEXT                 IP address or hostname of the TP4100 device
                                  [required]
  -p, --port INTEGER              Port number for HTTPS connection (default:
                                  443)
  -o, --output-dir TEXT           Directory path where collected data will be
                                  saved (default: ./output)
  -d, --duration INTEGER          Duration in seconds for data collection
                                  (default: 600)
  -c, --channels TEXT             Specific channels to collect data from (can
                                  be specified multiple times)
  -m, --metrics TEXT              Specific metrics to collect (can be
                                  specified multiple times)
  --method [chart_data|download_file]
                                  Collection method: "chart_data" for chart
                                  data for last (duration) seconds or
                                  "download_file" for previous 24h files
                                  (default: chart_data)
  --save-full-status              Save full status information to json
  -v, --verbose                   Verbose, keeps debug logs
  --help                          Show this message and exit.

twst

Collect data from Microchip TWST modems.

This command connects to TWST modems via IP address to collect measurement data including offset and EBNO tracking values, along with contextual information. Data is saved to CSV files with YAML metadata headers for comprehensive data logging.

Examples: opensampl-collect microchip twst --ip 192.168.1.100 opensampl-collect microchip twst --ip 192.168.1.100 --dump-interval 600 --total-duration 3600

Usage:

cli microchip twst [OPTIONS]

Options:

  --ip TEXT                 IP address of the modem  [required]
  --control-port INTEGER    Control port of the modem (default: 1700)
  --status-port INTEGER     Status port of the modem (default: 1900)
  --dump-interval INTEGER   Duration between file dumps in seconds (default:
                            300 = 5 minutes)
  --total-duration INTEGER  Total duration to run in seconds (default: run
                            indefinitely)
  --output-dir TEXT         Output directory for CSV files (default: ./output)
  --help                    Show this message and exit.