Analogue command set

Top  Previous  Next

To play a signal to an analogue output device (digital-to-analogue converter; DAC), you must create it in a buffer. Just as for audio devices, analogue output buffers are created for a particular output device, so to play the same pattern on multiple DACs, create a buffer for each one. Unlike audio devices, you may not play back more than one buffer to one DAC at once.

 

AnalogueClaim

Claims analogue lines. (Analogue lines are also supported by the ClaimGroup command.) As a safety feature, when claiming analogue output lines, you may specify the voltage to which they are set if the client relinquishes control (or have the server leave them as they are at that point).

AnalogueSetAlias

Sets aliases for analogue lines.

AnalogueRelinquishAll

Releases control of analogue lines.

AnalogueReadConfig

Allows the channel's configuration state to be read. This allows the user to find out whether the channel is an input or an output channel, the voltage range for the channel (e.g. -1.25V to +1.25V).

AnalogueReadState

Reads an instantaneous voltage value from an analogue input channel (analogue-to-digital converter, or ADC).

AnalogueSetState

Sets a digital-to-analogue converter (DAC) to a specified voltage, and cancels any ongoing waveform playback.

AnalogueSampleSignal

Samples an input and/or output line repeatedly, capturing input values from the ADC (and logging values sent simultaneously to the DAC if desired). Data may be reported back over the TCP link and/or logged directly to disk. Use Whisker's other data-logging facilities to record other types of event simultaneously.

AnalogueCancelSample

Cancels channel sampling.

AnalogueRequestEvent

Sets up event notification on an analogue input or output line. You can request notification when the voltage exceeds or falls below a threshold, or enters a specified range of values.

AnalogueKillEvent

Kills an event by its event name.

AnalogueKillEventByLine

Kills an event for a given analogue line.

AnalogueKillAllEvents

Kills all analogue events.

AnalogueCreateBuffer

Creates a buffer by specifying all the necessary values.

AnalogueLoadBuffer

Loads a buffer from a data file.

AnaloguePlayBuffer

Sends a pattern of voltages to the DAC from a buffer held in memory; optionally, the buffer may be played a set number of times, or cyclically until stopped. Note that when a buffer stops playing (when it is not being played cyclically and it finishes, or when it is aborted), the DAC is held at the voltage currently being 'played'. Buffers should therefore finish on a sensible final voltage value (often, but not necessarily, 0 V), and if you abort a buffer prematurely, you should follow the aborting command with an AnalogueSetState command to ensure the DAC is producing a sensible voltage. Only one buffer may be played to the DAC at once.

AnalogueStopPlayback

Stops playback on a given channel.

AnalogueDeleteBuffer

Deletes a buffer entirely.

AnalogueDeleteAllBuffers

Deletes all buffers in memory.