open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package
https://open-ephys.github.io/bonsai-onix1-docs/
Creative Commons Attribution Share Alike 4.0 International
0 stars 2 forks source link

"Devices" header Instead of "Properties" header for hubs #46

Open cjsha opened 1 month ago

cjsha commented 1 month ago

Look at this discussion for reference https://github.com/open-ephys/onix-bonsai-onix1/issues/226#issuecomment-2302622396_

cjsha commented 1 month ago

I propose it should follow the same hierarchy as is present in Bonsai.

image

Above is what's in Bonsai's properties panel for NeuropixelsV1eHeadstage Below is a proposal for the structure for the docs for that particular headstage:

## Properties

### Configuration

Table with rows corresponding to:
- Name
- Port
- PortVoltage

### Devices

#### Bno055

Table with row corresponding to:
- Enable

#### NeuropixelsV1e

Table with rows corresponding to:
- Enable
- EnableLed
- GainCalibrationFile
- AdcCalibrationFile
- ProbeConfiguration
bparks13 commented 2 weeks ago

If it is easier to automate this using attributes, Bonsai sorts these properties using the [Category()] attribute.