Document configuration interface

Question

Document configuration interface

danielkucera opened this issue 7 years ago · 4 comments

Hi Andy,

would it be possible to document the API of the card? I mean all the options which need/can be set for the card to work. I see that there's a minimal working example in https://github.com/drandyhaas/Haasoscope/blob/master/software/serial_read.py but it's not very explanatory.

This would be useful for writing different drivers for the card (I'm thinking about writing PoC driver for PulseView) or automated data collection.

Answer 1 · 2018-06-05T15:22:29.000Z

I added this file...
https://github.com/drandyhaas/Haasoscope/blob/master/software/commands.txt
Let me know if you have questions...

Answer 2 · 2018-06-05T20:52:56.000Z

https://github.com/drandyhaas/Haasoscope/blob/master/software/commands.md

Answer 3 · 2018-06-06T07:03:01.000Z

It's quite clear, thanks. But I wonder why did you not use some predefined format, e.g.: 1B command id, 1B data length, n Bytes data (board addr, parameters), 1B checksum, or something similar.

Answer 4 · 2018-06-06T07:16:33.000Z

That would have been smarter, in hindsight! The first commands I worked on didn't need extra data, so it sort of grew organically... and this is how it ended up.