Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
soplarpet:error_table [2024/09/16 10:33] superuser created |
soplarpet:error_table [2024/12/06 11:06] (current) superuser [Parameter Descriptions] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== Documentation for `GetErrorTable` Method ===== | ===== Documentation for `GetErrorTable` Method ===== | ||
| - | The `GetErrorTable` method returns a list of `ErrorData` objects representing the current errors in the system. Each `ErrorData` object contains information about the 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. | ||
| - | === Example 1: No Error === | + | ==== Example 1: No Error ==== |
| <code> | <code> | ||
| Line 17: | Line 49: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:15:30", | ||
| "ErrorType":1, | "ErrorType":1, | ||
| "DeviceCode":1, | "DeviceCode":1, | ||
| "Message":"Camera connection error: Device 1", | "Message":"Camera connection error: Device 1", | ||
| "Additional":[ | "Additional":[ | ||
| + | | ||
| ] | ] | ||
| } | } | ||
| Line 31: | Line 65: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:16:00", | ||
| "ErrorType":2, | "ErrorType":2, | ||
| - | "DeviceCode":102, | + | "DeviceCode":2, |
| - | "Message":"Camera ping error: Device 102", | + | "Message":"Camera ping error: Device 2", |
| "Additional":[ | "Additional":[ | ||
| Line 45: | Line 80: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:16:30", | ||
| "ErrorType":3, | "ErrorType":3, | ||
| - | "DeviceCode":103, | + | "DeviceCode":3, |
| - | "Message":"Camera missing: Device 103", | + | "Message":"Camera missing: Device 3", |
| "Additional":[ | "Additional":[ | ||
| Line 60: | Line 96: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:17:00", | ||
| "ErrorType":4, | "ErrorType":4, | ||
| - | "DeviceCode":104, | + | "DeviceCode":100, |
| - | "Message":"Configuration corrupted: Device 104", | + | "Message":"Configuration corrupted: Device 100", |
| "Additional":[ | "Additional":[ | ||
| Line 74: | Line 111: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:17:30", | ||
| "ErrorType":5, | "ErrorType":5, | ||
| - | "DeviceCode":105, | + | "DeviceCode":100, |
| - | "Message":"Configuration missing: Device 105", | + | "Message":"Configuration missing: Device 100", |
| "Additional":[ | "Additional":[ | ||
| Line 88: | Line 126: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:18:00", | ||
| "ErrorType":6, | "ErrorType":6, | ||
| - | "DeviceCode":106, | + | "DeviceCode":100, |
| - | "Message":"Halcon license missing: Device 106", | + | "Message":"Halcon license missing: Device 100", |
| "Additional":[ | "Additional":[ | ||
| Line 103: | Line 142: | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:18:30", | ||
| "ErrorType":7, | "ErrorType":7, | ||
| - | "DeviceCode":107, | + | "DeviceCode":100, |
| - | "Message":"Free space missing: Device 107", | + | "Message":"Free space missing: Device 100", |
| "Additional":[ | "Additional":[ | ||
| "5000000000" | "5000000000" | ||
| Line 114: | Line 154: | ||
| ==== Example 9: Multiple Errors ==== | ==== Example 9: Multiple Errors ==== | ||
| + | <code> | ||
| [ | [ | ||
| { | { | ||
| + | "Time":"2024-12-06T10:19:00", | ||
| "ErrorType":1, | "ErrorType":1, | ||
| - | "DeviceCode":101, | + | "DeviceCode":1, |
| - | "Message":"Camera connection error: Device 101", | + | "Message":"Camera connection error: Device 1", |
| "Additional":[ | "Additional":[ | ||
| Line 125: | Line 166: | ||
| }, | }, | ||
| { | { | ||
| + | "Time":"2024-12-06T10:19:30", | ||
| "ErrorType":2, | "ErrorType":2, | ||
| - | "DeviceCode":102, | + | "DeviceCode":1, |
| - | "Message":"Camera ping error: Device 102", | + | "Message":"Camera ping error: Device 1", |
| "Additional":[ | "Additional":[ | ||
| Line 133: | Line 175: | ||
| }, | }, | ||
| { | { | ||
| + | "Time":"2024-12-06T10:20:00", | ||
| "ErrorType":7, | "ErrorType":7, | ||
| - | "DeviceCode":107, | + | "DeviceCode":100, |
| - | "Message":"Free space missing: Device 107", | + | "Message":"Free space missing: Device 100", |
| "Additional":[ | "Additional":[ | ||
| - | "5000000000" | + | "100000000" |
| ] | ] | ||
| } | } | ||
| ] | ] | ||
| + | </code> | ||