Version 1, Revision 7
15 April, 2024
Dmitry Lavygin
© 2020-2024 Dmitry Lavygin (vdm.inbox@gmail.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THE SOFTWARE AND THIS DOCUMENT ARE PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE SOFTWARE OR THIS DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
| [PREVIOUS PAGE] | 2 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
| Revision | Notes | Date |
|---|---|---|
| 1 | Initial release | 2020-08-04 |
| 2 |
Fixed
Added
Changed
|
2021-05-30 |
| 3 |
Fixed
|
2021-06-06 |
| 4 |
Important The documentation has migrated to HTML format
Fixed
Added
Changed
|
2022-02-10 |
| 5 |
Fixed
|
2022-03-24 |
| 6 |
Added
Changed
|
2024-01-26 |
| 7 |
Added
Changed
|
2024-04-15 |
| [PREVIOUS PAGE] | 3 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
| [PREVIOUS PAGE] | 4 | [NEXT PAGE] | [UP] [HOME] |
| Term | Description |
|---|---|
| IP |
Internet Protocol The Internet Protocol (IP) is the principal communications protocol in the Internet protocol suite. It is responsible for addressing host interfaces, encapsulating data into datagrams (including fragmentation and reassembly) and routing datagrams from a source host interface to a destination host interface across one or more IP networks. |
| TCP/IP |
Transmission Control Protocol The Transmission Control Protocol provides a communication service at an intermediate level between an application program and the Internet Protocol. It provides host-to-host connectivity at the transport layer of the Internet model. |
| UDP/IP |
User Datagram Protocol UDP is a simple message-oriented transport layer protocol that is documented in RFC 768. Although UDP provides integrity verification (via checksum) of the header and payload, it provides no guarantees to the upper layer protocol for message delivery and the UDP layer retains no state of UDP messages once sent. |
| KRC |
KUKA Robot Controller |
| KRL |
KUKA Robot Language KUKA Robot programming language. |
| KUKA Cross 3 |
Internal mechanism of inter process communication in the KUKA robot control system. |
| KukavarProxy |
KukavarProxy is a TCP/IP server that allows KRL variables to be read and written over a network connection. |
| [PREVIOUS PAGE] | 5 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
This document describes the protocols used by the C3 Bridge Interface Server. The C3 Bridge Interface Server is a lightweight network application that allows remote clients to execute requests to KUKA Cross 3 subsystem and return responses. The application provides advanced functionality and high performance.
All products in the C3 Bridge family use versions consisting of three or, in some cases, four numbers. The first two numbers represent the major and minor components of the version. The third number denotes the type of build shown in the table below. The fourth number can only be used for internal builds.
| Version Number | Build Type |
|---|---|
| 0 | Open Source |
| 1 | Proprietary |
| 2 | Freeware |
| 3 | Internal Build |
| [PREVIOUS PAGE] | 6 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The C3 Bridge Interface Server can use two network protocols.
The first protocol, called the Discovery Protocol, is based on UDP and can be used to detect a remote server and find out its capabilities. The Discovery Protocol can operate in legacy or standard mode, or both. The legacy mode is implemented for compatibility with KukavarProxy features.
The second protocol is the primary one. It is based on TCP and is designed for remote interaction with the KUKA robot control system.
The table below shows a summary of the protocols and network ports on which they operate by default.
| Protocol | Based on | Listening port | Port to answer | Support in KukavarProxy |
|---|---|---|---|---|
| Discovery (legacy) | UDP | 6999 | 7000 | Yes |
| Discovery (standard) | UDP | 7000 | source port of peer | |
| Primary | TCP | 7000 | — | Yes, limited |
All multibyte fields in protocol messages are composed using the network byte order (or big-endian, most significant byte is transmitted first). Although this is in contradiction with the Intel IA-32 platform byte order (little-endian), the network byte order was chosen to provide compatibility with the KukavarProxy protocol.
The exceptions to this order are characters and strings in UTF16 format. The system byte order (little-endian) is used for them.
Base 16 (hexadecimal) numbers are represented by a string of hexadecimal digits followed by the character "h" (for example, 0D0Ah). A hexadecimal digit is a character from the following set: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B, C, D, E, and F.
| [PREVIOUS PAGE] | 7 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The following table gives information about the types of data used:
| Name | Description | Size (bytes) | Range | |
|---|---|---|---|---|
| MIN | MAX | |||
| UINT8 | Unsigned Integer, 8−bit | 1 | 0 | 255 |
| INT8 | Signed Integer, 8−bit | 1 | -128 | 127 |
| UINT16 | Unsigned Integer, 16−bit | 2 | 0 | 65535 |
| INT16 | Signed Integer, 16−bit | 2 | -32768 | 32767 |
| UINT32 | Unsigned Integer, 32−bit | 4 | 0 | 4294967295 |
| INT32 | Signed Integer, 32−bit | 4 | -2147483648 | 2147483647 |
| UINT64 | Unsigned Integer, 64−bit | 8 | 0 | 264 - 1 |
| INT64 | Signed Integer, 64−bit | 8 | -264 / 2 | 264 / 2 - 1 |
| BOOL | Boolean Type | 1 | 0 | 1[1] |
| CHAR | ASCII / ISO/IEC 8859−1 Character | 1 | ||
| STRING | ASCII / ISO/IEC 8859−1 String | variable | ||
| WCHAR | Unicode Character (encoded in UTF−16LE) |
2 | ||
| WSTRING | Unicode String (encoded in UTF−16LE) |
variable (even) | ||
| BINARY | Binary Data (array of UINT8) |
variable | ||
| [PREVIOUS PAGE] | 8 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The C3 Bridge Interface stores its settings in the HKEY_CURRENT_USER\Software\C3 Bridge Interface section of the Windows Registry. The most significant options can be set using command line arguments at the time the application is started.
All options except -debug and -verbose are only available in version 1.7.1 (Proprietary) and newer.
| Parameter | Description |
|---|---|
| -defaults | Sets all settings to default values. |
| -debug |
Sets the logging level to Debug and does not minimize the main window to the tray at startup.
Registry Parameter: LogSeverity |
| -verbose |
Sets the logging level to Verbose.
Registry Parameter: LogSeverity |
| -logSeverity <value> |
Possible Values: 1 - 6 Sets the desired logging level:
Registry Parameter: LogSeverity Default Value: 4 |
| -logLimit <value> |
Possible Values: 0 - 65536 Sets the maximum number of log lines. A zero value removes the software limit and leaves it to the discretion of the operating system.
Registry Parameter: LogLimit Default Value: 4000 |
| -tcpAddress <value> |
Possible Values: IPv4 address Sets the IP address where the primary protocol server (TCP) will listen.
Registry Parameter: NetworkTcpAddress Default Value: 0.0.0.0 |
| -tcpPort <value> |
Possible Values: 0 - 65534 Sets the network port on which the primary protocol server (TCP) will listen. A zero value has a special meaning and disables the protocol completely.
Registry Parameter: NetworkTcpPort Default Value: 7000
Registry Parameter: NetworkTcpEnabled Default Value: 1 |
| -udpAddress <value> |
Possible Values: IPv4 address Sets the IP address where the discovery protocol server (UDP) will listen.
Registry Parameter: NetworkUdpAddress Default Value: 0.0.0.0 |
| -udpPort <value> |
Possible Values: 0 - 65534 Sets the network port on which the discovery protocol server (UDP) will listen. A zero value has a special meaning and disables the protocol completely.
Registry Parameter: NetworkUdpPort Default Value: 7000
Registry Parameter: NetworkUdpEnabled Default Value: 1 |
| -legacyPort <value> |
Possible Values: 0 - 65534 Sets the network port on which the legacy discovery protocol server (UDP) will listen. A zero value has a special meaning and disables the protocol completely.
Registry Parameter: NetworkUdpLegacyPort Default Value: 6999
Registry Parameter: NetworkUdpLegacyEnabled Default Value: 1 |
| -legacyPeerPort <value> |
Possible Values: 1 - 65534 The remote port number to which the response from the legacy discovery server (UDP) will be sent.
Registry Parameter: NetworkUdpLegacyPeer Default Value: 7000 |
| C3Bridge.exe -debug -tcpPort 7001 |
| [PREVIOUS PAGE] | 9 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The Discovery Protocol uses the UDP datagrams that contain text messages of a predetermined length. In the legacy mode, the sender makes requests to the server on port 6999 and the server responds to port 7000 of the sender. In standard mode, the sender makes requests to the server on port 7000, and the server responds to the sender's address and port, allowing the sender to use any port to receive responses.
| [PREVIOUS PAGE] | 10 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: Yes
Determination of the control system address and readiness of the control system to process requests of the primary protocol (indirectly).
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 12 | STRING | WHEREAREYOU? |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | variable | STRING | KUKA|<model name>|<serial #> |
<model name> is the value of $MODEL_NAME[] KRL variable.
<serial #> is the value of $KR_SERIALNO KRL variable.
In case of an error when accessing the KUKA Cross 3 subsystem, the fields <model name> and <serial #> may be empty. In this case, the response has the following form:
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 6 | STRING | KUKA|| |
| [PREVIOUS PAGE] | 11 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Determining the type of proxy server. The C3 Bridge Interface responds to this request and KukavarProxy does not.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 11 | STRING | @PROXY_TYPE |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 19 | STRING | C3 BRIDGE INTERFACE |
| [PREVIOUS PAGE] | 12 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Obtaining information about the application version and license type.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 14 | STRING | @PROXY_VERSION |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | variable | STRING | <major>.<minor> <type> |
<major> is the major number of the software version.
<minor> is the minor number of the software version.
<type> is the type of the software edition (look at section 1.1. SOFTWARE VERSIONING), it can be (OPEN SOURCE), (PROPRIETARY), (FREEWARE), or (INTERNAL BUILD).
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 17 | STRING | 1.0 (OPEN SOURCE) |
| [PREVIOUS PAGE] | 13 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Determining the list of supported messages for the primary protocol.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 15 | STRING | @PROXY_FEATURES |
| Offset (bytes) | Size (bytes) | Type | Value | Meaning | |
|---|---|---|---|---|---|
| R E Q U I R E D |
-1 | 1 | CHAR | 1 | Message #0 is available |
| 0 | Message #0 is NOT available | ||||
| -2 | 1 | CHAR | 1 | Message #1 is available | |
| 0 | Message #1 is NOT available | ||||
| ... | |||||
| -8 | 1 | CHAR | 1 | Message #7 is available | |
| 0 | Message #7 is NOT available | ||||
| O P T I O N A L |
-9 | 1 | CHAR | 1 | Message #8 is available |
| 0 | Message #8 is NOT available | ||||
| ... | |||||
| -256 | 1 | CHAR | 1 | Message #255 is available | |
| 0 | Message #255 is NOT available | ||||
Negative offset means bytes counted from the end of the received datagram. For example, -1 means the last byte, -2 means the penultimate byte, etc.
| Offset (bytes) | Size (bytes) | Type | Value | Meaning |
|---|---|---|---|---|
| -1 | 1 | CHAR | 1 | Message #0 is available |
| -2 | 1 | CHAR | 1 | Message #1 is available |
| -3 | 1 | CHAR | 0 | Message #2 is NOT available |
| -4 | 1 | CHAR | 0 | Message #3 is NOT available |
| -5 | 1 | CHAR | 1 | Message #4 is available |
| -6 | 1 | CHAR | 1 | Message #5 is available |
| -7 | 1 | CHAR | 1 | Message #6 is available |
| -8 | 1 | CHAR | 1 | Message #7 is available |
| -9 | 1 | CHAR | 0 | Message #8 is NOT available |
| -10 | 1 | CHAR | 0 | Message #9 is NOT available |
| -11 | 1 | CHAR | 1 | Message #10 is available |
| -12 | 1 | CHAR | 1 | Message #11 is available |
| -13 | 1 | CHAR | 1 | Message #12 is available |
| -14 | 1 | CHAR | 1 | Message #13 is available |
| -15 | 1 | CHAR | 1 | Message #14 is available |
| -16 | 1 | CHAR | 0 | Message #15 is NOT available |
In this example, the string representation of the received data is as follows: 0111110011110011.
| [PREVIOUS PAGE] | 14 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Obtaining the computer name on which the robot control system is located.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 15 | STRING | @PROXY_HOSTNAME |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | variable | STRING | <KRC hostname> |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 9 | STRING | C010-07VM |
| [PREVIOUS PAGE] | 15 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Obtaining the date and time set on the robot control system in ISO 8601 format.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 11 | STRING | @PROXY_TIME |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 20 | STRING | YYYY-MM-DDThh:mm:ssZ |
[YYYY] indicates a four-digit year, 1601 through 9999.
[MM] indicates a two-digit month of the year, 01 through 12.
[DD] indicates a two-digit day of that month, 01 through 31.
[DD] indicates a two-digit day of that month, 01 through 31.
[T] is just ANSI character T, which is used to separate the date and time.
[hh] refers to a zero-padded hour between 00 and 23.
[mm] refers to a zero-padded minute between 00 and 59.
[ss] refers to a zero-padded second between 00 and 59.
[Z] means that the Coordinated Universal Time (UTC) is used.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 20 | STRING | 2020-08-04T06:46:10Z |
| [PREVIOUS PAGE] | 16 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.2.0 (Open Source)
Support in KukavarProxy: No
Obtaining the TCP/IP address where the primary C3 Bridge Interface protocol is listening. The address 0.0.0.0 means that listening is performed on all available network interfaces.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 14 | STRING | @PROXY_ADDRESS |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | variable | STRING | <TCP/IP address> |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 7 | STRING | 0.0.0.0 |
| [PREVIOUS PAGE] | 17 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.2.0 (Open Source)
Support in KukavarProxy: No
Obtaining the TCP/IP port where the primary C3 Bridge Interface protocol is listening.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 11 | STRING | @PROXY_PORT |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | variable | STRING | <TCP/IP port> |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 4 | STRING | 7000 |
| [PREVIOUS PAGE] | 18 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.2.0 (Open Source)
Support in KukavarProxy: No
Getting information about the status of the TCP/IP server of the primary protocol.
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 14 | STRING | @PROXY_ENABLED |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 4 | STRING | TRUE |
| Offset (bytes) | Size (bytes) | Type | Value |
|---|---|---|---|
| 0 | 5 | STRING | FALSE |
| [PREVIOUS PAGE] | 19 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The primary protocol uses long-term TCP/IP sessions. Data exchange takes place using binary messages of variable length. Transmitted messages are divided into requests and responses. The requests contain only the header and payload. The responses contain the header, payload, and error code at the end of the message. The server has the right not to reply to unknown or incorrect requests.
| [PREVIOUS PAGE] | 20 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Each message begins with a header, the structure of which is shown in the table below.
| Offset (bytes) | Size (bytes) | Type | Meaning |
|---|---|---|---|
| 0 | 2 | UINT16 | Tag ID This field specifies the message identifier. The response from the server will contain the same identifier as the request. This identifier does not define the type of request and can accept any values in the range from 0 to 65 535. |
| 2 | 2 | UINT16 | Message Length The full length of the message, excluding the Tag ID and Message Length fields. |
| 4 | 1 | UINT8 | Message Type An important field that defines the type of message. The message type indicates the number of the function that will be or has been executed by the C3 Bridge Interface. |
| [PREVIOUS PAGE] | 21 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The full list of error codes can be found in the file include/c3bi.h.
| Code | Name | Description |
|---|---|---|
| 0 | ErrorGeneral | Unspecified error. In some cases it may be the result of an E_FAIL error from the Windows COM subsystem. |
| 1 | ErrorSuccess | Not an error. The operation was successful. |
| 2 | ErrorAccess | General access denied error. COM equivalent: E_ACCESSDENIED. |
| 3 | ErrorArgument | One or more arguments are not valid. COM equivalent: E_INVALIDARG. |
| 4 | ErrorMemory | Failed to allocate necessary memory. COM equivalent: E_OUTOFMEMORY. |
| 5 | ErrorPointer | NULL was passed incorrectly for a pointer value. COM equivalent: E_POINTER. |
| 6 | ErrorUnexpected | Unexpected failure. COM equivalent: E_UNEXPECTED. |
| 7 | ErrorNotImplemented | The requested function has not been implemented. In some cases it may be the result of an E_NOTIMPL error from the Windows COM subsystem. |
| 8 | ErrorNoInterface | No such interface supported. COM equivalent: E_NOINTERFACE. |
| 9 | ErrorProtocol | Error in message content, incorrect number of fields, or their values. |
| 10 | ErrorLongAnswer | The response message is too big. The data cannot fit into a single message. |
| [PREVIOUS PAGE] | 23 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
The full list of message types can be found in the file include/c3bi.h.
| Type | Name |
|---|---|
| 0 | CommandReadVariableAscii |
| 1 | CommandWriteVariableAscii |
| 2 | CommandReadArrayAscii |
| 3 | CommandWriteArrayAscii |
| 4 | CommandReadVariable |
| 5 | CommandWriteVariable |
| 6 | CommandReadMultiple |
| 7 | CommandWriteMultiple |
| 8 | Reserved |
| 9 | |
| 10 | CommandProgramControl |
| 11 | CommandMotion |
| 12 | CommandKcpAction |
| 13 | CommandProxyInfo |
| 14 | CommandProxyFeatures |
| 15 | CommandProxyInfoEx |
| 16 | CommandProxyCrossInfo |
| 17 | CommandProxyBenchmark |
| 18 | Reserved |
| 19 | |
| 20 | CommandFileSetAttribute |
| 21 | CommandFileNameList |
| 22 | CommandFileCreate |
| 23 | CommandFileDelete |
| 24 | CommandFileCopy |
| 25 | CommandFileMove |
| 26 | CommandFileGetProperties |
| 27 | CommandFileGetFullName |
| 28 | CommandFileGetKrcName |
| 29 | CommandFileWriteContent |
| 30 | CommandFileReadContent |
| 31 | Reserved |
| ... | |
| 49 | |
| 50 | CommandCrossSetInfoOn |
| 51 | CommandCrossSetInfoOff |
| 52 | CommandCrossGetRobotDirectory |
| 53 | CommandCrossDownloadDiskToRobot |
| 54 | CommandCrossDownloadMemToRobot |
| 55 | CommandCrossUploadFromRobotToDisk |
| 56 | CommandCrossUploadFromRobotToMem |
| 57 | CommandCrossDeleteRobotProgram |
| 58 | CommandCrossRobotLevelStop |
| 59 | CommandCrossControlLevelStop |
| 60 | CommandCrossRunControlLevel |
| 61 | CommandCrossSelectModul |
| 62 | CommandCrossCancelModul |
| 63 | CommandCrossConfirmAll |
| 64 | CommandCrossKrcOk |
| 65 | CommandCrossIoRestart |
| 66 | CommandCrossReserved |
| 67 | |
| 68 | |
| 69 | |
| 70 | Reserved |
| ... | |
| 128 | |
| 129 | Free Range |
| ... | |
| 254 | |
| 255 | CommandExtended |
| [PREVIOUS PAGE] | 24 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: Yes
Retrieving the value of KRL variable or internal variable (ASCII version).
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 0 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVN Length of Variable Name |
| 7 | LVN | STRING | Variable Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 0 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVV Length of Variable Value |
| 7 | LVV | STRING | Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 0E | 00 | 00 | 0B | 24 | 41 | 43 | 43 | 55 | 5F | 53 | 54 | 41 |
| 00010 | 54 | 45 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 14 | |
| 4 | 1 | UINT8 | 0 | |
| P A Y L O A D |
5 | 2 | UINT16 | 11 |
| 7 | 11 | STRING | $ACCU_STATE |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 10 | 00 | 00 | 0A | 23 | 43 | 48 | 41 | 52 | 47 | 45 | 5F | 4F |
| 00010 | 4B | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 16 | |
| 4 | 1 | UINT8 | 0 | |
| P A Y L O A D |
5 | 2 | UINT16 | 10 |
| 7 | 10 | STRING | #CHARGE_OK | |
| F O O T E R |
17 | 2 | UINT16 | 1 |
| 19 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
C3 Bridge Interface contains several internal variables whose values can be obtained with the Read Variable message. Access to the internal variable is possible provided that there is no variable with the same name in the KRL system.
| Variable Name | Variable Value |
|---|---|
| PING | PONG |
| @PROXY_TYPE | C3 BRIDGE INTERFACE |
| @PROXY_VERSION | Look at section 2.3. PROXY VERSION REQUEST |
| @PROXY_FEATURES | Look at section 2.4. PROXY FEATURES REQUEST |
| @PROXY_HOSTNAME | Look at section 2.5. COMPUTER NAME REQUEST |
| @PROXY_TIME | Look at section 2.6. DATE AND TIME REQUEST |
| @PROXY_ADDRESS | Look at section 2.7. PROXY LISTENING ADDRESS REQUEST |
| @PROXY_PORT | Look at section 2.8. PROXY LISTENING PORT REQUEST |
| @PROXY_ENABLED | Look at section 2.9. PROXY ENABLED REQUEST |
| [PREVIOUS PAGE] | 25 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: Yes
Writing the new value of the KRL variable (ASCII version).
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 1 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVN Length of Variable Name |
| 7 | LVN | STRING | Variable Name | |
| variable | 2 | UINT16 | LVV Length of Variable Value |
|
| variable | LVV | STRING | Variable Value |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 1 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVV Length of Variable Value |
| 7 | LVV | STRING | Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 0E | 01 | 00 | 07 | 24 | 4F | 56 | 5F | 50 | 52 | 4F | 00 | 02 |
| 00010 | 33 | 35 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 14 | |
| 4 | 1 | UINT8 | 1 | |
| P A Y L O A D |
5 | 2 | UINT16 | 7 |
| 7 | 7 | STRING | $OV_PRO | |
| 14 | 2 | UINT16 | 2 | |
| 16 | 2 | STRING | 35 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 08 | 01 | 00 | 02 | 33 | 35 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 8 | |
| 4 | 1 | UINT8 | 1 | |
| P A Y L O A D |
5 | 2 | UINT16 | 2 |
| 7 | 2 | STRING | 35 | |
| F O O T E R |
9 | 2 | UINT16 | 1 |
| 11 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| [PREVIOUS PAGE] | 26 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: None
Support in KukavarProxy: Yes
(Translated from KukavarProxy source code)
Reading and formatting an array variable for the PLC.
Minimum supported version: None
Support in KukavarProxy: Yes
(Translated from KukavarProxy source code)
Writing an array variable to the PLC.
| [PREVIOUS PAGE] | 27 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Retrieving the value of KRL variable or internal variable.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 4 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVN Length of Variable Name (in characters) |
| 7 | LVN × 2 | WSTRING | Variable Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 4 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVV Length of Variable Value (in characters) |
| 7 | LVV × 2 | WSTRING | Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 02 | 00 | 00 | 15 | 04 | 00 | 09 | 24 | 00 | 41 | 00 | 43 | 00 | 54 | 00 | 5F |
| 00010 | 00 | 42 | 00 | 41 | 00 | 53 | 00 | 45 | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 512 |
| 2 | 2 | UINT16 | 21 | |
| 4 | 1 | UINT8 | 4 | |
| P A Y L O A D |
5 | 2 | UINT16 | 9 |
| 7 | 18 | WSTRING | $ACT_BASE |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 02 | 00 | 00 | 08 | 04 | 00 | 01 | 31 | 00 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 512 |
| 2 | 2 | UINT16 | 8 | |
| 4 | 1 | UINT8 | 4 | |
| P A Y L O A D |
5 | 2 | UINT16 | 1 |
| 7 | 2 | WSTRING | 1 | |
| F O O T E R |
9 | 2 | UINT16 | 1 |
| 11 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
Look at section 3.5.1. MESSAGE #0. READ VARIABLE (ASCII).
| [PREVIOUS PAGE] | 28 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Writing the new value of the KRL variable.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 5 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVN Length of Variable Name (in characters) |
| 7 | LVN × 2 | WSTRING | Variable Name | |
| variable | 2 | UINT16 | LVV Length of Variable Value (in characters) |
|
| variable | LVV × 2 | WSTRING | Variable Value |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 5 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LVV Length of Variable Value (in characters) |
| 7 | LVV × 2 | WSTRING | Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 15 | 05 | 00 | 07 | 24 | 00 | 4F | 00 | 56 | 00 | 5F | 00 | 50 |
| 00010 | 00 | 52 | 00 | 4F | 00 | 00 | 01 | 35 | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 21 | |
| 4 | 1 | UINT8 | 5 | |
| P A Y L O A D |
5 | 2 | UINT16 | 7 |
| 7 | 14 | WSTRING | $OV_PRO | |
| 21 | 2 | UINT16 | 1 | |
| 23 | 2 | WSTRING | 5 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 01 | 00 | 00 | 08 | 05 | 00 | 01 | 35 | 00 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 256 |
| 2 | 2 | UINT16 | 8 | |
| 4 | 1 | UINT8 | 5 | |
| P A Y L O A D |
5 | 2 | UINT16 | 1 |
| 7 | 2 | WSTRING | 5 | |
| F O O T E R |
9 | 2 | UINT16 | 1 |
| 11 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 29 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Do not use this function with the C3 Bridge Interface server versions lower than 1.2.0 (Open Source).
Earlier implementations did not work correctly.
Retrieving the values of several KRL variables or internal variables.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 6 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Number of Variables Value: 0-255 |
| OPTIONAL | ||||
| 6 | 2 | UINT16 | LVN1 Length of Variable 1 (in characters) |
|
| 8 | LVN1 × 2 | WSTRING | Variable 1 | |
| ... | ||||
| variable | 2 | UINT16 | LVNL Length of Last Variable (in characters) |
|
| variable | LVNL × 2 | WSTRING | Last Variable | |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 6 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Number of Variables |
| 6 | 1 | UINT8 | CODE1 Error code of Variable 1 request (look at section 3.3. ERROR CODES) |
|
| 7 | 2 | UINT16 | LVV1 Length of Variable 1 Value (in characters) |
|
| 9 | LVV1 × 2 | WSTRING | Variable 1 Value | |
| ... | ||||
| variable | 1 | UINT8 | CODEL Error code of Last Variable request (look at section 3.3. ERROR CODES) |
|
| variable | 2 | UINT16 | LVVL Length of Last Variable Value (in characters) |
|
| variable | LVVL × 2 | WSTRING | Last Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag | |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 04 | 00 | 00 | 24 | 06 | 02 | 00 | 04 | 50 | 00 | 49 | 00 | 4E | 00 | 47 | 00 |
| 00010 | 00 | 0B | 40 | 00 | 50 | 00 | 52 | 00 | 4F | 00 | 58 | 00 | 59 | 00 | 5F | 00 |
| 00020 | 50 | 00 | 4F | 00 | 52 | 00 | 54 | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 1024 |
| 2 | 2 | UINT16 | 36 | |
| 4 | 1 | UINT8 | 6 | |
| P A Y L O A D |
5 | 1 | UINT8 | 2 |
| 6 | 2 | UINT16 | 4 | |
| 8 | 8 | WSTRING | PING | |
| 16 | 2 | UINT16 | 11 | |
| 18 | 22 | WSTRING | @PROXY_PORT |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 04 | 00 | 00 | 1B | 06 | 02 | 01 | 00 | 04 | 50 | 00 | 4F | 00 | 4E | 00 | 47 |
| 00010 | 00 | 01 | 00 | 04 | 37 | 00 | 30 | 00 | 30 | 00 | 30 | 00 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 1024 |
| 2 | 2 | UINT16 | 27 | |
| 4 | 1 | UINT8 | 6 | |
| P A Y L O A D |
5 | 1 | UINT8 | 2 |
| 6 | 1 | UINT8 | 1 | |
| 7 | 2 | UINT16 | 4 | |
| 9 | 8 | WSTRING | PONG | |
| 17 | 1 | UINT8 | 1 | |
| 18 | 2 | UINT16 | 4 | |
| 20 | 8 | WSTRING | 7000 | |
| F O O T E R |
28 | 2 | UINT16 | 1 |
| 30 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| 10 | ErrorLongAnswer |
Look at section 3.5.1. MESSAGE #0. READ VARIABLE (ASCII).
| [PREVIOUS PAGE] | 30 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Do not use this function with the C3 Bridge Interface server versions lower than 1.3.0 (Open Source).
Earlier implementations did not work correctly.
Writing new values of several KRL variables.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 7 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Number of Variables Value: 0-255 |
| OPTIONAL | ||||
| 6 | 2 | UINT16 | LVN1 Length of Variable 1 (in characters) |
|
| 8 | LVN1 × 2 | WSTRING | Variable 1 | |
| variable | 2 | UINT16 | LVV1 Length of Variable 1 Value (in characters) |
|
| variable | LVV1 × 2 | WSTRING | Variable 1 Value | |
| ... | ||||
| variable | 2 | UINT16 | LVNL Length of Last Variable (in characters) |
|
| variable | LVNL × 2 | WSTRING | Last Variable | |
| variable | 2 | UINT16 | LVVL Length of Last Variable Value (in characters) |
|
| variable | LVVL × 2 | WSTRING | Last Variable Value | |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 7 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Number of Variables |
| 6 | 1 | UINT8 | CODE1 Error code of Variable 1 request (look at section 3.3. ERROR CODES) |
|
| 7 | 2 | UINT16 | LVV1 Length of Variable 1 Value (in characters) |
|
| 9 | LVV1 × 2 | WSTRING | Variable 1 Value | |
| ... | ||||
| variable | 1 | UINT8 | CODEL Error code of Last Variable request (look at section 3.3. ERROR CODES) |
|
| variable | 2 | UINT16 | LVVL Length of Last Variable Value (in characters) |
|
| variable | LVVL × 2 | WSTRING | Last Variable Value | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag | |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 04 | 00 | 00 | 30 | 07 | 02 | 00 | 07 | 24 | 00 | 4F | 00 | 56 | 00 | 5F | 00 |
| 00010 | 50 | 00 | 52 | 00 | 4F | 00 | 00 | 02 | 33 | 00 | 37 | 00 | 00 | 07 | 24 | 00 |
| 00020 | 4F | 00 | 56 | 00 | 5F | 00 | 4A | 00 | 4F | 00 | 47 | 00 | 00 | 03 | 31 | 00 |
| 00030 | 30 | 00 | 30 | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 1024 |
| 2 | 2 | UINT16 | 48 | |
| 4 | 1 | UINT8 | 7 | |
| P A Y L O A D |
5 | 1 | UINT8 | 2 |
| 6 | 2 | UINT16 | 7 | |
| 8 | 14 | WSTRING | $OV_PRO | |
| 22 | 2 | UINT16 | 2 | |
| 24 | 4 | WSTRING | 37 | |
| 28 | 2 | UINT16 | 7 | |
| 30 | 14 | WSTRING | $OV_JOG | |
| 44 | 2 | UINT16 | 3 | |
| 46 | 6 | WSTRING | 100 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 04 | 00 | 00 | 15 | 07 | 02 | 01 | 00 | 02 | 33 | 00 | 37 | 00 | 01 | 00 | 03 |
| 00010 | 31 | 00 | 30 | 00 | 30 | 00 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 1024 |
| 2 | 2 | UINT16 | 21 | |
| 4 | 1 | UINT8 | 7 | |
| P A Y L O A D |
5 | 1 | UINT8 | 2 |
| 6 | 1 | UINT8 | 1 | |
| 7 | 2 | UINT16 | 2 | |
| 9 | 4 | WSTRING | 37 | |
| 13 | 1 | UINT8 | 1 | |
| 14 | 2 | UINT16 | 3 | |
| 16 | 6 | WSTRING | 100 | |
| F O O T E R |
22 | 2 | UINT16 | 1 |
| 24 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| 10 | ErrorLongAnswer |
| [PREVIOUS PAGE] | 31 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Reset, start, stop or cancel the KRL program.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 10 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Command code: 1 — Reset 2 — Start 3 — Stop 4 — Cancel |
| 6 | 2 | UINT16 | Interpreter Type: 0 — Submit Interpreter 1 — Robot Interpreter |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 10 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Command code |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 02 | 8C | 00 | 04 | 0A | 01 | 00 | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 652 |
| 2 | 2 | UINT16 | 4 | |
| 4 | 1 | UINT8 | 10 | |
| P A Y L O A D |
5 | 1 | UINT8 | 1 |
| 6 | 2 | UINT16 | 0 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 02 | 8C | 00 | 05 | 0A | 01 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 652 |
| 2 | 2 | UINT16 | 5 | |
| 4 | 1 | UINT8 | 10 | |
| P A Y L O A D |
5 | 1 | UINT8 | 1 |
| F O O T E R |
6 | 2 | UINT16 | 1 |
| 8 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 32 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Select or run the KRL program.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 10 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Command code: 5 — Select 6 — Run |
| 6 | 2 | UINT16 | Interpreter Type (NOT USED) |
|
| 8 | 2 | UINT16 | LN Length of Name (in characters) |
|
| 10 | LN × 2 | WSTRING | Name | |
| variable | 2 | UINT16 | LP Length of Parameters (in characters) |
|
| variable | LP × 2 | WSTRING | Parameters | |
| variable | 1 | BOOL | Force Select/Run |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 10 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Command code |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 33 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Initiate a movement of type PTP, PTP_REL, LIN or LIN_REL.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 11 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Motion Type: 1 — PTP 2 — LIN 3 — PTP_REL 4 — LIN_REL |
| 6 | 2 | UINT16 | LP Length of Position String (in characters) |
|
| 8 | LP × 2 | WSTRING | Position String |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 11 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Motion Type |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 80 | 00 | 4A | 0B | 01 | 00 | 23 | 7B | 00 | 50 | 00 | 4F | 00 | 53 | 00 |
| 00010 | 3A | 00 | 20 | 00 | 58 | 00 | 20 | 00 | 30 | 00 | 2C | 00 | 20 | 00 | 59 | 00 |
| 00020 | 20 | 00 | 30 | 00 | 2C | 00 | 20 | 00 | 5A | 00 | 20 | 00 | 30 | 00 | 2C | 00 |
| 00030 | 20 | 00 | 41 | 00 | 20 | 00 | 30 | 00 | 2C | 00 | 20 | 00 | 42 | 00 | 20 | 00 |
| 00040 | 30 | 00 | 2C | 00 | 20 | 00 | 43 | 00 | 20 | 00 | 30 | 00 | 7D | 00 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 128 |
| 2 | 2 | UINT16 | 74 | |
| 4 | 1 | UINT8 | 11 | |
| P A Y L O A D |
5 | 1 | UINT8 | 1 |
| 6 | 2 | UINT16 | 35 | |
| 8 | 70 | WSTRING | {POS: X 0, Y 0, Z 0, A 0, B 0, C 0} |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 80 | 00 | 05 | 0B | 01 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 128 |
| 2 | 2 | UINT16 | 5 | |
| 4 | 1 | UINT8 | 11 | |
| P A Y L O A D |
5 | 1 | UINT8 | 1 |
| F O O T E R |
6 | 2 | UINT16 | 1 |
| 8 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 34 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Emulation of button pushing on the KCP device.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 12 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Key Type: 1 — Start Key 2 — Stop Key 3 — Jog Key 4 — 6D Space Mouse |
| 6 | 4 | INT32 | Interpreter Type: 0 — Submit Interpreter 1 — Robot Interpreter or Axis Number |
|
| 10 | 4 | INT32 | Key Code | |
| 14 | 1 | BOOL | Direction | |
| 15 | 1 | BOOL | Key Status: TRUE — Released FALSE — Pressed |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 12 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Key Type |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 35 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Request information about the C3 Bridge Interface Server.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 13 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 13 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Version Major Number |
| 6 | 1 | UINT8 | Version Minor Number | |
| 7 | 1 | UINT8 | Version Type (look at section 1.1. SOFTWARE VERSIONING) |
|
| 8 | 2 | UINT16 | Current Year | |
| 10 | 2 | UINT16 | Current Month | |
| 12 | 2 | UINT16 | Current Day of Week | |
| 14 | 2 | UINT16 | Current Day | |
| 16 | 2 | UINT16 | Current Hour (UTC) | |
| 18 | 2 | UINT16 | Current Minute (UTC) | |
| 20 | 2 | UINT16 | Current Second (UTC) | |
| 22 | 2 | UINT16 | Current Millisecond | |
| 24 | 2 | UINT16 | LCN Length of Computer Name (in characters) |
|
| 26 | LCN × 2 | WSTRING | Computer Name | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 00 | 00 | 01 | 0D |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 0 |
| 2 | 2 | UINT16 | 1 | |
| 4 | 1 | UINT8 | 13 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 00 | 00 | 2F | 0D | 01 | 00 | 00 | 07 | E4 | 00 | 08 | 00 | 02 | 00 | 04 |
| 00010 | 00 | 08 | 00 | 38 | 00 | 06 | 03 | 79 | 00 | 0B | 56 | 00 | 44 | 00 | 4D | 00 |
| 00020 | 48 | 00 | 4F | 00 | 53 | 00 | 54 | 00 | 54 | 00 | 45 | 00 | 53 | 00 | 54 | 00 |
| 00030 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 0 |
| 2 | 2 | UINT16 | 47 | |
| 4 | 1 | UINT8 | 13 | |
| P A Y L O A D |
5 | 1 | UINT8 | 1 |
| 6 | 1 | UINT8 | 0 | |
| 7 | 1 | UINT8 | 0 | |
| 8 | 2 | UINT16 | 2020 | |
| 10 | 2 | UINT16 | 8 | |
| 12 | 2 | UINT16 | 2 | |
| 14 | 2 | UINT16 | 4 | |
| 16 | 2 | UINT16 | 8 | |
| 18 | 2 | UINT16 | 56 | |
| 20 | 2 | UINT16 | 6 | |
| 22 | 2 | UINT16 | 889 | |
| 24 | 2 | UINT16 | 11 | |
| 26 | 22 | WSTRING | VDMHOSTTEST | |
| F O O T E R |
48 | 2 | UINT16 | 1 |
| 50 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 1 | ErrorSuccess |
| [PREVIOUS PAGE] | 36 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Request the list of supported messages for the primary protocol of the C3 Bridge Interface Server.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 14 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 14 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Bit field of available messages: from 255 to 248 |
| 6 | 1 | UINT8 | Bit field of available messages: from 247 to 240 |
|
| 7 | 1 | UINT8 | Bit field of available messages: from 239 to 232 |
|
| 8 | 1 | UINT8 | Bit field of available messages: from 231 to 224 |
|
| 9 | 1 | UINT8 | Bit field of available messages: from 223 to 216 |
|
| 10 | 1 | UINT8 | Bit field of available messages: from 215 to 208 |
|
| 11 | 1 | UINT8 | Bit field of available messages: from 207 to 200 |
|
| 12 | 1 | UINT8 | Bit field of available messages: from 199 to 192 |
|
| 13 | 1 | UINT8 | Bit field of available messages: from 191 to 184 |
|
| 14 | 1 | UINT8 | Bit field of available messages: from 183 to 176 |
|
| 15 | 1 | UINT8 | Bit field of available messages: from 175 to 168 |
|
| 16 | 1 | UINT8 | Bit field of available messages: from 167 to 160 |
|
| 17 | 1 | UINT8 | Bit field of available messages: from 159 to 152 |
|
| 18 | 1 | UINT8 | Bit field of available messages: from 151 to 144 |
|
| 19 | 1 | UINT8 | Bit field of available messages: from 143 to 136 |
|
| 20 | 1 | UINT8 | Bit field of available messages: from 135 to 128 |
|
| 21 | 1 | UINT8 | Bit field of available messages: from 127 to 120 |
|
| 22 | 1 | UINT8 | Bit field of available messages: from 119 to 112 |
|
| 23 | 1 | UINT8 | Bit field of available messages: from 111 to 104 |
|
| 24 | 1 | UINT8 | Bit field of available messages: from 103 to 96 |
|
| 25 | 1 | UINT8 | Bit field of available messages: from 95 to 88 |
|
| 26 | 1 | UINT8 | Bit field of available messages: from 87 to 80 |
|
| 27 | 1 | UINT8 | Bit field of available messages: from 79 to 72 |
|
| 28 | 1 | UINT8 | Bit field of available messages: from 71 to 64 |
|
| 29 | 1 | UINT8 | Bit field of available messages: from 63 to 56 |
|
| 30 | 1 | UINT8 | Bit field of available messages: from 55 to 48 |
|
| 31 | 1 | UINT8 | Bit field of available messages: from 47 to 40 |
|
| 32 | 1 | UINT8 | Bit field of available messages: from 39 to 32 |
|
| 33 | 1 | UINT8 | Bit field of available messages: from 31 to 24 |
|
| 34 | 1 | UINT8 | Bit field of available messages: from 23 to 16 |
|
| 35 | 1 | UINT8 | Bit field of available messages: from 15 to 8 |
|
| 36 | 1 | UINT8 | Bit field of available messages: from 7 to 0 |
|
| F O O T E R |
37 | 2 | UINT16 | Error Code |
| 39 | 1 | BOOL | Success Flag |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 00 | 00 | 01 | 0E |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 0 |
| 2 | 2 | UINT16 | 1 | |
| 4 | 1 | UINT8 | 14 |
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 00000 | 00 | 00 | 00 | 24 | 0E | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 |
| 00010 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 80 | 00 | 00 |
| 00020 | 00 | 00 | 00 | 7C | F3 | 00 | 01 | 01 |
| Offset (bytes) | Size (bytes) | Type | Value | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | 0 |
| 2 | 2 | UINT16 | 36 | |
| 4 | 1 | UINT8 | 14 | |
| P A Y L O A D |
5 | 1 | UINT8 | 0 |
| 6 | 1 | UINT8 | 0 | |
| 7 | 1 | UINT8 | 0 | |
| 8 | 1 | UINT8 | 0 | |
| 9 | 1 | UINT8 | 0 | |
| 10 | 1 | UINT8 | 0 | |
| 11 | 1 | UINT8 | 0 | |
| 12 | 1 | UINT8 | 0 | |
| 13 | 1 | UINT8 | 0 | |
| 14 | 1 | UINT8 | 0 | |
| 15 | 1 | UINT8 | 0 | |
| 16 | 1 | UINT8 | 0 | |
| 17 | 1 | UINT8 | 0 | |
| 18 | 1 | UINT8 | 0 | |
| 19 | 1 | UINT8 | 0 | |
| 20 | 1 | UINT8 | 0 | |
| 21 | 1 | UINT8 | 0 | |
| 22 | 1 | UINT8 | 0 | |
| 23 | 1 | UINT8 | 0 | |
| 24 | 1 | UINT8 | 0 | |
| 25 | 1 | UINT8 | 0 | |
| 26 | 1 | UINT8 | 0 | |
| 27 | 1 | UINT8 | 0 | |
| 28 | 1 | UINT8 | 0 | |
| 29 | 1 | UINT8 | 128 | |
| 30 | 1 | UINT8 | 0 | |
| 31 | 1 | UINT8 | 0 | |
| 32 | 1 | UINT8 | 0 | |
| 33 | 1 | UINT8 | 0 | |
| 34 | 1 | UINT8 | 0 | |
| 35 | 1 | UINT8 | 124 | |
| 36 | 1 | UINT8 | 243 | |
| F O O T E R |
37 | 2 | UINT16 | 1 |
| 39 | 1 | BOOL | TRUE |
| Code | Name |
|---|---|
| 1 | ErrorSuccess |
| [PREVIOUS PAGE] | 37 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: None
Support in KukavarProxy: No
This feature has not yet been implemented; the section is reserved for future use.
Minimum supported version: None
Support in KukavarProxy: No
This feature has not yet been implemented; the section is reserved for future use.
| [PREVIOUS PAGE] | 38 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.2.0 (Open Source)
Support in KukavarProxy: No
Calculation of execution time for multiple read or write operations of KRL variables.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 17 |
|
| P A Y L O A D |
5 | 1 | BOOL | WRITE Type of Operation: |
| 6 | 1 | UINT8 | Count of Variables Value: 0-255 |
|
| 7 | 4 | UINT32 | Number of Iterations Value: 0-4294967294 |
|
| OPTIONAL | ||||
| 11 | 2 | UINT16 | LVN1 Length of Variable 1 (in characters) |
|
| 13 | LVN1 × 2 | WSTRING | Variable 1 | |
| variable | 2 | UINT16 | LVV1 ONLY WHEN WRITE is TRUE |
|
| variable | LVV1 × 2 | WSTRING | ONLY WHEN WRITE is TRUE Variable 1 Value |
|
| ... | ||||
| variable | 2 | UINT16 | LVNL Length of Last Variable (in characters) |
|
| variable | LVNL × 2 | WSTRING | Last Variable | |
| variable | 2 | UINT16 | LVVL ONLY WHEN WRITE is TRUE |
|
| variable | LVVL × 2 | WSTRING | ONLY WHEN WRITE is TRUE Last Variable Value |
|
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 17 |
|
| P A Y L O A D |
5 | 1 | BOOL | WRITE Type of Operation: |
| 6 | 1 | UINT8 | Count of Variables | |
| 7 | 4 | UINT32 | Number of Iterations | |
| 11 | 4 | UINT32 | Start Time (ms) | |
| 15 | 4 | UINT32 | Stop Time (ms) | |
| 19 | 4 | UINT32 | Time Difference (ms) | |
| F O O T E R |
23 | 2 | UINT16 | Error Code |
| 25 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 39 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
This section lists the basic constants used in file system operations.
| Value | Name |
|---|---|
| 0 | None |
| 1 | Read Only |
| 2 | Hidden |
| 4 | System |
| 16 | Directory |
| 32 | Archive |
| 16 384 | Encrypted |
| 268 435 456 | Signed |
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | Directory |
| 2 | Virtual Directory |
| 4 | Archive |
| 8 | Binary File |
| 16 | Text File |
| 32 | Module |
| 64 | Raw |
| 128 | Motion File |
| 256 | Protected File Container |
| Value | Name |
|---|---|
| 0 | None |
| 1 | Recursive |
| 2 | Expand |
| 4 | Long |
| 8 | Old Long |
| 16 | No PFC |
| 32 | PFC as File |
| 64 | ZIP as File |
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | SUB |
| 2 | SRC |
| 4 | DAT |
| 5 | SUBDAT |
| 6 | SRCDAT |
| 8 | Template |
| 16 | Motion |
| Value | Name |
|---|---|
| 0 | None |
| 1 | Archive |
| 3 | Modify |
| 4 | Continue |
| 8 | Recursive |
| 16 | Refresh |
| 48 | Update |
| 64 | Overwrite Exists |
| 128 | No Directory Entries |
| 256 | Junk Directory |
| 512 | Force Binary |
| 1024 | Force Text |
| 2048 | No Version Check |
| 4096 | Overwrite Read |
| 8192 | No KRL Analysis |
| Value | Name |
|---|---|
| 0 | None |
| 1 | Type |
| 2 | Name |
| 4 | Size |
| 8 | Attributes |
| 16 | Creation Time |
| 32 | Access Time |
| 64 | Modified Time |
| 128 | Edit Mode |
| 255 | All |
| Value | Name |
|---|---|
| -1 | Unknown |
| 0 | Full Edit |
| 1 | DatKor |
| 2 | ProKor |
| 3 | Read Only |
| Value | Name |
|---|---|
| 0 | None |
| 1 | Begin Operation |
| 2 | Data Transfer |
| 3 | Get Data Size |
| 4 | End Operation |
| 5 | Get Data Checksum |
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | KRC Root |
| 2 | Removable Device |
| 3 | Fixed Device |
| 4 | CD-ROM Drive |
| 5 | Network Drive |
| 6 | RAM Disk |
| 7 | Archive Root |
| [PREVIOUS PAGE] | 40 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Changes file attributes.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 20 |
|
| P A Y L O A D |
5 | 4 | INT32 | Attributes 3.9.1.1. Item Attributes |
| 9 | 4 | INT32 | Mask 3.9.1.1. Item Attributes |
|
| 13 | 2 | UINT16 | LN Length of Name (in characters) |
|
| 15 | LN × 2 | WSTRING | Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 20 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 41 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Get a list of files and subdirectories in a directory.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 21 |
|
| P A Y L O A D |
5 | 4 | INT32 | Item Type 3.9.1.2. Item Types |
| 9 | 4 | INT32 | Flags 3.9.1.3. Item List Flags |
|
| 13 | 2 | UINT16 | LP Length of Path (in characters) |
|
| 15 | LP × 2 | WSTRING | Path |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 21 |
|
| P A Y L O A D |
5 | 2 | UINT16 | Count of Items |
| 7 | 2 | UINT16 | IL1 Length of First Item |
|
| 9 | IL1 × 2 | WSTRING | First Item | |
| ... | ||||
| variable | 2 | UINT16 | ILL Length of Last Item |
|
| variable | ILL × 2 | WSTRING | Last Item | |
| variable | 2 | UINT16 | Count of Item Infos | |
| variable | 2 | UINT16 | IIL1 Length of First Item Info |
|
| variable | IIL1 × 2 | WSTRING | First Item Info | |
| ... | ||||
| variable | 2 | UINT16 | IILL Length of Last Item Info |
|
| variable | IILL × 2 | WSTRING | Last Item Info | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| 10 | ErrorLongAnswer |
| [PREVIOUS PAGE] | 42 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Create a new text file, binary file or KRL module.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 22 |
|
| P A Y L O A D |
5 | 2 | UINT16 | Item Type 3.9.1.2. Item Types |
| 7 | 1 | UINT8 | Module Part 3.9.1.4. Module Parts |
|
| 8 | 1 | BOOL | Always Create | |
| 9 | 2 | UINT16 | LN Length of Name (in characters) |
|
| 11 | LN × 2 | WSTRING | Name | |
| variable | 2 | UINT16 | LTP Length of Template (in characters) |
|
| variable | LTP × 2 | WSTRING | Template |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 22 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 43 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Delete a file.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 23 |
|
| P A Y L O A D |
5 | 1 | BOOL | Always Delete |
| 6 | 2 | UINT16 | LN Length of Name (in characters) |
|
| 8 | LN × 2 | WSTRING | Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 23 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 44 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Copy a file to another location.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 24 |
|
| P A Y L O A D |
5 | 4 | INT32 | Flags 3.9.1.5. Copy Flags |
| 9 | 2 | UINT16 | LS Length of Source (in characters) |
|
| 11 | LS × 2 | WSTRING | Source | |
| variable | 2 | UINT16 | LD Length of Destination (in characters) |
|
| variable | LD × 2 | WSTRING | Destination |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 24 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 45 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Move a file to another location.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 25 |
|
| P A Y L O A D |
5 | 4 | INT32 | Flags 3.9.1.5. Copy Flags |
| 9 | 2 | UINT16 | LS Length of Source (in characters) |
|
| 11 | LS × 2 | WSTRING | Source | |
| variable | 2 | UINT16 | LD Length of Destination (in characters) |
|
| variable | LD × 2 | WSTRING | Destination |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 25 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 46 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Getting a file's type, attributes, size and time.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 26 |
|
| P A Y L O A D |
5 | 4 | INT32 | Flags 3.9.1.6. Item Property Flags |
| 9 | 2 | UINT16 | LN Length of Name (in characters) |
|
| 11 | LN × 2 | WSTRING | Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 26 |
|
| P A Y L O A D |
5 | 4 | INT32 | Item Type 3.9.1.2. Item Types |
| 9 | 4 | INT32 | Item Size (Low Part) | |
| 13 | 4 | INT32 | Item Size (High Part) | |
| 17 | 4 | INT32 | Attributes 3.9.1.1. Item Attributes |
|
| 21 | 4 | INT32 | Creation Time (Low Part) A Windows file creation time expressed in ticks |
|
| 25 | 4 | INT32 | Creation Time (High Part) | |
| 29 | 4 | INT32 | Creation Time Bias (minutes) | |
| 33 | 4 | INT32 | Access Time (Low Part) A Windows file last access time expressed in ticks |
|
| 37 | 4 | INT32 | Access Time (High Part) | |
| 41 | 4 | INT32 | Access Time Bias (minutes) | |
| 45 | 4 | INT32 | Modified Time (Low Part) A Windows file last modification time expressed in ticks |
|
| 49 | 4 | INT32 | Modified Time (High Part) | |
| 53 | 4 | INT32 | Modified Time Bias (minutes) | |
| 57 | 4 | INT32 | Edit Mode 3.9.1.7. Edit Modes |
|
| 61 | 2 | UINT16 | LN Length of Item Name (in characters) |
|
| 63 | LN × 2 | WSTRING | Item Name | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 47 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Getting the full path to a file.
For example, the path "/R1/TEST.SRC" will be converted to "KRC:\R1\PROGRAM\TEST.SRC".
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 27 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LP Length of File Path (in characters) |
| 7 | LP × 2 | WSTRING | File Path |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 27 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LP Length of Output Path (in characters) |
| 7 | LP × 2 | WSTRING | Output Path | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 48 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
Getting the KRC path to a file.
For example, the path "KRC:\R1\PROGRAM\TEST.SRC" will be converted to "/R1/TEST.SRC".
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 28 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LP Length of File Path (in characters) |
| 7 | LP × 2 | WSTRING | File Path |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 28 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LP Length of Output Path (in characters) |
| 7 | LP × 2 | WSTRING | Output Path | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 49 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoBegin: Creates a new buffer of a given size for further data writing to it. Any previously created buffer is destroyed along with the data.
FileIoGetSize: Specifies the size of a previously allocated buffer, or 0 if no buffer exists.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| 6 | 4 | UINT32 | ONLY WHEN OPERATION is 1 Total Size (in bytes) |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation |
| 6 | 4 | UINT32 | Buffer Size | |
| F O O T E R |
10 | 2 | UINT16 | Error Code |
| 12 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 50 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoData: Writes a chunk of data of a certain size to the buffer at the specified offset.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| 6 | 4 | UINT32 | Offset (in bytes) | |
| 10 | 4 | UINT32 | SIZE Chunk Size (in bytes) |
|
| 14 | SIZE | BINARY | Chunk Data |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation Value: 2 |
| 6 | 4 | UINT32 | Offset (in bytes) | |
| 10 | 4 | UINT32 | Size of Bytes Written | |
| F O O T E R |
14 | 2 | UINT16 | Error Code |
| 16 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 51 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: None
Support in KukavarProxy: No
This feature has not yet been implemented; the section is reserved for future use.
| [PREVIOUS PAGE] | 52 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoEnd: Writes the contents of the buffer to a file on disk.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| 6 | 4 | INT32 | Flags 3.9.1.5. Copy Flags |
|
| 10 | 2 | UINT16 | LN Length of File Name (in characters) |
|
| 12 | LN × 2 | WSTRING | File Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 29 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation Value: 4 |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 53 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoBegin: Transfers the contents of a file on disk to the read buffer and returns its size.
FileIoGetSize: Specifies the size of the read buffer, or 0 if no buffer exists.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| ONLY WHEN OPERATION is 1 | ||||
| 6 | 4 | INT32 | Flags 3.9.1.5. Copy Flags |
|
| 10 | 4 | UINT32 | LN Flags |
|
| 14 | LN × 2 | WSTRING | File Name | |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation |
| 6 | 4 | UINT32 | Buffer Size | |
| F O O T E R |
10 | 2 | UINT16 | Error Code |
| 12 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 54 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoData: Reads a data fragment of the specified size into the buffer at the specified offset.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| 6 | 4 | UINT32 | Offset (in bytes) | |
| 10 | 4 | UINT32 | Maximum Chunk Size (in bytes) This value can be FFFFFFFFh to read the largest amount of data at the time. |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation Value: 2 |
| 6 | 4 | UINT32 | Offset (in bytes) | |
| 10 | 4 | UINT32 | SIZE Size of Bytes Read |
|
| 14 | SIZE | BINARY | Chunk Data | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 55 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: None
Support in KukavarProxy: No
This feature has not yet been implemented; the section is reserved for future use.
| [PREVIOUS PAGE] | 56 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.1.2 (Freeware)
Support in KukavarProxy: No
FileIoEnd: Clearing the read buffer and freeing the memory.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | OPERATION 3.9.1.8. File IO Operations |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 30 |
|
| P A Y L O A D |
5 | 1 | UINT8 | Operation Value: 4 |
| F O O T E R |
6 | 2 | UINT16 | Error Code |
| 8 | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 57 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.7.1 (Proprietary)
Support in KukavarProxy: No
Get information about the volume type, its name (label) and capacity (amount of free space, used and total).
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 31 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LD Length of Drive (in characters) |
| 7 | LD × 2 | WSTRING | Drive |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 31 |
|
| P A Y L O A D |
5 | 4 | INT32 | Volume Type 3.9.1.9. Volume Types |
| 9 | 8 | UINT64 | Total size in bytes | |
| 17 | 8 | UINT64 | Free space in bytes | |
| 25 | 8 | UINT64 | Used space in bytes | |
| 33 | 2 | UINT16 | LN Length of Volume Name (in characters) |
|
| 35 | LN × 2 | WSTRING | Volume Name | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 58 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.7.1 (Proprietary)
Support in KukavarProxy: No
Set a new volume name (label).
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 32 |
|
| P A Y L O A D |
5 | 2 | UINT16 | LD Length of Drive (in characters) |
| 7 | LD × 2 | WSTRING | Drive | |
| variable | 2 | UINT16 | LN Length of Name (in characters) |
|
| variable | LN × 2 | WSTRING | Name |
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 32 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 9 | ErrorProtocol |
| [PREVIOUS PAGE] | 59 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.7.1 (Proprietary)
Support in KukavarProxy: No
Get a list of available volumes.
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 33 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 33 |
|
| P A Y L O A D |
5 | 2 | UINT16 | Count of Volumes |
| 7 | 2 | UINT16 | IL1 Length of First Volume |
|
| 9 | IL1 × 2 | WSTRING | First Volume | |
| ... | ||||
| variable | 2 | UINT16 | ILL Length of Last Volume |
|
| variable | ILL × 2 | WSTRING | Last Volume | |
| F O O T E R |
variable | 2 | UINT16 | Error Code |
| variable | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| 7 | ErrorNotImplemented |
| 9 | ErrorProtocol |
| 10 | ErrorLongAnswer |
| [PREVIOUS PAGE] | 60 | [NEXT PAGE] | [UP] [CONTENTS] [HOME] |
Minimum supported version: 1.0.0 (Open Source)
Support in KukavarProxy: No
Reset all errors on the KRC (emulation of pressing the Confirm All button).
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 63 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| Offset (bytes) | Size (bytes) | Type | Meaning | |
|---|---|---|---|---|
| H E A D E R |
0 | 2 | UINT16 | Tag ID |
| 2 | 2 | UINT16 | Message Length | |
| 4 | 1 | UINT8 | Message Type Value: 63 |
|
| P A Y L O A D |
NO PAYLOAD | |||
| F O O T E R |
5 | 2 | UINT16 | Error Code |
| 7 | 1 | BOOL | Success Flag | |
| Code | Name |
|---|---|
| 0 | ErrorGeneral |
| 1 | ErrorSuccess |
| [PREVIOUS PAGE] | 61 | [UP] [CONTENTS] [HOME] |