Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create common database for commands #1

Open
raacampbell opened this issue Aug 11, 2023 · 0 comments
Open

Create common database for commands #1

raacampbell opened this issue Aug 11, 2023 · 0 comments

Comments

@raacampbell
Copy link
Contributor

We lack a centralised location for storing the message protocol. If the message format changes, we will need to manually modify each plugin. e.g. the constants class in MATLAB. Information is also scattered too much right now. e.g. the aforementioned class has no information on how to decode the returned status ("idle", "active", and "rampdown") from Zapit. That currently sits in TCPserver.

I propose having this information in a text file organised in some clear manner. MATLAB and Python can then each have a class that reads from this file and presents its content in a way similar to what is now done by the constants class. Presumably something analogous is possible for Bonsai. But even if it's not, having all the information in a single language-agnostic place is a bonus.

There should be instructions on how to add or modify commands to the protocol. These instructions should explain what changes need to made both here and in the zapit.interfaces.TCPserver package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant