`spinfo`

✅ Verified · no code on this page ·

The badge reports the whole docs-verify suite, not this chapter alone.

Print a PV's type structure without fetching its value. The equivalent of EPICS Base pvinfo.

spinfo [OPTIONS] [PV]

Requires the client feature. Uses the CMD_GET_FIELD (0x11) protocol command, so the server answers with an introspection description and no data.

Flags beyond the shared set

Flag	Meaning
`-f`, `--field PATH`	inspect a sub-field, e.g. `value` or `alarm.severity`
`-t`, `--terse`	one-line type summary instead of the tree

Output

$ spinfo VAC:SETPOINT
VAC:SETPOINT:
struct epics:nt/NTScalar:1.0
value: double
alarm: structure
  severity: int
  status: int
  message: string
timeStamp: structure
  secondsPastEpoch: long
  nanoseconds: int
  userTag: int
display: structure
  limitLow: double
  limitHigh: double
  description: string
  units: string
  precision: int
  form: structure
    index: int
    choices: string[]
control: structure
  limitLow: double
  limitHigh: double
  minStep: double
valueAlarm: structure
  active: boolean
  lowAlarmLimit: double
  lowWarningLimit: double
  highWarningLimit: double
  highAlarmLimit: double

What it is good for

Confirming the normative type. The first line is the type ID. If a client library refuses a PV, this tells you whether the server is really sending epics:nt/NTScalar:1.0 or something else.

Seeing metadata that is published but unused. The valueAlarm block above exists because the record was built with .alarm_limits(...). The limits are on the wire, and spinfo proves it — but the server never compares the value against them. That distinction is the subject of Alarms, and spinfo is how you tell the two cases apart.

Working out what -F can ask for. The dotted paths in spget -F and spmonitor -F are exactly the paths in this tree.

Keyboard shortcuts

Spvirit

spinfo

Flags beyond the shared set

Output

What it is good for

`spinfo`