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

Add page that describes hardware configuration & data acquisition #186

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Jan 15, 2025

Resolve #93
Resolve #56

@cjsha cjsha requested a review from jonnew January 15, 2025 20:21
cjsha and others added 3 commits January 15, 2025 15:26
- To avoid rate-limiting, update to v2 in actions and set max-retries | max-concurrency | cache in both the local installation and the Action. Tested with version 0.18.0 locally, which removed the rate-limiting 429 response from learn.microsoft.com
@bparks13 bparks13 mentioned this pull request Jan 15, 2025
@cjsha cjsha changed the title Add page that describes hardware configuration Add page that describes hardware configuration & data acquisition Jan 17, 2025
Other edits to onix-bonsai.md:
- Change uid/title to reflect content better
- Fix header hierarchy and their capitalization
- Minor syntactical improvements
Other edits to other files:
- Add workflows where necessary
- Fix ref in template after changing uid
- Change some headings from progressive to imperative tense in visualize page
Copy link
Contributor

@ChucklesOnGitHub ChucklesOnGitHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is golden, Cris. Great work.


The DeviceName property of the AnalogInput operator is set to "BreakoutBoard/AnalogIO". This links
the operator to the AnalogIO device on the Breakout Board meaning that the AnalogInput operator will
streams data from that device.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: streams -> stream

> - Each hardware guide has a Python script to load and view data. You can use this is to load and
> view data from the example workflow or as a starting point for loading data from your own workflow.

<!-- For high data rates, use <xref:Bonsai.Dsp.MatrixWriter>. For lower data rates or files that store
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the comment about when to use each data writer is helpful, even if reductive. In fact, it could warrant a separate section on Writing Data, same as you did for Visualize Data. This could also include how to know what type of data a node produces (by either checking the reference or by using the text visualizer or whatever the actual method is).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, we should have a section like "visualize data" for "write data". that would be a good spot to plug a solution for issue #165

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