Skip to content

cli.rst

Latest commit

 

History

History
50 lines (36 loc) · 1.73 KB

cli.rst

File metadata and controls

50 lines (36 loc) · 1.73 KB
Raw

Command-line reference

Run pyvantagepro --help or pyvantagepro COMMAND --help for the installed CLI. All commands accept --timeout SECONDS (default 10) and --debug after the command name. Debug logging exposes protocol traffic.

Read commands

pyvantagepro gettime tcp:127.0.0.1:22222
pyvantagepro getinfo tcp:127.0.0.1:22222
pyvantagepro getbar tcp:127.0.0.1:22222
pyvantagepro getperiod tcp:127.0.0.1:22222
pyvantagepro getdata tcp:127.0.0.1:22222 --output live.csv

getdata writes one raw observation as CSV with a header. --delim selects the separator; the default is a comma. Use normalized Python API methods when SI conversion is required.

Archives and incremental CSV

pyvantagepro getarchives tcp:127.0.0.1:22222 \
  --start "2026-02-19 00:00" --stop "2026-02-19 23:59" \
  --output archives.csv --delim ";"
pyvantagepro update tcp:127.0.0.1:22222 archives.csv --delim ";"

Dates use YYYY-MM-DD HH:MM. Omit either boundary for its default. update creates a missing database file or uses the latest existing Datetime value to request subsequent archive data and append rows. Keep the delimiter and schema consistent with the existing file. Use one writer per CSV file and retain backups of long-running archives.

Use --output for archive CSV files: progress and record-count messages also go to the terminal, so redirecting stdout can mix them with data.

Configuration commands

These commands change the station:

pyvantagepro settime tcp:127.0.0.1:22222 "2026-02-19 12:30"
pyvantagepro setperiod tcp:127.0.0.1:22222 10

Valid archive periods are 1, 5, 10, 15, 30, 60 and 120 minutes.