Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
soplarpet:error_table [2024/12/06 11:01] superuser |
soplarpet:error_table [2024/12/06 11:06] (current) superuser [Parameter Descriptions] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| The `GetErrorTable` method returns a list of `ErrorData` objects representing the current errors in the system. Each `ErrorData` object contains information about the time the error occurred, error type, device code, error message, and any additional information. | The `GetErrorTable` method returns a list of `ErrorData` objects representing the current errors in the system. Each `ErrorData` object contains information about the time the error occurred, error type, device code, error message, and any additional information. | ||
| - | ==== Example Usage ==== | + | ==== Parameter Descriptions ==== |
| + | |||
| + | 1. **Time** | ||
| + | - **Type**: DateTime | ||
| + | - **Description**: The timestamp indicating when the error occurred. | ||
| + | |||
| + | 2. **ErrorType** | ||
| + | - **Type**: int | ||
| + | - **Description**: An enumeration representing the type of error. Examples include: | ||
| + | - **1**: Camera connection error | ||
| + | - **2**: Camera ping error | ||
| + | - **3**: Camera missing | ||
| + | - **4**: Configuration corrupted | ||
| + | - **5**: Configuration missing | ||
| + | - **6**: Halcon license missing | ||
| + | - **7**: Free space missing | ||
| + | |||
| + | 3. **DeviceCode** | ||
| + | - **Type**: int | ||
| + | - **Description**: Identifies the device associated with the error. | ||
| + | - Values below **100** indicate a camera (e.g., **1** for Camera 1). | ||
| + | - **100** represents the PC. | ||
| + | |||
| + | 4. **Message** | ||
| + | - **Type**: string | ||
| + | - **Description**: A descriptive message providing details about the error. | ||
| + | |||
| + | 5. **Additional** | ||
| + | - **Type**: string[] | ||
| + | - **Description**: An optional list of strings containing additional data relevant to the error. For example: For free space errors, this may include the amount of space needed (in bytes). | ||
| + | |||
| + | |||
| + | ==== Examples ==== | ||
| Below are examples of the JSON returned by the GetErrorTable method for different error types. | Below are examples of the JSON returned by the GetErrorTable method for different error types. | ||