Table of contents
1) Subject to change2) Introduction2.1) Establish connection3) Command structure3.1) Encoding3.2) Basic examples3.3) Header description3.4) Error codes3.5) Parameters3.6) Header and Payload revisited4) Authentication and permissions5) Examples5.1) Fixed header and payload examples5.2) Dynamic header and payload examples5.3) Authentication examples6) Listings7) Version info8) Categories9) Commands
1) Subject to change
The command interface defined in this protocol is subject to change. Commands that are currently defined using a positional, byte-oriented structure will be iteratively migrated in upcoming releases to a JSON-based payload format as defined by the corresponding JSON schema[1] specifications. Each command version is defined in exactly one format only, either in the legacy positional binary format, or in the new JSON-based format. There is no coexistence of both formats within the same command version. As part of this transition, commands will be converted step by step across multiple releases. Once a command has been migrated to JSON, the positional format will no longer apply to that command. Future versions will continue this transition until the positional binary format is fully deprecated. Integrators are strongly advised to prepare for this change and adopt the JSON-based format as early as possible to ensure forward compatibility.
2) Introduction
The WolfProt protocol is a byte-oriented protocol used to communicate with WolfVision® Visualizer, Cynap and Cynap Videobar systems. In this document, these systems are referred to as device. To interact with these devices, WolfProt commands are sent using WebSockets or using a TCP connection. Both methods provide a secure context for data transmission and should always be the preferred means of communication. Commands are processed serially by the device, with the exception of subscriptions. The replies will always be sent in the same order as commands are received by the device (FIFO). The best practice is to send a command, wait for the reply, and then proceed with the next command.
Please note that devices operate in various network environments and, in most cases, are only accessible through internal networks. Due to their non-public and dynamically assigned IP addresses, secure connections use self-signed certificates generated on the device, which must be accepted by the connecting client.
Older devices may only support communication using a TCP connection.
2.1) Establish connection
As mentioned before, the connection to send commands to a device can be established through a WebSocket or a TCP connection. Connection infos are described in the following. The [ip address] placeholder should be replaced with the device IP address.
2.1.1) WebSocket
TLS secured connection
wss://[ip address]/xxx
Insecure connection
ws://[ip address]/xxx
table
1)
WebSocket endpoints
2.1.2) TCP
TLS secured connection
[ip address]:50917
Insecure connection
[ip address]:50915
table
2)
TCP endpoints
3) Command structure
Commands exist in two basic types, GET and SET. GET commands are used to retrieve values from the device, while SET commands are used to set values on the device. Both GET and SET share the same command structure, but differ only in the header and payload configuration. Data is always sent and retrieved in binary. For better readability this binary data is encoded in hexadecimal format throughout this documentation. The process of sending a command always consists of a request and a reply, with their structure defined as shown below:
StructureLength
Header
1 or 2 byte
Command
1 or 2 byte
Payload length
1 up to 4 bytes
Payload
Parameters (0 to n)
0 up to n bytes
table
3)
Request and reply packet structure
In case the sent command results in an error (this can only occur on replies, no errors can be set on requests) the response structure changes slightly. The payload length is replaced by a 1 byte encoded error and no additional payload is provided:
StructureLength
Header
1 byte
Command
1 or 2 byte
Error code
1 byte
table
4)
Packet structure in case of an error
3.1) Encoding
The following table shows the encoding for the currently supported data types.
StructureLength
number (int8/int16/int32)
little endian
string
Non zero terminated ASCII
table
5)
Data type encoding
3.2) Basic examples
The following examples should provide an impression of how commands are sent. Header, payload length and payload (parameters) are explained in detail later.
3.2.1) Set example (Box name)
The following command sets the box name of a Cynap:
Request data:09 CB03 06 43796E617031
DescriptionValue
Header
09
Command
CB03
Payload length
06
Payload
43796E617031 Cynap1 (UTF-8)
The result, of the request, if proper permissions are given, should be as following:
Response data:09 CB03 00
DescriptionValue
Header
09
Command
CB03
Payload length
00
example
1)
Set box name
3.2.2) Get example (Box name)
The following command retrieves the box name of a Cynap:
Request data:08 CB03 00
DescriptionValue
Header
08
Command
CB03
Payload length
00
The result of the request may look like this:
Response data:08 CB03 06 43796E617031
DescriptionValue
Header
08
Command
CB03
Payload length
06
Payload
43796E617031 Cynap1 (UTF-8)
example
2)
Get box name
3.3) Header description
The command header configures various parameters when sending a command and consists of either 1 or 2 bytes. The later one is called the extended header and is used if the payload length needs 4 bytes to be encoded. The following table shows the regular header:
Bit index:
Error=1, No error=0
Reserved=0
Reserved=0
Reserved=0
Extended Command
Payload length: 2 byte
Extended header
GET=0, SET=1
7
6
5
4
3
2
1
0
Bit indexValue description
0
1 if it is a set command
0 otherwise
1
1 to enable extended header
0 otherwise

The extended header is only used if the payload has to be encoded with 4 bytes.
2
1 if the payload length has to be encoded with 2 bytes
0 if you use 1 or 4 bytes for the length
3
1 command itself uses 2 bytes
0 if the command uses 1 byte
4..6
Set to zero 0. Fields are reserved for future usage.
7
Only used in reply. Will be set to 1 if a command replies with an error.
table
6)
Header
The following table shows the extended header:
Bit index:
Reserved=0
Reserved=0
Reserved=0
Reserved=0
Reserved=0
Reserved=0
Reserved=0
Payload length: 4 byte
7
6
5
4
3
2
1
0
Bit indexValue description
0
1 if the payload length has to be encoded within 4 bytes
0 if the length is encoded with 1 or 2 bytes
1..7
Set to zero 0. Fields are reserved for future usage.
table
7)
Extended header
3.4) Error codes
The the error code byte (see Header) represents one of the following errors:
DescriptionValue
Timeout
0x01
Invalid command
0x02
Invalid parameter
0x03
Invalid length
0x04
Fifo full
0x05
Firmware update error
0x06
Access denied
0x07
Authentication required
0x08
Busy
0x09
Sip required
0x0A
Power off
0x0B
table
8)
Error codes
3.5) Parameters
Parameters are used in requests and replies. They can have a fixed or a dynamic length. The actual type of the value has to be interpreted from the command documentation.
LengthPatternExample
Fixed: 1 byte
[a-z][a-z]?
ac
a
i
Fixed: 1..n bytes
[a-z]0..[a-z]n
s0..s1 (2 bytes)
b0..b3 (4 bytes)
a0..a7 (8 bytes)
Dynamic
Dynamic inferred
[a-z]0..[a-z]n
[a-z]0..[a-z]ninf
s0..sn
s0..sninf
table
9)
Parameter types
3.5.1) Dynamic parameters
Dynamic length parameters are a special case. Their length is determined either by a preceeding fixed length parameter, or they are inferred by the payload length and are marked with the superscriptinf.
When inferring length for dynamic parameters from payload length, preceeding fixed length parameters have to be taken into account.
3.6) Header and Payload revisited
Commands exist in two different types regarding header and payload. Commands with fixed headers and payload, and commands with dynamic headers and payload. The fixed variant will always use the same header and payload as in the command documentation, except the reply responds with an error.
Header type (fixed or dynamic)ValueDescription
Fixed
i.e.: 08
should always be sent as 08
Dynamic
i.e.: [08]
is dynamic and changes depending on the payload length. The documentation should be interpreted as a prefilled bitmask which should be adjusted.
table
10)
Header types
Payload type (fixed or dynamic)ValueDescription
Fixed
ab
the payload length is encoded in 1 byte
Fixed
ab cd
the payload length is encoded in 2 bytes
Fixed
ab cd ef gh
the payload length is encoded in 4 bytes
Dynamic
[ab]
the payload length can be encoded in 1, 2, or 4 bytes
The header has to be adjusted accordingly
table
11)
Payload types
Please see the examples in the examples section for dynamic and fixed headers and payloads ( Fixed,  Dynamic)
4) Authentication and permissions
All commands require a certain permission level, also referred to as user level. The user level specifies an authentication level required to use a command. The user level can be acquired by sending the login command, which differs between Cynap (including Cynap Videobar) and Visualizer devices. The following table shows the various types of user levels:
User level may also be referred as access level, or login level in the documentation
User levelDescription
None
No authentication needed, user level None is automatically granted.
Viewer
Can be acquired by sending viewer password or pin

On Cynap, viewer user level can be enabled through:
  • Settings → Login → Viewer
Annotation
Used for annotation purposes.
User
Moderator user level login. If the system has no moderator authentication, this user level is automatically granted.
Inherits rights from None

On Cynap, moderator user level authorization can be enforced by enabling moderator password or RMS authentication:
  • Settings → Login → Moderator password required
  • Settings → Login → Room Management System (RMS)

On Visualizer, moderator user level authorization can be enforced by enabling moderator password:
  • OSD → Advanced Settings → Security → Moderator password required
Admin
Highest user level, administrator login is required.
Inherits rights from User
 
 
App
Internal usage for vSolution App only.
table
12)
User levels
For examples please see the Authentication examples.
5) Examples
The following section contains various command examples.
5.1) Fixed header and payload examples
These commands always use the same header and payload length encoding as seen in the documentation.
5.1.1) Get Boxname (Cynap)
GET
Boxname
Userlevel: None
Request Command
Request Parameters
Comment
08 CB03 00
Reply Command
Reply Parameters
Comment
08 CB03 ab n0..nn
n0..nninf
Name of box
Max. 32 bytes
Below are examples of requests and their corresponding replies:Request
Documentation valuesExample 1)Example 2)
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB03
CB03
CB03
Payload length
00 (Value is zero and has one byte)
00
00
Reply
Documentation valuesExample 1)Example 2)
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB03
CB03
CB03
Payload length
ab (1 byte length)
0A
0A
Parameter
n0..nninf
Parameter length is determined by payload length
50616e646f726131 Pandora1 (UTF-8)
Length: 8 bytes
43796E617031 Cynap1 (UTF-8)
Length: 6 bytes
example
3)
Get Boxname (Cynap), fixed header and payload length
5.1.2) Set Boxname (Cynap)
SET
Boxname
Userlevel: Admin
Request Command
Request Parameters
Comment
09 CB03 ab n0..nn
n0..nninf
Name of box
Max. 32 bytes
Reply Command
Reply Parameters
Comment
09 CB03 00
Below are examples of requests and their corresponding replies:Request
Documentation valuesExample 1)Example 2) - No Admin user level
Header
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB03
CB03
CB03
Payload length
ab (1 byte length)
0A
0A
Parameter
n0..nninf
50616e646f726131 Pandora1 (UTF-8)
50616e646f726131 Pandora1 (UTF-8)
Reply
Documentation valuesExample 1)Example 2) - No Admin user level
Header
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
89
Header:89
Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB03
CB03
CB03
Payload length
00 (Value is zero has 1 byte length)
00
07
Payload length is now the error code: Access denied
example
4)
Set Boxname (Cynap), fixed header and payload length
5.2) Dynamic header and payload examples
These commands vary in their header and payload length encoding depending on their payload length.
5.2.1) Get Picture (Visualizer)
The following command will retrieve the live preview picture of a Visualizer device provided as JPEG. The size of the image will vary drastically depending on the captured content. The 250 byte example may not occur in real life situations, but is provided for completeness.
GET
Get Picture
Userlevel: User
Request Command
Request Parameters
Comment
08 4117 00
Reply Command
Reply Parameters
Comment
[08] 4117 [ab] p s b0..bn
p
picture format
s
start indicator 0x00
b0..bninf
picture data.
Get live picture.
If web viewer mode is enabled (see WPC_WEBVIEWER_MODE),
this command will not require any authentication.
Size of the picture data is the command
length from header subtracted by 2.
Below are examples of requests and their corresponding replies:Request
Documentation valuesExample (250 Byte)Example (15 Ki)Example (4 Mi)
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
4117
4117
4117
4117
Payload length
00
00
00
00
Reply
Documentation valuesExample (250 Byte)Example (15 Ki)Example (4 Mi)
Header
[08]
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
0C
Header:0C
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
1 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
0A01
Header:0A
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
1 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Extended header:01
Bit index:
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Payload length: 4 byte
7
6
5
4
3
2
1
0
Command
4117
4117
4117
4117
Payload length
[ab] 1 - 4 bytes
FA
3C00
00400000
Parameter
p Picture format
s Start indicator
b0..bninf Picture data
Length is determined by Payload length
00 Picture format
00 Start indicator
ff0d8ffe0…n247 Picture data
Length:
250B - 2B → 247B
00 Picture format
00 Start indicator
ff0d8ffe0…n15358 Picture data
Length:
15360B - 2B → 15358B
00 Picture format
00 Start indicator
ff0d8ffe0…n4194302 Picture data
Length:
4194304B - 2B → 4194302B
example
5)
Get Picture (Visualizer), dynamic header and payload length
5.3) Authentication examples
Authentication differs slightly between Visualizer and Cynap devices. The authentication should be done for each connection to the device. Please see the following examples:
5.3.1) Visualizer authentication
The following command can be used to request a user level for the current connection:
SET
Login Level
Userlevel: None
Request Command
Request Parameters
Comment
[09] 400B [ab] l s0..sn
l
login level
0x00
NONE
0x01
USER
0x02
ADMIN
s0..sninf
password
Set login level.
Reply Command
Reply Parameters
Comment
09 400B 00
Below are examples of requests and their corresponding replies:Request
Documentation valuesCorrect credentialsWrong credentials
Header
[09]
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
400B
400B
400B
Payload length
[ab] 1 - 4 bytes
09
08
Parameter
l User level
s0..sninf Password
02 Admin
50616e646f7261313232 Pandora1 (UTF-8)
02 Admin
5061646f7261313232 Padora1 (UTF-8)
Reply
Documentation valuesCorrect credentialsWrong credentials
Header
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
89
Header:89
Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
400B
400B
400B
Payload length
00
00
07
Payload length is now the error code: Access denied
example
6)
Set Login Level (Visualizer), dynamic header and payload length
The following command shows the active user level for the current connection:
GET
Login Level
Userlevel: None
Request Command
Request Parameters
Comment
08 400B 00
Reply Command
Reply Parameters
Comment
08 400B 01 l
l
login level
0x00
NONE
0x01
USER
0x02
ADMIN
0x03
ADJUSTMENT
Get current login level.
Below are examples of requests and their corresponding replies:Request
Documentation valuesAleady authenticatedNot authenticated
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
400B
400B
400B
Payload length
00
00
00
Reply
Documentation valuesAleady authenticatedNot authenticated
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
400B
400B
400B
Payload length
01
01
01
Parameter
lv User level
01 Admin
00 None
example
7)
Get Login Level (Visualizer), fixed header and payload length
5.3.2) Cynap authentication
The following command can be used to request a user level for the current connection.
Please note: Login using PIN or Connection ID is not covered in this example. When using the PIN parameter the password length has to be set to 00 and the password parameter should not be set.
SET
Login
Userlevel: None
Request Command
Request Parameters
Comment
09 CB42 ab al lp p0..pn ln n0..nn
al
Access level
0x01
User
0x02
Admin
0x03
Annotation
0x04
Viewer
lp
Password length
Max. 63 bytes
p0..pn
Password
ln
PIN length. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections
Max. 63 bytes
n0..nn
PIN. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections
Reply Command
Reply Parameters
Comment
09 CB42 00
Below are examples of requests and their corresponding replies:Request
Documentation valuesCorrect credentialsWrong credentials
Header
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB42
CB42
CB42
Payload length
ab 1 byte
0B
0A
Parameter
l Accesslevel (User level)
lp Password length
p0..pn Password
ln Pin length
n0..nn Pin
02 Admin
08
50616e646f726131 Pandora1 (UTF-8)
00 No pin provided
-- Not used
02 Admin
07
5061646f726131 Padora1 (UTF-8)
00 No pin provided
-- Not used
Reply
Documentation valuesCorrect credentialsWrong credentials
Header
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
09
Header:09
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
89
Header:89
Bit index:
1 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
1 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB42
CB42
CB42
Payload length
00
00
07
Payload length is now the error code: Access denied
example
8)
Set Login (Cynap), fixed header and payload length
The following command shows the active user level for the current connection.
GET
Login Level
Userlevel: None
Request Command
Request Parameters
Comment
08 CB55 00
Reply Command
Reply Parameters
Comment
08 CB55 01 lv
lv
Level
0x00
None
0x01
User
0x02
Admin
0x03
Annotation
0x04
Viewer
Below are examples of requests and their corresponding replies:Request
Documentation valuesAleady authenticatedNot authenticated
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB55
CB55
CB55
Payload length
00
00
00
Reply
Documentation valuesAleady authenticatedNot authenticated
Header
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
08
Header:08
Bit index:
0 Error=1, No error=0
0 Reserved=0
0 Reserved=0
0 Reserved=0
1 Extended Command
0 Payload length: 2 byte
0 Extended header
0 GET=0, SET=1
7
6
5
4
3
2
1
0
Command
CB55
CB55
CB55
Payload length
01
01
01
Parameter
lv User level
01 Admin
00 None
example
9)
Get Login Level (Cynap), fixed header and payload length
6) Listings
Tables:
1) WebSocket endpoints2) TCP endpoints3) Request and reply packet structure4) Packet structure in case of an error5) Data type encoding6) Header7) Extended header8) Error codes9) Parameter types10) Header types11) Payload types12) User levels
Examples:
1) Set box name2) Get box name3) Get Boxname (Cynap),
fixed header and payload length4) Set Boxname (Cynap),
fixed header and payload length5) Get Picture (Visualizer),
dynamic header and payload length6) Set Login Level (Visualizer),
dynamic header and payload length7) Get Login Level (Visualizer),
fixed header and payload length8) Set Login (Cynap),
fixed header and payload length9) Get Login Level (Cynap),
fixed header and payload length
Links:
1) https://json-schema.org/
7) Version info

Firmware Version:
2.00c

Firmware Type:
Cynap

8) Categories
DeviceNetworkOutputRecordingRemoteSystem
9) Commands
Scroll to top
Device (2)
GET
Boxname
Userlevel: None
Request Command
Request Parameters
Comment
08 CB03 00
Reply Command
Reply Parameters
Comment
08 CB03 ab n0..nn
n0..nninf
Name of box
Max. 32 bytes
SET
Boxname
Userlevel: Admin
Request Command
Request Parameters
Comment
09 CB03 ab n0..nn
n0..nninf
Name of box
Max. 32 bytes
Reply Command
Reply Parameters
Comment
09 CB03 00
Network (2)
GET
Mirroring
Userlevel: None
Request Command
Request Parameters
Comment
08 CB3B 00
Reply Command
Reply Parameters
Comment
08 CB3B 03 st t0..t1
st
0x00
Disabled
0x01
Enabled
t0..t1
Time left
0x00..0x1E
In seconds (0..30)
SET
Mirroring
Userlevel: User
Request Command
Request Parameters
Comment
09 CB3B 01 st
st
0x00
Disable
0x01
Enable
Reply Command
Reply Parameters
Comment
09 CB3B 00
Output (4)
GET
Content Per Output
Userlevel: User
Request Command
Request Parameters
Comment
0C CD5D 0003 o0..o1 ext
o0..o1
output (OR operation with the desired outputs)
0x0001
HDMI1
0x0002
HDMI2
0x0020
Screenshare
ext
extended information
0x00
No
0x01
Yes
Reply Command
Reply Parameters
Comment
0C CD5D ab cd ct cbl0..cbl1 cb0..cbn tbl0..tbl1 tb0..tbn
ct
content type
0x00
windows
cbl0..cbl1
window common block length
cb0..cbn
window common block
ty: window type
  • 0x00 = None
  • 0x01 = Visualizer
  • 0x02 = HDMI
  • 0x03 = Browser
  • 0x04 = Miracast
  • 0x05 = Airplay/Chromecast
  • 0x06 = Video
  • 0x07 = vSolution Cast/App
  • 0x08 = Image
  • 0x09 = PDF
  • 0x0A = Office PPT/PPTX
  • 0x0B = Office DOC/DOCX/TXT
  • 0x0C = Office XLS/XLSX
  • 0x0D = Whiteboard
  • 0x0E = Audio
  • 0x0F = Webconference
  • 0x10 = Webcam
  • 0x11 = Stream Input
  • 0x13 = Office 365 Outlook
  • 0x14 = Office 365 Word
  • 0x15 = Office 365 Excel
  • 0x16 = Office 365 PowerPoint
  • 0x17 = Office 365 OneNote
  • 0x18 = vMatrix Pull Stream (from station)
  • 0x19 = vMatrix Push Stream (to station)
  • 0x1A = vMatrix Station Browser
  • 0x1B = Office 365 Teams
  • 0x1C = vMatrix Groupwork Stream
  • 0x1E = Office 365 Whiteboard
  • 0x1F = Office 365 Planner
id0..id7: app id
idx: window index/slot
op0..op1: output port
  • 0x0001: HDMI1
  • 0x0002: HDMI2
  • 0x0008: Edit Mode
  • 0x0020: Screenshare
rw0..rw1: reference width
rh0..rh1: reference height
x0..x1: x position (left upper corner)
y0..y1: y position (left upper corner)
w0..w1: width
h0..h1: height
mu: mute
  • 0x00: not muted
  • 0x01: muted
vo: volume (0x00..0x7d: volume in percent)
rec: display as transparent window for recording/streaming
  • 0x00: no
  • 0x01: yes
webrtc: shared over webrtc
  • 0x00: no
  • 0x01: yes
fs: full screen
  • 0x00: normal
  • 0x01: full screen
wr: window restricted
  • 0x00: no
  • 0x01: yes
tbl0..tbl1
type specific block length
tb0..tbn
type specific block
Type Visualizer and HDMI (wt=0x01..0x02):
in0..in3: Index
ln0..ln1: Input name length
n0..nn: Input name
Type Browser, Webconference, Office365, vMatrix Station Browser (wt=0x03, 0x0F, 0x13..0x17, 0x1A, 0x1B):
lu0..lu1: URL length
u0..un: URL
lt0..lt1: Title length
t0..tn: Title
it: Input type (request keyboard)
pdf: PDF viewer active
pp0..pp3: Page of PDF
tpp0..tpp3: Total page count of PDF
bu: Busy
pft0..pft3: Password field top (0x00000000 if not available)
pfb0..pfb3: Password field bottom (0x00000000 if not available)
pfl0..pfl3: Password field left (0x00000000 if not available)
pfr0..pfr3: Password field right (0x00000000 if not available)
zlp0..zlp3: Zoom level in percent
Types Office365 & webconf additionally: scr: Screenshare status
Type Airplay, vMatrix Pull Stream (from station), vMatrix Groupwork Stream (wt=0x05, 0x18, 0x1C):
ln0..ln1: Name length
n0..nn: Name
Type vMatrix Push Stream (wt=0x19):
ln0..ln1: Name length
n0..nn: Name
pi: Push index
  • 0x00..0x03: Input stream 1..4 as stream source
  • 0xFC: Matrix master stream source (HDMI2)
  • 0xFD: Station stream source (Coaching)
  • 0xFE: Station stream source (Groupwork)
  • 0xFF: Matrix master stream source (HDMI1)
Type Video and Audio (wt=0x06, 0x0E):
du0..du3: Duration in ms
p0..p3: Position in ms
sp: Speed
  • 0x00: Pause
  • 0x01: Normal
  • 0x02..0x0A: Speed multiplier Forward
  • 0xFF: Backward
  • 0xFE..0xF6: Speed multiplier Backward
lo: Loop
  • 0x00: Off
  • 0x01: On

tl0..tl1: Title length
t0..tn: Title
ps: Playback Status
  • 0x00: Stopped
  • 0x01: Paused
  • 0x02: Seek Backward
  • 0x03: Seek Forward
  • 0x04: Playing
Type Image (wt=0x08):
in0..in3: Image number
tn0..tn3: Total number of images
lf0..lf1: Filename length
f0..fn: Filename
Type PDF (wt=0x09):
p0..p3: Page
tp0..tp3: Total number of pages
zlp0..zlp3: Zoom level in percent
Type Office (wt=0x0A..0x0C):
p0..p3: Page
tp0..tp3: Total pages
ld0..ld1: Document name length
dn0..dnn: Document name
wp0..wp3: Worksheet pages
lw0..lw1: Worksheet name length
wn0..wnn: Worksheet name
Type Whiteboard (wt=0x0D):
nu: Number of users
Type Webcam (wt=0x10):
ct: Content type
  • 0x00 = HDMI
  • 0x01 = Visualizer
  • 0x02 = Disc Player
  • 0x03 = Computer
  • 0x0A = Camera
ln0..ln1: Camera name length
n0..nn: Camera name
Type Stream Input (wt=0x11):
ct: Content type
  • 0x00 = HDMI
  • 0x01 = Visualizer
  • 0x02 = Disc Player
  • 0x03 = Computer
  • 0x0A = Camera
  • 0x0B = Stream Input
  • 0x0D = Cynap
ln0..ln1: Stream name length
n0..nn: Stream name (URL encoded)
Type Miracast (wt=0x04):
ln0..ln1: Name length
n0..nn: Name
ll: Low latency state
  • 0x00: Off
  • 0x01: On
Type vSolution Cast/App (wt=0x07):
ln0..ln1: Name length
n0..nn: Name
cb: Camera Back Session Window
  • 0x00: No
  • 0x01: Yes
The parameters content type, window common block length, window common block, type specific block length and type specific block are combined in one block that is repeated n times.
SET
Start Application
Userlevel: User
Request Command
Request Parameters
Comment
09 CD60 0d o0..o1 ra0..ra7 pai re wt
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x01
Visualizer
0x0D
Whiteboard
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
09 CD60 0e o0..o1 ra0..ra7 pai re wt idx
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x02
HDMI
0x10
Webcam
0x11
Stream Input
idx
Input index
0x00 = HDMI IN1/ Webcam 1/ Stream 1
0x01 = HDMI IN2/ Webcam 2/ Stream 2
...
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
0D CD60 ab cd o0..o1 ra0..ra7 pai re wt ul0..ul1 u0..un
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x13
Office 365 Outlook
0x14
Office 365 Word
0x15
Office 365 Excel
0x16
Office 365 PowerPoint
0x17
Office 365 OneNote
0x1E
Office 365 Whiteboard
0x1F
Office 365 Planner
ul0..ul1
URL length
max 2048 bytes
u0..un
URL
If no URL is provided, the default page is opened
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
0D CD60 ab cd o0..o1 ra0..ra7 pai re wt ul0..ul1 u0..un idx
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x03
Browser
ul0..ul1
URL length
max 2048 bytes
u0..un
URL
If no URL or valid index is provided, the default page is opened
idx
Browser shortcut index
Browser shortcut index or 0xFF if not used
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
0D CD60 ab cd o0..o1 ra0..ra7 pai re wt ul0..ul1 u0..un ns
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x0F
Webconference
ul0..ul1
Join Meeting URL length
max 2048 bytes
u0..un
Join Meeting URL
If no URL is provided, the first URL specified in the WebRTC settings is opened
ns
Native Screenshare
0x00
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
0D CD60 ab cd o0..o1 ra0..ra7 pai re wt fl0..fl1 f0..fn
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..255
Position in the prepare area application list. Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x09
Remote PDF
0x20
Local file
fl0..fl1
File path length
max 2048 bytes
f0..fn
Fully qualified path
E.g. Internal:///snapshots/image.jpg
Reply Command
Reply Parameters
Comment
09 CD60 00
Request Command
Request Parameters
Comment
0B01 CD60 ab cd ef gh o0..o1 ra0..ra7 pai re wt ac ul0..ul1 u0..un lpr0..lpr1 pr0..prn
o0..o1
0x0001
HDMI1
0x0002
HDMI2
ra0..ra7
Replace application ID
0 if no replace is needed
pai
Prepare Area Index
0..0xFF
Position in the prepare area application list (0xFF to append). Ignored if none of the outputs is the prepare area
re
Restricted flag
0x00
Normal window
0x01
Restricted window: Full control of such a window is only allowed for the client starting the window and for the local frontend. Click/Touch/Key events as well as WolfProt window control commands are ignored from other clients
wt
Window type
0x1B
Office 365 Teams
0x1D
Zoom
ac
Action
0x00
Join Meeting
0x01
Start local meeting room
ul0..ul1
Join Meeing URL length
u0..un
Join Meeting URL
lpr0..lpr1
Private data length
pr0..prn
Private data
Cookies array as JSON string
Example:
{“cookies”: [{ "url": "https://teams.microsoft.com/", "name": "MUIDB", "value": "0A86A8C113F963AF2606B96E122062F1", "path": "/", "secure": true, "httpOnly": true, "expirationDate": 1687167192.6475179, "storeId": "0" }, …]}
Reply Command
Reply Parameters
Comment
09 CD60 00
SET
Control Application
Userlevel: None
Request Command
Request Parameters
Comment
09 CD61 09 ai0..ai7 ac
ai0..ai7
Application ID
ac
Action
0x00
Close
0x01
Fullscreen
0x02
Normal
0x05
Toggle Fullscreen/Normal
0x09
WebRTC Screen Sharing On
0x0A
WebRTC Screen Sharing Off
0x0B
WebRTC Screen Sharing Toggle
Reply Command
Reply Parameters
Comment
09 CD61 00
Request Command
Request Parameters
Comment
09 CD61 0a a0..a7 ac oo
a0..a7
Application ID
ac
Action
0x03
Mute
oo
0x00
Off
0x01
On
Reply Command
Reply Parameters
Comment
09 CD61 00
Request Command
Request Parameters
Comment
09 CD61 0a a0..a7 ac wv
a0..a7
Application ID
ac
Action
0x04
Volume
wv
0x00..0x7d
Volume in percent (0..125)
Reply Command
Reply Parameters
Comment
09 CD61 00
Request Command
Request Parameters
Comment
09 CD61 0e a0..a7 ac o0..o1 s0..s1 pai
a0..a7
Application ID
ac
Action
0x0C
Show on. Invalid action during annotation (busy error reply will be sent back)
o0..o1
0x0001
HDMI1
0x0002
HDMI2
s0..s1
Bit 0
HDMI1
Bit 1
HDMI2
pai
Prepare Area Index
Ignored if none of the outputs is the Prepare Area
Reply Command
Reply Parameters
Comment
09 CD61 00
Request Command
Request Parameters
Comment
09 CD61 11 sa0..sa7 ac ra0..ra7
sa0..sa7
Source Application ID
ac
Action
0x0D
Replace. Invalid action during annotation (busy error reply will be sent back)
ra0..ra7
Replace Application ID
Reply Command
Reply Parameters
Comment
09 CD61 00
SET
Control Specific Type Application
Userlevel: User
Request Command
Request Parameters
Comment
09 CD62 0c wt ai0..ai7 ac s0..s1
wt
Window type
0x01
Visualizer
ai0..ai7
Application ID
ac
Action
0x00
Zoom Wide
0x01
Zoom Tele
0x02
Focus Far
0x03
Focus Near
s0..s1
Speed
0x0000
Stop
0x0001..0x000F
Speed (1..15)
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
09 CD62 0a wt ai0..ai7 ac
wt
Window type
0x01
Visualizer
ai0..ai7
Application ID
ac
Action
0x04
Auto Focus On
0x05
Auto Focus Off
0x06
Freeze On
0x07
Freeze Off
0x08
Preset Save
0x09
Preset Recall
0x0A
Auto Focus Toggle
0x0B
Freeze Toggle
0x0C
Power On
0x0D
Power Off
0x0E
Power Toggle
0x0F
Light On
0x10
Light Off
0x11
Light Toggle
0x12
Capture Area Shift On
0x13
Capture Area Shift Off
0x14
Capture Area Shift Toggle
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
09 CD62 0c wt ai0..ai7 ac f0..f1
wt
Window type
0x01
Visualizer
ai0..ai7
Application ID
ac
Action
0x15
One-Push Auto Focus
f0..f1
Field index
0x0001..0x0009
Field (1..9)
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 ab cd wt ai0..ai7 ac u0..un
wt
Window type
0x03
Browser
ai0..ai7
Application ID
ac
Action
0x00
URL
u0..uninf
URL
Max. 512 bytes
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x03
Browser
ai0..ai7
Application ID
ac
Action
0x01
Reload
0x02
Stop
0x03
Zoom In
0x04
Zoom Out
0x05
Cursor Down
0x06
Cursor Up
0x07
Cursor Right
0x08
Cursor Left
0x09
Back
0x0A
Forward
0x0B
(PDF Viewer) Next page
0x0C
(PDF Viewer) Previous page
0x0E
(PDF Viewer) Set zoom to full height
0x0F
(PDF Viewer) Set zoom to full width
0x10
(PDF Viewer) Set zoom to full page
0x11
Scroll Down
0x12
Scroll Up
0x13
Scroll Right
0x14
Scroll Left
0x15
Browser Home
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac p0..p1
wt
Window type
0x03
Browser
ai0..ai7
Application ID
ac
Action
0x0D
Set page (PDF Viewer)
p0..p1
Page number
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x06
Video
ai0..ai7
Application ID
ac
Action
0x00
Play
0x01
Pause
0x02
Stop
0x03
Forward
0x04
Rewind
0x07
Loop Off
0x08
Loop On
0x09
Loop Toggle
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac f0..f1
wt
Window type
0x06
Video
ai0..ai7
Application ID
ac
Action
0x05
File path
f0..f1
Max. 512 bytes
Fully qualified name: e.g. USB:///folder/video.mp4
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000e wt ai0..ai7 ac p0..p3
wt
Window type
0x06
Video
ai0..ai7
Application ID
ac
Action
0x06
Seek
p0..p3
Position
In ms
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac f0..f1
wt
Window type
0x08
Image
ai0..ai7
Application ID
ac
Action
0x00
File path
f0..f1
Max. 512 bytes
Fully qualified name: e.g. USB:///folder/image.jpg
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x08
Image
ai0..ai7
Application ID
ac
Action
0x01
Previous Image
0x02
Next Image
0x03
First Image
0x04
Last Image
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac f0..f1
wt
Window type
0x09
PDF
ai0..ai7
Application ID
ac
Action
0x00
File path
f0..f1
Fully qualified name: e.g. USB:///folder/document.pdf
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x09
PDF
ai0..ai7
Application ID
ac
Action
0x01
Zoom In
0x02
Zoom Out
0x03
Cursor Down
0x04
Cursor Up
0x05
Cursor Right
0x06
Cursor Left
0x07
Next Page
0x08
Previous Page
0x0A
Set zoom to full height
0x0B
Set zoom to full width
0x0C
Set zoom to full page
0x0D
Scroll Down
0x0E
Scroll Up
0x0F
Scroll Right
0x10
Scroll Left
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac p0..p1
wt
Window type
0x09
PDF
ai0..ai7
Application ID
ac
Action
0x09
Set page
p0..p1
Page number
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x0E
Audio
ai0..ai7
Application ID
ac
Action
0x00
Play
0x01
Pause
0x02
Stop
0x03
Forward
0x04
Rewind
0x07
Loop Off
0x08
Loop On
0x09
Loop Toggle
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac f0..f1
wt
Window type
0x0E
Audio
ai0..ai7
Application ID
ac
Action
0x05
File path
f0..f1
Max. 512 bytes
Fully qualified name: e.g. USB:///folder/audio.mp3
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000e wt ai0..ai7 ac p0..p3
wt
Window type
0x0E
Audio
ai0..ai7
Application ID
ac
Action
0x06
Seek
p0..p3
Position
In ms
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac f0..f1
wt
Window type
0x0A
Office Presentation
0x0B
Office Text
0x0C
Office Calc
ai0..ai7
Application ID
ac
Action
0x00
File path
f0..f1
Max. 512 bytes
Fully qualified name: e.g. USB:///folder/spreadsheet.xlsx
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x0A
Office Presentation
0x0B
Office Text
0x0C
Office Calc
ai0..ai7
Application ID
ac
Action
0x01
Zoom In
0x02
Zoom Out
0x03
Cursor Down
0x04
Cursor Up
0x05
Cursor Right
0x06
Cursor Left
0x07
Next Page
0x08
Previous Page
0x09
Next Worksheet
0x0A
Previous Worksheet
0x0B
Set zoom to full page
0x0C
Set zoom to full width
0x0D
Scroll Down
0x0E
Scroll Up
0x0F
Scroll Right
0x10
Scroll Left
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000c wt ai0..ai7 ac u0..u1
wt
Window type
0x13
Office365 Outlook
0x14
Office365 Word
0x15
Office365 Excel
0x16
Office365 PowerPoint
0x17
Office365 OneNote
0x1B
Office365 Teams
0x1E
Office365 Whiteboard
0x1F
Office365 Planner
ai0..ai7
Application ID
ac
Action
0x00
URL
u0..u1
Max. 512 bytes
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x13
Office365 Outlook
0x14
Office365 Word
0x15
Office365 Excel
0x16
Office365 PowerPoint
0x17
Office365 OneNote
0x1B
Office365 Teams
0x1E
Office365 Whiteboard
0x1F
Office365 Planner
ai0..ai7
Application ID
ac
Action
0x01
Reload
0x02
Stop
0x03
Zoom In
0x04
Zoom Out
0x05
Cursor Down
0x06
Cursor Up
0x07
Cursor Right
0x08
Cursor Left
0x09
Back
0x0A
Forward
0x0B
Scroll Down
0x0C
Scroll Up
0x0D
Scroll Right
0x0E
Scroll Left
Reply Command
Reply Parameters
Comment
09 CD62 00
Request Command
Request Parameters
Comment
0D CD62 000a wt ai0..ai7 ac
wt
Window type
0x04
Miracast
ai0..ai7
Application ID
ac
Action
0x00
Low latency off
0x01
Low latency on
0x02
Low latency toggle
Reply Command
Reply Parameters
Comment
09 CD62 00
Recording (1)
SET
Image Snapshot
Userlevel: User
Request Command
Request Parameters
Comment
09 CB32 01 ac
ac
Action
0x00
Take snapshot
Reply Command
Reply Parameters
Comment
09 CB32 00
Remote (1)
SET
CB Remote
Userlevel: None
Request Command
Request Parameters
Comment
09 CB01 02 ky ac
ky
Key
0x00
None
0x01
Left
0x02
Right
0x03
Up
0x04
Down
0x05
OK
0x06
Menu
0x07
Red
0x08
Green
0x09
Yellow
0x0A
Blue
0x0B
Toolbox
0x0C
USB File Listing
ac
Action
0x00
None
0x01
Hit: Button was pressed and is currently hold (Begin of long press)
0x02
Release: Button was released after holding it (End of long press)
0x03
Tip: Button was pressed and is already released (Short press)
Reply Command
Reply Parameters
Comment
09 CB01 00
System (20)
GET
Power
Userlevel: None
Request Command
Request Parameters
Comment
08 CB0C 00
Reply Command
Reply Parameters
Comment
08 CB0C 01 oo
oo
0x00
Off
0x01
On
SET
Power
Userlevel: User
Request Command
Request Parameters
Comment
09 CB0C 01 oo
oo
0x00
Off
0x01
On
"Power On" is only applicable within 30 seconds after "Power Off" command was sent. If Cynap is already in Standby mode, Wake On LAN has to be used instead of "Power On" command
Reply Command
Reply Parameters
Comment
09 CB0C 00
GET
Presentation Mode
Userlevel: None
Request Command
Request Parameters
Comment
08 CB38 00
Reply Command
Reply Parameters
Comment
08 CB38 02 mo pe
mo
Mode
0x00
Meeting
0x01
Lecture
pe
Permission timeout
0x0A..0x78
10 sec - 120 sec
SET
Presentation Mode
Userlevel: Admin
Request Command
Request Parameters
Comment
09 CB38 01 mo
mo
Mode
0x00
Meeting
0x01
Lecture
Reply Command
Reply Parameters
Comment
09 CB38 00
Request Command
Request Parameters
Comment
09 CB38 02 mo pe
mo
Mode
0x00
Meeting
0x01
Lecture
pe
Permission timeout
0x0A..0x78
10 sec - 120 sec
Reply Command
Reply Parameters
Comment
09 CB38 00
SET
Login
Userlevel: None
Request Command
Request Parameters
Comment
09 CB42 ab al lp p0..pn ln n0..nn
al
Access level
0x01
User
0x02
Admin
0x03
Annotation
0x04
Viewer
lp
Password length
Max. 63 bytes
p0..pn
Password
ln
PIN length. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections
Max. 63 bytes
n0..nn
PIN. This is an optional parameter and is only required if Admin Remote PIN is set to PIN required and Access level is set to Admin. Also used as connection ID pin for safe connections
Reply Command
Reply Parameters
Comment
09 CB42 00
SET
End Presentation
Userlevel: User
Request Command
Request Parameters
Comment
09 CB49 04 dr ds mo dw
dr
Delete recordings folder
0x00
No
0x01
Yes
ds
Delete snapshots folder
0x00
No
0x01
Yes
mo
Power off mode
0x00
New Presentation
0x01
Standby (formerly: Power off)
0x02
Screen Off
0x03
Screensaver
dw
Delete whiteboards folder
0x00
No
0x01
Yes
Reply Command
Reply Parameters
Comment
09 CB49 00
GET
Master Volume
Userlevel: Annotation
Request Command
Request Parameters
Comment
08 CB56 00
Reply Command
Reply Parameters
Comment
08 CB56 01 vo
vo
0x00..0x64
Volume in percent (0..100)
SET
Master Volume
Userlevel: User
Request Command
Request Parameters
Comment
09 CB56 01 vo
vo
0x00..0x64
Volume in percent (0..100)
Reply Command
Reply Parameters
Comment
09 CB56 00
GET
Master Mute
Userlevel: Annotation
Request Command
Request Parameters
Comment
08 CB58 00
Reply Command
Reply Parameters
Comment
08 CB58 01 oo
oo
0x00
Off
0x01
On
SET
Master Mute
Userlevel: User
Request Command
Request Parameters
Comment
09 CB58 01 oo
oo
0x00
Off
0x01
On
0x02
Toggle
Reply Command
Reply Parameters
Comment
09 CB58 00
GET
Mic Mute
Userlevel: Annotation
Request Command
Request Parameters
Comment
08 CB59 00
Reply Command
Reply Parameters
Comment
08 CB59 01 oo
oo
0x00
Off
0x01
On
SET
Mic Mute
Userlevel: User
Request Command
Request Parameters
Comment
09 CB59 01 oo
oo
0x00
Off
0x01
On
0x02
Toggle
Reply Command
Reply Parameters
Comment
09 CB59 00
GET
Main Freeze
Userlevel: Annotation
Request Command
Request Parameters
Comment
08 CB5A 00
Reply Command
Reply Parameters
Comment
08 CB5A 01 oo
oo
0x00
Off
0x01
On
Request Command
Request Parameters
Comment
08 CB5A 00
Reply Command
Reply Parameters
Comment
08 CB5A 02 oo of
oo
0x00
Off
0x01
On
of
Output flags (bit mask)
0x01
HDMI1
0x02
HDMI2
SET
Main Freeze
Userlevel: User
Request Command
Request Parameters
Comment
09 CB5A 01 oo
oo
0x00
Off
0x01
On
0x02
Toggle
Reply Command
Reply Parameters
Comment
09 CB5A 00
Request Command
Request Parameters
Comment
09 CB5A 02 oo of
oo
0x00
Off
0x01
On
0x02
Toggle
of
Output flags (bit mask)
0x01
HDMI1
0x02
HDMI2
Reply Command
Reply Parameters
Comment
09 CB5A 00
GET
Content Sources
Userlevel: Annotation
Request Command
Request Parameters
Comment
08 CB90 00
Reply Command
Reply Parameters
Comment
0C CB90 ab cd ns ls src ct ln n0..nn t0..tn
ns
Number of sources
ls
Source block length
Combined length of Source status, Content type, Source name length, Source name and Type specific source block
src
Source status
0x00
Not ready
0x01
Available and ready
ct
Content type
0x00
HDMI
0x01
Visualizer
0x02
Disc Player
0x03
Computer
0x04
Browser
0x07
Mirroring
0x08
Annotation/Whiteboard
0x09
Webconference
0x0A
Webcam
0x0B
Stream Input
0x0C
Office365
0x0D
Cynap
0x0E
Zoom
0x0F
Office365 Teams Webconference
0x10
Stream Input List
0x11
Camera
0x12
Browser Shortcut
0xFF
Undefined
ln
Source name length
n0..nn
Source name
t0..tninf
Type specific source block
This block is optional (depends on Content type)
Type HDMI (ct=0x00):
  • in: Index
    • 0 = HDMI 1
    • 1 = HDMI 2
Type Webcam (ct=0x0A):
  • in: Index (0..1)
  • ct: Content type
    • 0x00 = HDMI
    • 0x01 = Visualizer
    • 0x02 = Disc Player
    • 0x03 = Computer
    • 0x0A = Camera
Type Stream Input (ct=0x0B):
  • in: Index (0..3)
  • ct: Content type
    • 0x00 = HDMI
    • 0x01 = Visualizer
    • 0x02 = Disc Player
    • 0x03 = Computer
    • 0x0A = Camera
    • 0x0B = Stream Input
    • 0x0D = Cynap
Type Browser Shortcut (ct=0x12):
  • in: Index (0..3)
The parameters Source block length, Source status, Content type, Source name length, Source name and Type specific source block are combined in a block called Source infos. In this specification, only the Source infos block for source 0 is listed but this block is actually repeated as many times as Number of sources specifies
GET
BYOD PIN Display
Userlevel: User
Request Command
Request Parameters
Comment
08 CBE4 00
Reply Command
Reply Parameters
Comment
08 CBE4 05 di p0..p3
di
Display
0x00
Hide PIN
0x01
Show PIN
0x02
Popup PIN
p0..p3
PIN
PIN as 4-digit string: e.g. 0245, 8934 or 1500
GET
Power Down Mode
Userlevel: None
Request Command
Request Parameters
Comment
08 CCC7 00
Reply Command
Reply Parameters
Comment
08 CCC7 01 mo
mo
Mode
0x00
Standby
0x01
Shutdown
SET
Power Down Mode
Userlevel: Admin
Request Command
Request Parameters
Comment
09 CCC7 01 mo
mo
Mode
0x00
Standby
0x01
Shutdown
Reply Command
Reply Parameters
Comment
09 CCC7 00
SET
Splash Screen Trigger
Userlevel: User
Request Command
Request Parameters
Comment
09 CCEE 01 ac
ac
Action
0x00
Trigger
Reply Command
Reply Parameters
Comment
09 CCEE 00
SET
Subscribe
Userlevel: None
Request Command
Request Parameters
Comment
0D CD40 ab cd s0..sn
s0..sninf
Subscribed commands
List of commands, max. length 1024 bytes.
Supported commands:
0x08CCC700
Power Down Mode
0x08CD2D00
Admin Message
0x08CD3000
Presentation Status
0x08CB0C00
Power
0x08CC7600
Screensaver State
0x08CB6800
Visualizer Status
0x08CB2E00
FW Update Status
0x08CB7A00
Web Update
0x08CD6701[so]
RAUC Update Status
0x08CD7300
Simple Windows Basic
0x08CB5200
PIN Destination
0x08CB5400
PIN Status RMS
0x08CB3800
Presentation Mode
0x08CB3B00
Mirroring
0x08CB5A00
Main Freeze
0x08CB5800
Master Mute
0x08CB5900
Mic Mute
0x08CB5600
Master Volume
0x08CB2500
Video Recording
0x08CBE400
BYOD Pin Display
Reply Command
Reply Parameters
Comment
09 CD40 00