Thanks. That really helps a lot. One small area that could use improvement is for the register() function. The Wiki page documents the first parameter but not the optional other parameters. For example. jitter/pd.py has these lines self.out_ann = self.register(srd.OUTPUT_ANN) self.out_binary = self.register(srd.OUTPUT_BINARY) self.out_clk_missed = self.register(srd.OUTPUT_META, meta=(int, 'Clock missed', 'Clock transition missed')) self.out_sig_missed = self.register(srd.OUTPUT_META, meta=(int, 'Signal missed', 'Resulting signal transition missed'))
This one isn't hard for a developer to figure out on their own, even without the Wiki. Thanks, Chris ---------------------------------------- > Date: Thu, 25 Aug 2016 13:28:30 +0200 > From: [email protected] > To: [email protected] > CC: [email protected] > Subject: Re: [sigrok-devel] Substantial improvement to decoding of MIDI > messages > > Hi, > > On Wed, Aug 24, 2016 at 11:28:17PM -0700, Chris Dreher wrote: >> Is there deeper documentation for the various OUTPUT_ types (annotations, >> binary, meta, etc)? I reviewed >> http://sigrok.org/wiki/Protocol_decoder_API and >> http://sigrok.org/wiki/Protocol_decoder_output and found some info but >> didn't see the format for annotations defined (i.e. the list of strings >> wasn't mentioned). Is the Wiki the full documentation but it is still a >> work-in-progress or is the Wiki a starter guide and there is more >> documentation elsewhere. If all else fails, I can go read the C code >> directly. :-) > > There's also this page with a short HOWTO/tutorial: > http://sigrok.org/wiki/Protocol_decoder_HOWTO > > But you're right, the actual data format for the different output types > wasn't really documented apparently, so I added some info here: > http://sigrok.org/wiki/Protocol_decoder_API#Backend_library > > Please let us know if there are other open questions or undocumented > parts. > > > Uwe. > -- > http://hermann-uwe.de | http://randomprojects.org | http://sigrok.org ------------------------------------------------------------------------------ _______________________________________________ sigrok-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/sigrok-devel
