Function-based API

This API is like as C functions which supplied by Digilent. But some modifications are applied for pythonic-way programming.

1. When error is returned by SDK, the exception DWFError is raised.

2. All output values, which are passed by reference, are changed to return-value of function.

3. Arrays of parameters are converted from/to python’s list.

char version[32];
FDwfGetVersion(version);
printf("DWF version: %s\n", version);

version = dwf.FDwfGetVersion()
print("DWF version: " + version)

HDWF hdwf;
double rgdSamples[4096];
for (int i = 0; i < 4096; i++) rgdSamples[i] = 2.0*i/4095-1;

FDwfDeviceOpen(-1, &hdwf);
FDwfAnalogOutNodeSet(hdwf, 0, AnalogOutNodeCarrier, true);
FDwfAnalogOutNodeFunctionSet(hdwf, 0, AnalogOutNodeCarrier, funcCustom);
FDwfAnalogOutNodeDataSet(hdwf, 0, AnalogOutNodeCarrier, rgdSamples, 4096);
...

rgdSamples = []
for i in range(4096): rgdSamples.append(2.0*i/4095-1)

hdwf = dwf.FDwfDeviceOpen()
dwf.FDwfAnalogOutNodeSet(hdwf, 0, dwf.AnalogOutNodeCarrier, True)
dwf.FDwfAnalogOutNodeFunctionSet(hdwf, 0, dwf.AnalogOutNodeCarrier, dwf.funcCustom)
dwf.FDwfAnalogOutNodeDataSet(hdwf, 0, dwf.AnalogOutNodeCarrier, rgdSamples)
...

Class-based API

Class-based APIs are made from function-based APIs. Documents of this API is now writing.

This API has below function and classes.

DwfEnumeration()

Device enumeration. This function returns list of DwfDevice.

class DwfDevice

call FDwfEnum*() functions.

class Dwf

call FDwfDevice*() functions.

class DwfAnalogIn

call FDwfAnalogIn*() functions.

class DwfAnalogOut

call FDwfAnalogOut*() functions.

class DwfAnalogIO

call FDwfAnalogIO*() functions.

class DwfDigitalIO

call FDwfDigitalIO*() functions.

class DwfDigitalIn

call FDwfDigitalIn*() functions.

class DwfDigitalOut

call FDwfDigitalOut*() functions.

With this API, example code is translated to

rgdSamples = []
for i in range(4096): rgdSamples.append(2.0*i/4095-1)

dwf_ao = dwf.DwfAnalogOut()
dwf_ao.nodeSet(0, dwf_ao.NODE.CARRIER, True)
dwf_ao.nodeFunctionSet(0, dwf_ao.NODE.CARRIER, dwf_ao.FUNC.CUSTOM)
dwf_ao.nodeDataSet(0, dwf_ao.NODE.CARRIER, rgdSamples)
...