init
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Enums/Hardware/HardwareTypes.cs
|
||||
generated_at: "2026-04-17T16:14:41.840190+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "c3e7211775a00a58"
|
||||
---
|
||||
|
||||
# Hardware
|
||||
|
||||
### Purpose
|
||||
This module defines the `HardwareTypes` enumeration within the `DatabaseImport` namespace. It provides a comprehensive catalog of hardware device identifiers used throughout the system, covering SLICE device variants (Base, Bridge, IEPE, NANO, Micro, etc.), TDAS equipment, G5 components, Ribeye devices, and various modules (TOM, SIM, DIM). This enum serves as the canonical hardware type reference for database import operations and hardware identification across the system.
|
||||
|
||||
### Public Interface
|
||||
- **`HardwareTypes`** (enum) - A public enumeration with 34 named hardware type constants:
|
||||
- `SLICE_Base = 0`, `SLICE_Bridge = 1`, `SLICE_Distributor = 2`
|
||||
- `TDAS_Pro_Rack = 3`
|
||||
- `SLICE2_IEPE_Hi = 4`, `SLICE2_IEPE_Lo = 5`, `SLICE2_Bridge_Hi = 6`, `SLICE2_Bridge_Lo = 7`, `SLICE2_Base = 8`
|
||||
- `TOM = 9`, `SIM = 10`, `DIM = 11`
|
||||
- `G5VDS = 12`
|
||||
- `Ribeye = 13`, `RibeyeLED = 14`
|
||||
- `SLICE_IEPE = 15`
|
||||
- `SLICE1_5_Nano_Base = 16`, `SLICE_Micro_Base = 17`, `SLICE_NANO_Base = 18`
|
||||
- `SLICE2_SIM = 19`, `SLICE2_DIM = 20`, `SLICE2_TOM = 21`
|
||||
- `G5INDUMMY = 23` (note: value 22 is skipped/commented out as `G5IPORT`)
|
||||
- `SLICE_EthernetController = 24`
|
||||
- `SLICE1_5_Micro_Base = 25`
|
||||
- `SLICE_LabEthernet = 26`
|
||||
- `SLICE2_SLS = 27`, `SLICE1_G5Stack = 28`, `SLICE2_SLT = 29`, `SLICE2_SLD = 30`
|
||||
- `TDAS_LabRack = 31`
|
||||
- `SLICE6_Base = 32`, `SLICE6DB = 33`
|
||||
|
||||
### Invariants
|
||||
- Enum values are explicitly assigned and
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Enums/Sensors/SensorStatus.cs
|
||||
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Enums/Sensors/LinearizationFormula.cs
|
||||
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Enums/Sensors/ZeroMethodType.cs
|
||||
generated_at: "2026-04-17T16:44:42.091498+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "dd75266de8fb5275"
|
||||
---
|
||||
|
||||
# Documentation: Sensor Enums (DatabaseImport)
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines three enumeration types used within the `DatabaseImport` namespace to represent sensor-related states and configuration options. `SensorStatus` tracks the operational lifecycle state of a sensor. `NonLinearStyles` specifies available linearization formulas for processing non-linear sensor data, with several options specific to IRTracc devices. `ZeroMethodType` defines methods for calculating electrical zero values during sensor data import, with explicit values maintained for legacy compatibility with older data formats (e.g., GM ISF imports).
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `SensorStatus` (enum)
|
||||
Represents the operational status of a sensor in the system.
|
||||
|
||||
| Member | Description |
|
||||
|--------|-------------|
|
||||
| `Available` | Sensor is available for use |
|
||||
| `InUse` | Sensor is currently in use |
|
||||
| `OutForService` | Sensor is out for service |
|
||||
| `OutForCalibration` | Sensor is out for calibration |
|
||||
| `Retired` | Sensor has been retired |
|
||||
|
||||
---
|
||||
|
||||
### `NonLinearStyles` (enum)
|
||||
Defines linearization formula types for non-linear sensor data processing.
|
||||
|
||||
| Member | Description |
|
||||
|--------|-------------|
|
||||
| `IRTraccManual` | IRTracc manual linearization |
|
||||
| `IRTraccDiagnosticsZero` | IRTracc diagnostics zero method |
|
||||
| `IRTraccZeroMMmV` | IRTracc zero MM/mV method |
|
||||
| `IRTraccAverageOverTime` | IRTracc average over time method |
|
||||
| `Polynomial` | Polynomial-based linearization |
|
||||
| `IRTraccCalFactor` | IRTracc calibration factor method |
|
||||
|
||||
---
|
||||
|
||||
### `ZeroMethodType` (enum)
|
||||
Defines methods for calculating electrical zero values. Members have explicit integer values assigned for legacy compatibility.
|
||||
|
||||
| Member | Value | Description |
|
||||
|--------|-------|-------------|
|
||||
| `AverageOverTime` | 0 | Calculate electrical zero using an average over time |
|
||||
| `UsePreEventDiagnosticsZero` | 1 | Calculate zero using time in pre-event diagnostics |
|
||||
| `None` | 2 | Calculate zero using an injected value (absolute zero) |
|
||||
|
||||
---
|
||||
|
||||
## 3. Invariants
|
||||
|
||||
- **`ZeroMethodType` explicit values must not change**: The source explicitly states that "Lots of legacy compatibility (e.g. importing GM ISF) depends on the order/value of this enum." The integer values 0, 1, and 2 are contractually bound for backward compatibility.
|
||||
- **Enum member order for `ZeroMethodType` is significant**: Reordering members would break legacy data import functionality.
|
||||
|
||||
---
|
||||
|
||||
## 4. Dependencies
|
||||
|
||||
**Dependencies of this module:**
|
||||
- None visible from source. These enums are self-contained with no external imports.
|
||||
|
||||
**Dependents (inferred):**
|
||||
- Other components within the `DatabaseImport` namespace that handle sensor data import, particularly those processing IRTracc sensor data or GM ISF legacy formats.
|
||||
|
||||
---
|
||||
|
||||
## 5. Gotchas
|
||||
|
||||
1
|
||||
Reference in New Issue
Block a user