 |
Xentara WebSocket API Specification v2.1
User Manual
|
|
Xentara WebSocket API Specification v2.1
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 | Metadata |
|---|---|
| 0 | Primary Key |
| 1 | Element Category |
| 2 | Attribute List |
| 3 | Has Children |
| 4 | Child Count |
Child count metadata (metadata identifier 4) is not supported in protocol version 1 (Xentara 2.0).
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 value |
| 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 | 8-bit character string |
| 12 | platform specific wide character string |
| 13 | UTF-8 string |
| 14 | UTF-16 string |
| 15 | UTF-32 string |
| 16 | time point |
| 17 | uUID |
| 18 | quality |
| 19 | element category |
| 20 | error code |
| 21 | custom data type |
| 22 | no data |
| 23 | image |
The image data type (data type identifier 23) is not used in protocol version 1 (Xentara 2.0). Instead, data type identifier 21 (custom data type) is used.
The access identifier defines the access level for Xentara attributes.
| Value | Access |
|---|---|
| 0 | Read Only |
| 1 | Write Only |
| 2 | Read and Write |