Table of contents

1) Introduction 1.1) Establish connection 2) Command structure 2.1) Encoding 2.2) Basic examples 2.3) Header description 2.4) Error codes 2.5) Parameters 2.6) Header and Payload revisited 3) Authentication and permissions 4) Examples 4.1) Fixed header and payload examples 4.2) Dynamic header and payload examples 4.3) Authentication examples 5) Listings 6) Version info 7) Categories 8) Commands

1) 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.

1.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.

1.1.1) WebSocket

TLS secured connection

wss://[ip address]/xxx

Insecure connection

ws://[ip address]/xxx

table
1)
WebSocket endpoints

1.1.2) TCP

TLS secured connection

[ip address]:50917

Insecure connection

[ip address]:50915

table
2)
TCP endpoints

2) 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

2.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

2.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.

2.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

2.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

2.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

Extended Command

Payload length: 2 byte

Extended header

GET=0, SET=1

Bit indexValue description

1 if it is a set command
0 otherwise

1 to enable extended header
0 otherwise

The extended header is only used if the payload has to be encoded with 4 bytes.

1 if the payload length has to be encoded with 2 bytes
0 if you use 1 or 4 bytes for the length

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.

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

Payload length: 4 byte

Bit indexValue description

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

2.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

2.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

2.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 superscript^inf.

When inferring length for dynamic parameters from payload length, preceeding fixed length parameters have to be taken into account.

2.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)

3) 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.

4) Examples

The following section contains various command examples.

4.1) Fixed header and payload examples

These commands always use the same header and payload length encoding as seen in the documentation.

4.1.1) Get Boxname (Cynap)

GET

Boxname

Userlevel: None

08 CB03 00

08 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

Below are examples of requests and their corresponding replies:Request

Documentation valuesExample 1)Example 2)

Header

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

4.1.2) Set Boxname (Cynap)

SET

Boxname

Userlevel: Admin

09 CB03 ab n₀..n_n

n₀..n_n^inf

Name of box

Max. 32 bytes

09 CB03 00

Below are examples of requests and their corresponding replies:Request

Documentation valuesExample 1)Example 2) - No Admin user level

Header

09Header: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

09Header: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

09Header: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

09Header: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

09Header: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

89Header: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

4.2) Dynamic header and payload examples

These commands vary in their header and payload length encoding depending on their payload length.

4.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

08 4117 00

[08] 4117 [ab] p s b₀..b_n

picture format

start indicator 0x00

b₀..b_n^inf

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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

0CHeader: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

0A01Header: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

4.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:

4.3.1) Visualizer authentication

The following command can be used to request a user level for the current connection:

SET

Userlevel: None

[09] 400B [ab] l s₀..s_n

0x00

NONE

0x01

USER

0x02

ADMIN

s₀..s_n^inf

password

Set login level.

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

09Header: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

09Header: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

09Header: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

09Header: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

89Header: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

Userlevel: None

08 400B 00

08 400B 01 l

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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

4.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

Userlevel: None

09 CB42 ab al lp p₀..p_n ln n₀..n_n

Access level

0x01

User

0x02

Admin

0x03

Annotation

0x04

Viewer

Password length

Max. 63 bytes

p₀..p_n

Password

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

n₀..n_n

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

09 CB42 00

Below are examples of requests and their corresponding replies:Request

Documentation valuesCorrect credentialsWrong credentials

Header

09Header: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

09Header: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

09Header: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

09Header: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

09Header: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

89Header: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

Userlevel: None

08 CB55 00

08 CB55 01 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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

08Header: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

5) Listings

Tables:

1) WebSocket endpoints 2) TCP endpoints 3) Request and reply packet structure 4) Packet structure in case of an error 5) Data type encoding 6) Header 7) Extended header 8) Error codes 9) Parameter types 10) Header types 11) Payload types 12) User levels

Examples:

1) Set box name 2) Get box name 3) Get Boxname (Cynap),
fixed header and payload length 4) Set Boxname (Cynap),
fixed header and payload length 5) Get Picture (Visualizer),
dynamic header and payload length 6) Set Login Level (Visualizer),
dynamic header and payload length 7) Get Login Level (Visualizer),
fixed header and payload length 8) Set Login (Cynap),
fixed header and payload length 9) Get Login Level (Cynap),
fixed header and payload length

6) Version info

Firmware Version:
1.86d

Firmware Type:
Visualizer

7) Categories

Basic Status & Control Device Info & Description Image Related Misc System Setting Network Related

8) Commands

Scroll to top

Basic Status & Control (40)

GET

Power

Userlevel: None

08 4100 00

08 4100 01 b

Power status

0x00

Off

0x01

Power status

SET

Power

Userlevel: User

09 4100 01 b

Power status

0x00

Off

0x01

0x02

Toggle

Power status

09 4100 00

GET

Usb Mount

Userlevel: None

08 4103 00

08 4103 01 l

Status of USB memory device

0x00

USB memory device not mounted

0x01

USB memory device mounted

Status of USB memory device

GET

Light

Userlevel: None

08 4104 00

08 4104 01 b

Status of light (On/Off)

0x00

Off

0x01

Status of light (On/Off)

SET

Light

Userlevel: User

09 4104 01 b

Status of light (On/Off)

0x00

Off

0x01

0x02

Toggle

Status of light (On/Off)

09 4104 00

GET

Freeze

Userlevel: None

08 4105 00

08 4105 01 b

Status of image freeze

0x00

Off

0x01

Status of image freeze

SET

Freeze

Userlevel: User

09 4105 01 b

Status of image freeze

0x00

Off

0x01

0x02

Toggle

Status of image freeze

09 4105 00

GET

Source

Userlevel: None

08 4106 00

08 4106 01 l

Select(ed) source

0x00

Live view

0x01

Internal memory

0x02

USB memory device

0x03

HDMI input 1

0x04

HDMI input 2

Select(ed) source

SET

Source

Userlevel: User

09 4106 01 l

Select(ed) source

0x00

Live view

0x01

Internal memory

0x02

USB memory device

0x03

HDMI input 1

0x04

HDMI input 2

Select(ed) source

09 4106 00

GET

Hdmi In 1 5v Status

Userlevel: None

08 4107 00

08 4107 01 b

5V present at HDMI input 1

0x00

Off

0x01

5V present at HDMI input 1

GET

Hdmi In 2 5v Status

Userlevel: None

08 4108 00

08 4108 01 b

5V present at HDMI input 2

0x00

Off

0x01

5V present at HDMI input 2

SET

Recording Start

Userlevel: User

09 4109 00

Start recording

09 4109 00

SET

Recording Pause

Userlevel: User

09 410A 00

Pause recording

09 410A 00

SET

Recording Stop

Userlevel: User

09 410B 00

Stop recording

09 410B 00

SET

Recall Preset A3

Userlevel: User

09 410C 00

Recall preset for A3 paper size on working surface

09 410C 00

SET

Recall Preset A4

Userlevel: User

09 410D 00

Recall preset for A4 paper size on working surface

09 410D 00

SET

Recall Preset A5

Userlevel: User

09 410E 00

Recall preset for A5 paper size on working surface

09 410E 00

GET

Sidebyside

Userlevel: User

08 410F 00

08 410F 01 b

In live view a snapshot and live view is shown.
Otherwise the current source and live view is shown.

0x00

Off

0x01

Start side by side view on HDMI output
In live view a snapshot and live view is shown.
Otherwise the current source and live view is shown.

SET

Sidebyside

Userlevel: User

09 410F 01 b

In live view a snapshot and live view is shown.
Otherwise the current source and live view is shown.

0x00

Off

0x01

0x02

Toggle

Start side by side view on HDMI output
In live view a snapshot and live view is shown.
Otherwise the current source and live view is shown.

09 410F 00

SET

Recall Preset

Userlevel: User

09 4111 01 t

Recall preset - index starts with zero

09 4111 00

SET

Store Preset

Userlevel: User

09 4112 01 t

3 presets are supported, therefore the index
has to be 0x00, 0x01 or 0x02

Store the current status in a preset.
3 presets are supported, therefore the index
has to be 0x00, 0x01 or 0x02

09 4112 00

GET

Stream Status Active

Userlevel: None

08 4113 00

08 4113 01 b

Device is streaming

0x00

Off

0x01

Device is streaming

GET

Stream Status Clients

Userlevel: None

08 4114 00

08 4114 04 i₀..i₃

i₀..i₃

Number of clients receiving the stream

GET

Record Status State

Userlevel: None

08 4115 00

08 4115 01 l

Recording status

0x00

Idle

0x01

Recording

0x02

Recording paused

0x03

Syncing

Recording status

GET

Record Status Duration

Userlevel: None

08 4116 00

08 4116 04 i₀..i₃

i₀..i₃

Duration of recording in ms

GET

Get Picture

Userlevel: User

08 4117 01 p

Picture format

0x01

JPEG encoded 1080p

[08] 4117 [ab] p s b₀..b_n

Picture format

0x01

JPEG encoded 1080p

Start indicator 0x00

b₀..b_n^inf

Picture data

SET

Recall Preset Power On

Userlevel: User

09 4118 00

Recall power-on preset

09 4118 00

SET

Recall Preset Default

Userlevel: User

09 4119 00

Recall default preset

09 4119 00

SET

Snapshot

Userlevel: User

09 4120 00

Take a snapshot

09 4120 00

SET

Store Preset Power On

Userlevel: User

09 4121 00

Store current settings in power-on preset

09 4121 00

SET

Image Viewer Prev

Userlevel: User

09 4123 00

Select previous image

09 4123 00

SET

Image Viewer Next

Userlevel: User

09 4124 00

Select next image

09 4124 00

SET

Image Viewer First

Userlevel: User

09 4125 00

Select first image

09 4125 00

SET

Image Viewer Last

Userlevel: User

09 4126 00

Select last image

09 4126 00

SET

Image Viewer Select

Userlevel: User

09 4127 00

Show selected image

09 4127 00

GET

Light Level

Userlevel: None

08 412A 00

08 412A 01 l

Light level

0x00

Level Low

0x01

Level Medium

0x02

Level High

Light level

SET

Light Level

Userlevel: User

09 412A 01 l

Light level

0x00

Level Low

0x01

Level Medium

0x02

Level High

Light level

09 412A 00

SET

System Reboot

Userlevel: Admin

09 412B 00

GET

Display Backlight

Userlevel: None

08 412C 00

08 412C 04 i₀..i₃

i₀..i₃

Display backlight level from 0 to 255

SET

Display Backlight

Userlevel: User

09 412C 04 i₀..i₃

i₀..i₃

Display backlight level from 0 to 255

09 412C 00

Device Info & Description (27)

GET

Displayname

Userlevel: None

08 4001 00

[08] 4001 [ab] s₀..s_n

s₀..s_n^inf

Display name of the device (e.g. "VZ-8.UHD")

GET

Adj Serialnumber

Userlevel: None

08 4002 00

08 4002 04 i₀..i₃

i₀..i₃

Serial number of the device.

GET

Version

Userlevel: None

08 4003 00

[08] 4003 [ab] s₀..s_n

s₀..s_n^inf

Firmware version (e.g. "V1.00a")

GET

Buildnumber

Userlevel: None

08 4004 00

[08] 4004 [ab] s₀..s_n

s₀..s_n^inf

Build number of firmware (e.g. "20200101120000")

GET

Hostname

Userlevel: None

08 4005 00

[08] 4005 [ab] s₀..s_n

s₀..s_n^inf

Hostname of the device

SET

Hostname

Userlevel: Admin

[09] 4005 [ab] s₀..s_n

s₀..s_n^inf

Hostname of the device

09 4005 00

GET

Device Description

Userlevel: None

08 4006 00

[08] 4006 [ab] s₀..s_n

s₀..s_n^inf

Description of the device

SET

Device Description

Userlevel: Admin

[09] 4006 [ab] s₀..s_n

s₀..s_n^inf

Description of the device

09 4006 00

SET

Update Start

Userlevel: None

09 4008 00

Initiate a system update.
File size as 4 byte integer value

09 4008 00

SET

Update Data

Userlevel: None

09 4009 00

Upload update file data.
Data chunks of update file with chunk size < 1MiB

09 4009 00

SET

Update End

Userlevel: None

09 400A 00

GET

Userlevel: None

08 400B 00

08 400B 01 l

0x00

None

0x01

User

0x02

Admin

Get current login level.

SET

Userlevel: None

[09] 400B [ab] l s₀..s_n

0x00

None

0x01

User

0x02

Admin

s₀..s_n^inf

Password

Set login level.

09 400B 00

GET

Usb Update Available

Userlevel: None

08 400D 00

08 400D 01 b

Check if an update is available on connected USB memory device

0x00

Off

0x01

Check if an update is available on connected USB memory device

SET

Usb Update Start

Userlevel: Admin

09 400E 00

Start system update from USB memory device

09 400E 00

GET

Http Update State

Userlevel: None

08 400F 00

08 400F 01 l

State of internet system update

0x00

Idle

0x01

Failed

0x02

Not connected to server

0x03

Checking if a system update is available

0x04

Installed version is up to date

0x05

Installed version is out of date

0x06

Downloading system update from server

0x07

Updating

State of internet system update

GET

Http Update Version

Userlevel: None

08 4010 00

[08] 4010 [ab] s₀..s_n

s₀..s_n^inf

Version of update file on server

GET

Http Update Progress

Userlevel: None

08 4011 00

08 4011 04 i₀..i₃

i₀..i₃

Internet system update progress in percent

SET

Http Update Check

Userlevel: Admin

09 4012 00

Check if a system update is available on server

09 4012 00

SET

Http Update Start

Userlevel: Admin

09 4013 00

Start internet system update

09 4013 00

SET

Http Update Cancel

Userlevel: Admin

09 4014 00

Cancel internet system update

09 4014 00

GET

Adj Model

Userlevel: None

08 4016 00

08 4016 01 l

Model code of device

0x00

VZ-8.UHD

0x01

VZ-3neo.UHD

0x02

VZ-8neo.UHD

0x03

Reserved

0x04

VZ-2.UHD

0x05

VZ-CVB

Model code of device

SET

Factory Reset

Userlevel: Admin

09 4017 00

Delete all settings, presets and images

09 4017 00

SET

Settings Reset

Userlevel: Admin

09 4018 00

Reset all device settings to default

09 4018 00

GET

System Update Stage

Userlevel: None

08 401D 00

08 401D 01 l

Stage of system update

0x00

Idle

0x01

Uploading

0x02

Programming

0x03

Finished

0x04

Failed

0x05

Rebooting after udpate

Stage of system update

GET

System Update Progress

Userlevel: None

08 401E 00

08 401E 04 i₀..i₃

i₀..i₃

System update progress in percent

GET

Features

Userlevel: None

08 4021 00

08 4021 08 a₀..a₇

a₀..a₇

8 bytes containing supported features.

Get supported features.
For each feature, the corresponding bit will be set.
Feature bits as follows, from MSB to LSB:
byte 0: ZOOM, BRIGHTNESS, MIRROR, FOCUS, AUTOFOCUS, POWER, LIGHT, EXT1
byte 1: TEXT, WHITEBALANCE, RESET, IMAGE, IMAGE_TURN, FREEZE, ARM, MACRO
byte 2: PRESET_1, PRESET_2, PRESET_3, PRESET_4, PRESET_5, PRESET_6, PRESET_7, PRESET_8
byte 3: CAP_SHIFT, MEMORY_1, MEMORY_2, MEMORY_3, MEMORY_4, MEMORY_5, MEMORY_6, MEMORY_7
byte 4: MEMORY_8, MEMORY_9, SHOW_ALL, MENU, OPAF, SNAPSHOT, POS_NEG, POS_BLUE
byte 5: FW, reserved, reserved, STR_TOGGLE, HELP, not used, not used, not used
byte 6: PIP, VZ, MEM, USB, BLACK_WHITE, VERGENCE, MIRROR_CENTER, THREE_D
byte 7: MEM_USB_NAV, EXT2, STR, VIDEO_PB, OPAF_9, RECORDING, not used, not used

Image Related (36)

GET

Brightness

Userlevel: None

08 4200 00

08 4200 04 i₀..i₃

i₀..i₃

Brightness from -10 to +10

SET

Brightness

Userlevel: User

09 4200 04 i₀..i₃

i₀..i₃

Brightness from -10 to +10

09 4200 00

GET

Shutter Mode

Userlevel: None

08 4201 00

08 4201 01 l

Mode for shutter

0x00

Automatic

0x01

Manual

Mode for shutter

SET

Shutter Mode

Userlevel: User

09 4201 01 l

Mode for shutter

0x00

Automatic

0x01

Manual

Mode for shutter

09 4201 00

GET

Shutter Step

Userlevel: None

08 4202 00

08 4202 01 l

Shutter step

0x00

1/60s

0x01

1/100s

0x02

1/120s

0x03

1/250s

0x04

1/500s

0x05

1/1000s

0x06

1/2000s

0x07

1/3000s

Shutter step

SET

Shutter Step

Userlevel: User

09 4202 01 l

Shutter step

0x00

1/60s

0x01

1/100s

0x02

1/120s

0x03

1/250s

0x04

1/500s

0x05

1/1000s

0x06

1/2000s

0x07

1/3000s

Shutter step

09 4202 00

GET

Whitebalance Mode

Userlevel: None

08 4203 00

08 4203 01 l

White balance mode

0x00

Automatic

0x01

Manual

White balance mode

SET

Whitebalance Mode

Userlevel: User

09 4203 01 l

White balance mode

0x00

Automatic

0x01

Manual

White balance mode

09 4203 00

GET

Whitebalance Red

Userlevel: None

08 4204 00

08 4204 04 i₀..i₃

i₀..i₃

Whitebalance value for red from -100 to +100

SET

Whitebalance Red

Userlevel: User

09 4204 04 i₀..i₃

i₀..i₃

Whitebalance value for red from -100 to +100

09 4204 00

GET

Whitebalance Blue

Userlevel: None

08 4205 00

08 4205 04 i₀..i₃

i₀..i₃

Whitebalance value for blue from -100 to +100

SET

Whitebalance Blue

Userlevel: User

09 4205 04 i₀..i₃

i₀..i₃

Whitebalance value for blue from -100 to +100

09 4205 00

GET

Color Mode

Userlevel: None

08 4206 00

08 4206 01 l

Color mode

0x00

sRGB

0x01

Presentation

0x02

DLP

0x03

Webconference

0x04

Black & White

0x05

Manual

Color mode

SET

Color Mode

Userlevel: User

09 4206 01 l

Color mode

0x00

sRGB

0x01

Presentation

0x02

DLP

0x03

Webconference

0x04

Black & White

0x05

Manual

Color mode

09 4206 00

GET

Gamma Mode

Userlevel: None

08 4207 00

08 4207 01 l

Gamma mode

0x00

Gamma value 1.55

0x01

Gamma value 1.80

0x02

Gamma value 2.05

0x03

Gamma value 2.20

Gamma mode

SET

Gamma Mode

Userlevel: User

09 4207 01 l

Gamma mode

0x00

Gamma value 1.55

0x01

Gamma value 1.80

0x02

Gamma value 2.05

0x03

Gamma value 2.20

Gamma mode

09 4207 00

GET

Saturation

Userlevel: None

08 4208 00

08 4208 04 i₀..i₃

i₀..i₃

Saturation value from 0 to 150

SET

Saturation

Userlevel: User

09 4208 04 i₀..i₃

i₀..i₃

Saturation value from 0 to 150

09 4208 00

GET

Detail Mode

Userlevel: None

08 4209 00

08 4209 01 l

Detail mode

0x00

Off

0x01

Low

0x02

Medium

0x03

High

0x04

Max

Detail mode

SET

Detail Mode

Userlevel: User

09 4209 01 l

Detail mode

0x00

Off

0x01

Low

0x02

Medium

0x03

High

0x04

Max

Detail mode

09 4209 00

GET

Digital Zoom

Userlevel: None

08 420A 00

08 420A 01 b

Digital zoom (On/Off)

0x00

Off

0x01

Digital zoom (On/Off)

SET

Digital Zoom

Userlevel: Admin

09 420A 01 b

Digital zoom (On/Off)

0x00

Off

0x01

0x02

Toggle

Digital zoom (On/Off)

09 420A 00

GET

Noise Reduction

Userlevel: None

08 420B 00

08 420B 01 l

Noise reduction

0x00

Off

0x01

Low

0x02

Medium

0x03

High

Noise reduction

SET

Noise Reduction

Userlevel: User

09 420B 01 l

Noise reduction

0x00

Off

0x01

Low

0x02

Medium

0x03

High

Noise reduction

09 420B 00

GET

Autofocus

Userlevel: None

08 420C 00

08 420C 01 b

Permanent autofocus

0x00

Off

0x01

Permanent autofocus

SET

Autofocus

Userlevel: User

09 420C 01 b

Permanent autofocus

0x00

Off

0x01

0x02

Toggle

Permanent autofocus

09 420C 00

SET

Onepush Autofocus

Userlevel: User

09 420D 01 t

The live image is divided into 9 focus fields:
1 2 3
4 5 6
7 8 9
The index can either be 0 (to focus on the whole image) or 1 - 9 to focus on one of the fields.
When One-Push-Autofocus is triggered, permanent AF is turned off.

Trigger the One-Push-Autofocus
The live image is divided into 9 focus fields:
1 2 3
4 5 6
7 8 9
The index can either be 0 (to focus on the whole image) or 1 - 9 to focus on one of the fields.
When One-Push-Autofocus is triggered, permanent AF is turned off.

09 420D 00

SET

Onepush Whitebalance

Userlevel: User

09 420E 00

Trigger the One-Push-Whitebalance
Select the optimal whitebalance based on the current image.

09 420E 00

GET

Zoom

Userlevel: None

08 420F 00

08 420F 02 p₀..p₁

p₀..p₁

Position in range 0x0000 to 0x0FFF

Get zoom position

SET

Zoom

Userlevel: User

09 420F 01 z

Zoom direction

0x11

Start wide

0x12

Start tele

Start zoom

09 420F 00

09 420F 02 p₀..p₁

p₀..p₁

Position in range 0x0000 to 0x0FFF

Set zoom position with maximum speed

09 420F 00

09 420F 03 z s₀..s₁

Zoom direction

0x01

Wide

0x02

Tele

s₀..s₁

Speed in range 0x0000 to 0x000F

Start zoom with given speed

09 420F 00

GET

Focus

Userlevel: None

08 4210 00

08 4210 02 p₀..p₁

p₀..p₁

Position in range 0x0000 to 0x0FFF

Get focus position

SET

Focus

Userlevel: User

09 4210 01 d

Direction

0x11

Start far

0x12

Start near

Start focus

09 4210 00

09 4210 02 p₀..p₁

p₀..p₁

Position in range 0x0000 to 0x0FFF

Set focus position with maximum speed

09 4210 00

09 4210 03 d s₀..s₁

Direction

0x01

Far

0x02

Near

s₀..s₁

Speed in range 0x0000 to 0x000F

Start focus with given speed

09 4210 00

GET

Backlightcomp Mode

Userlevel: None

08 4211 00

08 4211 01 l

Backlight compensation

0x00

Off

0x01

Auto

Backlight compensation

SET

Backlightcomp Mode

Userlevel: User

09 4211 01 l

Backlight compensation

0x00

Off

0x01

Auto

Backlight compensation

09 4211 00

GET

Contrast

Userlevel: None

08 4212 00

08 4212 04 i₀..i₃

i₀..i₃

Contrast from -100 to +100

SET

Contrast

Userlevel: User

09 4212 04 i₀..i₃

i₀..i₃

Contrast from -100 to +100

09 4212 00

Misc System Setting (74)

GET

Resolution

Userlevel: None

08 4400 00

08 4400 01 l

Configured resolution of HDMI output

0x00

Automatically select resolution

0x01

4k@60Hz (4:4:4)

0x02

4k@60Hz (4:2:0)

0x03

4k@30Hz (4:4:4)

0x04

1080p@60Hz (4:4:4)

0x05

720p@60Hz (4:4:4)

Configured resolution of HDMI output

SET

Resolution

Userlevel: Admin

09 4400 01 l

Configured resolution of HDMI output

0x00

Automatically select resolution

0x01

4k@60Hz (4:4:4)

0x02

4k@60Hz (4:2:0)

0x03

4k@30Hz (4:4:4)

0x04

1080p@60Hz (4:4:4)

0x05

720p@60Hz (4:4:4)

Configured resolution of HDMI output

09 4400 00

GET

Current Resolution

Userlevel: None

08 4401 00

08 4401 01 l

Actual resolution of HDMI output

0x00

Automatically select resolution

0x01

4k@60Hz (4:4:4)

0x02

4k@60Hz (4:2:0)

0x03

4k@30Hz (4:4:4)

0x04

1080p@60Hz (4:4:4)

0x05

720p@60Hz (4:4:4)

Actual resolution of HDMI output

GET

Hdcp

Userlevel: None

08 4402 00

08 4402 01 b

HDCP protection of HDMI in- and output

0x00

Off

0x01

HDCP protection of HDMI in- and output

SET

Hdcp

Userlevel: Admin

09 4402 01 b

HDCP protection of HDMI in- and output

0x00

Off

0x01

0x02

Toggle

HDCP protection of HDMI in- and output

09 4402 00

GET

Admin Password

Userlevel: Admin

08 4406 00

[08] 4406 [ab] s₀..s_n

s₀..s_n^inf

Password for login level admin

SET

Admin Password

Userlevel: Admin

[09] 4406 [ab] s₀..s_n

s₀..s_n^inf

Password for login level admin

09 4406 00

GET

Autoerase Mem

Userlevel: None

08 4407 00

08 4407 01 b

Automatically clear all images at power down and up

0x00

Off

0x01

Automatically clear all images at power down and up

SET

Autoerase Mem

Userlevel: Admin

09 4407 01 b

Automatically clear all images at power down and up

0x00

Off

0x01

0x02

Toggle

Automatically clear all images at power down and up

09 4407 00

GET

Stream Service

Userlevel: None

08 4408 00

08 4408 01 b

Network stream (On/Off)

0x00

Off

0x01

Network stream (On/Off)

SET

Stream Service

Userlevel: Admin

09 4408 01 b

Network stream (On/Off)

0x00

Off

0x01

0x02

Toggle

Network stream (On/Off)

09 4408 00

GET

Stream Format

Userlevel: None

08 4409 00

08 4409 01 l

Network stream format

0x00

JPEG

0x01

H.264

Network stream format

SET

Stream Format

Userlevel: Admin

09 4409 01 l

Network stream format

0x00

JPEG

0x01

H.264

Network stream format

09 4409 00

GET

Stream Resolution

Userlevel: None

08 440A 00

08 440A 01 l

Resolution of network stream

0x00

1080p

0x01

Resolution of network stream

SET

Stream Resolution

Userlevel: Admin

09 440A 01 l

Resolution of network stream

0x00

1080p

0x01

Resolution of network stream

09 440A 00

GET

Record Service

Userlevel: None

08 440B 00

08 440B 01 b

Recording feature (On/Off)

0x00

Off

0x01

Recording feature (On/Off)

SET

Record Service

Userlevel: Admin

09 440B 01 b

Recording feature (On/Off)

0x00

Off

0x01

0x02

Toggle

Recording feature (On/Off)

09 440B 00

GET

Power On Preset

Userlevel: None

08 440C 00

08 440C 01 b

Preset loaded at power on

0x00

Default

0x01

Custom

Preset loaded at power on

SET

Power On Preset

Userlevel: Admin

09 440C 01 b

Preset loaded at power on

0x00

Default

0x01

Custom

Preset loaded at power on

09 440C 00

GET

Mains On Action

Userlevel: None

08 440D 00

08 440D 01 l

Action after device is connected to mains supply

0x00

Switch power on

0x01

Standby mode

Action after device is connected to mains supply

SET

Mains On Action

Userlevel: Admin

09 440D 01 l

Action after device is connected to mains supply

0x00

Switch power on

0x01

Standby mode

Action after device is connected to mains supply

09 440D 00

GET

Auto Power Off

Userlevel: None

08 440E 00

08 440E 01 l

Power down after inactivity

0x00

Off

0x01

Power off after 30min inactivity

0x02

Power off after 60min inactivity

0x03

Power off after 120min inactivity

0x04

Power off after 180min inactivity

0x05

Power off after 240min inactivity

Power down after inactivity

SET

Auto Power Off

Userlevel: Admin

09 440E 01 l

Power down after inactivity

0x00

Off

0x01

Power off after 30min inactivity

0x02

Power off after 60min inactivity

0x03

Power off after 120min inactivity

0x04

Power off after 180min inactivity

0x05

Power off after 240min inactivity

Power down after inactivity

09 440E 00

GET

Arm Standby Control

Userlevel: None

08 440F 00

08 440F 01 b

Power up/down controlled by arm

0x00

Off

0x01

Power up/down controlled by arm

SET

Arm Standby Control

Userlevel: Admin

09 440F 01 b

Power up/down controlled by arm

0x00

Off

0x01

Power up/down controlled by arm

09 440F 00

GET

Standby Mode

Userlevel: None

08 4410 00

08 4410 01 l

Standby mode

0x00

Standby

0x01

Deep standby but Wake-On-LAN is enabled

0x02

Deep standby

0x03

Standby but HDMI inputs are passed to output

Standby mode

SET

Standby Mode

Userlevel: Admin

09 4410 01 l

Standby mode

0x00

Standby

0x01

Deep standby but Wake-On-LAN is enabled

0x02

Deep standby

0x03

Standby but HDMI inputs are passed to output

Standby mode

09 4410 00

GET

Ntp Enable

Userlevel: None

08 4411 00

08 4411 01 b

Sync time via Network Time Protocol

0x00

Off

0x01

Sync time via Network Time Protocol

SET

Ntp Enable

Userlevel: Admin

09 4411 01 b

Sync time via Network Time Protocol

0x00

Off

0x01

0x02

Toggle

Sync time via Network Time Protocol

09 4411 00

GET

Ntp Url

Userlevel: None

08 4412 00

[08] 4412 [ab] s₀..s_n

s₀..s_n^inf

URL of NTP server

SET

Ntp Url

Userlevel: Admin

[09] 4412 [ab] s₀..s_n

s₀..s_n^inf

URL of NTP server

09 4412 00

GET

Ir Code

Userlevel: None

08 4413 00

08 4413 01 l

IR code of remote

0x00

IR code 1

0x01

IR code 2

0x02

IR code 3

0x03

IR code 4

0x04

IR code 5

0x05

IR code 6

0x06

IR code 7

0x07

IR code 8

0x08

IR code 9

IR code of remote

SET

Ir Code

Userlevel: Admin

09 4413 01 l

IR code of remote

0x00

IR code 1

0x01

IR code 2

0x02

IR code 3

0x03

IR code 4

0x04

IR code 5

0x05

IR code 6

0x06

IR code 7

0x07

IR code 8

0x08

IR code 9

IR code of remote

09 4413 00

GET

Time

Userlevel: None

08 4414 00

[08] 4414 [ab] s₀..s_n

s₀..s_n^inf

ASCII encoded byte array: "HH:MM:SS"

Get current time

SET

Time

Userlevel: Admin

[09] 4414 [ab] s₀..s_n

s₀..s_n^inf

ASCII encoded byte array: "HH:MM:SS"

Set current time

09 4414 00

GET

Date

Userlevel: None

08 4415 00

[08] 4415 [ab] s₀..s_n

s₀..s_n^inf

ASCII encoded byte array: "YYYY-MM-DD"

Get current date

SET

Date

Userlevel: Admin

[09] 4415 [ab] s₀..s_n

s₀..s_n^inf

ASCII encoded byte array: "YYYY-MM-DD"

Set current date

09 4415 00

GET

Stream Transport

Userlevel: None

08 4416 00

08 4416 01 l

Network stream transport mode

0x00

Unicast

0x01

Multicast

Network stream transport mode

SET

Stream Transport

Userlevel: Admin

09 4416 01 l

Network stream transport mode

0x00

Unicast

0x01

Multicast

Network stream transport mode

09 4416 00

GET

Stream Multicast Ip

Userlevel: None

08 4417 00

08 4417 04 ip₀..ip₃

ip₀..ip₃

Destination IP of multicast stream

SET

Stream Multicast Ip

Userlevel: Admin

09 4417 04 ip₀..ip₃

ip₀..ip₃

Destination IP of multicast stream

09 4417 00

GET

Stream Multicast Port

Userlevel: None

08 4418 00

08 4418 04 i₀..i₃

i₀..i₃

Base port number for transport of multicast stream

SET

Stream Multicast Port

Userlevel: Admin

09 4418 04 i₀..i₃

i₀..i₃

Base port number for transport of multicast stream

09 4418 00

GET

Stream Multicast Ttl

Userlevel: None

08 4419 00

08 4419 04 i₀..i₃

i₀..i₃

TTL of multicast stream

SET

Stream Multicast Ttl

Userlevel: Admin

09 4419 04 i₀..i₃

i₀..i₃

TTL of multicast stream

09 4419 00

GET

Security Mode Status

Userlevel: None

08 441A 00

08 441A 01 b

Actual security mode status

0x00

Off

0x01

Actual security mode status

GET

Privacy Mode

Userlevel: None

08 4433 00

08 4433 01 b

In privacy mode, streaming (including GET_PICTURE) is disabled.

0x00

Off

0x01

Privacy mode.
In privacy mode, streaming (including GET_PICTURE) is disabled.

SET

Security Mode Apply

Userlevel: Admin

09 4434 00

Apply configured security mode (triggers reboot)

09 4434 00

GET

Security Mode

Userlevel: Admin

08 4435 00

08 4435 01 b

In security mode, all means of storing an image are disabled. USB
(memory device, UVC) is turned off, and the image cannot be frozen.
Storing, recording and streaming are disabled (including GET_PICTURE).

0x00

Off

0x01

Security mode. Changing this setting triggers a reboot.
In security mode, all means of storing an image are disabled. USB
(memory device, UVC) is turned off, and the image cannot be frozen.
Storing, recording and streaming are disabled (including GET_PICTURE).

SET

Security Mode

Userlevel: Admin

09 4435 01 b

0x00

Off

0x01

0x02

Toggle

09 4435 00

GET

Mgmt Subscribe Mode

Userlevel: None

08 4437 00

08 4437 01 l

Management subscribe mode

0x00

Off

0x01

DHCP

0x02

Static

Management subscribe mode

SET

Mgmt Subscribe Mode

Userlevel: Admin

09 4437 01 l

Management subscribe mode

0x00

Off

0x01

DHCP

0x02

Static

Management subscribe mode

09 4437 00

GET

Mgmt Subscribe Address

Userlevel: None

08 4438 00

[08] 4438 [ab] s₀..s_n

s₀..s_n^inf

Server address for static management subscribe mode

SET

Mgmt Subscribe Address

Userlevel: Admin

[09] 4438 [ab] s₀..s_n

s₀..s_n^inf

Server address for static management subscribe mode

09 4438 00

GET

Mgmt Subscribe Status

Userlevel: None

08 4439 00

GET

Mgmt Subscribe Act Addr

Userlevel: None

08 443A 00

GET

Mic Mute

Userlevel: None

08 443D 00

08 443D 01 b

Status of microphone mute

0x00

Off

0x01

Status of microphone mute

SET

Mic Mute

Userlevel: User

09 443D 01 b

Status of microphone mute

0x00

Off

0x01

0x02

Toggle

Status of microphone mute

09 443D 00

GET

Usb Mic Enable

Userlevel: None

08 443E 00

08 443E 01 b

Enable support for USB microphone

0x00

Off

0x01

Enable support for USB microphone

SET

Usb Mic Enable

Userlevel: Admin

09 443E 01 b

Enable support for USB microphone

0x00

Off

0x01

0x02

Toggle

Enable support for USB microphone

09 443E 00

GET

Usb Mic Volume

Userlevel: None

08 443F 00

08 443F 04 i₀..i₃

i₀..i₃

Volume of USB microphone in percent (0..100)

SET

Usb Mic Volume

Userlevel: Admin

09 443F 04 i₀..i₃

i₀..i₃

Volume of USB microphone in percent (0..100)

09 443F 00

GET

Master Mute

Userlevel: None

08 4444 00

08 4444 01 b

Status of master volume mute

0x00

Off

0x01

Status of master volume mute

SET

Master Mute

Userlevel: User

09 4444 01 b

Status of master volume mute

0x00

Off

0x01

0x02

Toggle

Status of master volume mute

09 4444 00

GET

Master Volume

Userlevel: None

08 4445 00

08 4445 04 i₀..i₃

i₀..i₃

Master volume in percent (0..100)

SET

Master Volume

Userlevel: User

09 4445 04 i₀..i₃

i₀..i₃

Master volume in percent (0..100)

09 4445 00

GET

Hdmi In Volume

Userlevel: None

08 4447 00

08 4447 04 i₀..i₃

i₀..i₃

Volume of HDMI In audio in percent (0..100)

SET

Hdmi In Volume

Userlevel: Admin

09 4447 04 i₀..i₃

i₀..i₃

Volume of HDMI In audio in percent (0..100)

09 4447 00

GET

Hdmi Out Audio Enable

Userlevel: None

08 4448 00

08 4448 01 b

Enable support for HDMI Out audio

0x00

Off

0x01

Enable support for HDMI Out audio

SET

Hdmi Out Audio Enable

Userlevel: Admin

09 4448 01 b

Enable support for HDMI Out audio

0x00

Off

0x01

0x02

Toggle

Enable support for HDMI Out audio

09 4448 00

GET

Dehaze Mode

Userlevel: None

08 4451 00

08 4451 01 l

Dehaze mode

0x00

Off

0x01

Medium

0x02

High

Dehaze mode

SET

Dehaze Mode

Userlevel: User

09 4451 01 l

Dehaze mode

0x00

Off

0x01

Medium

0x02

High

Dehaze mode

09 4451 00

GET

Enforce Https

Userlevel: None

08 4453 00

08 4453 01 b

0x00

Off

0x01

SET

Enforce Https

Userlevel: Admin

09 4453 01 b

0x00

Off

0x01

0x02

Toggle

09 4453 00

Network Related (27)

GET

Lan0 Dhcp

Userlevel: None

08 4300 00

08 4300 01 b

(On/Off)

0x00

Off

0x01

Configured DHCP client on network interface 0
(On/Off)

SET

Lan0 Dhcp

Userlevel: Admin

09 4300 01 b

(On/Off)

0x00

Off

0x01

0x02

Toggle

Configured DHCP client on network interface 0
(On/Off)

09 4300 00

GET

Lan0 Ip

Userlevel: None

08 4301 00

08 4301 04 ip₀..ip₃

ip₀..ip₃

Configured IP address of network interface 0

SET

Lan0 Ip

Userlevel: Admin

09 4301 04 ip₀..ip₃

ip₀..ip₃

Configured IP address of network interface 0

09 4301 00

GET

Lan0 Netmask

Userlevel: None

08 4302 00

08 4302 04 ip₀..ip₃

ip₀..ip₃

Configured subnet mask of network interface 0

SET

Lan0 Netmask

Userlevel: Admin

09 4302 04 ip₀..ip₃

ip₀..ip₃

Configured subnet mask of network interface 0

09 4302 00

GET

Lan0 Gateway

Userlevel: None

08 4303 00

08 4303 04 ip₀..ip₃

ip₀..ip₃

Configured gateway of network interface 0

SET

Lan0 Gateway

Userlevel: Admin

09 4303 04 ip₀..ip₃

ip₀..ip₃

Configured gateway of network interface 0

09 4303 00

GET

Lan0 Nameserver1

Userlevel: None

08 4304 00

08 4304 04 ip₀..ip₃

ip₀..ip₃

Configured first DNS server of network interface 0

SET

Lan0 Nameserver1

Userlevel: Admin

09 4304 04 ip₀..ip₃

ip₀..ip₃

Configured first DNS server of network interface 0

09 4304 00

GET

Lan0 Nameserver2

Userlevel: None

08 4305 00

08 4305 04 ip₀..ip₃

ip₀..ip₃

Configured second DNS server of network interface 0

SET

Lan0 Nameserver2

Userlevel: Admin

09 4305 04 ip₀..ip₃

ip₀..ip₃

Configured second DNS server of network interface 0

09 4305 00

GET

Lan0 Status Dhcp

Userlevel: None

08 4306 00

08 4306 01 b

(On/Off)

0x00

Off

0x01

Actual DHCP client status on network interface 0
(On/Off)

SET

Lan0 Status Dhcp

Userlevel: Admin

09 4306 01 b

(On/Off)

0x00

Off

0x01

0x02

Toggle

Actual DHCP client status on network interface 0
(On/Off)

09 4306 00

GET

Lan0 Status Ip

Userlevel: None

08 4307 00

08 4307 04 ip₀..ip₃

ip₀..ip₃

Actual IP address of network interface 0

SET

Lan0 Status Ip

Userlevel: Admin

09 4307 04 ip₀..ip₃

ip₀..ip₃

Actual IP address of network interface 0

09 4307 00

GET

Lan0 Status Netmask

Userlevel: None

08 4308 00

08 4308 04 ip₀..ip₃

ip₀..ip₃

Actual subnet mask of network interface 0

SET

Lan0 Status Netmask

Userlevel: Admin

09 4308 04 ip₀..ip₃

ip₀..ip₃

Actual subnet mask of network interface 0

09 4308 00

GET

Lan0 Status Gateway

Userlevel: None

08 4309 00

08 4309 04 ip₀..ip₃

ip₀..ip₃

Actual gateway of network interface 0

SET

Lan0 Status Gateway

Userlevel: Admin

09 4309 04 ip₀..ip₃

ip₀..ip₃

Actual gateway of network interface 0

09 4309 00

GET

Lan0 Status Nameserver1

Userlevel: None

08 430A 00

08 430A 04 ip₀..ip₃

ip₀..ip₃

Actual first DNS server of network interface 0

SET

Lan0 Status Nameserver1

Userlevel: Admin

09 430A 04 ip₀..ip₃

ip₀..ip₃

Actual first DNS server of network interface 0

09 430A 00

GET

Lan0 Status Nameserver2

Userlevel: None

08 430B 00

08 430B 04 ip₀..ip₃

ip₀..ip₃

Actual first DNS server of network interface 0

SET

Lan0 Status Nameserver2

Userlevel: Admin

09 430B 04 ip₀..ip₃

ip₀..ip₃

Actual first DNS server of network interface 0

09 430B 00

GET

Lan0 Status Mac

Userlevel: None

08 430C 00

[08] 430C [ab] s₀..s_n

s₀..s_n^inf

"00:00:00:00:00:00")

MAC address of network interface 0 (ASCII encoded:
"00:00:00:00:00:00")

SET

Lan0 Status Mac

Userlevel: Admin

[09] 430C [ab] s₀..s_n

s₀..s_n^inf

"00:00:00:00:00:00")

MAC address of network interface 0 (ASCII encoded:
"00:00:00:00:00:00")

09 430C 00

SET

Lan0 Apply Set

Userlevel: Admin

09 430D 01 t

Immediately apply settings to network interface 0

09 430D 00

Firmware Version: 1.86d

Firmware Type: Visualizer

Firmware Version:
1.86d

Firmware Type:
Visualizer