56 lines
2.7 KiB
Markdown
56 lines
2.7 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Interface/Communication/ICommunicationReport.cs
|
||
|
|
- Common/DTS.Common/Interface/Communication/IDASConnectedDevice.cs
|
||
|
|
- Common/DTS.Common/Interface/Communication/ICommunication_DASInfo.cs
|
||
|
|
generated_at: "2026-04-17T16:35:32.988385+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "32c2a3f63497bcca"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Interface.Communication
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines a set of interfaces for modeling communication with Data Acquisition System (DAS) hardware and connected devices. It provides contracts for reporting communication results (`ICommunicationReport`), describing devices connected to a DAS (`IDASConnectedDevice`), and exposing DAS-specific metadata such as serial numbers, firmware versions, first-use tracking, and streaming capability (`ICommunication_DASInfo`). These interfaces enable decoupled communication between hardware abstraction layers and higher-level application logic.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `ICommunicationReport`
|
||
|
|
Defines a structure for reporting the outcome of a communication operation.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `UserState` | `object` | Gets or sets arbitrary user state associated with the communication. |
|
||
|
|
| `Result` | `CommunicationConstantsAndEnums.CommunicationResult` | Gets or sets the result status of the communication. |
|
||
|
|
| `Data` | `byte[]` | Gets or sets the raw data payload from the communication. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `IDASConnectedDevice`
|
||
|
|
Describes a device connected to a DAS (e.g., an S6 connected to an S6DB). Part of feature 10582 for auto-discovering and monitoring DAS status.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `DeviceType` | `HardwareTypes` | Gets the hardware type of the connected device. |
|
||
|
|
| `Port` | `int` | Gets the 0-based port index on the DAS where the device is connected. |
|
||
|
|
| `SpotOnPort` | `int` | Gets the 0-based position on the chain or port where the device resides. |
|
||
|
|
| `PhysicalAddress` | `PhysicalAddress` | Gets the MAC/physical address of the device. |
|
||
|
|
| `IPAddress` | `string` | Gets the IP address of the device. |
|
||
|
|
| `SerialNumber` | `string` | Gets the serial number of the device. |
|
||
|
|
| `Location` | `string` | Gets the location descriptor of the device. |
|
||
|
|
| `Version` | `string` | Gets the firmware/hardware version of the device. |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `ICommunication_DASInfo`
|
||
|
|
Provides metadata and device enumeration for a DAS unit.
|
||
|
|
|
||
|
|
| Member | Type | Description |
|
||
|
|
|--------|------|-------------|
|
||
|
|
| `ConnectedDevices` | `IDASConnectedDevice[]` | Gets the array of devices connected to this DAS. Currently only used by SLICE6DB. |
|
||
|
|
| `SetConnectedDevices(IDASConnectedDevice[] devices)` | `void` | Sets the `ConnectedDevices` array. |
|
||
|
|
| `SerialNumbers` |
|