Issue 112

[ChucklesOnGitHub]

Fixes #112

[ChucklesOnGitHub]

Potentially here we should link to the different capabilities of the hardware depending what software it is used with.
E.g. Analog Inputs in the OE GUI are acquired at 25kHz, while in Bonsai at 100kHz. - are there any more such differences?

[cjsha]

Potentially here we should link to the different capabilities of the hardware depending what software it is used with. E.g. Analog Inputs in the OE GUI are acquired at 25kHz, while in Bonsai at 100kHz. - are there any more such differences?

These are the differences I think are true off the dome:

Feature	Bonsai	Open Ephys GUI
Digital Inputs	Adjustable sample rate (or one sample whenever digital input status changes)	25 kHz sample rate
Analog Inputs	100 kHz sample rate	25 kHz sample rate
Digital Outputs	Supported	Not yet supported
Analog Outputs	Supported	Not yet supported
Headstage 64	Supported	Not yet supported
Headstage RHS2116	Supported	Not yet supported

@bparks13 can you help fill out this table or correct anything I might've gotten wrong here?

[cjsha]

I made a separate PR (#117) to merge into this branch. Please take a look and incorporate my edits as you wish. Then I will approve review.

[bparks13]

@cjsha There are a couple other things to mention, but you've highlighted most of the differences. The only other things I can see when glancing through the Onix1 library is:

Feature	Bonsai	Open Ephys GUI
HeadstageNric1384	Supported	Not supported yet
Any Miniscope	Supported	Will not be supported

[ChucklesOnGitHub]

Do the devices on the headstages have the same data streams and sample rates?

[cjsha]

I think they're the same, maybe with the exception that the bno055 calibration data might be parsed differently by the GUI and by the Onix1 Bonsai package. I don't think we have to explain that here though

[bparks13]

The Bno055 streams should be approximately the same sampling rate (more specifically, the PolledBno055 too). However, users in Bonsai have the ability to disable specific data streams which can increase the sampling rate. They also have the ability to change the sampling rate, while in the GUI we have it locked at all data streams at 100 Hz. That might be worth mentioning, since they do have fairly different capabilities.

I agree with Cris that the mention of how the calibration data is parsed isn't worth mentioning.

[ChucklesOnGitHub]

Even if not for this doc page, it would be good to have this information available outside the source code. It's not apparent to those of us that don't know the code what the differences in implementation are. Perhaps this belongs in a more of a spec sheet of the system capabilities per software.

What would be the maximum sample rate of the Bno055 and PolledBno055 in Bonsai then?
What is the difference in how the calibration data is parsed?

[cjsha]

In the bonsai package, calibration data is sent as one byte. Each sensor calibration status (the magnetometer accelerometer and gyroscope) and the system calibration status occupies two bits in this byte (look at https://open-ephys.github.io/bonsai-onix1-docs/api/OpenEphys.Onix1.Bno055DataFrame.html for reference). In the GUI, I believe each sensor and the system calibration status get their own byte. Is this right @bparks13?

As far as the sample rates, I don't know those details myself.

[cjsha]

Regarding the varying BNO055 sample rate in Bonsai, we can link to the article that spawns from this issue:
open-ephys/bonsai-onix1-docs#269

[ChucklesOnGitHub]

What is the difference in how the calibration data is parsed?

sounds like there are no differences between the acq board and onix in the GUI and onix in Bonsai, in terms of datastreams available to the user and data processing. My worry was there was a difference here as there is between the implementation of the miniscope in the miniscope library vs the onix library. it doesn't seem to be. and we can spare them furtehr details, as y'all suggested.

[cjsha]

in my meeting with chuckles, we discussed maintaining a chart or list like the one from this comment on the onix-source plugin page instead of in the onix-docs. this is probably a more appropriate repo, and the page that's being edited in the PR can just link out to that plugin page where that info is.

[cjsha]

just take what ideas you want from PR #117 and feel free to merge. Also feel free to re-request me if you want me to do another review

[cjsha]

we should tack #121 to this PR