Where is the documentation about the API

[Kiva]

Hi guys,

I bought a crazyflie 2.0 some days ago and after spent some times to play with it, I want to explore the API to develop with it.

I browse the wiki, the web site and github repositories and I don't find a global documentation about the code.

For example, I search a documentation about C function for the firmware (which function does what) or in the python client, which module does what.

I can explore the code (I had started to do that) but read all the code to find which function does what is not really easy to start.

Does it exist a documentation about the code ?

Thanks a lot

[tobias]

Unfortunately there is no good high level architecture documentation . There are some architectural documentation on the wiki describing protocols and such.

[Kiva]

I didn't find this doc in the Wiki so it's already a good thing

Thanks for your help.

[Kiva]

I'll ask you the same things with sensors.

I flash the firmware to activate the kalman filter and I have many new sensors whose appear in the crazyflie client.

It's very difficult to understand what sensor pull what data and what does meen these data.

Do you have a link about these sensors and data ?

Globaly, the crazyflie is a beautiful object but the lack of documentation is hard to start to develop.

Thanks for your help.

[arnaud]

Crazyflie is a moving target so it is hard to keep it documented and the Kalman filter is among the newest and most bleeding edge part of it. The best documentation for that is the code so far, if you wonder about a log variable find its declaration in the code and find what it does. The Kalman filter code is actually pretty well documented with link to scientific papers: https://github.com/bitcraze/crazyflie-f ... man.c#L215.

We have had talk about generating Doxygen documentation for the source code, this way we could keep some documentation updated. Do you feel this would help?

[Kiva]

Yes it could be a good thing

[arnaud]

Added a ticket for it: https://github.com/bitcraze/crazyflie-f ... issues/186