search

open-ephys / ONI

Open Neuro Interface Hardware Specification and API Documentation
https://open-ephys.github.io/ONI/
Creative Commons Attribution Share Alike 4.0 International
2 stars 2 forks source link

Reword device channel list introduction #46

Open aacuevas opened 6 days ago

aacuevas commented 6 days ago 
          MUST seems wrong here since two of the following elements are optional?

_Originally posted by @jonnew in https://github.com/open-ephys/ONI/pull/45#discussion_r1847129021_

aacuevas commented 6 days ago

I agree, but I cannot think of a good way to write this. Any ideas?

jonnew commented 2 days ago

We decided on the following path:

Instead of this:

A device MUST expose the following :ref:`communication channels
<com-channels>`:

- A REQUIRED register interface
- An OPTIONAL read stream
- An OPTIONAL write stream

use this:

A device exposes a set  :ref:`communication channels <com-channels>`:

- It MUST expose a register interface. 
- It MAY a read stream.
- It MAY expose a write stream.

Additionally, provide reference links for the thread communication channel types in the list

aacuevas commented 2 days ago

Regarding the last point, links will not be provided because we do not have specific sections for the device streams, the base definitions on comm-channels plus what it is explained on this pae and sample format is all that applies to them