Documentation clarifications

[Charles K]

Hi Digilent,

I installed the latest Waveforms on my Ubuntu Linux 20.04 computer.

Inside /usr/include/digilent/waveforms/dwf.h I see ...

typedef int DWFERC;
const DWFERC dwfercInvalidParameter0 = 0x10; // Invalid parameter sent in API call
const DWFERC dwfercInvalidParameter1 = 0x11; // Invalid parameter sent in API call
const DWFERC dwfercInvalidParameter2 = 0x12; // Invalid parameter sent in API call
const DWFERC dwfercInvalidParameter3 = 0x13; // Invalid parameter sent in API call
const DWFERC dwfercInvalidParameter4 = 0x14; // Invalid parameter sent in API call

But inside reference manual ...
https://reference.digilentinc.com/reference/software/waveforms/waveforms-sdk/reference-manual

Error Codes                 int     Error Code Definition
dwfercInvalidParameter0     5       Parameter 0 was invalid in last API call.
dwfercInvalidParameter1     6       Parameter 1 was invalid in last API call.
dwfercInvalidParameter2     7       Parameter 2 was invalid in last API call.
dwfercInvalidParameter3     8       Parameter 3 was invalid in last API call.

dwfercInvalidParameter0 = 0x10 is not the same as dwfercInvalidParameter0 = 5

Is this a typo or am I missing something?  Thanks

[Charles K]

Inside https://reference.digilentinc.com/waveforms/ref_manual
Typo:
"DwfDeviceReset" should be "FDwfDeviceReset"
"Desacription" should be "Description" (near FDwfAnalogInStatusRecord)

The following functions exists in dwf.h but are missing documentation inside
Inside https://reference.digilentinc.com/waveforms/ref_manual

Specifically missing Docs for:
FDwfParamGet
FDwfDeviceEnableSet
FDwfAnalogInTriggerForce
FDwfAnalogInStatusNoise2
FDwfAnalogInStatusTime
FDwfAnalogInNoiseSizeSet
FDwfAnalogInChannelBandwidthSet
FDwfAnalogInChannelBandwidthGet
FDwfAnalogInChannelImpedanceSet
FDwfAnalogInChannelImpedanceGet
FDwfAnalogInTriggerPositionStatus
FDwfAnalogOutCustomAMFMEnableSet
FDwfAnalogOutCustomAMFMEnableGet
FDwfDigitalIOOutputEnableInfo64
FDwfDigitalIOOutputEnableSet64
FDwfDigitalIOOutputEnableGet64
FDwfDigitalIOOutputInfo64
FDwfDigitalIOOutputSet64
FDwfDigitalIOOutputGet64
FDwfDigitalIOInputInfo64
FDwfDigitalIOInputStatus64
FDwfDigitalInStatusNoise2
FDwfDigitalInStatusTime
FDwfDigitalInTriggerInfo
FDwfAnalogImpedanceConfigure
FDwfDigitalInMixedSet
FDwfAnalogInTriggerSourceInfo
FDwfAnalogOutTriggerSourceInfo
FDwfDigitalInTriggerSourceInfo
FDwfDigitalOutTriggerSourceInfo
FDwfEnumAnalogInChannels
FDwfEnumAnalogInBufferSize
FDwfEnumAnalogInBits
FDwfEnumAnalogInFrequency

Inside dwf.h
DWFAPI int FDwfDigitalInSampleModeSet(HDWF hdwf, DwfDigitalInSampleMode v);  //
has trailing "//" comment

Inside https://reference.digilentinc.com/waveforms/ref_manual
FDwfAnalogIOChannelNodeName(HDWF hdwf, int idxChannel, char szNodeName[32], char szUnits[8])
but inside dwf.h
DWFAPI int FDwfAnalogIOChannelNodeName(HDWF hdwf, int idxChannel, int idxNode, char szNodeName[32], char szNodeUnits[16]);
missing idxNode

Inside https://reference.digilentinc.com/waveforms/ref_manual
FDwfDigitalInTriggerAutoTimeoutInfo(HDWF hdwf, double* psecMin, double* psecMax, int* pnSteps)
but inside dwf.h
DWFAPI int FDwfDigitalInTriggerAutoTimeoutInfo(HDWF hdwf, double *psecMin, double *psecMax, double *pnSteps);
is pnSteps an int or double?

[attila]

Hi @Charles H

Thank you for the observation.
Most of the missing functions are added and already corrected in the PDF manual in the latest version:
https://forum.digilentinc.com/topic/8908-waveforms-beta-download/

The online version will be updated soon.

The functions at the end of the dwf.h are obsolete like the mentioned FDwfEnum* and comments indicate the alternatives.