 |
Xentara WebSocket API Specification v2.0.3
User Manual
|
|
Xentara WebSocket API Specification v2.0.3
User Manual
|
The packet type identifier is used to distinguish between various types of packets.
| Value | Packet Type |
|---|---|
| 0 | Request |
| 1 | Success Response |
| 2 | Error Response |
| 8 | Events |
The event type identifier is used to distinguish between various types of events.
| Value | Event Type |
|---|---|
| 0 | Data Change |
The element categories identifier corresponds to the Xentara element categories.
| Value | Category |
|---|---|
| 0 | Root Element |
| 1 | Element Group |
| 2 | Data Point |
| 3 | Timer |
| 4 | Execution Track |
| 5 | Execution Pipeline |
| 6 | Device |
| 7 | Sub Device |
| 8 | Device Group |
| 9 | Data Point Group |
| 10 | Transaction |
| 11 | Microservice |
| 12 | AI |
| 13 | Data Storage |
| 14 | External Interface |
| 15 | Special Purpose |
The server information identifier is used to obtain various server properties, including the current Xentara version, the account username, and the file path of the active model.
| Value | Server Information |
|---|---|
| 0 | Version |
| 1 | User Name |
| 2 | Model File Path |
The metadata identifier is utilized to retrieve various properties of Xentara elements, providing detailed information about each element.
| Value | Meta Data |
|---|---|
| 0 | Primary Key |
| 1 | Element Category |
| 2 | Attribute List |
| 3 | Has Children |
The attribute identifier is used to describe the various attributes of a Xentara elements. For convenience, the default and most commonly used attributes are assigned specific identifiers.
| Value | Attribute |
|---|---|
| 0 | Primary Key |
| 1 | Name |
| 2 | UUID |
| 3 | Type |
| 4 | Category |
| 5 | Source Time |
| 6 | Update Time |
| 7 | Change Time |
| 8 | Write Time |
| 9 | Quality |
| 10 | Device State |
| 11 | Value |
| 12 | Error |
| 13 | Write Error |
The quality identifier is associated with the Xentara data quality.
| Value | Quality |
|---|---|
| 0 | Good |
| 1 | Acceptable |
| 2 | Unreliable |
| 3 | Bad |
The operational stage identifier corresponds to the various Xentara operational stages.
| Value | Operational Stage |
|---|---|
| 0 | Start Up |
| 1 | Pre Operational |
| 2 | Operational |
| 3 | Post Operational |
| 4 | Shutdown |
| 5 | Suspended |
The data type identifier specifies the data type of Xentara attributes.
| Value | Data Type |
|---|---|
| 0 | Boolean |
| 1 | 8 bit Signed Integer |
| 2 | 16 bit Signed Integer |
| 3 | 32 bit Signed Integer |
| 4 | 64 bit Signed Integer |
| 5 | 8 bit Unsigned Integer |
| 6 | 16 bit Unsigned Integer |
| 7 | 32 bit Unsigned Integer |
| 8 | 64 bit Unsigned Integer |
| 9 | Single Precision Floating Point Number |
| 10 | Double Precision Floating Point Number |
| 11 | String |
| 12 | WString |
| 13 | U8String |
| 14 | U16String |
| 15 | U32String |
| 16 | Time Point |
| 17 | Uuid |
| 18 | Quality |
| 19 | Element Category |
| 20 | Error Code |
| 21 | Custom |
| 22 | None |
The access identifier defines the access level for Xentara attributes.
| Value | Access |
|---|---|
| 0 | Read Only |
| 1 | Write Only |
| 2 | Read and Write |