WaveForms™ provides an interface that allows users to interact with Digilent Analog Design hardware, such as the Analog Discovery™ and Electronics Explorer™. While the WaveForms application offers a refined graphical interface, the WaveForms SDK provides access to a public application programming interface (API) that gives users the ability to create custom PC applications. This WaveForms SDK manual describes the main components and architecture of the WaveForms system and details each function contained in the WaveForms API. The SDK package also offers examples demonstrating how to identify, connect to, and control analog hardware devices. The WaveForms software, as well as the SDK, can be downloaded for free at the Digilent website.

The WaveForms system is comprised of multiple components. The most visible component is the WaveForms Application; a suite of graphical instrument panels that give full access to the analog and digital instruments in the connected hardware. The WaveForms application uses the WaveForms Runtime to control all signal generation and acquisition. The WaveForms Runtime is comprised of the DWF Dynamic Library and several configuration files. This library is located in:

• Windows in System Directory: C: \Windows\System32\dwf.dll
• Linux: /usr/lib/libdwf.so.x.x.x

The static library is located on Windows in the install path:

• Windows 32bit: C:\Program Files\Digilent\WaveFormsSDK\lib\x86
• Windows 64bit: C:\Program Files (x86)\Digilent\WaveFormsSDK\lib\x64

The C header file is located in:

• Windows: C:\Program Files\Digilent\WaveFormsSDK\inc
• Windows 64bit: C:\Program Files (x86)\Digilent\WaveFormsSDK\inc
• Linux: /usr/local/include/digilent/waveforms

Working code examples are provided with the SDK to demonstrate basic use of each API function set. You can find samples in the installation directory, which are located here:

• Windows 32bit: C:\Program Files\Digilent\WaveFormsSDK\samples
• Windows 64bit: C:\Program Files (x86)\Digilent\WaveFormsSDK\samples
• Linux: /usr/local/share/digilent/waveforms/samples

The DWF Library uses the Adept Runtime, which provides basic communication with the targeted hardware instruments (i.e. Analog Discovery and Electronics Explorer). Although the Adept Runtime is an integral part of the WaveForms System, knowledge of its structure is not required to write custom applications.

The requirements for Linux version are the libusb-1.0-0, Digilent Adept Runtime, and the included FTDI drivers:

$ sudo apt-get install linusb-1.0-0 digilent.adept.runtime_#/ftdi.drivers_# $ sudo bash install.sh digilent.adept.runtime_# $ sudo bash install.sh

Everything needed to write custom applications is included in the WaveForms SDK, which provides the header/library files and documentation to access the API for the DWF Library. A custom application must properly link to these files to make the appropriate API function calls. Every function in the WaveForms public API is declared in the dwf.h header file.

Basic usage of the WaveForms API can be broken down into the following steps:

1. Call enumeration functions to discover connected hardware devices.
2. Call FDwfDeviceOpen function to establish a connection to specific hardware device.
3. Call function to enable instrument within hardware device.
4. Call functions to configure instrument and acquire/generate signals.
5. Call function to disable instrument.
6. Call FDwfDeviceClose function to disconnect from device.

There are nine main groups of API functions, each named with different prefixes:

Each instrument is directly controlled using three types of functions in the API:

Note: Although there are multiple “Status” functions for each instrument, these functions are the only ones that actually read data from the device.

There are a number of type definitions and corresponding constants in the dwf.h include file. The majority of them are used as parameters. When a hardware device is opened, a handle is returned (HDWF), which is used to access and finally close in all instrument API functions.

The API functions are C style and return a Boolean value: TRUE if the call is successful, FALSE if unsuccessful. This Boolean value is an integer type definition, not the standard c-type bool. In general, the API functions contain variations of the following parameters:

The API functions won’t fail when a parameter pointer is NULL or when a setting (*Set) parameter value is out of limits. To verify the actual setting value, use the *Get API return the actual value.

The supported discrete parameters are retrieved in bit field value. To decode the capabilities of the device use the IsBitSet macro. int fsfilter; FDwfAnalogInChannelFilterInfo(h, &fsfilter) if(IsBitSet(fsfilter, filterAverage)){ FDwfAnalogInChannelFilterSet(hdwf, 0, filterAverage) }

The function above is used to retrieve the last error code in the calling process. The error code is cleared when other API functions are called and is only set when an API function fails during execution. Error codes are declared in dwf.h:

The function above is used to retrieve the last error message. This may consist of a chain of messages, separated by a new line character, that describe the events leading to the failure.

The function above is used to retrieve the version string. The version string is composed of major, minor, and build numbers (i.e. “2.0.19”).

The FDwfEnum functions are used to discover all connected, compatible devices.

Calling the function above will build an internal list of detected devices filtered by the enumfilter parameter. The function above must be called before using other FDwfEnum functions because they obtain information about enumerated devices from this list identified by the device index.

The function above is used to return the device ID and version ID.

The function above is used to retrieve a Boolean specifying if a device is already opened by this, or any other process.

The function above is used to retrieve the user name of the enumerated device. 

The function above is used to retrieve the device name of the enumerated device.

The function above is used to retrieve the 12-digit, unique serial number of the enumerated device.

The function above opens a device identified by the enumeration index and retrieves a handle. To automatically enumerate all connected devices and open the first discovered device, use index -1.

The function above is used to close an interface handle when access to the device is no longer needed. Once the function above has returned, the specified interface handle can no longer be used to access the device.

The function above is used to close all opened devices by the calling process. It does not close all devices across all processes.

The function above enables or disables the AutoConfig setting for a specific device. When this setting is enabled, the device is automatically configured every time an instrument parameter is set. For example, when AutoConfigure is enabled, FDwfAnalogOutConfigure does not need to be called after FDwfAnalogOutRunSet. This adds latency to every Set function; just as much latency as calling the corresponding Configure function directly afterward.

The function above returns the AutoConfig setting in the device. See the function description for FDwfDeviceAutoConfigureSet for details on this setting.

The function above resets and configures all device and instrument parameters to default values.

The function above returns the supported trigger source options for the global trigger bus. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the TRIGSRC constants in dwf.h.

The global trigger bus allows multiple instruments to trigger each other. These trigger source options are:

The function above is used to configure the trigger I/O pin with a specific TRIGSRC option.

The function above returns the configured trigger setting for a trigger I/O pin. The trigger source can be “none”, an internal instrument, or an external trigger.

The function above generates one pulse on the PC trigger line.

The Analog In instrument states:

The states are defined in dwf.h DwfState type.

Ready: Initial state. After FDwfAnalogInConfigure or any FDwfAnalogIn*Set function call goes to this state. With FDwfAnalogInConfigure, reconfigure goes to Configure state.

Configure: The needed configurations are performed and auto trigger is reset.

Prefill: Prefills the buffer with samples needed before trigger.

Armed: Waits for the trigger.

Running:

• Single acquisition mode: remains in this state to acquire samples after trigger according trigger position parameter.
• Scan screen and shift modes: remains in this state until configure or any set function of this instrument.
• Record mode: the time period according record length parameter.

Done: Final state.

The function above resets and configures all AnalogIn instrument parameters to default values. 

The function above is used to configure the instrument and start or stop the acquisition. To reset the Auto trigger timeout, set fReconfigure to TRUE.

The function above is used to check the state of the acquisition. To read the data from the device, set fReadData to TRUE. For single acquisition mode, the data will be read only when the acquisition is finished.

Note: To ensure simultaneity of information and data, all of the following AnalogInStatus* functions do not communicate with the device. These functions only return information and data from the last FDwfAnalogInStatus call.

The function above is used to retrieve the number of samples left in the acquisition.

The function above is used to retrieve the number of valid/acquired data samples.

The function above is used to retrieve the buffer write pointer. This is needed in ScanScreen acquisition mode to display the scan bar.

The function above is used to verify if the acquisition is auto triggered.

The function above is used to retrieve the acquired data samples from the specified idxChannel on the AnalogIn instrument. It copies the data samples to the provided buffer.

The function above gets the last ADC conversion sample from the specified idxChannel on the AnalogIn instrument.

The function above is used to retrieve information about the recording process. The data loss occurs when the device acquisition is faster than the read process to PC. In this case, the device recording buffer is filled and data samples are overwritten. Corrupt samples indicate that the samples have been overwritten by the acquisition process during the previous read. In this case, try optimizing the loop process for faster execution or reduce the acquisition frequency or record length to be less than or equal to the device buffer size (record length ⇐ buffer size/frequency).

The function above is used to set the Record length in seconds.

The function above is used to get the current Record length in seconds.

The function above is used to retrieve the minimum and maximum (ADC frequency) settable sample frequency.

The function above is used to set the sample frequency for the instrument. 

The function above is used to read the configured sample frequency. The AnalogIn ADC always runs at maximum frequency, but the method in which the samples are stored in the buffer can be individually configured for each channel with FDwfAnalogInChannelFilterSet function.

The function above is used to retrieve the number bits used by the AnalogIn ADC.

The function above returns the minimum and maximum allowable buffer sizes for the instrument.

The function above is used to adjust the AnalogIn instrument buffer size.

The function above returns the used AnalogIn instrument buffer size.

The function above returns the supported AnalogIn acquisition modes. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the ACQMODE constants in dwf.h. The acquisition mode selects one of the following modes, ACQMODE:

The function above is used to set the acquisition mode.

The function above is used to get retrieve the acquisition mode. 

The oscilloscope channel settings are identical across all channels.

The function above is used to read the number of AnalogIn channels of the device.

The function above is used to enable or disable the specified AnalogIn channel.

The function above is used to get the current enable/disable status of the specified AnalogIn channel.

The function above returns the supported acquisition filters. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the FILTER constants in dwf.h. When the acquisition frequency (FDwfAnalogInFrequencySet) is less than the ADC frequency (maximum acquisition frequency), the samples can be stored in one of the following ways using FILTER:

• filterDecimate: Store every Nth ADC conversion, where N = ADC frequency /acquisition frequency.
• filterAverage: Store the average of N ADC conversions.
• filterMinMax: Store interleaved, the minimum and maximum values, of 2xN conversions.

The function above is used to set the acquisition filter for each AnalogIn channel. With channel index -1, each enabled AnalogIn channel filter will be configured to use the same, new option.

The function above returns the configured acquisition filter.

The function above returns the minimum and maximum range, peak to peak values, and the number of adjustable steps.

The function above is used to read the range of steps supported by the device. For instance: 1, 2, 5, 10, etc. 

The function above is used to configure the range for each channel. With channel index -1, each enabled Analog In channel range will be configured to the same, new value.

The function above returns the real range value for the given channel.

The function above returns the minimum and maximum offset levels supported, and the number of adjustable steps.

The function above is used to configure the offset for each channel. When channel index is specified as -1, each enabled AnalogIn channel offset will be configured to the same level. 

The function above returns for each AnalogIn channel the real offset level.

The trigger is used for Single and Record acquisitions. For ScanScreen and ScanShift, the trigger is ignored. To achieve the classical trigger types:

• None: Set FDwfAnalogInTriggerSourceSet to trigsrcNone.
• Auto: Set FDwfAnalogInTriggerSourceSet to something other than trigsrcNone, such as trigsrcDetectorAnalogIn and FDwfAnalogInTriggerAutoTimeoutSet to other than zero.
• Normal: Set FDwfAnalogInTriggerSourceSet to something other than trigsrcNone, such as trigsrcDetectorAnalogIn or FDwfAnalogInTriggerAutoTimeoutSet to zero.

The function above returns the supported trigger source options for the AnalogIn instrument. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the TRIGSRC constants in dwf.h. For more detail regarding these constants, see the description of FDwfDeviceTriggerInfo.

The function above is used to configure the AnalogIn acquisition trigger source.

The function above returns the configured trigger source. The trigger source can be “none” or an internal instrument or external trigger. To use the trigger on AnalogIn channels (edge, pulse, etc.), use trigsrcDetectorAnalogIn.

The function above returns the minimum and maximum values of the trigger position in seconds. The horizontal trigger position is used for Single acquisition mode and it is relative to the buffer middle point.

The function above is used to configure the horizontal trigger position in seconds.

The function above returns the configured trigger position in seconds.

The function above returns the minimum and maximum auto trigger timeout values, and the number of adjustable steps. The acquisition is auto triggered when the specified time elapses. With zero value the timeout is disabled, performing “Normal” acquisitions.

The function above is used to configure the auto trigger timeout value in seconds.

The function above returns the configured auto trigger timeout value in seconds.

The function above returns the supported range of the trigger Hold-Off time in Seconds. The trigger hold-off is an adjustable period of time during which the acquisition will not trigger. This feature is used when you are triggering on burst waveform shapes, so the oscilloscope triggers only on the first eligible trigger point. 

The function above is used to set the trigger hold-off for the AnalongIn instrument in Seconds.

The function above is used to get the current trigger hold-off for the AnalongIn instrument in Seconds.

The following functions configure the trigger detector on analog in channels. To use this set trigger source with FDwfAnalogInTriggerSourceSet to trigsrcDetectorAnalogIn.

The function above returns the supported trigger type options for the instrument. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the TRIGTYPE constants in dwf.h. These trigger type options are:

• trigtypeEdge: trigger on rising or falling edge. This is the default setting.
• trigtypePulse: trigger on positive or negative; less, timeout or more pulse lengths
• trigtypeTransition: trigger on rising or falling; less, timeout or more transition times

The function above is used to set the trigger type for the instrument.

The function above is used to get the current trigger type for the instrument.

The function above returns the range of channels that can be triggered on.

The function above is used to set the trigger channel.

The function above is used to retrieve the current trigger channel index. 

The function above returns the supported trigger filters. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the FILTER constants in DWF.h. Select trigger detector sample source, FILTER:

• filterDecimate: Looks for trigger in each ADC conversion, can detect glitches.
• filterAverage: Looks for trigger only in average of N samples, given by FDwfAnalogInFrequencySet.

The function above is used to set the trigger filter.

The function above is used to get the trigger filter.

The function above returns the supported trigger type options for the instrument. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the TRIGCOND constants in dwf.h. These trigger condition options are:

trigcondRisingPositive (This is the default setting):

• For edge and transition trigger on rising edge.
• For pulse trigger on positive pulse.

trigcondFallingNegative:

• For edge and transition trigger on falling edge.
• For pulse trigger on negative pulse.

The function above is used to set the trigger condition for the instrument.

The function above is used to set the trigger condition for the instrument.

The function above is used to retrieve the range of valid trigger voltage levels for the AnalogIn instrument in Volts.

The function above is used to set the trigger voltage level in Volts.

The function above is used to get the current trigger voltage level in Volts.

The function above is used to retrieve the range of valid trigger hysteresis voltage levels for the AnalogIn instrument in Volts. The trigger detector uses two levels: low level (TriggerLevel - Hysteresis) and high level (TriggerLevel + Hysteresis). Trigger hysteresis can be used to filter noise for Edge or Pulse trigger. The low and high levels are used in transition time triggering.

The function above is used to set the trigger hysteresis level in Volts.

The function above is used to get the current trigger hysteresis level in Volts.

The function above returns the supported trigger length condition options for the AnalogIn instrument. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the TRIGLEN constants in DWF.h. These trigger length condition options are:

• triglenLess: Trigger immediately when a shorter pulse or transition time is detected.
• triglenTimeout: Trigger immediately as the pulse length or transition time is reached.
• triglenMore: Trigger when the length/time is reached and pulse or transition has ended.

The function above is used to set the trigger length condition for the AnalongIn instrument.

The function above is used to get the current trigger length condition for the AnalongIn instrument.

The function above returns the supported range of trigger length for the instrument in Seconds. The trigger length specifies the minimal or maximal pulse length or transition time.

The function above is used to set the trigger length in Seconds.

The function above is used to get the current trigger length in Seconds. 

The Analog Out instrument states:

The states are defined in dwf.h DwfState type.

• Ready: Initial state. After FDwfAnalogOutConfigure or any FDwfAnalogOut*Set function call goes to this state. With digital out configure start command goes to Armed state
• Armed: It waits for trigger.
• Wait: Remains in this state for time period specified by FDwfAnalogOutWaitSet function.
• Running: Remains in this state for time period specified by FDwfAnalogOutRunSet function.
• Repeat: Goes to Armed or Wait state according the FDwfAnalogOutRepeatTriggerSet setting, for number of times specified by FDwfAnalogOutRepeatSet.
• Done: Final state.

The analog out channels can run independently or synchronized using the Master parameter. The states are defined by trigger, wait, run and repeat options. It is enough to start with FDwfAnalogOutConfigure the master channel, the slave channels will also start. 

The function above resets and configures all AnalogOut instrument parameters to default values for the specified channel. To reset instrument parameters across all channels, set idxChannel to -1.

The function above is used to start or stop the instrument.

The function above is used to check the state of the instrument.

The function above is used to retrieve information about the play process. The data lost occurs when the device generator is faster than the sample send process from the PC. In this case, the device buffer gets emptied and generated samples are repeated. Corrupt samples are a warning that the buffer might have been emptied while samples were sent to the device. In this case, try optimizing the loop for faster execution; or reduce the frequency or run time to be less or equal to the device buffer size (run time ⇐ buffer size/frequency).

The function above is used to sending new data samples for play mode. Before starting the Analog Out instrument, prefill the device buffer with the first set of samples using the AnalogOutDataSet function. In the loop of sending the following samples, first call AnalogOutStatus to read the information from the device, then AnalogOutPlayStatus to find out how many new samples can be sent, then send the samples with AnalogOutPlayData.

The function above returns the number of Analog Out channels by the device specified by hdwf.

The function above sets the state machine master of the channel generator.

The function above is used to verify the parameter.

The function above returns the supported AnalogOut nodes of the AnalogOut channel. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the AnalogOutNode constants in dwf.h. These node types are:

• AnalogOutNodeCarrier
• AnalogOutNodeFM
• AnalogOutNodeAM

The function above enables or disables the channel node specified by idxChannel and node. The Carrier node enables or disables the channel and AM/FM the modulation.

The function above is used to verify if a specific channel and node is enabled or disabled.

The function above returns the supported generator function options. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the FUNC constants in dwf.h. These are:

The function above is used to set the generator output function for the specified instrument channel. 

The function above is used to retrieve the current generator function option for the specified instrument channel.

The function above is used to return the supported frequency range for the instrument. The maximum value shows the DAC frequency. The frequency of the generated waveform: repetition frequency for standard types and custom data; DAC update for noise type; sample rate for play type.

The function above is used to set the frequency.

The function above is used to get the currently set frequency for the specified channel-node on the instrument.

The function above is used to retrieve the amplitude range for the specified channel-node on the instrument. The amplitude is expressed in Volts units for carrier and in percentage units (modulation index) for AM/FM.

The function above is used to set the amplitude or modulation index for the specified channel-node on the instrument.

The function above is used to get the currently set amplitude or modulation index for the specified channel-node on the instrument.

The function above is used to retrieve available the offset range. For carrier node in units of volts, and in percentage units for AM/FM nodes.

The function above is used to set the offset value for the specified channel-node on the instrument.

The function above is used to get the current offset value for the specified channel-node on the instrument.

The function above is used to obtain the symmetry (or duty cycle) range (0..100). This symmetry is supported for standard signal types. It the pulse duration divided by the pulse period.

The function above is used to set the symmetry (or duty cycle) for the specified channel-node on the instrument.

The function above is used to get the currently set symmetry (or duty cycle) for the specified channel-node of the instrument.

The function above is used to retrieve the phase range (in degrees 0…360) for the specified channel-node of the instrument.

The function above is used to set the phase for the specified channel-node on the instrument.

The function above is used to get the current phase for the specified channel-node on the instrument.

The function above is used to retrieve the minimum and maximum number of samples allowed for custom data generation.

The function above is used to set the custom data or to prefill the buffer with play samples. The samples are double precision floating point values (rgdData) normalized to ±1.

With the custom function option, the data samples (cdData) will be interpolated to the device buffer size. The output value will be Offset + Sample*Amplitude, for instance:

• 0 value sample will output: Offset.
• +1 value sample will output: Offset + Amplitude.
• -1 value sample will output: Offset – Amplitude.

The function above returns the supported trigger source options for the instrument. See the description of FDwfDeviceTriggerInfo.

The function above is used to set the trigger source for the channel on instrument.

The function above is used to get the current trigger source setting for the channel on instrument.

The function above is used to return the supported run length range for the instrument in Seconds. Zero values represent an infinite (or continuous) run. Default value is zero.

The function above is used to set the run length for the instrument in Seconds.

The function above is used to read the configured run length for the instrument in Seconds.

The function above is used to read the remaining run length. It returns data from the last FDwfAnalogOutStatus call.

The function above is used to return the supported wait length range in Seconds. The wait length is how long the instrument waits after being triggered to generate the signal. Default value is zero.

The function above is used to set the wait length for the channel on instrument.

The function above is used to get the current wait length for the channel on instrument.

The function above is used to return the supported repeat count range. This is how many times the generated signal will be repeated upon. Zero value represents infinite repeat. Default value is one.

The function above is used to set the repeat count.

The function above is used to read the current repeat count.

The function above is used to read the remaining repeat counts. It only returns information from the last FDwfAnalogOutStatus function call, it does not read from the device.

The function above is used to set the repeat trigger option. To include the trigger in wait-run repeat cycles, set fRepeatTrigger to TRUE. It is disabled by default.

The function above is used to verify if the trigger has been included in wait-run repeat cycles.

The AnalogIO functions are used to control the power supplies, reference voltage supplies, voltmeters, ammeters, thermometers, and any other sensors on the device. These are organized into channels which contain a number of nodes. For instance, a power supply channel might have three nodes: an enable setting, a voltage level setting/reading, and current limitation setting/reading.

The function above resets and configures all AnalogIO instrument parameters to default values.

The function above is used to configure the instrument.

The function above reads the status of the device and stores it internally. The following status functions will return the information that was read from the device when the function above was called.

The function above is used to verify if Master Enable Setting and/or Master Enable Status are supported for the AnalogIO instrument. The Master Enable setting is essentially a software switch that “enables” or “turns on” the AnalogIO channels. If supported, the status of this Master Enable switch (Enabled/Disabled) can be queried by calling FDwfAnalogIOEnableStatus.

The function above is used to set the master enable switch.

The function above returns the current state of the master enable switch. This is not obtained from the device.

The function above returns the master enable status (if the device supports it). This can be a switch on the board or an overcurrent protection circuit state.

The function above returns the number of AnalogIO channels available on the device.

The function above returns the name (long text) and label (short text, printed on the device) for a channel.

The function above returns the number of nodes associated with the specified channel.

The function above returns the node name (“Voltage”, “Current”…) and units (“V”, “A”) for an Analog I/O node.

The function above returns the supported channel nodes. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the ANALOGIO constants in dwf.h. The acquisition mode selects one of the following modes, ANALOGIO:

These functions return node value limits. Since a Node can represent many things (Power supply, Temperature sensor, etc.), the Minimum, Maximum, and Steps parameters also represent different types of values. In broad terms, the (Maximum – Minimum)/Steps = the number of specific input/output values.

FDwfAnalogIOChannelNodeInfo returns the type of values to expect and

FDwfAnalogIOChannelNodeName returns the units of these values.

The function above is used to set the node value for the specified node on the specified channel.

The function above returns the currently set value of the node on the specified channel.  

The function above returns node the range of reading values available for the specified node on the specified channel.

The function above returns the value reading of the node.

The function above resets all DigitalIO instrument parameters to default values. It sets the output enables to zero (tri-state), output value to zero, and configures the DigitalIO instrument.

The function above is used to configure the DigitalIO instrument. This doesn’t have to be used if AutoConfiguration is enabled. 

The function above reads the status and input values, of the device DigitalIO to the PC. The status and values are accessed from the FDwfDigitalIOInputStatus function.

The function above returns the output enable mask (bit set) that can be used on this device. These are the pins that can be used as outputs on the device.

The function above is used to enable specific pins for output. This is done by setting bits in the fsOutEnable bit field (1 for enabled, 0 for disabled).

The function above returns a bit field that specifies which output pins have been enabled.

The function above returns the settable output value mask (bit set) that can be used on this device. 

The function above is used to set the output logic value on all output pins.

The function above returns the currently set output values across all output pins.

The function above returns the readable input value mask (bit set) that can be used on the device.

FDwfDigitalIOInputStatus(HDWF hdwf, unsigned int* pfsInput)

The function above returns the input states of all I/O pins. Before calling the function above, call the FDwfDigitalIOStatus function to read the Digital I/O states from the device.

The Digital In instrument states:

The states are defined in dwf.h DwfState type.

• Ready: Initial state. After FDwfDigitalInConfigure or any FDwfDigitalIn*Set function call goes to this state. With FDwfDigitalInConfigure reconfigure goes to Configure state
• Configure: The digital in auto trigger is reset.
• Prefill: Prefills the buffer with samples need before trigger.
• Armed: It waits for trigger.
• Running: For single acquisition mode remains in this state to acquire samples after trigger set by FDwfDigitalInTriggerPositionSet. For scan screen and shift modes remains until configure or any set function of this instrument.
• Done: Final state.

The function above resets and configures all DigitalIn instrument parameters to default values.

The function above is used to configure the instrument and start or stop the acquisition. To reset the Auto trigger timeout, set fReconfigure to TRUE.

The function above is used to check the state of the instrument. To read the data from the device, set fReadData to TRUE. For single acquisition mode, the data will be read only when the acquisition is finished.

The function above is used to retrieve the number of samples left in the acquisition.

The function above is used to retrieve the number of valid/acquired data samples.

The function above is used to retrieve the buffer write pointer. This is needed in ScanScreen acquisition mode to display the scan bar. 

The function above is used to verify if the acquisition is auto triggered.

The function above is used to retrieve the acquired data samples from the instrument. It copies the data samples to the provided buffer. The sample format is specified by FDwfDigitalInSampleFormatSetfunction.

The function above is used to retrieve the internal clock frequency.

The function above returns the supported clock sources for Digital In instrument. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the DwfDigitalInClockSource constants in dwf.h:

• DwfDigitalInClockSourceInternal: Internal clock.
• DwfDigitalInClockSourceExternal: External clock source.

The function above is used to set the clock source of instrument.

The function above is used to get the clock source of instrument.

The function above returns the maximum supported clock divider value. This specifies the sample rate.

The function above is used to set the clock divider value.

The function above is used to get the configured clock divider value.

The function above returns the number of Digital In bits.  

The function above is used to set the sample format, the number of bits starting from least significant bit. Valid options are 8, 16, and 32.

The function above is used to return the configured sample format.

The function above returns the Digital In maximum buffer size.

The function above is used to set the buffer size.

The function above is used to return the configured buffer size.

The function above returns the supported sample modes. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the DwfDigitalInSampleMode constants in dwf.h:

• DwfDigitalInSampleModeSimple: Stores one sample on every divider clock pulse.
• DwfDigitalInSampleModeNoise: Stores alternating noise and sample values, where noise is more than one transition between two samples. This could indicate glitches or ringing. It is available when sample rate is less than maximum clock frequency, divider is greater than one.

The function above is used to set the sample mode.

The function above is used to return the configured sample mode

The function above returns the supported AnalogIn acquisition modes. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the ACQMODE constants in DWF.h. The acquisition mode selects one of the following modes, ACQMODE:

• acqmodeSingle: Perform a single buffer acquisition. This is the default setting.
• acqmodeScanShift: Perform a continuous acquisition in FIFO style. The trigger setting is ignored. The last sample is at the end of buffer. The FDwfDigitalInStatusSamplesValid function is used to show the number of the acquired samples, which will grow until reaching the BufferSize. Then the waveform “picture” is shifted for every new sample.
• acqmodeScanScreen: Perform continuous acquisition circularly writing samples into the buffer. The trigger setting is ignored. The IndexWrite shows the buffer write position. This is similar to a heart monitor display.

The function above is used to set the acquisition mode.

The function above is used to get retrieve the acquisition mode.

The function above returns the supported trigger source options for the instrument. See the description of FDwfDeviceTriggerInfo.

The function above is used to set the trigger source for the instrument.

The function above is used to get the current trigger source setting for the instrument.

The function above returns maximum values of the trigger position in samples. This can be greater than the specified buffer size.

The function above is used to set the number of samples to acquire after trigger.

The function above is used to get the configured trigger position.

The function above returns the minimum and maximum auto trigger timeout values, and the number of adjustable steps.

The function above is used to configure the auto trigger timeout value in seconds.

The function above returns the configured auto trigger timeout value in seconds. The acquisition is auto triggered when the specified time elapses. With zero value the timeout is disabled, performing “Normal” acquisitions.

In order to use trigger on digital in pins, set trigger source with FDwfDigitalInTriggerSourceSet to trigsrcDetectorDigitalIn.

The function above returns the supported digital in triggers. The bits of the arguments represent pins. The logic for the trigger bits is: Low and High and (Rise or Fall). Setting a bit in both rise and fall will trigger on any edge, any transition. For instance FDwfDigitalInTriggerInfo(hdwf, 1, 2, 4, 8) will generate trigger when DIO-0 is low and DIO-1 is high and DIO-2 is rising or DIO-3 is falling.

The function above is used to configure the digital in trigger detector.

The function above returns the configured digital in trigger detector option.

The DigitalOut instrument states:

The states are described defined in dwf.h DwfState type.

• Ready: Initial state. After FDwfDigitalOutConfigure or any FDwfDigitalOut*Set function call goes to this state. With digital out configure start command goes to Armed state
• Armed: It waits for trigger.
• Wait: Remains in this state for time period specified by FDwfDigitalOutWaitSet function.
• Running: Remains in this state for time period specified by FDwfDigitalOutRunSet function.
• Repeat: Goes to Armed or Wait state according the FDwfDigitalOutRepeatTriggerSet setting, for number of times specified by FDwfDigitalOutRepeatSet.
• Done: Final state.

This states machine controls all digital out channels. 

Channel configuration:

The initial values, for divider and counter, specify the initially loaded values, initial delay, when entering in Running state. The Divider specifies the clock division. This rate will be the custom sample frequency and step for the counter. When entering Running state the initial value specified with FDwfDigitalOutDividerInitSet is loaded. When this expires the value specified by FDwfDigitalOutDividerSet will be loaded upon each expiration. The Counter initial value is set by FDwfDigitalOutCounterInitSet function. This function also sets the initial level. When this expires the level values specified by FDwfDigitalOutCounterSet are loaded upon further expiration. On counter expiration the level is toggled and this directs the low or high value loading. In case one of these is zero the level is not toggled.

The Counter is used for:

• Pulse to generate the low and high state lengths.
• Random to set update rate.
• Custom to address buffer. The samples are configured by FDwfDigitalOutDataSet function. This also configures the counter low/high according countOfBits parameter. In TS mode the counter step is double, providing two bits of samples for output: value and enable.

The output Mode (FDwfDigitalOutModeSet) selects between: PP, OS, OD and TS. The Idle output (FDwfDigitalOutIdleSet) selects the output while not in Running state.

Pulse signal:

For pulse signal the initial level and initial value are specified with FDwfDigitalOutCounterInitSet function. These are loaded when entering Running state.

The function above resets and configures all of the instrument parameters to default values.

The function above is used to start or stop the instrument.  

The function above is used to check the state of the instrument.

The function above is used to retrieve the internal clock frequency.

The function above returns the supported trigger source options for the instrument. See the description of FDwfDeviceTriggerInfo.

The function above is used to set the trigger source for the instrument. Default setting is trigsrcNone.

The function above is used to get the current trigger source setting for the instrument.

The function above is used to return the supported run length range for the instrument in seconds. Zero value (default) represent an infinite (or continuous) run.

The function above is used to set the run length for the instrument in Seconds.

The function above is used to read the configured run length for the instrument in seconds.

The function above is used to read the remaining run length. It returns data from the last FDwfDigitalOutStatus call.

The function above is used to return the supported wait length range in seconds. The wait length is how long the instrument waits after being triggered to generate the signal. Default value is zero.

The function above is used to set the wait length.

The function above is used to get the current wait length.

The function above is used to return the supported repeat count range. This is how many times the generated signal will be repeated. Zero value represents infinite repeats. Default value is one.

The function above is used to set the repeat count.

The function above is used to read the current repeat count. 

The function above is used to read the remaining repeat counts. It only returns information from the last FDwfDigitalOutStatus function call, it does not read from the device.

The function above is used to set the repeat trigger option. To include the trigger in wait-run repeat cycles, set fRepeatTrigger to TRUE. It is disabled by default.

The function above is used to verify if the trigger has been included in wait-run repeat cycles.

The function above returns the number of Digital Out channels by the device specified by hdwf.

The function above enables or disables the channel specified by idxChannel.

The function above is used to verify if a specific channel is enabled or disabled.

The function above returns the supported output modes of the channel. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the

• DwfDigitalOutOutput constants in DWF.h:
• DwfDigitalOutOutputPushPull: Default setting.
• DwfDigitalOutOutputOpenDrain: External pull needed.
• DwfDigitalOutOutputOpenSource: External pull needed.
• DwfDigitalOutOutputThreeState: Available with custom and random types.

The function above specifies output mode of the channel.

The function above is used to verify if a specific channel output mode. 

The function above returns the supported types of the channel. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the DwfDigitalOutType constants in dwf.h: DwfDigitalOutTypePulse: Frequency = internal frequency/divider/(low + high counter). DwfDigitalOutTypeCustom: Sample rate = internal frequency / divider. DwfDigitalOutTypeRandom: Random update rate = internal frequency/divider/counter alternating between low and high values.

The function above sets the output type of the specified channel.

The function above is used to verify the type of a specific channel.

The function above returns the supported idle output types of the channel. They are returned (by reference) as a bit field. This bit field can be parsed using the IsBitSet Macro. Individual bits are defined using the * DwfDigitalOutIdle constants in dwf.h. Output while not running:

• DwfDigitalOutIdleInit: Output initial value.
• DwfDigitalOutIdleLow: Low level.
• DwfDigitalOutIdleHigh: High level.
• DwfDigitalOutIdleZet: Three state.

The function above sets the idle output of the specified channel.

The function above is used to verify the idle output of a specific channel.

The function above is used to return the supported clock divider value range.

The function above sets the initial divider value of the specified channel.

The function above is used to verify the initial divider value of the specified channel.

The function above sets the divider value of the specified channel.

The function above is used to verify the divider value of the specified channel.

The function above is used to return the supported counter value range.

The function above sets the initial state and counter value of the specified channel.

The function above is used to verify the initial state and counter value of the specified channel.

The function above sets the counter low and high values of the specified channel.

The function above is used to verify the low and high counter value of the specified channel.

The function above is used to return the maximum buffers size, the number of custom data bits.

The function above is used to set the custom data bits. The function also sets the counter initial, low and high value, according the number of bits. The data bits are sent out in LSB first order. For TS output, the count of bits is the total number of output value (I/O) and output enable (OE) bits, which should be an even number.