RedPitaya / Documentation

https://redpitaya.readthedocs.io/
4 stars 14 forks source link

Multiple incompatible definitions of rp_AcqSetTriggerSrc() #64

Closed edgar-bonet closed 3 months ago

edgar-bonet commented 3 months ago

Within the List of supported SCPI & API commands, in the section Acquisition trigger (source), two versions of the C function rp_AcqSetTriggerSrc() are documented:

This is impossible: the C language does not support function overloading. Furthermore, only the first version seems to be defined in the C API.

Lightsaver7 commented 3 months ago

Hello Edgar, Thank you for noticing this. This is a typo in the function names. The second function is called rp_AcqSetTriggerSrcCh(rp_channel_t channel, rp_acq_trig_src_t source). I have fixed the typo in the official docs.

edgar-bonet commented 3 months ago

@Lightsaver7: There is no such thing as rp_AcqSetTriggerSrcCh(). Other than this issue, this name does not appear anywhere in any of the Red Pitaya GitHub repos.

Should I open another issue for the missing function or could you reopen this one?

Lightsaver7 commented 3 months ago

Ture. The split trigger functionality is still in development (as stated by the “ecosystem” column in the command table) and the development code is not yet available on GitHub. However the function can be used on the latest Nightly Build OS versions.

edgar-bonet commented 3 months ago

@Lightsaver7: Is there a publicly available repo with the development version of the code?

If that version is closed source, then I believe the status of the GitHub issues (open/closed) should reflect the state of the publicly available code.

Lightsaver7 commented 3 months ago

@edgar-bonet As it is still in development, no, there is no publicly available development repository. It would be way too chaotic and confusing if we posted everything on GitHub, so we stick with publishing the code for the official OS releases.

We do keep the users in touch with the latest development through the Nightly Builds and updating the documentation ahead of time (marked as “in-dev”).

We will try to keep the status of the GitHub isses in sync with the published code - please see the ecosystem repository for more information. However for this specific issue, I will leave it closed as it is related to a typo and the affected code is currently still closed (so it has minor impact on the situation).