VMUSB slow controls protocol

Name

VMUSB Slow controls protocol -- VMUSB Slow controls protocol

Synopsis

Set module-name parameter-name value

Get module-name parameter-name

mon module-name

DESCRIPTION

The slow controls protocol allows control panel software to be built that communicates with slow controls drivers in the VM-USB raadout framework. This is intended to allow the contruction of control panels for devices that have slow controls drivers. Note that the vmusb controller allows drivers to be written for devices that don't have slow controls drivers yet.

The slow controls server listens for connections on the port specified by the Readout program's --port option or 27000 if that option is not specified.

Connected clients send commands to the server as lines of text and get back singe line replies. Replies are expected to begin with OK if the request was successful and ERROR otherwise. The text that follows the header text depends on the driver.

COMMANDS

Set module-name module-parameter value

Attempts to set a parameter module-parameter in a module module-name to a new value.

module-name is the name of a module that has been defined by the control configuration file. module-parameter is a parameter that must be recognized by the driver that manage that module. value must be a valid new value for that parameter.

Get module-name module-parameter

Retrives a parameter (module-parameter) from a module (module-name).

module-name is the name of a module that has been defined by the control configuration file. module-parameter is a parameter that must be recognized by the driver that manage that module. It is entirely up to the module driver to decide what is returned, however by convention, as described above, the string returned will begin either with OK or ERROR.

mon module-name

Returns data that is monitored by the device. Again it is up to the driver to decide exactly what should be returned.