WaveForms SDK Documentation Mistake

[kdumont]

There appears to be a mistake in the WaveForms SDK Reference Manual supplied with the SDK. 

The document says:

Quote

FDwfAnalogIOChannelNodeName(
HDWF hdwf, int idxChannel, char szNodeName[32], char szUnits[16])

But the function actually requires the idxChannel AND idxNode, like this:

Quote

FDwfAnalogIOChannelNodeName(
HDWF hdwf, int idxChannel, int idxNode, char szNodeName[32], char szUnits[16])

I'm running the following code segment to get the different node options:

num_channels = c_int()
dwf.FDwfAnalogIOChannelCount(hdwf, byref(num_channels))
print(num_channels.value, "channels")
for i in range(0, num_channels.value):
    print("Channel", i)
    channel_name = create_string_buffer(32)
    channel_label = create_string_buffer(16)
    dwf.FDwfAnalogIOChannelName(hdwf, c_int(i), channel_name, channel_label)
    print(str(channel_name.value), str(channel_label.value))

    num_nodes = c_int()
    dwf.FDwfAnalogIOChannelInfo(hdwf, c_int(i), byref(num_nodes))
    for n in range(0, num_nodes.value):
        node_name = create_string_buffer(32)
        node_label = create_string_buffer(16)
        dwf.FDwfAnalogIOChannelNodeName(hdwf, c_int(i), c_int(n), node_name, node_label)
        print("  ", str(node_name.value), str(node_label.value))

 

[jpeyron]

Hi @kdumont,

I moved your forum thread to a better section so the more experience engineers with WaveForms SDK will see your post.

cheers,

Jon

[attila]

Hi @kdumont

Thank you for the observation, it will be corrected. 

[ElectroTech425]

Almost 3 years later after this post, this issue still persists. Just a reminder, that this still needs to be corrected in the WaveForms SDK Manual. Thanks and have a nice day.

[attila]

Hi @ElectroTech425

It was corrected immediately.

Where you looking at the manual on the "SDK Legacy" page?
Please use the SDK Manual and examples from the WaveForms installation.

I use to correct bugs immediately when noticed or reported.
For critical issues push WF beta version within hours or days: 
https://forum.digilentinc.com/topic/8908-waveforms-beta-download/
These versions also contain new features.

The public releases are about twice a year:
https://reference.digilentinc.com/reference/software/waveforms/waveforms-3/start
These go through more testing, for about 2 weeks only fixing (feature freeze) then about 2 weeks just testing (code freeze).

 

 

[ElectroTech425]

Hello @attila,

I wasn't looking at the legacy page. I was looking at the downloadable pdf version from the WaveForms SDK page.

[JColvin]

The downloadable PDF was also the old version, as noted by the 2015 revision date. I have made sure that the versions on the WaveForms SDK Resource Center are current as of the last revision (September 7th, 2020).

Thanks,
JColvin