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

Clarification for gma.canbus, added gma.gethardwaretype() #4

Closed vjandrea closed 5 years ago

vjandrea commented 5 years ago

Updated 'hold' param & return type for gma.canbus.hardkey()

Hobadee commented 5 years ago

--@treturn boolean success Can we flush that line out some? I assume it's true on success, false otherwise? Can we add something to that effect?

vjandrea commented 5 years ago

What I've found bizarre is that it returns always true: if you call gma.canbus.hardkey(-1, true, false) it will return true indeed. [edit 2: I managed to make it return falseonly using a wrong parameter number, like gma.canbus.hardkey(53)]. Similar issue with hold=true: it's supposed to emulate a key held down, but if I try with the Oops or Store keycodes I can't see any reaction. [edit: hold=true works]

Hobadee commented 5 years ago

Ok - if it appears to always returns true, just make a note of that in the LDoc.