ModalityTeam/Modality-toolkit

MKtlElementCollective needs a helpfile

LFSaw opened this issue · 6 comments

LFSaw commented

as we are assembling the release for #200, I stumbled over MKtlElementCollective which still needs a basic Help file. I am willing to write it, though need some two sentences on what it does. @adcxyz ?

adcxyz commented

Actually @sensestage knows this much better, but I'll try anyway - the intro for the help file could be:

MKtlElementCollective contains elements whose values the corresponding device sends (or receives) in grouped form: For example, an OSC device which sends all its button states in a single OSC message with a message name and n values.
Very likely one never needs to make an MKtlElementCollective by hand; it is created automatically when a description file defines a group of elements as a collective.
For code examples, see link::Tutorials/How_to_create_a_description_file:: esp. the sections on collective input and output.

LFSaw commented
adcxyz commented

just committed a first pass, hope it makes sense.
nice that modal hibernation is over ;-)

sensestage commented

I'm actually not sure whether the collectives are still working after the code refactoring.

My contributions will stay in bursts - when I happen to be working on a (paid) project needing Modality...

LFSaw commented

Last time I checked (with XPee etc) it worked (without me knowing that it where collectives)...

With a little bit of digging, I found the place where they are used:

MKtl(\a, "*xpee*")
MKtl(\a).desc
MKtl(\a).desc.openFile

MKtl(\a).desc.fullDesc[\collectives]

(see MKtl:makeCollectives and OSCMKtlDevice:initCollectives)

adcxyz commented

@LFSaw - good enough to close?