Skip to content

Commit

Permalink
Merge pull request #48 from open-ephys/remove-duplate-special-devs
Browse files Browse the repository at this point in the history
Remove duplicate text
  • Loading branch information
aacuevas authored Nov 18, 2024
2 parents ac96c87 + 64c6d2d commit b513c8f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
6 changes: 3 additions & 3 deletions source/hw-spec/devices/descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ table <dev-table>`. The descriptor must contain the following information:
uint32 Read_Sample_Size
uint32 Write_Sample_Size

- ``Device_ID``: :ref:`As previously described. <dev-id>`.
- ``Device_ID``: :ref:`As previously described <dev-id>`.
- ``Device_Version``: A version number to distinguish between implementations
of a singular device type. Different versions that address minor issues MUST
NOT change the device's sample data format or alter an existing register
of a singular device type. Different versions MUST
NOT change the device's sample data format or alter an existing register
map. However, register additions that do not affect the existing register map
are allowed. Any change that warrants a modification of a device's streaming
data format, read size, write size, or existing register map MUST be
Expand Down
6 changes: 2 additions & 4 deletions source/hw-spec/devices/hubs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Hubs
====
Hubs are collections of devices sharing a common clock. They can be independent
hardware aggregates connected to the controller (e.g., a headstage for neural
acquisition) or a logical partition of existing hardware (e.g., a collection of
hardware aggregates connected to the controller (e.g. a headstage for neural
acquisition) or a logical partition of existing hardware (e.g. a collection of
devices implemented in the same firmware as the controller). Hubs that exist on
hardware that is physically separated from the :ref:`controller <controller>` are
referred to as remote hubs, while hubs existing on the controller are local hubs.
Expand Down Expand Up @@ -32,5 +32,3 @@ particular collection of devices on a specific hardware platform communicating
with the controller through a specific link. Changes in the device collection,
the communications link or the general hardware architecture require a new
identifier.


3 changes: 1 addition & 2 deletions source/hw-spec/devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ physical element interfacing with the environment (e.g. an external sensor with
a digital communication interface), something programmed within the firmware to
emulate this (e.g. a digital logic module on an FPGA) or a purely internal data
source (e.g. a controller based digital logic module that generates system
status reports). A device MUST expose the following :ref:`communication channels
status reports). A device exposes the following :ref:`communication channels
<com-channels>`:

- A REQUIRED register interface
Expand All @@ -27,7 +27,6 @@ order to reach ONI-compliance.
devid
descriptor
sample
descriptor
registers
datasheet
hubs
Expand Down

0 comments on commit b513c8f

Please sign in to comment.