init
This commit is contained in:
68
docs/ai/DataPRO/CanFDApiProxy/Interfaces.md
Normal file
68
docs/ai/DataPRO/CanFDApiProxy/Interfaces.md
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/CanFDApiProxy/Interfaces/ICANFDApi.cs
|
||||
generated_at: "2026-04-17T16:30:03.655597+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "b24ad9d8b14edfc6"
|
||||
---
|
||||
|
||||
# Interfaces
|
||||
|
||||
### Purpose
|
||||
This module defines the `ICANFDApi` interface, which abstracts communication with CAN-FD (Controller Area Network with Flexible Data-rate) devices. It provides a comprehensive contract for retrieving device status, configuring hardware settings, and managing file operations on remote CAN-FD devices identified by a device host string.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**Interface: `ICANFDApi`**
|
||||
|
||||
**Read Operations (all async, return `Task<T>`):**
|
||||
- `Task<UsbTreeMessage> GetUsbTree(string deviceHost, CancellationToken cancellationToken)` - Retrieves USB tree structure.
|
||||
- `Task<UsbStatsMessage> GetUsbStats(string deviceHost, CancellationToken cancellationToken)` - Retrieves USB statistics.
|
||||
- `Task<SerialMessage> GetSerial(string deviceHost, CancellationToken cancellationToken)` - Retrieves serial information.
|
||||
- `Task<LEDsMessage> GetLEDs(string deviceHost, CancellationToken cancellationToken)` - Retrieves LED status.
|
||||
- `Task<ClocksMessage> GetClocks(string deviceHost, CancellationToken cancellationToken)` - Retrieves clock information.
|
||||
- `Task<EventPinMessage> GetEventPin(string deviceHost, CancellationToken cancellationToken)` - Retrieves event pin status.
|
||||
- `Task<CANConfigMessage> GetCANConfig(string deviceHost, CancellationToken cancellationToken)` - Retrieves CAN configuration.
|
||||
- `Task<CANInfoMessage> GetCANInfo(string deviceHost, CancellationToken cancellationToken)` - Retrieves CAN information.
|
||||
- `Task<CANStateMessage> GetCANState(string deviceHost, CancellationToken cancellationToken)` - Retrieves CAN state.
|
||||
- `Task<CANStatsMessage> GetCANStats(string deviceHost, CancellationToken cancellationToken)` - Retrieves CAN statistics.
|
||||
- `Task<BatteryMessage> GetBattery(string deviceHost, CancellationToken cancellationToken)` - Retrieves battery status.
|
||||
- `Task<ServicesMessage> GetServices(string deviceHost, CancellationToken cancellationToken)` - Retrieves services information.
|
||||
- `Task<NtpMessage> GetNtp(string deviceHost, CancellationToken cancellationToken)` - Retrieves NTP configuration.
|
||||
- `Task<PowerMessage> GetPower(string deviceHost, CancellationToken cancellationToken)` - Retrieves power status.
|
||||
- `Task<DeviceInfoMessage> GetDeviceInfo(string deviceHost, CancellationToken cancellationToken)` - Retrieves device information.
|
||||
- `Task<RecordingMessage> GetRecording(string deviceHost, CancellationToken cancellationToken)` - Retrieves recording status.
|
||||
- `Task<NetworkMessage> GetNetwork(string deviceHost, CancellationToken cancellationToken)` - Retrieves network configuration.
|
||||
|
||||
**Write Operations (all async):**
|
||||
- `Task<SerialMessage> SetSerial(string deviceHost, SerialRequest serialRequest, CancellationToken cancellationToken)` - Sets serial configuration.
|
||||
- `Task<LEDsPostMessage> SetLEDs(string deviceHost, LedName led, LedCmd cmd, LedColor color, CancellationToken cancellationToken)` - Controls LED state.
|
||||
- `Task<ClocksMessage> SetClocks(string deviceHost, DateTime dateTime, CancellationToken cancellationToken)` - Sets device clock.
|
||||
- `Task<EventPinMessage> SetEventPinArm(string deviceHost, CancellationToken cancellationToken)` - Arms the event pin.
|
||||
- `Task<EventPinMessage> SetEventPinDisarm(string deviceHost, CancellationToken cancellationToken)` - Disarms the event pin.
|
||||
- `Task<ClocksMessage> SyncClocks(string deviceHost, CancellationToken cancellationToken)` - Synchronizes clocks.
|
||||
- `Task<CANConfigMessage> SetCANConfig(string deviceHost, CANConfigRequest canConfigRequest, CancellationToken cancellationToken)` - Sets CAN configuration.
|
||||
- `Task<PowerMessage> SetPowerOff(string deviceHost, CancellationToken cancellationToken)` - Powers off the device.
|
||||
- `Task<PowerMessage> SetPowerReboot(string deviceHost, CancellationToken cancellationToken)` - Reboots the device.
|
||||
- `Task<RecordingMessage> SetRecordingStart(string deviceHost, CancellationToken cancellationToken)` - Starts recording.
|
||||
- `Task<RecordingMessage> SetRecordingStop(string deviceHost, CancellationToken cancellationToken)` - Stops recording.
|
||||
- `Task<NetworkMessage> SetNetwork(string deviceHost, NetworkRequest networkRequest, CancellationToken cancellationToken)` - Sets network configuration.
|
||||
|
||||
**File Operations:**
|
||||
- `Task Download(string deviceHost, string usbPath, string destinationDirectory, TimeSpan timeOut, CancellationToken cancellationToken)` - Downloads a file from device.
|
||||
- `Task<StatusMessage> Upload(string deviceHost, string uploadUsbPath, string sourcefile, TimeSpan timeOut, CancellationToken cancellationToken)` - Uploads a file to device.
|
||||
- `Task<StatusMessage> Delete(string deviceHost, string usbPath, CancellationToken cancellationToken)` - Deletes a file on device.
|
||||
|
||||
### Invariants
|
||||
- All interface methods require a non-null `deviceHost` string (not enforced at interface level, but implied by design).
|
||||
- All operations are cancellable via `CancellationToken`.
|
||||
- All operations are asynchronous and return `Task` or `Task<T>`.
|
||||
|
||||
### Dependencies
|
||||
**Depends on:**
|
||||
- `CANFDApiProxy.Messages` - Message types for responses (UsbTreeMessage, SerialMessage, etc.)
|
||||
- `CANFDApiProxy.Requests` - Request types for write operations (SerialRequest, CANConfigRequest, NetworkRequest)
|
||||
- `System`, `System.Threading`, `System.Threading.Tasks` - BCL types
|
||||
|
||||
**Depended on by:** Implementations of this interface (not present
|
||||
77
docs/ai/DataPRO/CanFDApiProxy/Messages.md
Normal file
77
docs/ai/DataPRO/CanFDApiProxy/Messages.md
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/CanFDApiProxy/Messages/StatusMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/ErrorMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/NtpMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/LEDsPostMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/DiagnosticsMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/ClocksMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/DeviceInfoMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/SerialMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/ServicesMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/NetworkMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CalibrationMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CANInfoMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/UsbTreeMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/BatteryMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/RecordingMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/PowerMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/EventPinMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CANStateMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/LEDsMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CANStatsMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CANConfigMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/UsbStatsMessage.cs
|
||||
- DataPRO/CanFDApiProxy/Messages/CANInfoInternal.cs
|
||||
generated_at: "2026-04-17T15:45:02.925780+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "2dc83337f53d0fe1"
|
||||
---
|
||||
|
||||
# CANFDApiProxy.Messages Documentation
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines Data Transfer Objects (DTOs) for serializing and deserializing messages exchanged with a CAN-FD (Controller Area Network Flexible Data-rate) device API. It provides strongly-typed representations of device state, configuration, diagnostics, and control messages for hardware components including CAN bus interfaces, battery systems, USB storage, LEDs, network interfaces, and system services. The module serves as the message contract layer between the API proxy and downstream consumers.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Simple Message Classes
|
||||
|
||||
| Class | Properties | Notes |
|
||||
|-------|------------|-------|
|
||||
| `StatusMessage` | `status` (string) | Generic status response |
|
||||
| `ErrorMessage` | `Error` (string) | Error response container |
|
||||
| `NtpMessage` | `Ntp` (string), `Fallback` (string) | NTP server configuration |
|
||||
| `LEDsPostMessage` | `status` (string), `reply` (string) | LED POST operation response |
|
||||
| `DiagnosticsMessageRequest` | `format` (string) | Overrides `ToString()` |
|
||||
| `ClocksMessage` | `Rtc_present` (bool?), `Rtc_setup` (bool?), `System` (string), `Status` (string) | Real-time clock status |
|
||||
| `DeviceInfoMessage` | `Kernel_version`, `Os_release`, `Serial_number`, `Version_number` (all string) | Device identification |
|
||||
| `SerialMessage` | `Serial` (string), `Status` (string) | Overrides `ToString()` |
|
||||
| `NetworkMessage` | `Current_address`, `Interface`, `Mac_address`, `Set_address`, `Ok` (string); `Dhcp` (bool) | Network configuration |
|
||||
| `CalibrationMessage` | `Calibration_date` (int), `Calibration_date_string` (string) | Overrides `ToString()` |
|
||||
| `RecordingMessage` | `Recording`, `Recording_dir`, `Ok`, `Reply` (string); `Autoarm` (bool) | Overrides `ToString()` |
|
||||
| `PowerMessage` | `Battery_enable`, `Nvin_pin`, `On_pin`, `Power_fault` (bool); `Status` (string) | Overrides `ToString()` |
|
||||
| `EventPinMessage` | `Armed`, `Event`, `Event_pin` (bool?); `File_name`, `Ok`, `Reply` (string) | Overrides `ToString()` |
|
||||
| `BatteryMessage` | `LoadV`, `Current`, `Power`, `Percent` (decimal); `Enable` (bool) | Overrides `ToString()` |
|
||||
|
||||
### Collection-Based Message Classes
|
||||
|
||||
**`ServicesMessage`**
|
||||
- `services` (Service[])
|
||||
- Nested class `Service`: `Enabled` (bool), `Name` (string), `Status` (string)
|
||||
|
||||
**`CANInfoMessage`**
|
||||
- `CANInfoList` (List\<CANInfo\>)
|
||||
- Nested class `CANInfo`: Constructor `(string name, string info)`, read-only properties `Name`, `Info`
|
||||
|
||||
**`CANStateMessage`**
|
||||
- `CANStateList` (List\<CANState\>)
|
||||
- Nested class `CANState`: Constructor `(string name, string state, float last_updated)`, `Name` (read-only), `State`, `Last_updated` (settable)
|
||||
|
||||
**`CANStatsMessage`**
|
||||
- `CANStatsList` (List\<CANStats\>)
|
||||
- Nested class `CANStats`: Constructor with parameters `(string name, int std_data, int std_remote, int ext_data, int ext_remote, int err_frame, float bus
|
||||
35
docs/ai/DataPRO/CanFDApiProxy/Properties.md
Normal file
35
docs/ai/DataPRO/CanFDApiProxy/Properties.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/CanFDApiProxy/Properties/AssemblyInfo.cs
|
||||
generated_at: "2026-04-17T16:13:47.324171+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "f4a4a1f2e3e78604"
|
||||
---
|
||||
|
||||
# Properties
|
||||
|
||||
### Purpose
|
||||
This module contains assembly metadata for the TDASCommands assembly. It is a standard .NET Framework assembly information file that defines versioning, copyright, and COM visibility settings for the TDASCommands component, which appears to be a commands library dating from 2010.
|
||||
|
||||
### Public Interface
|
||||
No public types are defined in this module. It consists solely of assembly-level attributes:
|
||||
- `AssemblyTitle("TDASCommands")` - Sets the assembly title
|
||||
- `AssemblyProduct("TDASCommands")` - Sets the product name
|
||||
- `AssemblyCopyright("Copyright © 2010")` - Sets copyright information
|
||||
- `ComVisible(false)` - Disables COM visibility for all types
|
||||
- `Guid("58258526-9c64-480c-8758-99cb200c3277")` - COM type library identifier
|
||||
- `AssemblyVersion("1.06.0081")` - Assembly version
|
||||
- `AssemblyFileVersion("1.06.0081")` - File version
|
||||
|
||||
### Invariants
|
||||
- `ComVisible` is always `false` for the entire assembly.
|
||||
- `AssemblyVersion` and `AssemblyFileVersion` are synchronized at "1.06.0081".
|
||||
|
||||
### Dependencies
|
||||
**Depends on:**
|
||||
- `System.Reflection`
|
||||
- `System.Runtime.CompilerServices`
|
||||
- `System.Runtime.InteropServices`
|
||||
|
||||
**Depended on by:** Unclear from source alone (this is a leaf metadata module
|
||||
64
docs/ai/DataPRO/CanFDApiProxy/Requests.md
Normal file
64
docs/ai/DataPRO/CanFDApiProxy/Requests.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
source_files:
|
||||
- DataPRO/CanFDApiProxy/Requests/SerialRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/CanPostRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/FileRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/ClocksRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/NetworkRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/LEDsRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/CANConfigRequest.cs
|
||||
- DataPRO/CanFDApiProxy/Requests/CanConfigItem.cs
|
||||
generated_at: "2026-04-17T16:44:05.151206+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "8f8c1bcb2ea885e5"
|
||||
---
|
||||
|
||||
# CANFDApiProxy.Requests Namespace Documentation
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines Data Transfer Objects (DTOs) for request payloads in the CANFDApiProxy system. It provides strongly-typed models for serializing requests to a CAN FD (Flexible Data-rate) API proxy, covering operations such as CAN bus configuration, LED control, network settings, serial number handling, file operations, and clock synchronization. These request models serve as the input contracts for API calls to the underlying CAN FD hardware abstraction layer.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### Public Classes
|
||||
|
||||
#### `SerialRequest`
|
||||
```csharp
|
||||
public class SerialRequest
|
||||
{
|
||||
public string serial { get; set; }
|
||||
}
|
||||
```
|
||||
A request model for serial number operations. Contains a single `serial` property for transmitting or querying serial number data.
|
||||
|
||||
---
|
||||
|
||||
#### `NetworkRequest`
|
||||
```csharp
|
||||
public class NetworkRequest
|
||||
{
|
||||
public bool dhcp { get; set; }
|
||||
public string set_address { get; set; }
|
||||
}
|
||||
```
|
||||
A request model for network configuration. The `dhcp` flag enables/disables DHCP mode; `set_address` specifies a static IP address when DHCP is disabled.
|
||||
|
||||
---
|
||||
|
||||
#### `LEDsRequest`
|
||||
```csharp
|
||||
public class LEDsRequest
|
||||
{
|
||||
public string led { get; set; }
|
||||
public string cmd { get; set; }
|
||||
public string color { get; set; }
|
||||
}
|
||||
```
|
||||
A request model for controlling LEDs on the CAN FD device. All properties are strings, though corresponding enums exist for type-safe usage.
|
||||
|
||||
**Associated Enums:**
|
||||
- `LedColor
|
||||
Reference in New Issue
Block a user