Hobadee / grandMA2_LUA_ldoc

LDoc for the grandMA2 API, since their API is poorly documented.
GNU General Public License v3.0
43 stars 12 forks source link

Add more documentation and corrections for gma.lua, gma.canbus, gma.network, gma.show and gma.show.getobj #9

Closed gutasiadam closed 1 year ago

gutasiadam commented 1 year ago

Added documentation and corrections for gma.lua, gma.canbus, gma.network, gma.show and gma.show.getobj.

Hobadee commented 1 year ago

Thanks for this!

I did notice some grammar and spelling errors, so those will need to be cleaned up. (It sounds like English might not be your first language so no worries, I can do this a bit later when I'm not on my phone.)

Also, I don't have access to a physical MA anymore to test with. Everything looks like it makes sense, but can you please confirm how you got this info? (Experimentation is fine, I just want it on the public record.)

gutasiadam commented 1 year ago

Thank you for your feedback! I could soon fix the spelling errors as well. I am unsure whether a new merge request is required for another commit.

The information I added to the documentation is based solely on experiments. Currently, I only have access to a command wing with onPc. Based on the concept of how the onPc version emulates real MA, I believe these commands should work just fine.

Hobadee commented 1 year ago

I reviewed grammar, spelling, and formatting. Good to merge.