search

F5OEO / librpitx

Radio frequency transmitter library - Engine of rpitx
GNU General Public License v3.0
87 stars 36 forks source link

Notes on librpitx #18

Open hiperiondev opened 3 years ago

hiperiondev commented 3 years ago

Congratulations on this excellent project!

I have noticed some things that I would like to tell you that, perhaps, could help the project.

1) Documentation: there are some comments in the code but in general there is no information about its use. You could put at least some information about the methods in each class 2) Modulation modes within the generic library: atv, fskburst and ookburst are specific communication modes and not part of the transmission library. Maybe they should be out of this library and integrated into each particular project in rpitx 3) C and C ++ mixed: practically the entire library is written in C ++ so mailbox should also be a cpp file

F5OEO commented 3 years ago

1 - Complely agree. Didn't do it because not a lot of request of detailed implementation 2- Even it is some communications modes, it uses low level acess of register thus not really doable through API 3 - Agree , should fix it

hiperiondev commented 3 years ago

I have rearranged the code for readability, separating the core functions from the modulation functions. All files were also formatted to maintain uniformity as well as some aesthetic arrangements. In this way the code is clearer to understand and generate a minimum of documentation, when you have time and desire :-)

I hope it can be useful

librpitx.zip