64 lines
2.0 KiB
Markdown
64 lines
2.0 KiB
Markdown
|
---
|
||
|
|
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
|