From 921583544e055d25580c373fefbb6e7a11f9eb8a Mon Sep 17 00:00:00 2001 From: jonnew Date: Fri, 2 Aug 2024 11:12:38 -0400 Subject: [PATCH 1/2] Minor updates to documentation - Clarification and typo fixes --- OpenEphys.Onix1/MultiDeviceFactory.cs | 34 +++++++++++++++++---------- OpenEphys.Onix1/StartAcquisition.cs | 4 ++-- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/OpenEphys.Onix1/MultiDeviceFactory.cs b/OpenEphys.Onix1/MultiDeviceFactory.cs index a6e0f4fe..45a56c8f 100644 --- a/OpenEphys.Onix1/MultiDeviceFactory.cs +++ b/OpenEphys.Onix1/MultiDeviceFactory.cs @@ -6,19 +6,26 @@ namespace OpenEphys.Onix1 { /// /// Provides an abstract base class for configuration operators responsible for - /// registering all devices in an ONI device aggregate in the context device table. + /// registering logical groups of s. /// /// /// - /// ONI devices are often grouped into multi-device aggregates connected to hubs or - /// headstages. These aggregates provide access to multiple devices through hub-specific - /// addresses and usually require a specific sequence of configuration steps to determine - /// operational port voltages and other link-specific settings. + /// The ONI standard states that devices are grouped into aggregates called hubs, each of which is + /// governed by a single, potentially asynchronous clock and share a common base address. The devices on + /// a headstage are an example of a hub. Devices within a hub are accessed through hub-specific addresses + /// and usually require a specific sequence of configuration steps prior to acquisition. /// /// - /// These multi-device aggregates are the most common starting point for configuration - /// of an ONI system, and the provides a modular abstraction - /// for flexible assembly and sequencing of multiple such aggregates. + /// This class allows configuration of logical device groups of s across ONI-defined + /// hubs. For instance, the group of devices within a headstage (a single hub) can be combined with a device + /// from another hub that is used to control its port voltage and communication status + /// (e.g. ). Alternatively, diagnostic devices that are present within + /// an ONI hub can be omitted from a device group to aid it useability (e.g. ). + /// + /// + /// These device groups are the most common starting point for configuration + /// of an ONI system, and the provides a modular abstraction for flexible + /// assembly and sequencing of device groups. /// /// public abstract class MultiDeviceFactory : DeviceFactory, INamedElement @@ -34,10 +41,10 @@ internal MultiDeviceFactory() } /// - /// Gets or sets a unique hub device name. + /// Gets or sets a unique device group name. /// /// - [Description("The unique hub device name.")] + [Description("The unique device group name.")] public string Name { get { return _name; } @@ -62,7 +69,7 @@ internal virtual void UpdateDeviceNames() } /// - /// Configure all the ONI devices in the multi-device aggregate. + /// Configure all devices in the device group. /// /// /// This will schedule configuration actions to be applied by a instance @@ -71,13 +78,13 @@ internal virtual void UpdateDeviceNames() /// A sequence of instances that hold configuration actions. /// /// The original sequence modified by adding additional configuration actions required to configure - /// all the ONI devices in the multi-device aggregate. + /// all the devices in the device group. /// public override IObservable Process(IObservable source) { if (string.IsNullOrEmpty(_name)) { - throw new InvalidOperationException("A valid hub device name must be specified."); + throw new InvalidOperationException("A valid device group name must be specified."); } var output = source; @@ -90,3 +97,4 @@ public override IObservable Process(IObservable source } } } + diff --git a/OpenEphys.Onix1/StartAcquisition.cs b/OpenEphys.Onix1/StartAcquisition.cs index 6474acd8..5bc60ab6 100644 --- a/OpenEphys.Onix1/StartAcquisition.cs +++ b/OpenEphys.Onix1/StartAcquisition.cs @@ -13,7 +13,7 @@ namespace OpenEphys.Onix1 public class StartAcquisition : Combinator> { /// - /// Gets or sets the number of bytes read by the device driver access to the read channel. + /// Gets or sets the number of bytes read per cycle of the 's acquisition thread. /// /// /// This option allows control over a fundamental trade-off between closed-loop response time and overall bandwidth. @@ -23,7 +23,7 @@ public class StartAcquisition : Combinator). /// - [Description("The number of bytes read by the device driver access to the read channel.")] + [Description("Number of bytes read per cycle of the acquisition thread.")] public int ReadSize { get; set; } = 2048; /// From 7a3a6c235a03e3d64b8e2a78113c52aa37779624 Mon Sep 17 00:00:00 2001 From: Brandon Parks Date: Fri, 2 Aug 2024 16:43:02 -0400 Subject: [PATCH 2/2] Change spelling --- OpenEphys.Onix1/MultiDeviceFactory.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenEphys.Onix1/MultiDeviceFactory.cs b/OpenEphys.Onix1/MultiDeviceFactory.cs index 45a56c8f..5874abfe 100644 --- a/OpenEphys.Onix1/MultiDeviceFactory.cs +++ b/OpenEphys.Onix1/MultiDeviceFactory.cs @@ -20,7 +20,7 @@ namespace OpenEphys.Onix1 /// hubs. For instance, the group of devices within a headstage (a single hub) can be combined with a device /// from another hub that is used to control its port voltage and communication status /// (e.g. ). Alternatively, diagnostic devices that are present within - /// an ONI hub can be omitted from a device group to aid it useability (e.g. ). + /// an ONI hub can be omitted from a device group to aid its useability (e.g. ). /// /// /// These device groups are the most common starting point for configuration