RCP Plus

Reference

(RCP Version 3)

Specification

Firmware versionmajor4
minor15
build1





Copyright

This manual is the intellectual property of VCS and is protected by copyright. All rights are reserved. No part of this document may be reproduced or transmitted for any purpose, by whatever means, be they electronic or mechanical, without the express written permission of VCS.

© Copyright 2001-2006 VCS Video Communication Systems AG

 

 

 

Note

This manual was compiled with the greatest of care and all information double checked. At the time of printing the description was complete and correct. Because of the further development of products, the content of the manual might change without prior notice. VCS will not be liable for damage which is directly or indirectly due to errors, incompleteness, or discrepancies between the manual and the product described.

 

 

 

Trade marks

All names used in this manual for hardware and software are very probably registered trade marks and must be treated as such.

 

 

Table Of Contents



FUNCTIONAL_DESCRIPTION
CONNECTION
SYSTEM
IDENTIFICATION
BROWSER
LANGUAGE
TIME
CONNECTION
STATUS
USER_TASK
DEBUG
AUX
ENCODER
VIDEO
AUDIO
ALARM
DIGITAL_IO
SERIAL
NETWORK
ISCSI
STORAGE
RECORDING
REPLAY
FAT32
SPAN
STORAGE_REPORT
STORAGE_REPORT_SECONDARY
STORAGE_MEDIUM_TYPE
STORAGE_MEDIUM_AVAIL
STORAGE_LIST
STORAGE_IO
APPENDIX
Transport Protocol
The transport protocol for this remote control must be TCP. All VideoJets will establish a TCP listen socket on port 1756. Any remote control must be sent to this port. Multiple RCP connections from the same endpoints are allowed. The maximum number of RCP connections on a single endpoint is limited to 50 connections at the same time. Alternatively, a connection can be made using a HTTP tunnel. See this chapter for details.
Remote Control ProtocolPlus Protocol Header Layout
Version 3 (VIP, VideoJet and VipX Series and VIP110Version 6.0 and higher). The RCP Plus protocol header consists of 16 Bytes. The begin of the payload section is now on DWORD boundary.
16 32
Tag
2 Bytes		 Data Type
1 Byte		 Version
4 Bits		 R/W
4 Bits
C
1		 Action
7 Bits		 Reserved
1 Byte		 Client ID
2 Bytes
Session ID
4 Bytes
Numeric Descriptor
2 Bytes		 Payload Length
2 Bytes
8 24
Tag
Each tag is represented by two octets. It identifies the command which should be processed by the VideoJet.
Data Type
Specifies the data type of the payload section. These are the currently available data types:
Values:
FLAG0x00 (1 Byte)
T_OCTET0x01 (1 Byte)
T_WORD0x02 (2 Byte)
T_INT0x04 (4 Byte)
T_DWORD0x08 (4 Byte)
P_OCTET0x0C (N Byte)
P_STRING0x10 (N Byte)
P_UNICODE0x14 (N Byte)
Version
The current RCP version is 3. Backward compatibility to version 2 or version 0 is NOT provided.
R/W
Specifies whether the command should read or write. The Read/Write field is coded in the lower nibble of byte 4.
Values:
Read0x0
Write0x1
C
Continuation. This bit signals, when set, that this RCP+ packet is not terminated in the payload; additional packets with the full RCP+ header will follow immediately in the stream as long as this bit is cleared. The reassembly of the complete payload is up to the application and is beyond the scope of this document.
Action
Specifies the kind of the packet.
Values:
Request0x00
Reply0x01
Message0x02
Error0x03
Specific Error0x04
Client ID
Each RCP client register results in a Client ID; this ID has to be provided in all following RCP commands.
Session ID
This ID is used for implementations which need to identify a once registered user in other applications or RCP sessions.
Numeric Descriptor
The Numeric Descriptor specifies an attribute for components which are installed more than one time inside the VideoJet, e.g. inputs or relays. The first component is always counted as 1. If this field is not applicable to the command in this packet, a value of zero should be inserted.
Payload Length
The number of data bytes inside the payload section. The length field itself is not counted.
Reserved
This byte is returned by the VideoJet unchanged. It is up to the user to setup a request ID here to assign the replies to multiple pending requests .
Packetizing in the TCP Stream
As TCP is a stream oriented protocol, packetizing information has to be inserted to achieve proper packet reconstruction. For this purpose the TPKT structure is used.
16 32
Version
1 Byte		 Reserved
1 Byte		 Length
2 Bytes
RCP Packet
N Bytes
8 24
Version
TPKT version 3.
Reserved
Should be set to zero.
Length
Byte count of the complete packet; RCP packet length + TPKT length (4 Bytes).
RCP Protocol Procedure
Request / Reply
The VideoJet unit will send back a reply on each incoming request. In some protocol functions the reply will carry no data.


NOTE: A reply from a write command which is not readable will be an RCP_ERROR_READ_NOT_SUPPORTED (error code 0x90) This means that it is not possible to determine correct setting of the command.
Messages
A message will be generated on the VideoJet on certain events (see RCP command for details). If an RCP client is registered to receive a certain message (e.g. an input state has changed), the VideoJet will generate it. The message has the same payload format as the response to a Read command of the same tag.


RCP is capable of sending messages on certain events. Before an RCP client can receive these messages, a registration at the VideoJet is necessary.
RCP Errors
The packet will have the standard layout with the method field set to ‘Error’. The payload length will always be 1; in the payload section the cause of the error can be determined:
RCP_ERROR_UNKNOWN 0xFF
RCP_ERROR_INVALID_VERSION 0x10
RCP_ERROR_NOT_REGISTERED 0x20
RCP_ERROR_INVALID_CLIENT_ID 0x21
RCP_ERROR_INVALID_METHOD 0x30
RCP_ERROR_INVALID_CMD 0x40
RCP_ERROR_INVALID_ACCESS_TYPE 0x50
RCP_ERROR_INVALID_DATA_TYPE 0x60
RCP_ERROR_WRITE_ERROR 0x70
RCP_ERROR_PACKET_SIZE 0x80
RCP_ERROR_READ_NOT_SUPPORTED 0x90
RCP_ERROR_INVALID_AUTH_LEVEL 0xa0
RCP_ERROR_INVAILD_SESSION_ID 0xb0
RCP_ERROR_TRY_LATER 0xc0

Note the error code 0xc0 RCP_ERROR_TRY_LATER indicates, that the VideoJet recognizes the command, but it cannot be processed immediately. The client should repeat this command later.
RCP over a HTTP tunnel
Many network installations includes firewalls to protect network segments against unauthorisized access. In many cases, the HTTP port (80) is enabled by default to gain Internet access. For this purpose, RCP offers a second network port. As the VideoJet has a built in webserver, the connection can be made to the webserver, the token
“GET /rcp_tunnel HTTP1.0\r\n\r\n”
advices the webserver to pass this socket to the RCP server. From that point on, the client is connected to the RCP server and can immediately cointinue with RCP registration.
Note: the delimiters ‘\r’ and ‘\n’ are written here in C notation; in the TCP packet to the server these delimiters corresponds with the ASCII codes 0x0d and 0x0a.
Example:
  1. Establish a TCP connection to port 80 at your Videjet
  2. Send the string “GET /rcp_tunnel HTTP 1.0\r\n\r\n” (as HEX string: 0x47 0x45 0x54 0x20 0x2f 0x72 0x63 0x70 0x5f 0x74 0x75 0x6e 0x6e 0x65 0x6c 0x20 0x48 0x54 0x54 0x50 0x31 0x2e 0x30 0x0d 0x0a 0x0d 0x0a)
  3. Proceed in the same manner as a normal RCP connection
Receiving media data
The VideoJet is capable for tunneling media data through HTTP. In some network environments this might be helpful.
When using this mechanism, the connect primitive must set the “RTP over TCP” for the media encapsulation protocol. The response for Media host and port can be ignored. After that, a TCP connection to the HTTP port must be established. By sending the string
GET /media_tunnel/SSSSSSSS/CC/DD/LL/CO HTTP 1.0\r\n\r\n
SSSSSSS The session ID returned from the connect primitive (padded with leading zeros to 8)
CC The media type (see connect primitive; 01=video, 02=audio)
DD direction of media (01=receive media, 00=transmit media)
LL the line input number
CO The coder number

When the HTTP server inside the VideoJet received this string, it passes this socket to the RCP. From that point on, media data will be transferred over this socket using TPKT encapsulation (see chapter Packetizing in the TCP Stream).

When all sockets of a session are in data sending mode, a RCP message MEDIA_SOCKETS_COMPLETE with the associated session ID will be sent out to the initiator of the session. This is useful when a session is used for replay; the replay PLAY command can securely be applied when the MEDIA_SOCKETS_COMPLETE message has been arrived.
RCP over CGI
RCP+ command my also be encapsulated in CGI (Common Gateway Interface) using a standard web browsers URL. All needed parameters are passed to the HTTP server of the video server which tunnels the RCP+ commands to the RCP server. The reply returned is a text based XML structure.
The CGI interface may also be used by a HTTP client written from the scratch based on RFC 1945 (HTTP 1.0) using 'GET' method. The unit's HTTP server will only examine 'Connection: Keep-Alive' and optional 'Authorization: ' header fields. See RFC for implementing details.
Valid CGI parameters:
command
Values:
The RCP+ command tag number
type
Values:
F_FLAG
T_OCTET
T_WORD
T_DWORD
P_OCTET
P_STRING
P_UNICODE
direction
Values:
READ
WRITE
num
Values:
The numeric parameter
payload
Values:
The payload as readable string for payload type P_STRING
The payload as octet array with no spaces preceeded with 0x for payload type P_OCTET and P_UNICODE
The payload value in hex or decimal notion for all other payload types
Optional CGI parameters:
idstring
Values:
User defined parameter which will not be processed by the unit; will return unchanged in the reply
sessionid
Values:
Context specific session ID for this command
Multiple parameters are passed in CGI manner with '&' in between two parameter-value pairs.
A sample request to readout the units hardware version will look like
http://ip.ip.ip.ip/rcp.xml?command=0x002e&type=P_STRING&direction=READ
The reply XML structure will then have this format:
    <rcp>
        <command>
            <hex>0x002e</hex>
            <dec>46</dec>
        </command>
        <type>T_DWORD</type>
        <direction>READ</direction>
        <num>0</num>
        <idstring />
        <payload />
        <cltid>0x00ff</cltid>
         <result>
            <hex>0xf0000f43</hex>
            <dec>4026535747</dec>
        </result>
    </rcp>
The upper part contains the request, the <result> contains the reply. Numerical values are presented in <hex> and <dec>, strings, unicodes and p_octet in <str> sections. <cltid> shows the client number assiged by the RCP+ server.
Message handling
RCP+ messages will be processed and received by the CGI client using a poll mechansim. A CGI command set with the requested messages command tag numbers need to be issued. After issueing a request, the reply returns immedialty after a message has been sent or the default timeout of 1000 ms has been expired. When the timeout expires, a message count of 0 is returned. Otherwise the number of received messages is signaled. The default timeout can be altered by setting the 'collectms' CGI value to the approriate number of milliseconds.
Vailed CGI commands to control messages:
message
Values:
One or a list of requested message RCP+ command tag numbers separated by '$'
collectms
Values:
Time in milliseconds to collect messages before returning with 'No messages'; default is 1000 ms
The <msgcnt> section contains the number of vailed <msg> sections inside the reply.
A buffer mechanism (depth 64) ensures that no messages will be lost during two consecutive poll cycles. The <over> sections counts the number of lost messages. <clip> signals too small internal buffers; this should never occur.
The <poll> section counts the number of issued poll requests
A sample request to receive all connection related messages (CONF_CONNECT_TO) will look like
http://ip.ip.ip.ip/rcp.xml?message=0xffcc&collectms=5000
The reply XML structure will then have this format:
    <message_list>
        <stats>
            <msgcnt>2</msgcnt>
            <over>0</over>
            <clip>0</clip>
            <poll>1</poll>
        </stats>
    <cltid>0x002a</cltid>
    <msg>
        <no>1</no>
        <command>0xffcc</command>
        <num>0</num>
        <sessionID>0x7063001f</sessionID>
        <hex>0xa00a0034000000000101000001010001</hex>
        </msg>
    <msg>
        <no>2</no>
        <command>0xffcc</command>
        <num>0</num>
        <sessionID>0x70630020</sessionID>
        <hex>0xa00a0034000000000101000001010001</hex>
    </msg>
    </message_list>
Authentication
The RCP+ server need proper authentication to process protected commands. The CGI interface provides three basic authentication schemes to be used.
Using http authentication
In this case, HTTP header authentication (basic or digest) must be present in the request. The internal HTTP server will pass the login information to the RCP+ server.
Using session cookie
For each successful HTTP authentication (for all available resources like html pages, images...) a session cookie will be returned by the HTTP server. When this cookie is present in any further HTTP connections, the same authorization level will be granted the same level as the originating connection. The session cookie will remain active as long as at least one HTTP connection remains open. In this case the internal HTTP server will pass the login information to the RCP+ server.
CGI inline
By passing the CGI parameter 'pwd' with a value of the identification string as defined in the CONF_RCP_CLIENT_REGISTRATION section for normal method. This information will be directly passed to the RCP+ server for validation.
Autodetecting Devices
VCS products are being detected on a network using an IP broadcast to UDP port 1757. The format for requesting an identification is shown below.
Request Packet
16 32
0x99
1 Byte		 0x39
1 Byte		 0xA4
1 Byte		 0x27
1 Byte
Sequence Number
4 Bytes
0x00
1 Byte		 0x00
1 Byte		 Reply Port
2 Bytes
8 24
Sequence Number
This sequence number must be a randomized number.
Reply Port
Specifies the reply UDP port e.g. RP1 0x06; RP2 0xDE -> reply port: 1758

Additional information on hardware versions
32-Bit Hardware version Former Scheme:
16 32
ID
4 Bits		 R
2 Bits		 FL
2 Bits		 Serial Number
2 Bytes		 Net
4 Bits		 opt
4 Bits
8 24
ID
Values:
NCID_NVR0x1
NCID_VJ80000x2
NCID_VIP100x3
NCID_VIP10000x4
NCID_VJ4000x6
NCID_VIP1000x7
NCID_VJEX0x8
NCID_VJ10000x9
NCID_VJ1000xA
NCID_VJ100xB
NCID_VJ80080xC
NCID_VJ80040xD (latest unit carrying the old numbering scheme)
EscapeCode0xF (used to switch over to new detection)
FL
Values:
HARDWARE_TYPE_VIN0x0
HARDWARE_TYPE_VOUT0x1
HARDWARE_TYPE_VIN_OUT0x2
Net
Values:
Bit1HARDWARE_SYSTEM_OPT_ISDN
Bit3HARDWARE_SYSTEM_ETHERNET
opt
Values:
Bit1HARDWARE_OPT_HDD
Bit3HARDWARE_OPT_AUDIO


32-Bit Hardware version New Scheme:
16 32
Esc
4 Bits		 R
1		 M
1		 FL
2 Bits		 Reserved
8 Bits		 ID
1 Byte		 Net
4 Bits		 Opt
4 Bits
8 24
Esc
Must be set to 0xF
M
Values:
Master0
Slave1
FL
Flavour
Values:
HARDWARE_TYPE_VIN0x0
HARDWARE_TYPE_VOUT0x1
HARDWARE_TYPE_VIN_OUT0x2
ID
Values:
HARDWARE_ID_VIPX10x01
HARDWARE_ID_VIPX20x02
HARDWARE_ID_VIPXDEC0x03
HARDWARE_ID_VJ_X100x05
HARDWARE_ID_VJ_X200x06
HARDWARE_ID_VJ_X400x07
HARDWARE_ID_VJ_X40_ECO0x08
HARDWARE_ID_VJ_X10_ECO0x09
HARDWARE_ID_VJ_X20_ECO0x0A
HARDWARE_ID_IP_PANEL0x0d
HARDWARE_ID_GEN40x0e
HARDWARE_ID_M16000x0f
HARDWARE_ID_FLEXIDOME0x11
HARDWARE_ID_M1600_DEC0x13
HARDWARE_ID_VIPX1600_XF0x15
HARDWARE_ID_VRM0xfc
HARDWARE_ID_VIDOS_SERVER0xfd
HARDWARE_ID_VIDOS_MONITOR0xfe
1st Reply Packet
16 32
0x99
1 Byte		 0x39
1 Byte		 0xa4
1 Byte		 0x27
1 Byte
Sequence Number
4 Bytes
Harware Address
6 Bytes ...
0x03
1 Byte		 ID
1 Byte
Device IP
4 Bytes
Subnet Mask
4 Bytes
Gatway IP
4 Bytes
Flavor
1 Byte		 Connections
1 Byte		 Reserved
1 Bytes		 ID new
1 Bytes
8 24
Sequence Number
Returns the sequence number from the request packet.
Hardware Address
MAC address of the device.
ID
Unit Hardware ID returned from request (will be 0xff when the new version layout is used).
Device IP
Current IP address of the device.
Subnet Mask
Current Subnet mask of the device.
Gatway IP
Current Gateway of the device.
Flavor
Flavor of this device.
Connections
Number of active connections.
ID new
The ID filed of the new version layout.
2nd Reply Packet
<?xml version="1.0"?> 
<root xmlns="OEMExtXX:device-1-0"> 
<device> 
   <deviceType>OEMExtXX:device:deviceIDYY</deviceType> 
   <friendlyName>VideoJet</friendlyName> 
   <unitName>UnitName</unitName>
   <serialNumber>XXXXXXXX:YYYYYYYY</serialNumber> 
   <physAddress>XX-XX-XX-XX-XX-XX</physAddress> 
   <sessionKey>XXXXXXXXXXXXXXXX</sessionKey> 
   <unitIPAddress>XXX.XXX.XXX.XXX</unitIPAddress> 
   <unitSubnetMask>XXX.XXX.XXX.XXX</unitSubnetMask> 
   <unitGatewayIp>XXX.XXX.XXX.XXX</unitGatewayIp> 
   <activeConnections>XX</activeConnections> 
</device> 
</root> 

<root xmlns="OEMExtXX:device-1-0"> 
XX is the OEM Extension; 0x00 for VCS; OEM specific 

<deviceType>OEMExtXX:device:deviceIDYY</deviceType> 
XX is the OEM Extension; 0x00 for VCS; OEM specific 
YY is the VideoJet ID from the request packet 

<friendlyName>VideoJet</friendlyName> 
The name and type of the VideoJet; type and OEM specific 

<unitName>UnitName</unitName> 
The name of the unit coded in UTF-8

<serialNumber>XXXXXXXX:YYYYYYYY</serialNumber> 
XXXXXXX is the Hardware version of the VideoJet 
YYYYYYY is the Softwareware version of the VideoJet 

<physAddress> XX-XX-XX-XX-XX-XX </physAddress> 
XX-XX-XX-XX-XX-XX is the MAC address of the VideoJet 

<sessionKey>XXXXXXXXXXXXXXXX</sessionKey> 
No common use 

<unitIPAddress> XXX.XXX.XXX.XXX </unitIPAddress> 
XXX.XXX.XXX.XXX is the current IP address of the VideoJet 

<unitSubnetMask>XXX.XXX.XXX.XXX</unitSubnetMask> 
XXX.XXX.XXX.XXX is the subnet mask of the VideoJet 

<unitGatewayIp>XXX.XXX.XXX.XXX</unitGatewayIp> 
XXX.XXX.XXX.XXX is the current gateway IP address of the VideoJet 

<activeConnections>XX</activeConnections> 
XX is the number of active media connections of the VideoJet 

<HTTPPort>XXXX</HTTPPort> 
XXXX is the current HTTP port number the VideoJet is listening to

<ClusterMember>XXX.XXX.XXX.XXX</ClusterMember> 
XXX.XXX.XXX.XXX is one of the cluster members; there might be multiple entries including this device

<ClusterID>XX</ClusterID> 
XX is index number of the above ClusterMember list of this device
Setting an IP Address using Broadcast Mechanism
If the current IP address of a device doesn’t match the subnet settings, this unit cannot be reached using the standard Remote Control Protocol. All IP parameters of a VideoJet can be set using a UDP broadcast message to port 1759.
Payload Structure
16 32
Hardware Address
6 Bytes ...
Reserved
2 Bytes
IP Address
4 Bytes
Subnet Mask
4 Bytes
Gateway IP
4 Bytes
Reserved
4 Bytes
8 24
Hardware Address
MAC address of the device.
IP Address
IP address to set.
Subnet Mask
Subnet mask to set.
Gateway IP
Gateway IP address to set.
As all VideoJets will receive this message, only the unit matching the hardware address (HW1-HW6) will update its IP parameters.
NOTE: There will be no reply to this command.
NOTE: This command will only work if NO service password is set.
Request or setting of system or network parameters using Broadcast Mechanism
In addition to the SETTING_AN_IP_ADDRESS_USING_BROADCAST, an additional way to setup non network configured devices has been introduced. The device itself is selected using the ethernet mac address as the first parameter inside the command structure. A list of commands including payload length information may be added. All commands must be addressed using UDP broadcast message to port 1760.
Payload Structure
MAC address
6 Bytes ...
Reserved
2 Byte		 Command ID
2 Byte
Payload length
2 Byte		 Variable length payload
n Bytes
MAC address
MAC address of the unit to configure
Command ID
ID of broadcast setting command
LED_BLINK = 0x0000
Payload length 4 bytes. Requests the unit blink the power led; payload containin the number of seconds for blinking. NOTE duration is limited to 60 sec.
SWITCH DHCP = 0x0001
Payload length 4 bytes. Switches DHCP on (payload = 1) or off (payload=0).
NOTE: This command will only work if NO service password is set.
Payload length
Length of the payload section
Variable length payload
Payload; depending on Command ID
NOTE: There will be no reply to this command.
CONF_RCP_CLIENT_REGISTRATION
  Tag code    NumDes    Message    SNMP Support  
  0xff00   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   p_octet   noprot   see detailed description  
 
The registration is a standard RCP packet with the command code 0xFF00 with data type P_OCTET (0x0c). The Numeric Descriptor is not used. The Client ID in the header section is ignored.
Payload Structure
Payload Structure
RegType
1 Byte		 Reserved
1 Byte		 Client ID
2 Byte
PE
1 Byte		 PL
1 Byte		 Nbr
2 Byte
Tag 1
2 Byte		 N x 2 Bytes Tag N
2 Byte ...
Char 1
1 Byte		 N x 1 Byte Char N
1 Byte
RegType
Values:
Normal Registration0x01
Hook On Registration0x02
Hook Back Registration0x03
Client ID
Unused in Normal Registration. Must be provided in Hook On Registration.
PE
Password and User Delivery Encryption.
Values:
Plain text0x00
MD5 hash0x01
PL
Password and User String Length. Number of bytes to follow for the password string.
Nbr
Number of message tags inside this packet.
Tag 1 - N
Tag codes for the messages which should be passed to the RCP client (see tag code table for capability to generate messages) – A Tag code of 0xFFFF will force the VideoJet to generate a message on all possible events.
Char 1 - N
Password string itself. NOTE: No \0 termination!
Registration Procedure
Normal Registration
  1. The client opens up a TCP connection to the VideoJet.
  2. The client sends an RCP registration as mentioned above.
  3. The RCP server (the VideoJet) will respond with the result code and the assigned Client ID.
  4. The client is now allowed to send RCP Requests provided with the Client ID.
Hook On Registration
The ‘Hook On’ registration is applicable if a registered application running on one host can provide its Client ID to a second application on the same host. This application can now perform a register at the VideoJet without naming the password.
  1. The client opens up a TCP connection to the VideoJet.
  2. The client sends an RCP registration with the ‘Hook On’ command and an existing Client ID on the same host. The password is not needed in this case (PL set to 0).
  3. The RCP server (the VideoJet) will check whether the other client is registered properly on the same host.
  4. The RCP server (the VideoJet) will respond with the result code and a NEWLY assigned Client ID.
  5. The client is now allowed to send RCP Requests provided with this Client ID.
Hook Back Registration
This mechanism is used during connection establishment only. A called host is requested to do a back register to the calling host. To achieve proper client allocation on the calling host, the Client ID of the server session on the called host must be provided in the ‘Hook back’ registration.
Format: XXXX@PasswordString
XXXX: The Client ID in hexadecimal notation (4 digits)
PasswordString: as defined below
Password and User Delivery and Encryption
There are currently three user levels on the videojet:
  • live – For video access only; no control
  • user – For video access and control over the video stream (e.g. caminput)
  • service - for video and all administrative access
Plain text:
The identification string must have the following format: +Username:Password+
MD5 hash encryption:
  1. A 16 character random string for MD5 hash calculation must be requested from the VideoJet (RCP command CONF_RCP_REG_MD5_RANDOM).
  2. A string +random_string+++username:password+ must be formed.
  3. The response MD5 hash over this string must be calculated.
  4. The identification string in the register packet must have the following format: +Username:random_string:response_string+
NOTE: No additional whitespaces are allowed.
Server Reply
16 32
Result
1 Byte		 Level
1 Byte		 Client ID
2 Bytes
8 24
Result
Values:
Registration failed0x00
Registration successful0x01
Level
The level after this registration.
Client ID
Identification number under which the client is now registered at the VideoJet.
CONF_RCP_CLIENT_UNREGISTER
  Tag code    NumDes    Message    SNMP Support  
  0xff01   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   p_octet   noprot   see detailed description  
 
Request
The unregister is a standard RCP packet with the command code 0xFF01 with no payload section. The needed information (Client ID) will be taken from the header section.
Reply
The reply will have the following format:
16 32
Result
1 Byte		 Level
1 Byte		 Client ID
2 Bytes
8 24
Result
Values:
Unregister failed 0x00
Unregister successful0x01
Level
The level before this unregister.
Client ID
Identification number under which the client was registered at the VideoJet.

NOTE: This command is NOT readable.
CONF_RCP_CLIENT_TIMEOUT_WARNING
  Tag code    NumDes    Message    SNMP Support  
  0xff03   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   not supported; will generate message if client idle timeout will happen in 1 minute  
 
  Write   f_flag   noprot   not supported; will generate message if client idle timeout will happen in 1 minute. see detailed description  
 
Timeout handling
The RCP server has to deal with lots of RCP connections at the same time. If an RCP client is going down without notification to the server, an orphan table entry will remain. To avoid this, a timeout mechanism is provided. Each RCP client must show any activity within 10 minutes. After this time the registration of a specific RCP client is invalid. For easy handling, the RCP client can register itself for an RCP_CLIENT_TIMEOUT_WARNIG message. The client will be notified 1 minute before the timeout occurs.
The timeout renewal can be achieved by any RCP read or write command. A good advise is to read the RCP_CLIENT_REGISTRATION.
CONF_RCP_REG_MD5_RANDOM
  Tag code    NumDes    Message    SNMP Support  
  0xff05   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   returns a 16 char. random string to be used in MD5 hash encrypted registration. see detailed description  
 
  Write   %   noprot   %  
 
NOTE: To avoid ‘denial of service’ attacks, the RCP server will only grant up to 5 random strings at the same time. Maximum time from the request of a random string to its use: 5 seconds. Multiple requests from the same host are ignored.
CONF_RCP_TRANSFER_TRANSPARENT_DATA
  Tag code    NumDes    Message    SNMP Support  
  0xffdd   yes   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_live   see detailed description  
 
  Write   p_octet   l_user   see detailed description  
 
The transparent data from and to the serial interfaces is handled by the RCP to achieve reliable transfer of information. To gather control over the remote serial interface a successful registration is necessary.
Request packet
Options
1 Byte		 Reserved
1 Byte		 Lease Time
2 Bytes
Trans. Data 1
1 Byte		 N x 1 Byte Trans. Data N
1 Byte
Options
Currently no options used
Lease Time
Time in seconds the lease is requested
Values:
Only this packet should be sent out; no further control is requested0x0000
Indefinite lease time; request lease as long as the current registration is valid0xFFFF
NOTE: The lease time should be treated as a request; the VideoJet may switch leases before the requested time is over due to a higher prioritized RCP client
For this direction, an RCP Write command to a specific port (addressed by the Numeric Descriptor) is necessary. Once the VideoJet has received a TRANSFER_TRANSPARENT_DATA command, it checks whether the RCP client is in control or not. If the RCP client is allowed to send data to the serial interface, the reply will present an OK. If the RCP client is not allowed to send data, a FAIL will be returned. In this case another RCP client is controlling the serial out. The timeout and priority handling of the serial ports is beyond the scope of this document.
NOTE: This command is NOT readable.
Write reply packet
16 32
Code
1 Byte		 Reserved
1 Byte		 Reserved
2 Bytes
8 24
Code
Values:
Access to the serial port denied0x00
Access to the serial port granted0x01
Reading the TRANSFER_TRANSPARENT_DATA command
The reply to the Read command will be the same as the reply to the write command. The returned code will present the availability of the serial port.
NOTE: Despite a positive reply to a read command, the port may be locked by another RCP client in the time slice between the read and a following write command.
Serial IN -> RCP Client
The data coming from the serial input is delivered using an RCP message. All RCP clients which want to receive this data must be registered for the message 0xFFDD. Data is posted if the corresponding RCP client is in control only.
If no client has a lease on the serial port, a message to all registered clients will be generated.
NOTE: The received message will carry NO header.
CONF_CONNECT_PRIMITIVE
  Tag code    NumDes    Message    SNMP Support  
  0xff0c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   l_live   %  
 
  Write   p_octet   l_live   see detailed description  
 
Switching Media Channels
Each RCP client may have different media sources and media receivers. To connect these media channels, a low level connect/disconnect primitive is implemented. These low level primitives can be grouped together to more complex commands, which can connect more than one media channel at the same time.
The primitives are designed to be asserted by media sources or receivers itself. Manager software should use the high level commands (see next chapter).
Using GET
By sending a CONNECT GET to the remote endpoint, this endpoint will start sending media to the requested address. For example, a VideoJet receiver is registered at a VideoJet transmitter. On sending a ‘CONNECT GET video to port 1234’ to the transmitter, the transmitter starts to send video to the appropriate port at the receiver.
The endpoint requesting the media stream (the VideoJet receiver) must be prepared to receive the stream from the network.
The coding (and resolution bits for video) must b e set according to the receivers capability to decode the data stream). E.g. a Decoder capable of decoding MPEG2 and MPEG4 in QCIF, CIF and 4CIF resolution should set all these bits.
Using PUT
By sending a CONNECT PUT to the remote endpoint, the endpoint will prepare itself for receiving data from the one initiating the request. For example, a VideoJet transmitter is registered at a VideoJet receiver. On sending a ‘CONNECT PUT video to port 2222’ to the receiver, the receiver will prepare its network stack to receive data from the appropriate port.
The endpoint initiating the media stream (the VideoJet transmitter) must start sending the media stream to the network.
The coding (and resolution bits for video) must be set to a value suitable to the current encoding parameters inside the VideoJet. E.g. if a video encoder is set to encode MPEG4 in CIF mode, only a PUT request having these bits set is accepted.
The coder parameter is used to address a specific encoder/decoder inside the VideoJet. As the VideoJet may have a Dual-stream feature, one physical line input might be connected to more than one encoder. By setting a coder to another value than 0, the VideoJet only tries this specific coder to establish a connection. When the coder value is set to 0, all coders inside the system will be checked.
Each connect primitive will result in a Session ID for maintaining and controlling the media stream with other RCP commands. The Session ID can be treated as unique on the entire system.
DISCONNECT
By sending a DISCONNECT supplied with a valid Session ID, the receiver of the command will stop sending/receiving to/from the media stream. The endpoint initiating the DISCONNECT command must stop receiving/sending from/to the media stream.
Request Packet
Sequence of:
Method
1 Byte		 Media
1 Byte		 Reserved
1 Byte		 Flags
1 Byte
Reserved
4 Bytes
Media Descriptor 1
M Bytes (Length depends on Media type)
N x M Bytes Media Descriptor N
M Bytes ...
Method
Values:
GET0x00
PUT0x01
Key transport0xE0
Media
Values:
Video0x01
Audio0x02
Data0x03
Flags
Bit1: Do reverse Login. This will control whether the called server will perform a reverse RCP Login.

Bit2: Free Running Connection. When this bit is set, the connection is not needed to retrigger by the command CONF_RCP_CONNECTIONS_ALIVE.

Bit3: Optional signalling for streaming (for correct connection list display)

Bit3: Media key request (when using GET) / Media key is appended at the end of this section (when using PUT)
Media Descriptors 1 - N
Video 
16 32
MEP
1 Byte		 Flags
1 Byte		 MTA Port
2 Bytes
MTA IP Address
4 Bytes
Coder
1 Byte		 Line
1 Byte		 MCTA Port
2 Bytes
MCTA IP Address
4 Bytes
Coding
2 Bytes		 Resolution
2 Bytes
Linked Coder
1 Bytes		 Linked Line
1 Bytes		 Bandwidth
2 Bytes
8 24
MEP
Media Encapsulation Protocol.
Values:
RTP over UDP0x01
RTP over TCP0x04
notice: when using RTP over TCP, media channels must be established as described in 'RCP Protocol Procedure / Receiving media data'
Flags
Values:
Bit1Substitute connection (if an RX connection to the requested interface is already established, the old connection will be disconnected and substituted by a new connection coming with this request).
Bit2Use relative to line coder addressing.
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
VideoJet will take address from the incoming TCP header0.0.0.0
VideoJet will take its configured multicast group IP224.0.0.0
Coder
Specifies the internal coder number; when set to 0, the appropriate coder corresponding to the given line number and/or coding parameter is chosen by the VideoJet itself.
Line
Identifies the Line Input/Output channel for the specified coding engine.
MCTA Port
Media Control Transport Address Network Port. Currently unused.
MCTA IP Address
Media Control Transport Address IP Address. Currently unused.
Coding
Values:
Bit3MPEG-4 (elementary stream)
Bit4MPEG-2 (only video)
Bit5Meta Data (output from motion detector…)
Bit7H264
Bit8JPEG
Bit15Recorded Media
Bit16MPEG-2 (program stream)
Resolution
Values:
Bit1QCIF
Bit2CIF
Bit32CIF
Bit44CIF
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Bandwidth
Initial bandwidth request in kBit/s Must have an value > 0. Only used on VJX00 series.
Audio 
16 32
MEP
1 Byte		 Flags
1 Byte		 MTA Port
2 Bytes
MTA IP Address
4 Bytes
Coder
1 Byte		 Line
1 Byte		 MCTA Port
2 Bytes
MCTA IP Address
4 Bytes
Coding
2 Bytes		 Reserved
2 Bytes
Linked Coder
1 Bytes		 Linked Line
1 Bytes		 Reserved
2 Bytes
8 24
MEP
Media Encapsulation Protocol.
Values:
RTP over UDP0x01
RTP over TCP0x04
Flags
Values:
Bit1Substitute connection (if an RX connection to the requested interface is already established, the old connection will be disconnected and substituted by a new connection coming with this request).
Bit2Use relative to line coder addressing.
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
VideoJet will take address from the incoming TCP header0.0.0.0
VideoJet will take its configured multicast group IP224.0.0.0
Coder
Specifies the internal coder number; when set to 0, the appropriate coder corresponding to the given line number and/or coding parameter is chosen by the VideoJet itself.
Line
Identifies the Line Input/Output channel for the specified coding engine.
MCTA Port
Media Control Transport Address Network Port. Currently unused.
MCTA IP Address
Media Control Transport Address IP Address. Currently unused.
Coding
Values:
Bit1G.711
Bit15Recorded Media
Bit16MPEG-2 (program stream)
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Data 
16 32
MEP
1 Byte		 Reserved
1 Byte		 Reserved
2 Bytes
MTA IP Address
4 Bytes
Coder
1 Byte		 Line
1 Byte		 Reserved
2 Bytes
Reserved
4 Bytes
Coding
2 Bytes		 Reserved
2 Bytes
Linked Coder
1 Bytes		 Linked Line
1 Bytes		 Reserved
2 Bytes
8 24
MEP
Media Encapsulation Protocol.
Values:
RCP Intrinsic0x02
MTA IP Address
Media Transport Address IP Address
Values:
VideoJet will take address from the incoming TCP header0.0.0.0
Coder
Informational.
Line
Identifies the Line Input/Output channel for the specified coding engine.
Coding
Values:
Bit1RCP
Bit15Recorded Media
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Span Replay 
16 32
MEP
1 Byte		 Reserved
1 Byte		 Media Handle
2 Byte
iSCSI Server IP
4 Bytes
Coder
1 Byte		 Line
1 Byte		 Reserved
2 Byte
Target Idx
1 Byte		 Lun Idx
1 Byte		 Span Idx
2 Byte
Coding
2 Byte		 Resolution
2 Byte
Reserved
2 Byte		 Bandwidth
2 Byte
8 24
MEP
Media Encapsulation Protocol.
Values:
API Callback0x06
Media Handle
Identifier that is associated with the rtp data and is supplied with the rtp data in the callback function.
iSCSI Server IP
The IP address of the iSCSI server. Use 0xFFFFFFFF to connect to a span on a usb device that is locally connected to the device.
Coder
Specifies the internal coder number; when set to 0, the appropriate coder corresponding to the given line number and/or coding parameter is chosen by the VideoJet itself.
Line
Identifies the Line Input/Output channel for the specified coding engine.
Target Idx
The index of the target on the iSCSI Server. This index can be obtained by sending a disconver to the server.
Lun Idx
The index of the Lun of the specified target on the iscsi server.
Span Idx
The index of the span.
Coding
Values:
Bit15Recorded Media
Resolution
Values:
Bit1QCIF
Bit2CIF
Bit32CIF
Bit44CIF
Bandwidth
Initial bandwidth request in kBit/s Must have an value > 0. Only used on VJX00 series.

NOTE: If this command is used with the vj api, an specific error of the following type may be returned
SPAN_ERR_INTERNAL0x01
SPAN_ERR_INV_SPN_IDX0x02
SPAN_ERR_INV_HDR_TYPE0x03
SPAN_ERR_NOT_MNTD0x05
SPAN_ERR_INV_FS0x06
SPAN_ERR_INV_LUN_NFO0x07
SPAN_ERR_BAD_HDR_CKSM0x08
SPAN_ERR_RD_ONLY0x0a
SPAN_ERR_NO_REC_DAT0x0b
SPAN_ERROR_INV_PART_NFO0x0c
ISCSI_ERROR_CONNECT0x31
ISCSI_ERROR_INV_LUN0x33
ISCSI_ERROR_LOGIN0x34
ISCSI_ERROR_INV_TRG_IDX0x35
Key transport
When the media key bit is selected in the header flags, a variable length key field is appended at the end of the media descriptor. The key field has the following structure
Sequence of:
16 32
method
1 Byte		 bytes valid
1 Byte		 status tag
1 Byte		 reserved
1 Byte
key data
4 Bytes
8 24
method
must be set to 'Key transport' 0xE0
bytes valid
the number of valid key bytes in this header
status tag
must be set to 'Key transport tag' 0xE0
key data
the key payload
The media key is transferred using a sequence of key headers all with the method field set to 0xE0. The end of the key section is marked by a header with less than 4 bytes (or zero) indicated in the bytes valid field.
The typical key length is 16 bytes (128 bit AES). In this case, four full key headers followed by one empty header must be transferred (4 x 4 bytes valid + 1 x 0 bytes valid = 16 bytes)
For backward compatibility, the header method 0xE0 will be skipped by units with former firmwares versions.
The key is located and stored on each media source (using the CONF_CRYPT_KEY* commands); When the system is configured to publish its keys (see CONF_PUBLISH_MEDIA_KEYS), then the media sources must fill in the secret by sending (PUT method) or replying to (GET method) the connect primitive.
For example, when sending a GET connect primitive to a device and the key transport is selected, then the device will fill in its key in the reply to the connect primitive.
NOTE: be sure to use a secure RCP connection, the keys in the connect primitive are tranferred in plain
Reply Packet
Sequence of:
Method
1 Byte		 Media
1 Byte		 Status
1 Byte		 Reserved
1 Byte
Reserved
4 Bytes
Media Descriptor 1
M Bytes (Length depends on Media type)
N x M Bytes Media Descriptor N
M Bytes ...
Method
Values:
GET0x00
PUT0x01
Media
Values:
Video0x01
Audio0x02
data0x03
Status
Values:
Interface not available (Remark: former version may return this error in case of unknown method/media type)0x00
Access to this interface granted0x01
Access to this interface rejected0x02
Session ID invalid or connection no longer active0x03
Coding parameters incompatible0x04
Interface data will be supplied by another media descriptor0x05
The method field in the header does not carry a known method0x08
The media field in the header does not carry a known media type0x09
NOTE: Any wildcards used in the transport addresses will be replaced by the real used network addresses.
This command is NOT readable; to gain information on active connection refer to the ACTIVE_CONNECTION_LIST command.
NOTE: The Media Control sockets have currently no function
CONF_DISCONNECT_PRIMITIVE
  Tag code    NumDes    Message    SNMP Support  
  0xff0d   no   yes   yes  
 
  Datatype   Access Level   Description  
  Read   %   l_live   %  
 
  Write   p_octet   l_live   see detailed description  
 
Payload Structure
16 32
Status
1 Byte		 Cause
1 Byte		 Reserved
2 Bytes
Remote Host IP
4 Bytes
8 24
Status
Values:
Connection disconnected0x01
Connection identified by the given Session ID not found on this host0x02
Cause
Values:
Not closed0x00
Normal termination0x01
Abnormal termination0x02
No response0x03
Remote host terminated0x04
Timed out0x05
Remote login rejected0x06
No common media channels0x07
Connection substituted0x08
Automatic disconnect0x09
Stop streaming0x0a
Remote Host IP
IP address of the remote connected host.
NOTE: This command is NOT readable.
CONF_CONNECT_TO
  Tag code    NumDes    Message    SNMP Support  
  0xffcc   no   yes   yes  
 
  Datatype   Access Level   Description  
  Read   %   l_live   %  
 
  Write   p_octet   l_live   see detailed description  
 
Write Packet
16 32
Destination IP Address
4 Bytes
Reserved
1 Byte		 Line
1 Byte		 Flags
2 Bytes
Local Coder
1 Byte		 Local Line
1 Byte		 Put Channels
2 Bytes
Remote Coder
1 Byte		 Remote Line
1 Byte		 Get Channels
2 Bytes
8 24
Destination IP Address
The reception of this command will force the host to connect to the mentioned destination IP address.
Line
OBSOLETE
This parameter carries the number of the remote input (for get channels) or the local input (for put channels); For connection to the HDD, the Line byte must carry the partition number of the HD.
This parameter is updated by the local line/coder and remote line/coder settings.
Flags
NOTE: Only one video standard (MPEG2/4) can be used; setting all bits will result in best currently available mode.
Values:
Bit0Substitute an existing connection
Bit1Request video mode MPEG-4
Bit2Request video mode MPEG-2
Bit3Force the use of TCP as transportation protocol
Bit4Connect to the HDD to receive a recorded media stream
Bit6Connect a VCA meta data stream
Bit7Supress automatic media key exchange
Bit8Use SSL for the RCP control connection; if no destination port is specified, the remote port defaults to 443 (HTTPS) in case of SSL is requested otherwise 80(HTTP)
Bit9Request video mode H.264
Bit10Request video mode JPEG
Local Coder
This parameter carries the number of the local video input number. A wildcard of ‘0’ will result in first match.
Local Line
This parameter carries the number of the local video coder number. A wildcard of ‘0’ will result in first match.
Put Channels
Values:
Bit0Video
Bit1Audio
Bit2Data
Bit3-Bit15Reserved
Remote Coder
This parameter carries the number of the remote video coder number (at the destination IP). A wildcard of ‘0’ will result in first match.
Remote Line
This parameter carries the number of the remote video coder number (at the destination IP). A wildcard of ‘0’ will result in first match.
Get Channels
Values:
Bit0Video
Bit1Audio
Bit2Data
Bit3-Bit15Reserved
NOTE: For audio connections, the local and remote line parameter are taken from the video settings.
If this command is extended with the optional appendix, the remote port number for RCP login must be specified. This can be either 1756 for the normal RCP port or any available HTTP port at the remote host. When a port number different to 1756 is used, the login will use a HTTP tunnelling.
Optional Appendix
16 32
Dest. Port
2 Bytes		 Reserved
2 Bytes
Reserved
4 Bytes
8 24
Dest. Port
This parameter carries the number of the remote TCP port number used for RCP login.
Reply / Read / Message
The reply to this command will present the same packet format as the outgoing. The result will contain the really established channels.
A message will be generated if all requested channels are established; if a channel fails, the appropriate bit will be cleared in the channel section.
CONF_ACTIVE_CONNECTION_LIST
  Tag code    NumDes    Message    SNMP Support  
  0xffc1   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_user   see detailed description  
 
  Write   %   l_user   %  
 
Payload Structure
Sequence of:
16 32
Destination IP Address
4 Bytes
Local Coder
1 Byte		 Local Line
1 Byte		 Flags
2 Bytes
Session ID
4 Bytes
Remote Coder
1 Byte		 Remote Line
1 Byte		 Reserved
2 Bytes
TX Channels
4 Bytes
RX Channels
4 Bytes
8 24
Destination IP Address
IP address to which the unit is connected.
Local Coder
The local connected coder (relative to line).
Local Line
The remote connected line
Flags
Values:
Bit0Connection is MPEG2 VES
Bit1Connection is MPEG2 PRG
Bit2Connection is MPEG4
Bit3Connection is to HDD replay
Bit4Connection is started as streaming
Bit5Connection is using multicast
Bit6Connection is using TCP for transportation
Bit7Data stream is encrypted
Bit8Connection is H.264
Bit9Connection is Jpeg
Session ID
Session identifier.
Remote Coder
The remote connected coder (relative to line).
Remote Line
The remote connected line.
TX Channels
See CONNECT_TO command for bit mask.
RX Channels
See CONNECT_TO command for bit mask.
CONF_MEDIA_SOCKETS_COMPLETE
  Tag code    NumDes    Message    SNMP Support  
  0xffc7   -   yes (Message only)   no  
 
  Datatype   Access Level   Description  
  Read   %   l_user   %  
 
  Write   -   l_user   sends out a message when all TCP tunneled sockets of a session are connected  
 
CONF_RCP_CONNECTIONS_ALIVE
  Tag code    NumDes    Message    SNMP Support  
  0xffc2   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_live   retriggers a running connection identified by its session_id; returns the current number of active connections  
 
  Write   %   l_live   %  
 
CONF_CAPABILITY_LIST
  Tag code    NumDes    Message    SNMP Support  
  0xff10   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   %   noprot   %  
 
Reply payload Structure
0xBABA
2 Bytes		 Version
2 Bytes		 NbSection
2 Bytes		 Section 1
 ...Section N
Version
current version of the capabilities (0x0001)
NbSection
Number of following sections
Section Structure
Type
2 Bytes		 Size
2 Bytes		 NbElement
2 Bytes		 Element 1
 ...Element N
Type
Type of Element
Values:
Video0x0001
Audio0x0002
Serial0x0003
IO0x0004
Camera Data0x0005
Size
Size of the section including SectionType, Size and NbElement. If the section is unknown, you can skip to the next using the size
NbElement
determines how many Elements are following. The definition of each Element depends on the type of the section
Element Structure
For section type Video
Type
2 Bytes		 Identifier
2 Bytes		 Compr
2 Bytes		 InputNo
2 Bytes		 Resolution
2 Bytes
Type
is one of the following
Values:
VIDEO_ENCODER0x0001
VIDEO_DECODER0x0002
Identifier
Identifier is the RCP numeric descriptor to use to address the entity. It should be unique when associated with the type and the compression.
Compression
is one or multiple of the following
Values:
VIDEO_COMP_MPEG20x0001
VIDEO_COMP_MPEG40x0002
VIDEO_COMP_H2640x0004
VIDEO_COMP_JPEG0x0008
InputNo
InputNo is the number of the physical input from which the entity gets or puts its video
Resolution
is one or multiple of the following
Values:
VIDEO_RESO_QCIF0x0001
VIDEO_RESO_CIF0x0002
VIDEO_RESO_2CIF0x0004
VIDEO_RESO_4CIF0x0008
VIDEO_RESO_CUSTOM0x0010
Element Structure
For section type Audio
Type
2 Bytes		 Identifier
2 Bytes		 Compr
2 Bytes
Type
is one of the following
Values:
AUDIO_ENCODER0x0001
AUDIO_DECODER0x0002
Identifier
Identifier is the RCP numeric descriptor to use to address the entity. It should be unique when associated with the type and the compression.
Compression
is one or multiple of the following
Values:
AUDIO_COMP_MPEG20x0001
AUDIO_COMP_G7110x0002
Element Structure
For section type Serial
Type
2 Bytes		 Identifier
2 Bytes
Type
is one of the following
Values:
SERIAL_RS2320x0001
SERIAL_RS4850x0002
SERIAL_RS4220x0004
Identifier
is the RCP numeric descriptor to use to address the entity.
Element Structure
For section type IO
Type
2 Bytes		 Identifier
2 Bytes
Type
is one of the following
Values:
IO_INPUT0x0001
IO_OUTPUT0x0002
IO_VIRTUAL_IN0x0003
Identifier
is the RCP numeric descriptor to use to address the entity.
Element Structure
For section type Camera Data
Type
2 Bytes		 InputNo
2 Bytes
Type
is one of the following
Values:
CAMDATA_BILINX0x0001
InputNo
InputNo is the number of the physical video input.
CONF_RCP_CODER_LIST
  Tag code    NumDes    Message    SNMP Support  
  0xff11   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   %   noprot   %  
 
This command is used to retrieve the list of encoders and decoders from a VideoJet. There are two reply formats supported, the compact and the extended list view. The compact view only reports the absolute coder numbers available on a given line input or output. The extended view offers more information about coding capabilities and other parameters of a coder.
Request payload Structure
16
MediaType
1 Byte		 Direction
1 Byte		 Flags
1 Byte
8 24
MediaType
Values:
Video0x01
Audio0x02
Data0x03
Direction
physical port is
Values:
Input0x00
Output0x01
Flags
one or multiple of
Values:
Request compact format 0x00
Reqeust extended format list0x01
Compact format reply payload Structure
CoderNbr 1
1 Byte		 N x 1 Byte CoderNbr N
1 Byte
CoderNbr 1 - N
List of the absolute coder numbers
Extended format video reply payload structure
Sequence of
16 32
CodingNbr
2 Byte		 Coding Capabilities
2 Byte
Coding Current
2 Byte		 Resolution Capabilities
2 Byte
Resolution Current
2 Byte		 Reserved
2 Byte
Reserved
4 Byte
8 24
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
H.2630x0002
Mpeg40x0004
Mpeg20x0008
Meta Data0x0010
H.263-19980x0020
Recorded Media0x4000
Mpeg2 PrgStr0x8000
Coding Current
The current available coding capabilities (definitions see above)
Resolution Capabilities
All resolution capabilities is one or multiple of
Values:
QCIF0x0001
CIF0x0002
2CIF0x0004
4CIF0x0008
Custom0x0010
Resolution Current
The current available resolution capabilities (definitions see above)
Extended format audio reply payload structure
Sequence of
16 32
CodingNbr
2 Byte		 Coding Capabilities
2 Byte
Coding Current
2 Byte		 CodParameter Capabilities
2 Byte
CodParameter Current
2 Byte		 Reserved
2 Byte
Reserved
4 Byte
8 24
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
G.7110x0001
Mpeg2 PrgStr0x8000
Coding Current
The current available coding capabilities (definitions see above)
Extended format data reply payload structure
Sequence of
16 32
CodingNbr
2 Byte		 Coding Capabilities
2 Byte
Coding Current
2 Byte		 CodParameter Capabilities
2 Byte
CodParameter Current
2 Byte		 Reserved
2 Byte
Reserved
4 Byte
8 24
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
RCP0x0001
Coding Current
The current available coding capabilities (definitions see above)
CodParameter Capabilities
All coding CodParameter capabilities is one or multiple of
Values:
RS2320x0001
RS4850x0002
RS4220x0004
CodParameter Current
The current available coding capabilities (definitions see above)
CONF_PUBLISH_MEDIA_KEYS
  Tag code    NumDes    Message    SNMP Support  
  0x09fc   no   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   switches wheather the media key of a media source are readable and transferred during the hw-hw connection setup  
 
  Write   f_flag   l_serv   switches wheather the media key of a media source are readable and transferred during the hw-hw connection setup  
 
CONF_CRYPT_KEYAUDIO_ENC
  Tag code    NumDes    Message    SNMP Support  
  0x09fe   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_serv   set key for AES Audio data encryption/decryption  
 
  Write   p_octet   l_serv   set key for AES encryption/decryption of audio data see detailed description  
 
Payload Structure
16 32
Key
16 Bytes ...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
  • This description is valid for the the commands:
    CONF_CRYPT_KEYVIDEO_ENC,
    CONF_CRYPT_KEYVIDEO_DEC,
    CONF_CRYPT_KEYAUDIO_ENC,
    CONF_CRYPT_KEYAUDIO_DEC
  • The numeric descriptor contains the number of the coder instance (absolute)
  • Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
CONF_CRYPT_KEYVIDEO_ENC
  Tag code    NumDes    Message    SNMP Support  
  0x09ed   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_serv   set key for AES Video dataencryption/decryption  
 
  Write   p_octet   l_serv   set key for AES encryption/decryption of video data see detailed description  
 
Payload Structure
16 32
Key
16 Bytes ...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
  • This description is valid for the the commands:
    CONF_CRYPT_KEYVIDEO_ENC,
    CONF_CRYPT_KEYVIDEO_DEC,
    CONF_CRYPT_KEYAUDIO_ENC,
    CONF_CRYPT_KEYAUDIO_DEC
  • The numeric descriptor contains the number of the coder instance (absolute)
  • Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
CONF_CRYPT_KEYAUDIO_DEC
  Tag code    NumDes    Message    SNMP Support  
  0x09ff   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_serv   set key for AES Audio data encryption/decryption  
 
  Write   p_octet   l_serv   set key for AES encryption/decryption of audio data see detailed description  
 
Payload Structure
16 32
Key
16 Bytes ...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
  • This description is valid for the the commands:
    CONF_CRYPT_KEYVIDEO_ENC,
    CONF_CRYPT_KEYVIDEO_DEC,
    CONF_CRYPT_KEYAUDIO_ENC,
    CONF_CRYPT_KEYAUDIO_DEC
  • The numeric descriptor contains the number of the coder instance (absolute)
  • Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
CONF_CRYPT_KEYVIDEO_DEC
  Tag code    NumDes    Message    SNMP Support  
  0x0a00   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_serv   set key for AES Video dataencryption/decryption  
 
  Write   p_octet   l_serv   set key for AES encryption/decryption of video data see detailed description  
 
Payload Structure
16 32
Key
16 Bytes ...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
  • This description is valid for the the commands:
    CONF_CRYPT_KEYVIDEO_ENC,
    CONF_CRYPT_KEYVIDEO_DEC,
    CONF_CRYPT_KEYAUDIO_ENC,
    CONF_CRYPT_KEYAUDIO_DEC
  • The numeric descriptor contains the number of the coder instance (absolute)
  • Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
CONF_CRYPT_KEY_GENERATE_ALL
  Tag code    NumDes    Message    SNMP Support  
  0x0a13   no   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   returns flag=0 when all key are cleared otherwise flag=1  
 
  Write   f_flag   l_serv   generates a random key(flag=1) or clears all(flag=0) keys for AES encryption for all media encoders  
 
CONF_UNIT_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0024   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the unit name  
 
  Write   p_unicode (max 32 unicode character)   l_serv   set unit name  
 
CONF_UNIT_ID
  Tag code    NumDes    Message    SNMP Support  
  0x0025   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the unit ID  
 
  Write   p_unicode (max 32 unicode character)   l_serv   set unit ID  
 
CONF_CAMNAME
  Tag code    NumDes    Message    SNMP Support  
  0x0019   video line   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the camera name  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the camera name  
 
CONF_CAMNAME2
  Tag code    NumDes    Message    SNMP Support  
  0x0a7e   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the camera name2  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the camera name2  
 
CONF_HARDWARE_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x002e   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the hardware version  
 
  Write   void   noprot   not supported  
 
CONF_SOFTWARE_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x002f   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the software version  
 
  Write   void   noprot   not supported  
 
CONF_BOOTLOADER_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x09ef   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the bootloader version  
 
  Write   t_dword   noprot   not supported  
 
CONF_STARTPAGE_BACKGROUND_URL
  Tag code    NumDes    Message    SNMP Support  
  0x028d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the URL of the startpage' background image (max 64 char)  
 
  Write   p_string   l_serv   set the URL of the startpage' background image (max 64 char)  
 
CONF_STARTPAGE_LOGO_URL
  Tag code    NumDes    Message    SNMP Support  
  0x028e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the URL of the startpage' OEM logo image (max 64 char)  
 
  Write   p_string   l_serv   set the URL of the startpage' OEM logo image (max 64 char)  
 
CONF_STARTPAGE_PRESENTATION_SWITCHES
  Tag code    NumDes    Message    SNMP Support  
  0x028f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get switches for HTML startpage presentation (usage is up the the user)  
 
  Write   t_dword   l_serv   set switches for HTML startpage presentation (usage is up the the user)  
 
CONF_DYNAMIC_HTML_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0298   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the name for a dynamic HTML page (num range 1..4)  
 
  Write   p_string   l_user   set the name for a dynamic HTML page (num range 1..4) (max. 19 char)  
 
CONF_DYNAMIC_HTML_DATA
  Tag code    NumDes    Message    SNMP Support  
  0x0299   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   set the data(content) for a dynamic HTML page (num range 1..4) (max. 2048 char)  
 
  Write   p_octet   l_user   set the data(content) for a dynamic HTML page (num range 1..4) (max. 2048 char)  
 
CONF_BROWSER_LANGUAGE_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x01e3   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read current set browser language  
 
  Write   t_octet   l_serv   set browser language (numbering depends on toolkit implementation)  
 
CONF_BROWSER_DATETIME_FORMAT_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x01e9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read browser date/time format  
 
  Write   t_octet   l_serv   set browser date/time format (1=Europe, 2=USA, 3=Japan)  
 
CONF_DATE_WDAY
  Tag code    NumDes    Message    SNMP Support  
  0x0027   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   "Sunday" ... "Saturday"; read the weekday according to the systems date setting  
 
  Write   void   l_serv   not supported  
 
CONF_DATE_DAY
  Tag code    NumDes    Message    SNMP Support  
  0x0028   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet or p_string (2 chars length)   noprot   read the day of week  
 
  Write   t_octet   l_serv   set the day of week, not supported while recording is running  
 
CONF_DATE_MONTH
  Tag code    NumDes    Message    SNMP Support  
  0x0029   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet and p_string (2 chars length)   noprot   read the month  
 
  Write   t_octet   l_serv   set the month, not supported while recording is running  
 
CONF_DATE_YEAR
  Tag code    NumDes    Message    SNMP Support  
  0x002a   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word and p_string (4 chars length)   noprot   read the year  
 
  Write   t_word   l_serv   xx set the year; century needed, not supported while recording is running  
 
CONF_TIME_HRS
  Tag code    NumDes    Message    SNMP Support  
  0x002d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet and p_string (2 chars length)   noprot   read the hours  
 
  Write   t_octet   l_serv   set the hours, not supported while recording is running  
 
CONF_TIME_MIN
  Tag code    NumDes    Message    SNMP Support  
  0x002c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet and p_string (2 chars length)   noprot   read the minutes  
 
  Write   t_octet   l_serv   set the minutes, not supported while recording is running  
 
CONF_TIME_SEC
  Tag code    NumDes    Message    SNMP Support  
  0x002b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet and p_string (2 chars length)   noprot   read the seconds  
 
  Write   t_octet   l_serv   set the seconds, not supported while recording is running  
 
CONF_TIMEZONE
  Tag code    NumDes    Message    SNMP Support  
  0x024e   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   the timezone in which the unit has to operate (GMT +- nbr of seconds +- nbr of seconds DLS), read only version 2.50  
 
  Write   t_int   l_serv   the timezone in which the unit has to operate (GMT +- nbr of seconds +- nbr of seconds DLS), read only since version 2.50  
 
CONF_UTC_ZONEOFFSET
  Tag code    NumDes    Message    SNMP Support  
  0x031f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   the timezone in which the unit has to operate (GMT +- nbr of seconds)  
 
  Write   t_int   l_serv   the timezone in which the unit has to operate (GMT +- nbr of seconds)  
 
CONF_NTP_SERVER_IP_STR
  Tag code    NumDes    Message    SNMP Support  
  0x024f   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   reads the time servers ip address in "xxx.xxx.xxx.xxx" used to sync time from  
 
  Write   p_string   l_serv   sets the server ip in "xxx.xxx.xxx.xxx" to sync time from, not supported while recording is running  
 
CONF_DAY_LIGHT_SAVE_TIME_TABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0987   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read 20 entries for daylight save time: UTC time in sec since 2000 (4byte) and associated offset in sec (4 signed bytes), unused entries have to be filled with zero  
 
  Write   p_octet   l_serv   write 20 entries for daylight save time: UTC time in sec since 2000 (4byte) and associated offset in sec (4 signed bytes), unused entries have to be filled with zero  
 
CONF_DAY_LIGHT_SAVE_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0988   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   read the currently used day light save time offset in seconds  
 
  Write   t_int   l_serv   write the day light save time offset in seconds; the device updates this from DAY_LIGHT_SAVE_TIME_TABLE to show current offset used  
 
CONF_FORCE_TIME_SET
  Tag code    NumDes    Message    SNMP Support  
  0x0a0f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read the time, 8 bytes payload, offset 0: year (word); offset 2: month (octet); offset 3: day (octet); offset 4: hrs (octet); offset 5: min (octet); offset 6: sec (octet); offset 7: reserved (octet)  
 
  Write   p_octet   l_serv   set the time, if recording is running it will be stopped and restarted, parameter 8 bytes payload, offset 0: year (word); offset 2: month (octet); offset 3: day (octet); offset 4: hrs (octet); offset 5: min (octet); offset 6: sec (octet); offset 7: reserved (octet)  
 
CONF_PASSWORD_SETTINGS
  Tag code    NumDes    Message    SNMP Support  
  0x028b   password level   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   get the unit password (scrambled). num parameter sets the password levels; 1=user, 2=service, 3=live  
 
  Write   p_string   l_serv   set the unit password. num parameter sets the password levels; 1=user, 2=service, 3=live  
 
CONF_REMOTE_PASSWORD
  Tag code    NumDes    Message    SNMP Support  
  0x010c   destination IP number   no   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not supported  
 
  Write   p_string   l_serv   deposit the password of the called station  
 
CONF_MASTERPWD_CHALLENGE
  Tag code    NumDes    Message    SNMP Support  
  0x013f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   generates an password challenge which has to be passed to the operator for password reset  
 
  Write   p_string   noprot   not supported  
 
CONF_NBR_OF_TEMP_SENS
  Tag code    NumDes    Message    SNMP Support  
  0x09c4   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   the number of temperature sensors  
 
  Write   t_dword   noprot   not supported  
 
CONF_TEMP_SENS
  Tag code    NumDes    Message    SNMP Support  
  0x09c5   temperature sensor   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   value of the temperature sensor specified by numdes  
 
  Write   t_dword   noprot   not supported  
 
CONF_REDUNDANT_POWER
  Tag code    NumDes    Message    SNMP Support  
  0x09d7   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   reads the redundant power settings 0=off, 1=on  
 
  Write   t_dword   l_serv   sets the redundant power 0=off, 1=on  
 
CONF_POWER_SUPPLY
  Tag code    NumDes    Message    SNMP Support  
  0x09dd   no   yes   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   bit field of power supplies (supply n: supplybits = 1<<(n-1))  
 
  Write   t_dword   l_serv   bit field of power supplies (supply n: supplybits = 1<<(n-1))  
 
CONF_NBR_OF_FANS
  Tag code    NumDes    Message    SNMP Support  
  0x09d5   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   reads the number of fans  
 
  Write   t_dword   l_serv   not supported  
 
CONF_FAN_SPEED
  Tag code    NumDes    Message    SNMP Support  
  0x09d6   fan number   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   fan speed in RPM  
 
  Write   t_dword   l_serv   not supported  
 
CONF_MINIMUM_FAN_SPEED
  Tag code    NumDes    Message    SNMP Support  
  0x09de   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   minimum fan speed in RPM  
 
  Write   t_dword   l_serv   minimum fan speed in RPM  
 
CONF_BOOT_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x09e3   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_user   100 if booted  
 
  Write   t_dword   l_serv   not supported  
 
CONF_UPLOAD_PROGRESS
  Tag code    NumDes    Message    SNMP Support  
  0x0701   -   yes (Message only)   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   -   noprot   see detailed description  
 
Payload Structure
Progress
1 Byte
8
Progress
informs about current progress of an upload or possible error states
Values
progress in percent 1 ... 100
header error 101
write error 102
read back error 103
verify error 104
checksum mismatch (read back flash content vs. written data) 105
checksum mismatch (announced in header vs. received data) 106
magic error 110
version too low 111
flash type incompatible 112
device check failed 113
file entry marker failed 114
chunk size error 115
invalid file name 130
ROM init error 131
ROM write error 132
ROM close error 133
socket error 134
overflow error 135
final flush error 136
Values in the range of 1 ... 100 represent the upload progress in percent. Other values need to be handled as error during the upload and inform about the kind of the error that was encountered during the upload.
CONF_VIPROC_ID
  Tag code    NumDes    Message    SNMP Support  
  0x0803   video line   yes   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the viproc interface id (0:= no viproc)  
 
  Write   t_dword   l_serv   not supported  
 
CONF_VIPROC_ONOFF
  Tag code    NumDes    Message    SNMP Support  
  0x0800   video line   no   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   reads the VCA status 0=off, 1=on. command is obsolete with firmware 4.0 and replaced by VIPROC_MODE.  
 
  Write   flag   l_serv   switches on/off the video content analysis (VCA). command is obsolete with firmware 4.0 and replaced by VIPROC_MODE.  
 
CONF_VIPROC_CUSTOM_PARAMETERS
  Tag code    NumDes    Message    SNMP Support  
  0x0802   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   reads the video content analysis (VCA) custom parameters, payload is beyond the scope of this document  
 
  Write   p_octet   l_serv   sets the VCA custom parameters, payload is beyond the scope of this document  
 
CONF_VIPROC_DLL_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0804   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   reads the name of currently selected VCA component  
 
  Write   p_string   l_serv   specify the name of the VCA component  
 
CONF_VIPROC_DLL_NAME_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x0808   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   list of available viproc algorithm names  
 
  Write   p_string   l_serv   not supported  
 
CONF_VIPROC_DLL_RELOAD
  Tag code    NumDes    Message    SNMP Support  
  0x0809   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   not supported  
 
  Write   flag   l_serv   reload the viproc/VCA component  
 
CONF_VIPROC_SAVE_REFERENCE_IMAGE
  Tag code    NumDes    Message    SNMP Support  
  0x0805   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   not supported  
 
  Write   f_flag   l_serv   triggers the VCA to create a reference image, but only if NOT a dome camera is used  
 
CONF_VIPROC_REFERENCE_IMAGE_FILENAME
  Tag code    NumDes    Message    SNMP Support  
  0x0806   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   reads the current reference image filename  
 
  Write   p_string   l_serv   not supported  
 
CONF_START_VIPROC_CONFIG_EDITING
  Tag code    NumDes    Message    SNMP Support  
  0x0a38   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   not supported  
 
  Write   t_dword   l_serv   Moves to the dome to the scene corresponding to the specified config and freezes the dome there. If already a config is in configuration mode, this command returns with a dword of 0. All subsequent viproc commands are related to this configuration. This command works also for non-dome devices. There it won't try to move the dome to the corresponding scene.  
 
CONF_STOP_VIPROC_CONFIG_EDITING
  Tag code    NumDes    Message    SNMP Support  
  0x0a39   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   not supported  
 
  Write   t_dword   l_serv   Stops editing of the specified config (see CONF_START_VIPROC_CONFIG_EDITING). If the specified scene does not match the currently edited config, a dword with value 0 is returned.  
 
CONF_CONT_VIPROC_CONFIG_EDITING
  Tag code    NumDes    Message    SNMP Support  
  0x0a3a   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   not supported  
 
  Write   t_dword   l_serv   Configuration of a config stops automatically after 20 seconds. This command can be used to keep configuration active for another 20 seconds. If the specified config is currently not in configuration mode, the command replys with a dword of 0.  
 
CONF_VIPROC_SCENE
  Tag code    NumDes    Message    SNMP Support  
  0x0a3b   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the scene for which the active config is defined.  
 
  Write   t_dword   l_serv   writes the scene number of the active viproc configuration  
 
CONF_NUMBER_OF_VIPROC_CONFIGS
  Tag code    NumDes    Message    SNMP Support  
  0x0a3c   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of configurations for the specified line.  
 
  Write   t_dword   l_serv   -  
 
CONF_ACTIVE_VIPROC_CONFIG
  Tag code    NumDes    Message    SNMP Support  
  0x0a3f   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the config id activated by bool engine.  
 
  Write   t_dword   l_serv   Sets the specified config ID as active. The command has only an effect, if the VIPROC_MODE is set to SCRIPT mode (0xff). this command is not available on a gen4 dome.  
 
CONF_LOADED_VIPROC_CONFIG
  Tag code    NumDes    Message    SNMP Support  
  0x0a3d   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the currently loaded config id.  
 
  Write   t_dword   l_serv   cannot be written.  
 
CONF_VIPROC_CONFIG_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0a40   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   returns the name of the currently active viproc configuration.  
 
  Write   p_unicode   l_serv   writes the name of the currently active viproc configuration. The name can have at most 15 unicode characters.  
 
CONF_LIST_OF_VIPROC_SCENES
  Tag code    NumDes    Message    SNMP Support  
  0x0a41   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   this command works only for Gen4 autodomes. It returns the list of defined scenes together with their names. Thereby the first byte specifies the scene number, followed by the length L of the scene name. The next L bytes belong to the scene name in unicode without 0 termination. This structure repeats until either the payload ends or the scene number is zero.  
 
  Write   t_dword   l_serv   -  
 
CONF_VIPROC_TAGGED_CONFIG
  Tag code    NumDes    Message    SNMP Support  
  0x0a42   video line   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read a list of viproc items in an atomar way. see detailed description .  
 
  Write   p_octet   l_serv   writes any viproc commands in an atomar way. see detailed description .  
 
This command is an extension of the already existing RCP+ commands CONF_VIPROC_DLL_NAME, CONF_VIPROC_ONOFF, CONF_VIPROC_SCENE, CONF_VIPROC_CONFIG_NAME, CONF_VIPROC_CUSTOM_PARAMETERS, CONF_VCD_OPERATOR_PARAMS, CONF_VIPROC_ALARM_MASK, CONF_VIPROC_ALARM_AGGREGATION_TIME, and CONF_VIPROC_MOTION_DEBOUNCE_TIME. Each of these commands can only access one specific item of the currently active viproc configuration. The new command allows an atomic access to an arbitrary subset of configuration items, not only of the currently active one but of any configuration of a line.
The payload has a tag structure which is as follows:
4 6 8 8+Length1
Config ID
4 Bytes		 Tag1
2 Bytes		 Length1
2 Bytes		 Payload1
Length1 Bytes		 Tag2
2 Bytes		 Length2
2 Bytes		 Payload2
Length2 Bytes		 ... 0
4 Bytes
RCP Payload
N Bytes
where Config ID is an integer between 1 and the maximum number of configurations available for this line (this maximum number can be retrieved by the command CONF_NUMBER_OF_VIPROC_CONFIGS).
Num Value
The num value of the RCP command selects the video line to which the configuration belongs.
Return Value
For a read operation, payload of tags within the request are ignored. The reply payload contains all tags in the same order as in the request, however the size of the tags is adapted to fit the size of each item. If the structure of the request is invalid or an unknown tag is included, the command will fail.
For a write operation, the payload of tags must fit the size of the corresponding items. If this is not the case, the command will fail. If the CONF_VIPROC_CUSTOM_PARAMETERS and CONF_VCD_OPERATOR_PARAMS items are written for the currently active configuration, they are checked by the currently active viproc and ruleengine algorithms. If they are not accepted, the corresponding algorithm is set to default mode and the default parameters are put into the reply. To summarize, a write operation is successful, if the RCP+ command succeeds and the reply payload is identical to the request payload.
Tags
Values:
CONF_VIPROC_DLL_NAME
CONF_VIPROC_ONOFF
CONF_VIPROC_SCENE
CONF_VIPROC_CONFIG_NAME
CONF_VIPROC_CUSTOM_PARAMETERS
CONF_VCD_OPERATOR_PARAMS
CONF_VIPROC_ALARM_MASK
CONF_VIPROC_ALARM_AGGREGATION_TIME
CONF_VIPROC_MOTION_DEBOUNCE_TIME
Length
The length of the payload depends on the data type of the corresponding tag. The payload of a tag must be in network byte-order.
Values:
F_FLAG 1
T_WORD 2
T_DWORD 4
P_STRING string length
P_OCTET buffer length
The payload of a tag must be in network byte-order.
Example
The following payload example contains a configuration for the first configuration of a line. It consists of two tags, the first describing the CONF_VIPROC_CONFIG_NAME item, the second describing the CONF_VIPROC_ONOFF item.
4 6 8 15 17 19 20 24
Config ID
4 Bytes		 Tag1
2 Bytes		 Length1
2 Bytes		 Payload1
7 Bytes		 Tag2
2 Bytes		 Length2
2 Bytes		 Payload2
1 Byte		 0
4 Bytes
0x00 0x00 0x00 0x01 0x08 0x04 0x00 0x07 "viproc" 0x08 0x00 0x00 0x01 0x01 0x00 0x00 0x00 0x00
RCP Payload
N Bytes
CONF_VIPROC_TAGGED_CONFIG_INTERNAL
  Tag code    NumDes    Message    SNMP Support  
  0x0a43   video line   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read a list of viproc items in an atomar way.  
 
  Write   p_octet   l_serv   writes any viproc commands in an atomar way.  
 
CONF_VIPROC_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x0807   video line   yes   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_serv   message only  
 
Payload Structure
16 32
Alarm Flags
2 Byte		 Detector
2 Byte
ConfigId
1 Byte
8 24
Alarm Flags
The message is sent whenever any of the bit values changes. Additionally it is sent once per 10 seconds when any of the bits is set and if a new client registers to the message.
Values:
Bit01Motion flag
Bit02global change flag
Bit03signal too bright flag
Bit04signal too dark flag
Bit05signal too noisy flag
Bit06image too blurry flag
Bit07signal loss flag
Bit08reference image check failed flag
Bit09invalid configuration flag
Detector
State of the detectors. The LSB corresponds to detector one.
ConfigId
Identifcation number of the VCA profile caused this alarm.
CONF_AUPROC_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x0a79   audio line   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   message only, see detailed description  
 
  Write   p_octet   l_serv   message only  
 
Payload Structure
16 32
Alarm Flags
4 Byte
8 24
Alarm Flags
The message is sent whenever any of the bit values changes. Additionally it is sent once per second when any of the bits is set.
Values:
Bit01Frequency band 0-220 Hz
Bit02Frequency band 110-360 Hz
Bit03Frequency band 220-500 Hz
Bit04Frequency band 360-690 Hz
Bit05Frequency band 500-890 Hz
Bit06Frequency band 690-1110 Hz
Bit07Frequency band 890-1375 Hz
Bit08Frequency band 1110-1690 Hz
Bit09Frequency band 1375-2030 Hz
Bit10Frequency band 1690-2420 Hz
Bit11Frequency band 2030-2875 Hz
Bit12Frequency band 2420-3400 Hz
Bit13Frequency band 2875-4000 Hz
Bit14Entire frequency band
Bit15-32 are unused and should be zero.
CONF_AUPROC_CONFIG
  Tag code    NumDes    Message    SNMP Support  
  0x0a7a   yes (audio line)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read configuration of AUPROC  
 
  Write   p_octet   l_serv   write configuration of AUPROC  
 
Payload Structure
16 32
Version
4 Byte
Trigger Level
16 Byte



Sensitivity
16 Byte



unused
1 Byte		 Flags
1 Byte		 reserved
2 Byte
8 24
Version
Unused.
Trigger Level
16 Values between 0 and 255 (1 Byte each), setting the fixed threshold for every frequency band and energy level.
First Byte is for the lowest frequency and the last for the energy level. Trigger level 0 indicates that this requency band is set off.
Sensitivity
16 Values between 1 and 100 (1 Byte each), setting the sensitivity for every frequency band and energy level.
First Byte is for the lowest frequency and the last for the energy level.
Flags
1 Byte for flags is reserved. The highest bit indicates audio alarm onoff.
Values:
Bit 8OnOff flag
CONF_AUPROC_MELPEGEL
  Tag code    NumDes    Message    SNMP Support  
  0x0a7b   yes (audio line)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read the recent pegel in the frequency bands: detailed decription  
 
  Write   p_octet   l_serv   not supported  
 
Payload Structure
16 32
recent melpegel
16 Byte



adaptive threshold level
16 Byte



CONF_AUPROC_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0a7c   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   returns the name of the audio analysis  
 
  Write   p_unicode   l_serv   set the name of the audio analysis  
 
CONF_VIPROC_ALARM_MASK
  Tag code    NumDes    Message    SNMP Support  
  0x0a23   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read which of the 32 bits produced by the viproc+ruleengine are considered for the CONF_VIPROC_ALARM. see CONF_VIPROC_ALARM for the meaning of the 32 bits.  
 
  Write   p_octet   l_serv   configures which of 32 bits produced by the viproc+ruleengine are considered for the CONF_VIPROC_ALARM see CONF_VIPROC_ALARM for the meaning of the 32 bits.  
 
CONF_VIPROC_CONFIG_CHANGE_IN_RECORDING
  Tag code    NumDes    Message    SNMP Support  
  0x0a60   video line   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   If the recording module detects a viproc configuration change, it sends this message. The payload of the message has the following structure: 8 Bytes - UTC timestamp int Time64 format, 1 Byte - config ID, 16 Bytes - MD5 Hash of the configuration.  
 
  Write   p_octet   l_serv   -  
 
CONF_VIPROC_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0a65   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   octet   noprot   switches between silent motion(0)/manual(1..10)/off(0xfd)/scheduler(0xfe)/script mode(0xff) of the video content analysis (VCA). Returns current loaded id, if a dome is connected (if vca is turned off then 0xfd is returned).  
 
  Write   octet   l_serv   switches between silent motion(0)/manual(1..10)/off(0xfd)/scheduler(0xfe)/script mode(0xff) of the video content analysis (VCA). On the gen4 dome, the modes 0xfe and 0xff are not supported. Any value between 1 and 10 is interpreted as on.  
 
CONF_VIPROC_WEEKLY_SCHEDULE
  Tag code    NumDes    Message    SNMP Support  
  0x0a66   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Returns the weekly VCA schedule of the specified line. The format of the payload is the same as the one of the CONF_HD_RECORD_SCHEDULE command.  
 
  Write   p_octet   l_serv   Sets the weekly VCA schedule of the specified line. The format of the payload is the same as the one of the CONF_HD_RECORD_SCHEDULE command.  
 
CONF_VIPROC_HOLIDAYS_SCHEDULE
  Tag code    NumDes    Message    SNMP Support  
  0x0a67   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Returns the holidays VCA schedule of the specified line. The format of the payload is the same as the one of the CONF_HD_RECORD_HOLIDAYS command.  
 
  Write   p_octet   l_serv   Sets the holidays VCA schedule of the specified line. The format of the payload is the same as the one of the CONF_HD_RECORD_HOLIDAYS command.  
 
CONF_PTZ_CONTROLLER_AVAILABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0a51   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   returns true if for the specified line a ptz controller is available which can be used by the VCA module.  
 
  Write   flag   l_serv   is set to true if for the specified line a ptz controller is available which can be used by the VCA module.  
 
CONF_ENABLE_VCA
  Tag code    NumDes    Message    SNMP Support  
  0x0813   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   This command is used to configure the dome. Note that we write the information in the second bit of ptz_controller_available.  
 
  Write   flag   l_serv   This command is used to configure the dome. Note that we write the information in the second bit of ptz_controller_available.  
 
CONF_VIPROC_ALARM_AGGREGATION_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0aca   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read the alarm aggregation time of the video line (4,3s == 43). Note, this parameter belongs to a viproc config.  
 
  Write   t_octet   l_serv   write the duration of the alarm aggregation of the video line (1,6sec == 16). Note, this parameter belongs to a viproc config.  
 
CONF_VIPROC_MOTION_DEBOUNCE_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0acb   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read the motion alarm debounce time of the video line (4,3s == 43). Note, this parameter belongs to a viproc config.  
 
  Write   t_octet   l_serv   write the duration of the motion alarm debounce time of the video line (1,6sec == 16). Note, this parameter belongs to a viproc config.  
 
CONF_VIPROC_RESET
  Tag code    NumDes    Message    SNMP Support  
  0x0a86   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   not supported  
 
  Write   f_flag   l_serv   Reset the viproc algorithm  
 
CONF_VIPROC_INSERT_CONFIG_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x0a87   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   not supported  
 
  Write   p_octet   l_serv   Insert configuration information into the VCD stream of the VCA algorithm. This data will be added after the next FrameInfoTag of the output stream.  
 
CONF_VIPROC_VIDEO_FORMAT
  Tag code    NumDes    Message    SNMP Support  
  0x0a88   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Get the VCA video format  
 
  Write   p_octet   l_serv   Set the VCA video format  
 
This command reads or writes the video format parameters for the viproc algorithm. The payload components are also part of the ENC_META_FRAME_INFO struct (see viproc_frame_info.h).
The payload has the following structure:
4 8 12 16
Rows
4 Bytes		 Columns
4 Bytes		 StrideLuma
4 Bytes		 StrideChroma
4 Bytes
SkipRatio
4 Bytes		 FieldMode
4 Bytes		 PicFreqNum
4 Bytes		 PicFreqDenom
4 Bytes
AspectX
4 Bytes		 AspectY
4 Bytes		 ColorMode
4 Bytes		 ChromaSubRate
4 Bytes
FieldMode
Values:
0: progressive
1: interlaced top field first
ColorMode
Values:
0: YUV
1: HSV
ChromaSubRate
Values:
0: 4:4:4
1: 4:2:2
2: 4:2:0
3: 4:1:1
CONF_VCA_TASK_RUNNING_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x0a96   yes (camera line input number)   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   returs the current processing state of the VCA engine; TRUE when vca engine is running with no problems; FALSE if vca engine lack cpu performance  
 
  Write   -   l_serv   not supported  
 
CONF_VIPROC_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x0ab2   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   viproc interface version on FPGA VCA devices  
 
  Write   p_octet   l_serv   viproc interface version on FPGA VCA devices  
 
CONF_HEARTBEAT
  Tag code    NumDes    Message    SNMP Support  
  0x0ab1   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get heartbeat  
 
  Write   t_dword   l_serv   get heartbeat  
 
CONF_OEM_DEVICE_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x097c   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the oem device name  
 
  Write   p_string   l_serv   not supported  
 
CONF_OEM_EXT_ID
  Tag code    NumDes    Message    SNMP Support  
  0x097d   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   get the oem extension id  
 
  Write   t_octet   l_serv   not supported  
 
CONF_OEM_DEVICE_DOMAIN
  Tag code    NumDes    Message    SNMP Support  
  0x09e9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the oem device domain  
 
  Write   p_string   l_serv   get the oem device domain  
 
CONF_DEFAULTS
  Tag code    NumDes    Message    SNMP Support  
  0x093d   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   -   noprot   not supported  
 
  Write   flag   l_serv   sets config to default values exept IP,mcIP,subnet and gateway, reset is necessary to apply all default settings  
 
CONF_FACTORY_DEFAULTS
  Tag code    NumDes    Message    SNMP Support  
  0x09a0   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   -   noprot   not supported  
 
  Write   flag   l_serv   set the configuration to factory defaults and reset the board  
 
CONF_BOARD_RESET
  Tag code    NumDes    Message    SNMP Support  
  0x0811   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   not supported  
 
  Write   flag   l_serv   reset the board  
 
CONF_BOOT_DEFAULT_APP
  Tag code    NumDes    Message    SNMP Support  
  0x099f   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   not supported  
 
  Write   flag   l_serv   boot the default application  
 
CONF_VIDEO_TX_BITRATE_REQUEST
  Tag code    NumDes    Message    SNMP Support  
  0x0301   {   if (!SessionID)   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   %   l_serv   %  
 
CONF_VIDEO_ENC_PRIO
  Tag code    NumDes    Message    SNMP Support  
  0x0a81   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   reads the video encoder priorisation 0:= no, 1:=h26x, 2:=jpeg  
 
  Write   t_dword   l_serv   writes the video encoder priorisation 0:=no, 1:=h26x, 2:=jpeg, 3:=h26x_2nd stream  
 
CONF_LED_BLINKING
  Tag code    NumDes    Message    SNMP Support  
  0x013d   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   always 1  
 
  Write   flag   noprot   1=power LED will flash for 7 sec  
 
CONF_JPEG
  Tag code    NumDes    Message    SNMP Support  
  0x099e   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_live   20 byte write payload: byte1: 0=QCIF, 1=CIF, 2=2CIF 3=4CIF; byte1:jpeg quality (0 is best); byte2,3 reserved; bytes 4-15: 3 int values for lastdc offset YUV, 16:=borderY, 17:=borderU, 18:= border V, 19:= borderWidth; (only on request allowed, cmd fails if a previous request is still in work)  
 
  Write   not supported   l_live   -  
 
CONF_CLUSTER_GROUP_SETTING
  Tag code    NumDes    Message    SNMP Support  
  0x09ca   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   list of (DWORD ip, DWORD flags, OCTET[6] mac, WORD reserved) cluster members including this unit  
 
  Write   p_octet   noprot   list of (DWORD ip, DWORD flags, OCTET[6] mac, WORD reserved) cluster members including this unit  
 
CONF_CLUSTER_ID
  Tag code    NumDes    Message    SNMP Support  
  0x09cb   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the logical position inside a cluster (0=stand alone, >0=slot nbr.)  
 
  Write   t_dword   l_serv   not supported  
 
CONF_APP_OPTION
  Tag code    NumDes    Message    SNMP Support  
  0x09e0   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   reads if optional packages has been activated  
 
  Write   void   l_serv   not supported  
 
CONF_APP_OPTION_UNIT_ID
  Tag code    NumDes    Message    SNMP Support  
  0x09e1   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read out the unique unit id (installation code) for setting application options  
 
  Write   void   l_serv   not supported  
 
CONF_APP_OPTION_SET
  Tag code    NumDes    Message    SNMP Support  
  0x09e2   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   returns a readable string with the result code of the last applied set option  
 
  Write   p_string   l_serv   a key, generated by the license server to enable a specific application option; after entering a key, the APP_OPTION command returns the current activated application options  
 
CONF_CPU_LOAD_IDLE
  Tag code    NumDes    Message    SNMP Support  
  0x0a06   host=1, coproc=2   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   cpu load idle in percent  
 
  Write   t_dword   l_serv   not supported  
 
CONF_CPU_LOAD_CODER
  Tag code    NumDes    Message    SNMP Support  
  0x0a07   host=1, coproc=2   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   cpu load coder in percent  
 
  Write   t_dword   l_serv   not supported  
 
CONF_CPU_LOAD_CODER_INST
  Tag code    NumDes    Message    SNMP Support  
  0x0a7d   host=1, coproc=2   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   cpu load of coder inst in percent (array of 13 bytes: 4 coder lines, each line has 3 coder instances, one entry for scaler)  
 
  Write   p_octet   l_serv   not supported  
 
CONF_CPU_LOAD_VCA
  Tag code    NumDes    Message    SNMP Support  
  0x0a08   host=1, coproc=2   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   cpu load vca in percent  
 
  Write   t_dword   l_serv   not supported  
 
CONF_CPU_LOAD
  Tag code    NumDes    Message    SNMP Support  
  0x0a0a   host=1, coproc=2   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   cpu load vca in percent (byte 0=idle, byte 1 = coder, byte 2=vca)  
 
  Write   p_octet   l_serv   not supported  
 
CONF_CPU_COUNT
  Tag code    NumDes    Message    SNMP Support  
  0x0a09   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   number of cpus  
 
  Write   t_dword   l_serv   not supported  
 
CONF_SANITY_CHECK
  Tag code    NumDes    Message    SNMP Support  
  0x09da   no   yes   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read the array of sanity bits (bit0: hdd, bit1: device error host, bit2: device error coproc)  
 
  Write   p_octet   l_serv   set the array of sanity bits (bit0:hdd)  
 
CONF_NIGHT_MODE_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x0aa2   -   yes   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=night mode off; 1=night mode on (only for devices supporting night mode)  
 
  Write   void   l_serv   not supported  
 
CONF_MPEG_AUDIO_SAMPLING_FREQ
  Tag code    NumDes    Message    SNMP Support  
  0x0932   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   mpeg audio sampling frequency (Hz)  
 
  Write   t_dword   l_serv   not supported  
 
CONF_MPEG4_CURRENT_PARAMS
  Tag code    NumDes    Message    SNMP Support  
  0x0600   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the current profile preset number for the specified encoder (NumDesc)  
 
  Write   t_dword   l_serv   sets the video encoder (given by NumDesc) to a preset (payload)  
 
CONF_MPEG4_CURRENT_PARAMS_REL_CODER
  Tag code    NumDes    Message    SNMP Support  
  0x061c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get the current profile preset number for the specified encoder (relative to line).  
 
  Write   p_octet   l_serv   sets the video encoder (relative to line) to a preset.  
 
Payload Structure
16 32
Line
1 Byte		 Coder
1 Byte		 Coding Capabilities
2 Bytes
Preset
1 Byte		 Reserved
1 Byte		 Reserved
1 Byte		 Reserved
1 Byte
8 24
Line
Video input line
Coder
Relative coder number (relative to line)
Coding Capabilities
Coding capabilities of encoder.
All coding capabilities are one or multiple of:
Values:
H.2630x0002
Mpeg 40x0004
Mpeg 20x0008
H.2640x0040
Preset
Number of the encoder preset profile
Notes:
When reading the preset profile, the according byte in the payload will be set.
CONF_MPEG4_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0602   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the name of the preset given by the Numeric Descriptor  
 
  Write   p_string   l_serv   sets the name of the preset number given by the Numeric Descriptor  
 
CONF_MPEG4_BANDWIDTH_KBPS
  Tag code    NumDes    Message    SNMP Support  
  0x0607   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   reads the bandwidth of selected preset  
 
  Write   t_dword   l_serv   sets the bandwidth of selected preset  
 
CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT
  Tag code    NumDes    Message    SNMP Support  
  0x0612   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   reads the bandwidth soft limit (in KBPS) of selected preset  
 
  Write   t_dword   l_serv   sets the bandwith soft limit (in KBPS) of selected preset  
 
CONF_MPEG4_BANDWIDTH_KBPS_HARD_LIMIT
  Tag code    NumDes    Message    SNMP Support  
  0x0613   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the bandwidth hard limit (in KBPS) of selected preset  
 
  Write   t_dword   l_serv   sets the bandwidth hard limit (in KBPS) of selected preset  
 
CONF_MPEG4_INTRA_FRAME_DISTANCE
  Tag code    NumDes    Message    SNMP Support  
  0x0604   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the intra frame distance of selected preset  
 
  Write   t_dword   l_serv   sets the intra frame distance of selected preset (not supported while recording is running)  
 
CONF_MPEG4_FRAME_SKIP_RATIO
  Tag code    NumDes    Message    SNMP Support  
  0x0606   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets Mpeg4 frame skip ratio (1=all frames ,...)  
 
  Write   t_dword   l_serv   set Mpeg4 frame skip ratio (1=all frames ,...)  
 
CONF_MPEG4_RESOLUTION
  Tag code    NumDes    Message    SNMP Support  
  0x0608   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the spatial resolution (0=QCIF, 1=CIF, 2=2CIF, 3=4CIF, 4=Custom (1/2 D1), 5=2/3D1) for selected preset  
 
  Write   t_dword   l_serv   sets the spatial resolution (0=QCIF, 1=CIF, 2=2CIF, 3=4CIF, 4=Custom (1/2 D1), 5=2/3D1) for selected preset  
 
CONF_MPEG4_FIELD_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x060e   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   get Mpeg4 field mode (0=progressive, 1=merged, 2=separated)  
 
  Write   t_octet   l_serv   set Mpeg4 field mode (0=progressive, 1=merged field, 2=separated field)  
 
CONF_MPEG4_DEFAULTS
  Tag code    NumDes    Message    SNMP Support  
  0x0601   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not supported  
 
  Write   flag   l_serv   set the selected preset params to the default values (recording has to be stopped, otherwise the iframe distance cannot be set to zero)  
 
CONF_MPEG4_I_FRAME_QUANT
  Tag code    NumDes    Message    SNMP Support  
  0x060a   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the I frame quantizer (1-31,0=auto) for selected preset  
 
  Write   t_dword   l_serv   sets the I frame quantizer (1-31,0=auto) of selected preset  
 
CONF_MPEG4_P_FRAME_QUANT
  Tag code    NumDes    Message    SNMP Support  
  0x060b   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the P frame quantizer (1-31,0=auto) for selected preset  
 
  Write   t_dword   l_serv   sets the P frame quantizer (1-31,0=auto) for selected preset  
 
CONF_MPEG4_PARAMS_MAX_NUM
  Tag code    NumDes    Message    SNMP Support  
  0x0614   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   Number of MPEG4 presets  
 
  Write   %   l_serv   %  
 
CONF_MPEG4_AVC_I_FRAME_QUANT
  Tag code    NumDes    Message    SNMP Support  
  0x0615   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the I frame quantizer (9-51,0=auto) for selected preset  
 
  Write   t_dword   l_serv   sets the I frame quantizer (0=auto,9-51) for selected preset  
 
CONF_MPEG4_AVC_P_FRAME_QUANT
  Tag code    NumDes    Message    SNMP Support  
  0x0616   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the P frame quantizer (9-51,0=auto) for selected preset  
 
  Write   t_dword   l_serv   sets the P frame quantizer (0=auto,9...51) for selected preset  
 
CONF_MPEG4_AVC_P_FRAME_QUANT_MIN
  Tag code    NumDes    Message    SNMP Support  
  0x0620   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the P frame min quantizer (9-51,0=auto) for selected preset  
 
  Write   t_dword   l_serv   sets the P frame min quantizer (0=auto,9...51) for selected preset  
 
CONF_MPEG4_AVC_DELTA_IPQUANT
  Tag code    NumDes    Message    SNMP Support  
  0x0621   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   gets the difference (-10..+10) between I and P-Frame quantization for selected preset  
 
  Write   t_int   l_serv   sets the difference (-10..+10) between I- and P-Frame quantization for selected preset  
 
CONF_MPEG4_AVC_DEBLOCKING_ENABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0617   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_flag   noprot   gets the deblocking filter status for selected preset  
 
  Write   flag   l_serv   enables/disables the H264 deblocking filter  
 
CONF_MPEG4_AVC_DEBLOCKING_ALPHA
  Tag code    NumDes    Message    SNMP Support  
  0x0618   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   gets the alpha coefficient of the H264 deblocking filter for the selected preset  
 
  Write   t_int   l_serv   set the alpha H264 deblocking coefficent (-5...5)  
 
CONF_MPEG4_AVC_DEBLOCKING_BETA
  Tag code    NumDes    Message    SNMP Support  
  0x0619   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   gets the beta coefficient of the H264 deblocking filter for the selected preset  
 
  Write   t_int   l_serv   set the beta H264 deblocking coefficent (-5...5)  
 
CONF_MPEG4_AVC_CHROMA_QUANT_OFF
  Tag code    NumDes    Message    SNMP Support  
  0x061a   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   gets the chroma quantisation offset for the selected preset  
 
  Write   t_int   l_serv   set the chroma quantisation offset (-12...12)  
 
CONF_MPEG4_AVC_CODING_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0a45   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   gets the coding mode of the selected preset ( 0=frame; 1=field; 2=makro block adaptive ff; 3=picture adaptive ff )  
 
  Write   t_octet   l_serv   sets the coding mode for the selected preset ( 0=frame; 1=field; 2=makro block adaptive ff; 3=picture adaptive ff )  
 
CONF_MPEG4_AVC_GOP_STRUCTURE
  Tag code    NumDes    Message    SNMP Support  
  0x0a94   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   gets the GOP structure of the selected preset ( 0=IP; 1=IBP; 2=IBBP; 3=IBBRBP )  
 
  Write   t_octet   l_serv   sets the GOP structure for the selected preset ( 0=IP; 1=IBP; 2=IBBP; 3=IBBRBP )  
 
CONF_MPEG4_AVC_CABAC
  Tag code    NumDes    Message    SNMP Support  
  0x0aa6   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   gets cabac for the selected preset ( 0=off; 1=on )  
 
  Write   t_octet   l_serv   sets cabac for the selected preset ( 0=off; 1=on )  
 
CONF_VIDEO_QUALITY
  Tag code    NumDes    Message    SNMP Support  
  0x0a82   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the video quality for a selected preset (0=auto, 1(worst)..100(best))  
 
  Write   t_dword   l_serv   sets the video quality for a selected preset (0=auto, 1(worst)..100(best))  
 
CONF_JPEG_BANDWIDTH_KBPS
  Tag code    NumDes    Message    SNMP Support  
  0x061d   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the jpeg bandwidth (in KBPS) of selected preset  
 
  Write   t_dword   l_serv   sets the bandwith for jpeg streaming  
 
CONF_JPEG_BANDWIDTH_KBPS_SOFT_LIMIT
  Tag code    NumDes    Message    SNMP Support  
  0x061e   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the jpeg bandwidth soft limit(in KBPS) of selected preset  
 
  Write   t_dword   l_serv   sets the bandwith soft limit for jpeg streaming  
 
CONF_JPEG_BANDWIDTH_KBPS_HARD_LIMIT
  Tag code    NumDes    Message    SNMP Support  
  0x061f   profile preset   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the jpeg bandwidth hard limit(in KBPS) of selected preset  
 
  Write   t_dword   l_serv   sets the bandwith hard limit for jpeg streaming  
 
CONF_VID_ENCODER_ON
  Tag code    NumDes    Message    SNMP Support  
  0x0262   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   =1: video encoder is enabled on establishing a new connection; =0 video encoder is not enabled on establishing a new connection  
 
  Write   flag   l_serv   =1 enables the video encoder on establishing a new connection; =0 disables the video encoder on establishing a new connection  
 
CONF_VIDEO_ENCODER_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x09df   coder instance   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get encoder status (8bytes) 4 (high order) bytes 10*frames per sec, 4 (low order) bytes KBPS  
 
  Write   p_octet   l_serv   not supported  
 
CONF_VIDEO_ENCODER_STATUS_EXT
  Tag code    NumDes    Message    SNMP Support  
  0x0a90   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get encoder status (20 bytes) 1st DWORD: 10*frames per sec, 2nd DWORD: KBPS, 3rd DWORD: nbr of dropped frames by the encoder due to bandwidth or system limitation, 4th DWORD: nbr of lost frames by capture hardware, 5th DWORD nbr of skipped frames as configured in profile  
 
  Write   p_octet   l_serv   not supported  
 
CONF_ENC_GET_SPS_AND_PPS
  Tag code    NumDes    Message    SNMP Support  
  0x0a1d   Coder   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Gets the sequence and picture parameter from H264 encoder  
 
  Write   p_octet   l_serv   not supported  
 
CONF_NAME_STAMP_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x0084   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=name stamping off; 1=name stamping on bottom; 2=name stamping on top; 3=name stamping with custom attributes  
 
  Write   t_octet   l_user   0=set name stamping off; 1=set name stamping on bottom; 2=set name stamping on top; 3=set name stamping with custom attributes which can be set with the CONF_STAMP_ATTR_NAME tag  
 
CONF_TIME_STAMP_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x0085   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=time stamping off; 1=time stamping on bottom; 2=time stamping on top; 3=time stamping with custom attributes  
 
  Write   t_octet   l_user   0=set time stamping off; 1=set time stamping on bottom; 2=set time stamping on top; 3=set time stamping with custom attributes which can be set with the CONF_STAMP_ATTR_TIME tag  
 
CONF_TIME_STAMP_RESOLUTION
  Tag code    NumDes    Message    SNMP Support  
  0x0a7f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=second, 1=ms  
 
  Write   t_octet   l_user   0=second, 1=ms  
 
CONF_ALARM_DISP_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x008e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   1=alarm display off; 2=alarm display on; 3=alarm stamping with custom attributes  
 
  Write   t_octet   l_serv   1=disable alarm display; 2=enable alarm display; 3=alarm stamping with custom attributes which can be set with the CONF_STAMP_ATTR_ALARM tag  
 
CONF_ALARM_STRING
  Tag code    NumDes    Message    SNMP Support  
  0x0090   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   get the alarm string  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the alarm string  
 
CONF_STAMP_DEC_FREEZE_STRING
  Tag code    NumDes    Message    SNMP Support  
  0x092f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   string displayed on the local monitor if DEC_SHOW_FREEZE is enabled and no vido data is coming in  
 
  Write   p_string   l_serv   string displayed on the local monitor if DEC_SHOW_FREEZE is enabled and no vido data is coming in  
 
CONF_STAMP_ENC_NO_VIDEO_STRING
  Tag code    NumDes    Message    SNMP Support  
  0x0930   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   string displayed on the remote monitor if no video has locked on the encoder  
 
  Write   p_string   l_serv   string displayed on the remote monitor if no video has locked on the encoder  
 
CONF_STAMP_NO_LINK_STRING
  Tag code    NumDes    Message    SNMP Support  
  0x0931   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   string displayed on the local monitor if there is no ethernet link  
 
  Write   p_string   l_serv   string displayed on the local monitor if there is no ethernet link  
 
CONF_STAMP_ATTR_DEC_FREEZE
  Tag code    NumDes    Message    SNMP Support  
  0x0933   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_ATTR_ENC_NO_VIDEO
  Tag code    NumDes    Message    SNMP Support  
  0x0934   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_ATTR_NO_LINK
  Tag code    NumDes    Message    SNMP Support  
  0x0935   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_ATTR_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0936   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_ATTR_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0937   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_ATTR_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x0938   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
  Write   p_octet   l_serv   12 bytes: byte 0= pos x (0-255), byte 1= pos y (0-255), byte 3-11 reserved (set to zero)  
 
CONF_STAMP_WIDTH
  Tag code    NumDes    Message    SNMP Support  
  0x0a93   video line (1,..)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read the width of the current stamping in pixels. See detailed description  
 
  Write   void   l_serv   not supported  
 
Payload Structure
16 32
Stamping Type
2 Byte		 Reserved
2 Byte
Width
4 Byte
8 24
Note: This command can only be read. The payload defines the stamping which should be read
and returns the width in the corresponding field.
Stamping Type
Defines the stamping type of which the width should be determined.
The type can be one of the following:
Values:
Time Stamp0x0001
Name Stamp row 10x0002
Name Stamp row 20x0003
Alarm Stamp0x0004
Info Stamp0x0005
Width
Width of the stamping in pixels (hex)
CONF_VIDEO_CURRENT_PARAMS_CODNBR
  Tag code    NumDes    Message    SNMP Support  
  0x0982   Message : no   Description : get the current profile preset number for the specified encoder (NumDesc)   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   %   l_serv   %  
 
CONF_MAX_NBR_OF_ENC_STREAMS
  Tag code    NumDes    Message    SNMP Support  
  0x029e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   Number of encoder streams  
 
  Write   t_dword   l_serv   read only  
 
CONF_WATERMARK
  Tag code    NumDes    Message    SNMP Support  
  0x0924   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=watermark is disabled; 1=watermark is enabled  
 
  Write   t_octet   l_serv   0=disables watermark; 1=enables watermark  
 
CONF_CODER_VIDEO_OPERATION_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0a9c   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get video operation mode of the coder (given by NumDesc) (1 = h263, 2 = h264 ) (payload)  
 
  Write   t_dword   l_serv   set the coder (given by NumDesc) to a video operation mode (1 = h263, 2 = h264 ) (payload); (has only effect if coder is an video encoder); live connections will be dropped; only applicable if no recording is active  
 
CONF_CODER_VIDEO_OPERATION_OPTION
  Tag code    NumDes    Message    SNMP Support  
  0x0aa4   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the coder (given by NumDesc) to a video option (has only effect if coder is an video encoder) (0 = no options (std), 1 = h.264 compatibility mode )  
 
  Write   t_dword   l_serv   set the coder (given by NumDesc) to a video option (has only effect if coder is an video encoder) (0 = no options (std), 1 = h.264 compatibility mode ); for h.264 compatibility mode, the encoder will automatically switched to h.264 mode  
 
CONF_REQ_FAST_UPDATE
  Tag code    NumDes    Message    SNMP Support  
  0x01d3   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   not supported  
 
  Write   flag   noprot   request a video intra frame, SessionID is mandatory  
 
CONF_MPEG4_INTRA_FRAME_REQUEST
  Tag code    NumDes    Message    SNMP Support  
  0x0605   no   no   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not supported  
 
  Write   t_dword   noprot   request a video intra frame, SessionID is mandatory  
 
CONF_VID_IN_CONTRAST
  Tag code    NumDes    Message    SNMP Support  
  0x092b   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   reads the contrast value (0-255)  
 
  Write   t_octet   l_serv   sets the contrast value (0-255)  
 
CONF_VID_IN_SATURATION
  Tag code    NumDes    Message    SNMP Support  
  0x092c   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   reads the saturation value (0-255)  
 
  Write   t_octet   l_serv   sets the saturation value (0-255)  
 
CONF_VID_IN_BRIGHTNESS
  Tag code    NumDes    Message    SNMP Support  
  0x092a   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   reads the brightness value (0-255)  
 
  Write   t_octet   l_serv   sets the brightness value (0-255)  
 
CONF_VID_IN_WHITE_BALANCE_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0aa8   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   0=Auto White Balance,1=Manual White Balance actual RGB-Gain values are used, see CONF_VID_IN_RGB_GAIN  
 
  Write   t_dword   l_serv   0=Auto White Balance; 1=Manual White Balance actual RGB-Gain values are used, see CONF_VID_IN_RGB_GAIN; 2=Hold AWB actual RGB-Gain values are saved (only possible, if AWB-Mode is active), they can be accessed by CONF_VID_IN_RGB_GAIN  
 
CONF_VID_IN_RGB_GAIN
  Tag code    NumDes    Message    SNMP Support  
  0x0aa9   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   3 bytes: byte 0 =Red gain (0-255); byte 1 =Green gain (0-255), byte 2 =Blue gain (0-255)  
 
  Write   p_octet   l_serv   3 bytes: byte 0 =Red gain (0-255); byte 1 =Green gain (0-255), byte 2 =Blue gain (0-255)  
 
CONF_VID_IN_MIRROR
  Tag code    NumDes    Message    SNMP Support  
  0x0aaa   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=deactivate image mirror; 1=activate image mirror  
 
  Write   flag   l_serv   0=deactivate image mirror; 1=activate image mirror  
 
CONF_VIDEO_TERMINATION_RESISTOR_ON
  Tag code    NumDes    Message    SNMP Support  
  0x0274   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   1=analog video termination resistor is enabled (75 Ohms on); 0=analog video termination resistor is disabled (75 Ohms off)  
 
  Write   flag   l_serv   1=enables the analog video termination resistor (75 Ohms on); 0=disables the analog video termination resistor (75 Ohms off)  
 
CONF_VIDEO_TERMINATION_RESISTOR_OFF
  Tag code    NumDes    Message    SNMP Support  
  0x0275   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   1=analog video termination resistor is disabled (75 Ohms off); 0=analog video termination resistor is enabled (75 Ohms on)  
 
  Write   flag   l_serv   1=disables the analog video termination resistor (75 Ohms off); 0=enables the analog video termination resistor (75 Ohms on)  
 
CONF_VIDEO_INPUT_FORMAT
  Tag code    NumDes    Message    SNMP Support  
  0x0504   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the video input format 0=no, 1=PAL 2=NTSC  
 
  Write   t_dword   l_serv   set the VI norm 0=Autodetect; 1=PAL; 2=NTSC  
 
CONF_INPUT_SOURCE_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x0086   yes (line)   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   =1: camera; =2: vcr  
 
  Write   t_octet   l_serv   =1: camera; =2: vcr; =3: color_plane  
 
CONF_NBR_OF_VIDEO_IN
  Tag code    NumDes    Message    SNMP Support  
  0x01d6   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of installed video inputs  
 
  Write   void   noprot   not supported  
 
CONF_PRIV_MSK
  Tag code    NumDes    Message    SNMP Support  
  0x0ab7   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   1byte mode (0:=off,1:=black,2:=white,3:=grey), 1byte enable mask (bit 1 ==> rectangles 1 etc.), 2bytes reserved, 8 rectangles each 4bytes (x0,y0,x1,y2)  
 
  Write   p_octet   l_serv   1byte mode (0:=off,1:=black,2:=white,3:=grey), 1byte enable mask (bit 1 ==> rectangles 1 etc.), 2bytes reserved, 8 rectangles each 4bytes (x0,y0,x1,y2)  
 
CONF_VIDEO_OUT_STANDARD
  Tag code    NumDes    Message    SNMP Support  
  0x0700   output line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   get video output standard: 1=PAL; 2=NTSC; 3, 4, 5,...=VGA modes  
 
  Write   t_octet   l_serv   select video output standard: 1=PAL; 2=NTSC; 3, 4, 5,...=VGA modes  
 
CONF_MONITOR_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x028a   number of video output line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the video monitor name  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the video monitor name  
 
CONF_VID_DECODER_ON
  Tag code    NumDes    Message    SNMP Support  
  0x0264   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   =1: video decoder is enabled on establishing a new connection; =0 video encoder is not deabled on establishing a new connection  
 
  Write   flag   l_serv   =1 enables the video decoder on establishing a new connection; =0 disables the video decoder on establishing a new connection  
 
CONF_LOGO
  Tag code    NumDes    Message    SNMP Support  
  0x0939   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0 := show "logo.h263" from toolkit 1:= no logo  
 
  Write   t_octet   l_serv   0 := show "logo.h263" from toolkit 1:= no logo 2:= screen saver  
 
CONF_DEC_SHOW_FREEZE
  Tag code    NumDes    Message    SNMP Support  
  0x092e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   freeze string: 0=off, 1=on, n=on (n * 40ms delayed)  
 
  Write   t_octet   l_serv   freeze string: 0=off, 1=on, n=on (n * 40ms delayed)  
 
CONF_DECODER_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0812   no   no   no  
 
  Datatype   Access Level   Description  
  Read   octet   noprot   decoder mode =0: low delay; =1: A/V sync;  
 
  Write   octet   l_serv   decoder mode =0: low delay; =1: A/V sync;  
 
CONF_DECODER_LAYOUT_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x09a1   video out line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   list of supported layouts (0001=single view, 0002=quad view)  
 
  Write   p_octet   l_user   not supported  
 
CONF_DECODER_LAYOUT
  Tag code    NumDes    Message    SNMP Support  
  0x09a2   video out line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   first word (2bytes) is the layout, followed by the coder list in bytes (000101 for first monitor singleview, 000201020304 for quadview with chronological order)  
 
  Write   p_octet   l_user   first byte is the layout, followed by the coder list  
 
CONF_VIDEO_OUT_STANDARD_SPEC
  Tag code    NumDes    Message    SNMP Support  
  0x0706   yes: corresponding video output standard number (see CONF_VIDEO_OUT_STANDARD)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   obtain video output standard specification  
 
  Write   p_octet   l_serv   configure video output standard (use zero payload size to reset to default)  
 
Payload Structure
16 32
pixelClock
4 Bytes
width
2 Byte		 height
2 Byte
border_lft
2 Byte		 border_rgt
2 Byte
border_top
2 Byte		 border_bot
2 Byte
retrace_width
2 Byte		 retrace_height
2 Byte
hsync_start
2 Byte		 vsync_start
2 Byte
hsync_width
2 Byte		 vsync_width
2 Byte
border_width
2 Byte		 border_height
2 Byte
border_red
1 Byte		 border _green
1 Byte		 border_blue
1 Byte		 reserved
4 Bits		 h
1		 v
1		 sy
2
reserved
28 Bytes ...
8 24
pixelClock
pixel clock frequency in Hz
width
width of active screen in pixel
height
height of active screen in pixel
border_lft
width of the additional border left of the active screen
border_rgt
width of the additional border right of the active screen
border_top
height of the additional border above the active screen
border_bot
height of the additional border below active screen
retrace_width
duration of horizontal blanking period in pixel clock cycles
retrace_height
duration of vertical blanking period in scan line units
hsync_start
start of the horizontal sync impulse in pixel clock cycles past the beginning of the horizontal blanking period (signed 2s-complement)
vsync_start
start of the vertical sync impulse in scan lines past the beginning of the vertical blanking period (signed 2s-complement)
hsync_width
duration of the horizontal sync impulses in pixel clock cycles
vsync_width
duration of the vertical sync impulses in scan line units
border_width
(minimum) border width between the active subscreens in split screen mode
border_height
(minimum) border height between the active subscreens in split screen mode
border_red
intensity of the red channel of the border colour around the active screen and between subscreens
border _green
corresponding intensity of the green channel
border_blue
corresponding intensity of the blue channel
reserved
reserved for future extensions
hsync mode
polarity of horizontal sync signal
Values:
positive polarity (active high)0
negtive polarity (active low)1
vsync mode
polarity of vertical sync signal
Values:
positive polarity (active high)0
negative polarity (active low)1
sync signals
Values:
separate H-/V-sync signals0
composite sync signal 1
illegal2
composite sync on green 3
reserved
reserved for future extensions
Notes
In order to be selectable via CONV_VIDEO_OUT_STANDARD or CONV_VIDEO_OUT_CURRENT_SPEC, the corresponding parameters must comply with the currently active output device limits (see CONF_VIDEO_OUT_MONITOR_SPEC).
The resulting scan line frequency can be calculated by:
f_hsync = pixelClock / (width+border_lft+border_rgt+retrace_width)
The resulting vertical refresh frequency can be calculated by
f_vsync=f_hsync/(height+border_top+border_bot+retrace_height)
Negative values for sync_start and/or vsync_start are not guaranteed to work.
Depending on the hardware, the actual border colour may be different from the selected one and even different between the border around the active screen and the border between the subscreens in split screen mode.
Not all sync mode combinations are supported by the hardware.
The values returned on read may be different from the values set via the last write access, even if the supplied values are within the range supported by the output display as configured via CONF_VIDEO_OUT_MONITOR_SPEC.
CONF_VIDEO_OUT_CURRENT_SPEC
  Tag code    NumDes    Message    SNMP Support  
  0x0707   yes: video out line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read active specification on a video out line  
 
  Write   p_octet   l_serv   temporarily change specification for a video out line  
 
Payload Structure
16 32
pixelClock
4 Bytes
width
2 Byte		 height
2 Byte
border_lft
2 Byte		 border_rgt
2 Byte
border_top
2 Byte		 border_bot
2 Byte
retrace_width
2 Byte		 retrace_height
2 Byte
hsync_start
2 Byte		 vsync_start
2 Byte
hsync_width
2 Byte		 vsync_width
2 Byte
border_width
2 Byte		 border_height
2 Byte
border_red
1 Byte		 border _green
1 Byte		 border_blue
1 Byte		 reserved
4 Bits		 h
1		 v
1		 sy
2
reserved
28 Bytes ...
8 24
pixelClock
pixel clock frequency in Hz
width
width of active screen in pixel
height
height of active screen in pixel
border_lft
width of the additional border left of the active screen
border_rgt
width of the additional border right of the active screen
border_top
height of the additional border above the active screen
border_bot
height of the additional border below active screen
retrace_width
duration of horizontal blanking period in pixel clock cycles
retrace_height
duration of vertical blanking period in scan line units
hsync_start
start of the horizontal sync impulse in pixel clock cycles past the beginning of the horizontal blanking period (signed 2s-complement)
vsync_start
start of the vertical sync impulse in scan lines past the beginning of the vertical blanking period (signed 2s-complement)
hsync_width
duration of the horizontal sync impulses in pixel clock cycles
vsync_width
duration of the vertical sync impulses in scan line units
border_width
(minimum) border width between the active subscreens in split screen mode
border_height
(minimum) border height between the active subscreens in split screen mode
border_red
intensity of the red channel of the border colour around the active screen and between subscreens
border _green
corresponding intensity of the green channel
border_blue
corresponding intensity of the blue channel
reserved
reserved for future extensions
hsync mode
polarity of horizontal sync signal
Values:
positive polarity (active high)0
negtive polarity (active low)1
vsync mode
polarity of vertical sync signal
Values:
positive polarity (active high)0
negative polarity (active low)1
sync signals
Values:
separate H-/V-sync signals0
composite sync signal 1
illegal2
composite sync on green 3
reserved
reserved for future extensions
Notes
In order to be selectable via CONV_VIDEO_OUT_STANDARD or CONV_VIDEO_OUT_CURRENT_SPEC, the corresponding parameters must comply with the currently active output device limits (see CONF_VIDEO_OUT_MONITOR_SPEC).
The resulting scan line frequency can be calculated by:
f_hsync = pixelClock / (width+border_lft+border_rgt+retrace_width)
The resulting vertical refresh frequency can be calculated by
f_vsync=f_hsync/(height+border_top+border_bot+retrace_height)
Negative values for sync_start and/or vsync_start are not guaranteed to work.
Depending on the hardware, the actual border colour may be different from the selected one and even different between the border around the active screen and the border between the subscreens in split screen mode.
Not all sync mode combinations are supported by the hardware.
The values returned on read may be different from the values set via the last write access, even if the supplied values are within the range supported by the output display as configured via CONF_VIDEO_OUT_MONITOR_SPEC.
CONF_VIDEO_OUT_MONITOR_SPEC
  Tag code    NumDes    Message    SNMP Support  
  0x0708   yes: video out line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read active monitor specification of a video out line  
 
  Write   p_octet   l_serv   override default monitor timing spec  
 
Payload Structure
16 32
width_mm
2 Byte		 height_mm
2 Byte
native_width
2 Byte		 native_height
2 Byte
hSyncMin
4 Bytes
hSyncMax
4 Bytes
vSyncMin
4 Bytes
vSyncMax
4 Bytes
dotClockMax
4 Bytes
reserved
23 Bits		 s
1		 compSync
4 Bits		 sepSync
4 Bits
reserved
32 Bytes ...
8 24
width_mm
physical width of the actual display region in mm
height_mm
physical height of the actual display region in mm
native_width
(maximum) width of the active display in pixel
native_height
(maximum) height of the active display in pixel
hSyncMin
lowest supported scan line (hsync) frequency in Hz
hSyncMax
highest supported scan line (hsync) frequency in Hz
vSyncMin
lowest supported vertical refresh frequency in mHz
vSyncMax
highest supported vertical refresh frequency in mHz
dotClockMax
upper limit on the pixel clock
reserved
reserved for future extensions
syncOnGreen
sync on green support:
Values:
unsupported0
supported1
compSync
bitmask of supported composite sync signals:
Values:
h-sync active high, v-sync active high 1
h-sync active low, v-sync active high2
h-sync active high, v-sync active low4
h-sync active low, v-sync active low8
sepSync
bitmask of supported separate sync signals:
Values:
h-sync active high, v-sync active high 1
h-sync active low, v-sync active high2
h-sync active high, v-sync active low4
h-sync active low, v-sync active low8
reserved
reserved for future extensions
Notes
In addition to the specified limits, default modes corresponding to the respective physical connector (e.g. standard VGA timing on a VGA connector, PAL/NTSC on BNC) are typically also assumed to be supported by the display device. The device will only allow video output timings (see CONF_VIDEO_OUT_CURRENT_SPEC, CONF_VIDEO_OUT_STANDARD) within these limits and may use the mentioned default timings as fallback values.
CONF_VIDEO_OUT_OVERSCAN
  Tag code    NumDes    Message    SNMP Support  
  0x0709   line number, 0=default line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word or t_dword   noprot   configure overscan area; arg = (monitor_overscan<<16) + intended_overscan; 100 % = 65536, values >= 50 % are forced to tolerable values  
 
  Write   t_dword   l_serv   configure overscan area; arg = (monitor_overscan<<16) + intended_overscan; 100 % = 65536, values >= 50 % are forced to tolerable values  
 
CONF_DECODED_FRAMES
  Tag code    NumDes    Message    SNMP Support  
  0x0a1a   yes (coder number)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of decoded video frames of one deocder instance  
 
  Write   %   l_serv   %  
 
CONF_NBR_OF_VIDEO_OUT
  Tag code    NumDes    Message    SNMP Support  
  0x01d7   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of installed video outputs  
 
  Write   t_dword   noprot   returns the number of installed video outputs  
 
CONF_ENABLE_OSD
  Tag code    NumDes    Message    SNMP Support  
  0x0810   no   no   no  
 
  Datatype   Access Level   Description  
  Read   octet   noprot   osd on trimedia  
 
  Write   octet   l_serv   enable osd on trimedia  
 
CONF_OSD_ACCESS
  Tag code    NumDes    Message    SNMP Support  
  0x098a   0: print to all decoders, else, print only to selected absolute decoder   no   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   p_octet   l_serv   access to the OSD via RCP command  
 
Payload Structure
ID
2 Byte		 len
2 Byte
x
1 Byte		 y
1 Byte		 reserved
10 Bytes ...
String 1
1 Byte		 N x 1 Byte String N
1 Byte
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible
len
length of the complete payload
x
X-Position (0...255) where the string should be displayed (0 is left)
y
Y-Position (0...255) where the string should be displayed (0 is up)
reserved
Reserved fields for internal settings
String 1 - N
The string value which should be displayed
CONF_AUDIO_INPUT_LEVEL
  Tag code    NumDes    Message    SNMP Support  
  0x000a   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets current level of audio input. Range: 0 to AUDIO_INPUT_MAX  
 
  Write   dword   l_serv   sets level of audio input. Range: 0 to AUDIO_INPUT_MAX  
 
CONF_AUDIO_OUTPUT_LEVEL
  Tag code    NumDes    Message    SNMP Support  
  0x09b7   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets level of audio input. Range: 0 to AUDIO_INPUT_MAX  
 
  Write   t_dword   l_serv   sets level of audio input. Range: 0 to AUDIO_INPUT_MAX  
 
CONF_AUDIO_G711
  Tag code    NumDes    Message    SNMP Support  
  0x000c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=G.711 audio mode is not set, 1=G.711 audio mode is set  
 
  Write   flag   l_serv   set G.711 audio mode (0=off, 1=on) (has no effect on a running recording, to have the effect in recording, restart of recording is nessessary)  
 
CONF_AUDIO_STARTUP_SOUND
  Tag code    NumDes    Message    SNMP Support  
  0x09b6   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   turn on/off audio startup sound  
 
  Write   flag   l_serv   turn on/off audio startup sound  
 
CONF_AUDIO_INPUT
  Tag code    NumDes    Message    SNMP Support  
  0x09b8   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   dword   noprot   0=Line, 1=Mic  
 
  Write   dword   l_serv   0=Line, 1=Mic  
 
CONF_AUDIO_OUTPUT
  Tag code    NumDes    Message    SNMP Support  
  0x09b9   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   0=Decoder, 1=Sine, 2=Loop, 3=Mute, 4=Sample  
 
  Write   t_dword   l_serv   0=Decoder, 1=Sine, 2=Loop, 3=Mute, 4=Sample  
 
CONF_AUDIO_INPUT_MAX
  Tag code    NumDes    Message    SNMP Support  
  0x09ba   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the maximum input level that can be adjusted  
 
  Write   %   l_serv   %  
 
CONF_AUDIO_OUTPUT_MAX
  Tag code    NumDes    Message    SNMP Support  
  0x09bb   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the maximum output level that can be adjusted  
 
  Write   %   l_serv   %  
 
CONF_AUDIO_MIC_LEVEL
  Tag code    NumDes    Message    SNMP Support  
  0x09bc   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   dword   noprot   gets level of mic input. Range: 0 to AUDIO_MIC_MAX  
 
  Write   dword   l_serv   sets level of mic input. Range: 0 to AUDIO_MIC_MAX  
 
CONF_AUDIO_MIC_MAX
  Tag code    NumDes    Message    SNMP Support  
  0x09bd   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   dword   noprot   gets the maximum mic level that can be adjusted  
 
  Write   %   l_serv   %  
 
CONF_AUDIO_LOUDSPEAKER_ON_OFF
  Tag code    NumDes    Message    SNMP Support  
  0x09be   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   Gets Loudspeaker if on or off  
 
  Write   flag   l_serv   Sets Loudspeaker on or off  
 
CONF_AUDIO_OPTIONS
  Tag code    NumDes    Message    SNMP Support  
  0x09bf   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets options for Audio, Bit 0=Line In, Bit 1=Line Out, Bit 2=Mic, Bit 3=Loudspeaker  
 
  Write   %   l_serv   %  
 
CONF_AUDIO_INPUT_PEEK
  Tag code    NumDes    Message    SNMP Support  
  0x09c6   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the max iabs of the audio input signal (clears the value)  
 
  Write   t_dword   l_serv   get the max iabs of the audio input signal (clears the value)  
 
CONF_AUDIO_OUTPUT_PEEK
  Tag code    NumDes    Message    SNMP Support  
  0x09c7   audio line   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the max iabs of the audio output signal (clears the value)  
 
  Write   t_dword   l_serv   get the max iabs of the audio output signal (clears the value)  
 
CONF_NBR_OF_AUDIO_OUT
  Tag code    NumDes    Message    SNMP Support  
  0x01d9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of audio outputs  
 
  Write   %   l_serv   %  
 
CONF_NBR_OF_AUDIO_IN
  Tag code    NumDes    Message    SNMP Support  
  0x01d8   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of audio inputs  
 
  Write   %   l_serv   %  
 
CONF_ALARM_INPUT_LH_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x008d   alarm input   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   1=alarm pin high active; 2=alarm pin low active  
 
  Write   t_octet   l_serv   1=set alarm pin high active; 2=set alarm pin low active  
 
CONF_INPUT_PIN_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0108   alarm in   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the description for an input alarm  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the description for an input alarm  
 
CONF_VCD_OPERATOR_PARAMS
  Tag code    NumDes    Message    SNMP Support  
  0x0a1b   video line   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read parametrization of vcd operator which corresponds to line  
 
  Write   p_octet   l_serv   configures the vcd manager. if configuration fails an error is returned.  
 
CONF_CAMERA_MOTION_ALARM_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x09b2   motion area (1..4)   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   turn on/off the motion alarm of the dinion camera.  
 
  Write   flag   l_serv   turn on/off the motion alarm of the dinion camera.  
 
CONF_ALARM_CONNECT_TO_IP_STR
  Tag code    NumDes    Message    SNMP Support  
  0x0081   destination IP number   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the alarm IP using string notation (xxx.xxx.xxx.xxx)  
 
  Write   p_string   l_serv   set alarm IP using string notation (xxx.xxx.xxx.xxx)  
 
CONF_ALARM_CONNECT_TO_IP
  Tag code    NumDes    Message    SNMP Support  
  0x0041   destination IP number   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the connect on alarm event IP address  
 
  Write   t_dword   l_serv   specify the connect on alarm event IP address  
 
CONF_NBR_OF_ALTERNATIVE_ALARM_IPS
  Tag code    NumDes    Message    SNMP Support  
  0x0303   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the number of available alarm ip addresses (total presets)  
 
  Write   void   l_serv   not supported  
 
CONF_AUTO_DISCONNECT_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x030d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   0=no auto disconnect; 0 
 
  Write   t_dword   l_serv   0=no auto disconnect; 0 
 
CONF_DEFAULT_CONNECTION_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0289   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   t_octet   l_serv   get the default connection mode: 0=MPEG2, 1=MPEG4, 2=MPEG4/AVC, 3=JPEG  
 
CONF_STD_MEDIA_CONNECTION_DIRECTION
  Tag code    NumDes    Message    SNMP Support  
  0x030c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   =0: outgoing media for alarm connections; =1: req. incoming media for alarm connections; =2: req. bidirectional media for alarm connections  
 
  Write   t_octet   l_serv   =0: outgoing media for alarm connections; =1: req. incoming media for alarm connections; =2: req. bidirectional media for alarm connections  
 
CONF_STD_MEDIA_ENCAPSULATION_PROTOKOL
  Tag code    NumDes    Message    SNMP Support  
  0x0309   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   defines the standard media encapsulation protokol: 1=RTP over UDP, 2=TCP  
 
  Write   t_octet   l_serv   defines the standard media encapsulation protokol: 1=RTP over UDP, 2=TCP  
 
CONF_DEFAULT_CAM
  Tag code    NumDes    Message    SNMP Support  
  0x01af   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   reads the default camera for alarm connections  
 
  Write   t_octet   l_serv   defines the default camera for alarm connections  
 
CONF_ALARM_CONNECTION_DESTINATION_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a15   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   returns the network destination port on outgoing alarm connections  
 
  Write   t_word   l_serv   selects the destination network port for outgoing alarm connections; all other than 1756 (default RCP port) will use the HTTP tunneling protocol. In this case, this must be the HTTP/HTTPS port of the called host.  
 
CONF_ALARM_CONNECTION_USE_SSL
  Tag code    NumDes    Message    SNMP Support  
  0x0a16   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   use RCP SSL for outgoing alarm connections  
 
  Write   flag   l_serv   use RCP SSL for outgoing alarm connections  
 
CONF_CONNECT_URL
  Tag code    NumDes    Message    SNMP Support  
  0x0a1e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   get the connect url  
 
  Write   p_string   l_serv   set the connect url  
 
CONF_VIDEO_ALARM_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x01c2   video line   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=video alarm is off; 1=video alarm is on  
 
  Write   void   noprot   not supported  
 
CONF_INPUT_PIN_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x01c0   alarm in   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=alarm input off; 1= alarm input on  
 
  Write   void   noprot   not supported  
 
CONF_MOTION_ALARM_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x01c3   video line   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=motion alarm off; 1=motion alarm on (at elast one of the CONF_VIPROC_ALARM alarmbit (except the video loss alarm) is set  
 
  Write   flag   noprot   not supported  
 
CONF_RELAY_OUTPUT_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x01c1   relay output   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   returns the current logical level of an relay output  
 
  Write   flag   l_user   set the logical level of an relay output  
 
CONF_NBR_OF_ALARM_IN
  Tag code    NumDes    Message    SNMP Support  
  0x01db   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of installed alarm input contacts (possible masterswitch included)  
 
  Write   void   l_priv   not supported  
 
CONF_NBR_OF_ALARM_OUT
  Tag code    NumDes    Message    SNMP Support  
  0x01dc   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of installed alarm output contacts  
 
  Write   void   l_priv   not supported  
 
CONF_NBR_OF_MOTION_DETECTORS
  Tag code    NumDes    Message    SNMP Support  
  0x09af   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of installed motion detectors  
 
  Write   %   l_priv   %  
 
CONF_HD_MGR_SIGNAL_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x0915   no   no   no  
 
  Datatype   Access Level   Description  
  Read   -   noprot   not supported  
 
  Write   flag   l_serv   signal alarm: only one alarm per second is allowed,  
 
CONF_VIRTUAL_ALARM_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x0a8b   virtual alarm line 1 - 4   yes   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   0=virtual alarm off; 1=virtual alarm on  
 
  Write   flag   l_serv   0=virtual alarm off; 1=virtual alarm on  
 
CONF_RELAIS_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0109   relay output   no   no  
 
  Datatype   Access Level   Description  
  Read   p_unicode   noprot   read the description for a relay output  
 
  Write   p_unicode (max 32 unicode characters)   l_serv   set the description for a relay output  
 
CONF_RELAIS_SWITCH
  Tag code    NumDes    Message    SNMP Support  
  0x0094   relay output   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   return the current relay state  
 
  Write   flag   l_serv   switch the relais immediately  
 
CONF_SERIAL_PORT_APP_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x01f1   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=serial port application is in terminal mode; 0xFF=serial port application is in transparent datamode; values 1-10: camera type mode  
 
  Write   t_octet   l_serv   0=sets the serial port application in terminal mode; 0xFF=sets the serial port application in transparent datamode; values 1-10: sets to camera type mode  
 
CONF_SERIAL_PORT_RATE
  Tag code    NumDes    Message    SNMP Support  
  0x027e   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   bitrate=300; bitrate=600; bitrate=1200; bitrate=2400; bitrate=4800; bitrate=9600; bitrate=19200  
 
  Write   t_dword   l_serv   bitrate=300; bitrate=600; bitrate=1200; bitrate=2400; bitrate=4800; bitrate=9600; bitrate=19200  
 
CONF_SERIAL_PORT_BITS
  Tag code    NumDes    Message    SNMP Support  
  0x027f   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   7=seven data bits; 8=eight data bits  
 
  Write   t_octet   l_serv   7=set to seven data bits; 8=set to eight data bits  
 
CONF_SERIAL_PORT_STBITS
  Tag code    NumDes    Message    SNMP Support  
  0x0280   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   1=modemport stopbits are set to 1; 2=modemport stopbits are set to 2  
 
  Write   t_octet   l_serv   1=modemport stopbits are set to 1; 2=modemport stopbits are set to 2  
 
CONF_SERIAL_PORT_PAR
  Tag code    NumDes    Message    SNMP Support  
  0x0281   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=no parity; 1=even parity; 2=odd parity  
 
  Write   t_octet   l_serv   0=set to no parity; 1=set to even parity; 2=set to odd parity  
 
CONF_SERIAL_PORT_MODE_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x0208   physical port   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   1=port mode is set to RS232; 2=port mode is set to RS422/RS485 (NOT avalibale in conventional VideoJet)  
 
  Write   t_octet   l_serv   1=set port mode to RS232; 2=set port mode to RS422/RS485  
 
CONF_SERIAL_PORT_HD_MODE_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x020b   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   =0: halfduplex mode is set to off; =1:halfduplex mode is set to on; =2: halfduplex mode is set to on and buffered data (NOT avalibale in conventional VideoJet)  
 
  Write   t_octet   l_serv   =0: set halfduplex mode to off; =1:set halfduplex mode to on; =2: set halfduplex mode to on and buffered data  
 
CONF_SERIAL_PORT_HANDSHAKE
  Tag code    NumDes    Message    SNMP Support  
  0x09a9   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   get type of handshake (internal use only)  
 
  Write   t_octet   l_serv   set type of handshake (internal use only)  
 
CONF_BICOM_COMMAND
  Tag code    NumDes    Message    SNMP Support  
  0x09a5   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Executes a BICOM read command to the local Dinion camera module  
 
  Write   p_octet   l_user   Executes a BICOM write command to the local Dinion camera module , see detailed description  
 
Payload Structure
16 32
Flags
1 Byte		 Bicom Server ID
2 Byte		 Object ID
2 Byte ...
Operation
1 Byte		 Bicom Payload
30 Bytes ...
8 24
Flags
Transmission-Flags
Values:
Return_Payload (Must be set to 1 if return payload is expected)Bit 0
Best_Effort (Set to 1 to transmitt as best effort frame)Bit 1
Native_Errors (Set to 1 to receive the native BICOM errors)Bit 2
unused set to 0Bit 3
unused set to 0Bit 4
unused set to 0Bit 5
unused set to 0Bit 6
Flags_Available (Must be always set to 1)Bit 7
Bicom Server ID
e.g. Device-Server or IO-Server (See BICOM Application Doku)
Object ID
e.g. Device Type (= 0x100) (See BICOM Application Doku)
Operation
See BICOM Application Doku
Values:
GET0x01
SET0x02
SET_GET 0x03
INC 0x04
INC_GET 0x05
DEC 0x06
DEC_GET 0x07
SET_DFLT 0x08
Bicom Payload
Bicom Payload
Example for a RCP Request:
81 Return payload expected
00 02 Device = 2 = "Device server"
01 50 Parameter IdString
01 Operation Read
Example for a RCP Response:
81 Return payload expected
00 02 Device = 2 = "Device server"
01 50 Parameter IdString
01 Operation Read
00 68 00 68 00 68 00 68 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 00 20 34 Bytes Unicode ID String
CONF_BICOM_SRV_CONNECTED
  Tag code    NumDes    Message    SNMP Support  
  0x0a19   no   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   return true if the device is connected to the BICOM server (Camera)  
 
  Write   %   l_user   %  
 
CONF_BICOM_UPLOAD_PACKET
  Tag code    NumDes    Message    SNMP Support  
  0x09c9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   l_serv   %  
 
  Write   p_octet   l_serv   writes a sub-module firmware upload block  
 
CONF_BICOM_SUBCOMPONENTS_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x0aa5   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Read List of FamilyIDs and Firmware Versions for Subcomponents of Gen4 (Future Dinion?)  
 
  Write   p_octet   l_priv   Read List of FamilyIDs and Firmware Versions for Subcomponents of Gen4 (Future Dinion?)  
 
CONF_KBD_CONFIG_CAMERA
  Tag code    NumDes    Message    SNMP Support  
  0x0a31   yes (camera number on keyboard)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read configuration of camera numbers on keyboard  
 
  Write   p_octet   l_serv   configure camera numbers on keyboard; assign parameters to a number (given by num)  
 
Payload Structure
16 32
IP
4 Bytes
Line
1 Byte		 Coder
1 Byte		 Preset
1 Byte		 Reserved
1 Byte
8 24
IP
Encoder/Camera IP
Line
Video input line
Coder
Relative coder number (relative to line)
Preset (optional)
(Dome-) Preset Position. (Every Preset of a Dome can be treated as a seperate camera).
CONF_KBD_CONFIG_MONITOR
  Tag code    NumDes    Message    SNMP Support  
  0x0a32   yes (monitor number on keyboard)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read configuration of monitor numbers on keyboard  
 
  Write   p_octet   l_serv   configure monitor numbers on keyboard; assign parameters to a number (given by num)  
 
Payload Structure
16 32
IP
4 Bytes
Line
1 Byte		 Coder
1 Byte		 Reserved
1 Byte		 Reserved
1 Byte
8 24
IP
Decoder/Monitor IP
Line
Video output line
Coder
Relative coder number (relative to line)
CONF_KBD_CONNECT_PARAMS
  Tag code    NumDes    Message    SNMP Support  
  0x0a33   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read parameters for connections established via keyboard  
 
  Write   p_octet   l_serv   set parameters for connections established via keyboard  
 
Payload Structure
16 32
Flags
2 Bytes		 Reserved
2 Bytes
8 24
Flags (optional)
Values:
Bit 0Request audio TX (listen at decoder side)
Bit 1Request audio RX (speak at decoder side)
CONF_KBD_PASSWORD_CAMERA
  Tag code    NumDes    Message    SNMP Support  
  0x0a34   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   get the password (scrambled) for all cameras used on keyboard  
 
  Write   p_string   l_serv   deposit a password for all cameras used on keyboard  
 
CONF_KBD_PASSWORD
  Tag code    NumDes    Message    SNMP Support  
  0x0a69   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   get the password (scrambled) of the keyboard  
 
  Write   p_string   l_serv   deposit a password for the keyboard  
 
CONF_KBD_CONFIG_SALVO
  Tag code    NumDes    Message    SNMP Support  
  0x0a3e   yes (salvo number)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read configuration of salvos for keyboard  
 
  Write   p_octet   l_serv   configure salvos used for keyboard; assign parameters to a salvo number (given by num)  
 
Payload Structure
16 32
Duration
2 Bytes		 Reserved
2 Bytes
Camera Num 1
1 Byte		 N x 1 Byte Camera Num N
1 Byte
8 24
Duration
Duration of one salvo position in seconds
Camera Num N
Camera number for salvo position N
(note: Camera number has to be specified using CONF_KBD_CONFIG_CAMERA)
CONF_KBD_KEY_LABEL
  Tag code    NumDes    Message    SNMP Support  
  0x0a44   yes (key number; must be >0)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read a label of a key used for the alarm task editor. The label is shown on the keyboard display.  
 
  Write   p_string   l_serv   deposit a label for a key used for the alarm task editor. The label is shown on the keyboard display.  
 
CONF_KBD_SET_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x0a68   no   no   no  
 
  Datatype   Access Level   Description  
  Read   -   noprot   not supported  
 
  Write   f_flag   noprot   send alarm to keyboard  
 
CONF_MAC_ADDRESS
  Tag code    NumDes    Message    SNMP Support  
  0x00bc   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read out the systems MAC address  
 
  Write   void   noprot   not supported  
 
CONF_IP
  Tag code    NumDes    Message    SNMP Support  
  0x0001   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the unit's IP address  
 
  Write   t_dword   l_serv   set the unit's IP address  
 
CONF_IP_STR
  Tag code    NumDes    Message    SNMP Support  
  0x007c   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the unit's IP address using string notation (xxx.xxx.xxx.xxx)  
 
  Write   p_string   l_serv   set unit's IP address using string notation (xxx.xxx.xxx.xxx)  
 
CONF_SUBNET
  Tag code    NumDes    Message    SNMP Support  
  0x0002   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the unit's subnet  
 
  Write   t_dword   l_serv   set the unit's subnet  
 
CONF_GATEWAY_IP_STR
  Tag code    NumDes    Message    SNMP Support  
  0x007f   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the gateway IP using string notation (xxx.xxx.xxx.xxx)  
 
  Write   p_string   l_serv   set gateway IP using string notation (xxx.xxx.xxx.xxx)  
 
CONF_DNS_SERVER_IP
  Tag code    NumDes    Message    SNMP Support  
  0x0a1f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get dns server ip  
 
  Write   t_dword   l_serv   set dns server ip  
 
CONF_ETH_LINK
  Tag code    NumDes    Message    SNMP Support  
  0x092d   yes; num=0 is the mode of the external state on single ethernet port units or the internal link mode on multiple ethernet port units; num>=1 is the mode of the corresponding port on multiple ethenet port units (SFP Fiber port is always the last counted port). On module based units, only the master module is capable of setting the external port modes.   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   (half duplex=HD, full duplex =FD) 0=auto, 1=10MbitHD, 2=10MbitFD, 3=100MbitHD, 4=100MbitFD  
 
  Write   t_octet   l_serv   (half duplex=HD, full duplex =FD) 0=auto, 1=10MbitHD, 2=10MbitFD, 3=100MbitHD, 4=100MbitFD, 5=1000FD  
 
CONF_ETH_LINK_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x0a24   yes; num=0 returns the status of the external state on single ethernet port units or the internal link state on multiple ethernet port units; num>=1 returns the state of the corresponding port on multiple ethenet port units (SFP Fiber port is always the last counted port). On module based units, only the master module is capable of returning the external states.   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   (half duplex=HD, full duplex =FD) 0=No link, 1=10MbitHD, 2=10MbitFD, 3=100MbitHD, 4=100MbitFD, 5=1000FD;  
 
  Write   void   l_serv   not suported  
 
CONF_ETH_LINK_TROUGHPUT
  Tag code    NumDes    Message    SNMP Support  
  0x0a80   Message : no   Description : lower 16 bit: downlink KBPS, upper 16 bit: uplink KBPS   no  
 
  Datatype   Access Level   Description  
  Read   %   noprot   %  
 
  Write   void   l_serv   not suported  
 
CONF_ETH_TX_PKT_BURST
  Tag code    NumDes    Message    SNMP Support  
  0x0afe   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   eth tx pkts per burst (0:=no limitation)  
 
  Write   t_dword   l_serv   eth tx pkts per burst (0:=no limitation)  
 
CONF_NBR_OF_EXT_ETH_PORTS
  Tag code    NumDes    Message    SNMP Support  
  0x0a28   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of external ethernet ports of a device  
 
  Write   void   l_serv   not supported  
 
CONF_NBR_OF_EXT_ETH_COPPER_PORTS
  Tag code    NumDes    Message    SNMP Support  
  0x0a29   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of external copper ethernet ports of a device  
 
  Write   t_dword   l_serv   returns the number of external copper ethernet ports of a device  
 
CONF_NBR_OF_EXT_ETH_FIBER_PORTS
  Tag code    NumDes    Message    SNMP Support  
  0x0a2a   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the number of external fiber ethernet ports of a device  
 
  Write   t_dword   l_serv   returns the number of external fiber ethernet ports of a device  
 
CONF_ENABLE_TRAFFIC_LED
  Tag code    NumDes    Message    SNMP Support  
  0x09a6   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   network activity LED (Dinion, NBC-255 camera): 0=off, 1=on  
 
  Write   t_octet   l_serv   Enables or disables the network activity LED (Dinion, NBC-255 camera)  
 
CONF_SND_MSS
  Tag code    NumDes    Message    SNMP Support  
  0x0a02   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   max tcp send mss for all connections  
 
  Write   t_dword   l_serv   set the global tcp send mss; use this to reduce the max. send segment size for all tcp connections; higher settings than default will only be used by iSCSI connections (0 means default)  
 
CONF_SND_MSS_ISCSI
  Tag code    NumDes    Message    SNMP Support  
  0x0a22   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   max tcp send mss for iscsi  
 
  Write   t_dword   l_serv   set the max. tcp send mss for iSCSI connections; NOTE: this setting will also adjust the global setting SND_MSS  
 
CONF_EAP_IDENTITY
  Tag code    NumDes    Message    SNMP Support  
  0x09ea   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the EAP identity  
 
  Write   p_string   l_serv   write the EAP identity  
 
CONF_EAP_ENABLE
  Tag code    NumDes    Message    SNMP Support  
  0x09eb   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read the EAP/802.1x status (0: off/don't do EAP/802.1x; 1: on/use EAP/802.1x)  
 
  Write   t_octet   l_serv   write the EAP/802.1x status (0: off/don't do EAP/802.1x; 1: on/use EAP/802.1x)  
 
CONF_EAP_PASSWORD
  Tag code    NumDes    Message    SNMP Support  
  0x09ec   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the EAP password  
 
  Write   p_string   l_serv   write the EAP password  
 
CONF_SWITCH_TRUNKING
  Tag code    NumDes    Message    SNMP Support  
  0x0a6b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   external ports bitwise members of a trunk  
 
  Write   t_octet   l_serv   external ports bitwise members of a trunk  
 
CONF_SWITCH_RSTP_PRIO
  Tag code    NumDes    Message    SNMP Support  
  0x0a6e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   RSTP Priority val in range of 0 ... 61440, must be multiple of 4096  
 
  Write   t_dword   l_serv   RSTP Priority val in range of 0 ... 61440, must be multiple of 4096  
 
CONF_SWITCH_RSTP_HELLO_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0a6f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   RSTP Hello Time in range of 1...10, default 2  
 
  Write   t_octet   l_serv   RSTP Hello Time in range of 1...10, default 2  
 
CONF_SWITCH_RSTP_MAX_AGE
  Tag code    NumDes    Message    SNMP Support  
  0x0a70   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   RSTP Max Age in range of 6...40, default 20  
 
  Write   t_octet   l_serv   RSTP Max Age in range of 6...40, default 20  
 
CONF_SWITCH_RSTP_FWD_DELAY
  Tag code    NumDes    Message    SNMP Support  
  0x0a71   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   RSTP Forward Delay in range of 4...30, default 15  
 
  Write   t_octet   l_serv   RSTP Forward Delay in range of 4...30, default 15  
 
CONF_SWITCH_RSTP_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x0a72   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   RSTP Version, 0: STP compatible, 2: RSTP  
 
  Write   t_octet   l_serv   RSTP Version, 0: STP compatible, 2: RSTP  
 
CONF_SWITCH_RSTP_PORT_ENABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0a74   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   external ports bitwise enabling RSTP-only mode, 0: off, 1:on  
 
  Write   t_octet   l_serv   external ports bitwise enabling RSTP-only mode, 0: off, 1:on  
 
CONF_SWITCH_RSTP_PORT_EDGE
  Tag code    NumDes    Message    SNMP Support  
  0x0a75   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   external ports bitwise determining if RSTP edge port  
 
  Write   t_octet   l_serv   external ports bitwise determining if RSTP edge port  
 
CONF_SWITCH_RSTP_PORT_PATHCOST
  Tag code    NumDes    Message    SNMP Support  
  0x0a76   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   RSTP pathcost of external ports in range of 1...200000000, while 0 means auto  
 
  Write   t_dword   l_serv   RSTP pathcost of external ports in range of 1...200000000, while 0 means auto  
 
CONF_BACKPLANE_TYPE
  Tag code    NumDes    Message    SNMP Support  
  0x0a78   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   type of backplane 0xff: no backplane, 0xfe: old, 0: full-flavoured, 1: eco, 2: diplan  
 
  Write   %   l_serv   %  
 
CONF_BACKPLANE_FW_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x0a84   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   firmware version on backplane 0: error / no (valid) backplane, else: firmware revision  
 
  Write   %   l_serv   %  
 
CONF_SWITCH_IGMP_IP
  Tag code    NumDes    Message    SNMP Support  
  0x0a95   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   IP address that the VIPX1600 backplane uses as source IP in IGMP queries  
 
  Write   t_dword   l_serv   IP address that the VIPX1600 backplane uses as source IP in IGMP queries  
 
CONF_SWITCH_IGMP_SNOOPING_ENABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0a9a   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   enable IGMP snooping on Vitesse backplane switch, 0: off, 1: on  
 
  Write   t_dword   l_serv   enable IGMP snooping on Vitesse backplane switch, 0: off, 1: on  
 
CONF_SWITCH_MAC_IS_SET
  Tag code    NumDes    Message    SNMP Support  
  0x0a9d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   determine of backplane has a valid MAC address: 0: invalid, 1: not yet known, ask later (during boot process), 2: valid  
 
  Write   %   l_serv   %  
 
CONF_REBOOT_SWITCH
  Tag code    NumDes    Message    SNMP Support  
  0x0a9e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   %   l_serv   %  
 
  Write   t_dword   l_serv   reboot switch  
 
CONF_BP_FORCE_DEFAULTS
  Tag code    NumDes    Message    SNMP Support  
  0x0ab8   -   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   l_serv   returns =1 when a firmware upgrade to the backplane is pending; otherwise =0;  
 
  Write   t_dword   l_serv   force the backplane switch to go to factory defaults; also perform firmware upgrade; only applicable to backplanes which support fw upgrade  
 
CONF_PORT_FC_MODE
  Tag code    NumDes    Message    SNMP Support  
  0x0abb   yes; num=0 is the flow control mode of the external state on single ethernet port units or the internal fc mode on multiple ethernet port units; num>=1 is the fc mode of the corresponding port on multiple ethenet port units (SFP Fiber port is always the last counted port). On module based units, only the master module is capable of setting the external port fc modes.   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   0=off, 1=on  
 
  Write   t_octet   l_serv   0=off, 1=on  
 
CONF_SWITCH_POST_UPDATE_ACTION
  Tag code    NumDes    Message    SNMP Support  
  0x0ac5   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   id that indicates which action is to be executed as the switch firmware was updated (0: none)  
 
  Write   t_octet   l_serv   id that indicates which action is to be executed as the switch firmware was updated (0: none)  
 
CONF_MULTICAST_GROUP_IP_STR
  Tag code    NumDes    Message    SNMP Support  
  0x01b4   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the multicast group address  
 
  Write   p_string   l_serv   set the multicast group address (range: 224.0.0.10 .. 239.255.255.255)  
 
CONF_MULTICAST_GROUP_IP
  Tag code    NumDes    Message    SNMP Support  
  0x01b1   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the multicast group address  
 
  Write   t_dword   l_serv   set the multicast group address (range: 224.1.0.0 .. 239.255.255.255)  
 
CONF_MULTICAST_MPEG4_PORT_STR
  Tag code    NumDes    Message    SNMP Support  
  0x0288   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the mpeg4 multicast UDP port number  
 
  Write   p_string   l_serv   set the multicast video mpeg 4 UDP port (even port numbers only)  
 
CONF_MULTICAST_MPEG4_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0286   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   read the mpeg4 multicast UDP port number  
 
  Write   t_word   l_serv   set the multicast video mpeg 4 UDP port (even port numbers only)  
 
CONF_MULTICAST_AUDIO_PORT_STR
  Tag code    NumDes    Message    SNMP Support  
  0x01b5   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   read the g711 multicast UDP port number  
 
  Write   p_string   l_serv   set the multicast audio G711 UDP port (even port numbers only)  
 
CONF_MULTICAST_AUDIO_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x01b2   coder instance   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   read the g711 multicast UDP port number  
 
  Write   t_word   l_serv   set the multicast audio G711 UDP port (even port numbers only)  
 
CONF_MULTICAST_TTL
  Tag code    NumDes    Message    SNMP Support  
  0x0267   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   get the TTL (time to live) in IP-Header for multicast packets  
 
  Write   t_octet   l_serv   set the TTL (time to live) in IP-Header for multicast packets  
 
CONF_IGMP_VERSION
  Tag code    NumDes    Message    SNMP Support  
  0x09e5   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read the igmp(internet group management protocol) version (0: Automatic from network; 1: Version1; 2: Version2; 3: Version3)  
 
  Write   t_octet   l_serv   Set the igmp version (0: Automatic from network; 1: Version1; 2: Version2; 3: Version3). Reboot necessary.  
 
CONF_STREAMING_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x01b9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   =0: set multicast streaming mode to off; =1: set multicast streaming mode mpeg4 to on; =2: set multicast streaming mode mpeg2 to on; =3: set multicast streaming mode mpeg4+mpeg2 to on  
 
  Write   t_octet   l_serv   =0: set multicast streaming mode to off; =1: set multicast streaming mode mpeg4 to on; =2: set multicast streaming mode mpeg2 to on; =3: set multicast streaming mode mpeg4+mpeg2 to on  
 
CONF_VIDEO_ENC_STREAMING
  Tag code    NumDes    Message    SNMP Support  
  0x099a   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   video streaming on coder (video encoder n: coderbits=1<<(n-1))  
 
  Write   t_dword   l_serv   enable video streaming on coder. (video encoder n: coderbits=1<<(n-1))  
 
CONF_AUDIO_ENC_STREAMING
  Tag code    NumDes    Message    SNMP Support  
  0x099b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   audio streaming on coder (audio encoder n: coderbits=1<<(n-1))  
 
  Write   t_dword   l_serv   enable audio streaming on coder (audio encoder n: coderbits=1<<(n-1))  
 
CONF_JOIN_STREAM_NOW
  Tag code    NumDes    Message    SNMP Support  
  0x01d4   no   no   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not supported  
 
  Write   flag   l_live   start joining a multicast stream from the alarm IP  
 
CONF_DYNDNS_SERVER
  Tag code    NumDes    Message    SNMP Support  
  0x030f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   IP address of VCS dynamic DNS server  
 
  Write   t_dword   l_serv   IP address of VCS dynamic DNS server  
 
CONF_DYNDNS_TIMEOUT
  Tag code    NumDes    Message    SNMP Support  
  0x0310   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   time in sec when the VJ should retrigger its VCS dynamic server registration (30 .. 86400)  
 
  Write   t_dword   l_serv   time in sec when the VJ should retrigger its VCS dynamic server registration (30 .. 86400)  
 
CONF_DYNDNS_SERVER_REPLY
  Tag code    NumDes    Message    SNMP Support  
  0x0311   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   not supported; will generate message when server answers  
 
  Write   p_string   l_serv   not supported; will generate message when server answers  
 
CONF_DYNDNS_HOST_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0a56   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   read the dyndns host name that is to be registered at dyndns.com  
 
  Write   p_string   l_serv   write the dyndns host name that is to be registered at dyndns.com  
 
CONF_DYNDNS_USER_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x0a57   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   read the user name of account at dyndns.com  
 
  Write   p_string   l_serv   write the user name of account at dyndns.com  
 
CONF_DYNDNS_PASSWORD
  Tag code    NumDes    Message    SNMP Support  
  0x0a58   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_serv   read the password of account at dyndns.com  
 
  Write   p_string   l_serv   write the password of account at dyndns.com  
 
CONF_DYNDNS_ENABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0a59   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   1: enable, 0: disable registering at dyndns.com  
 
  Write   t_octet   l_serv   enable/disable registering at dyndns.com  
 
CONF_DYNDNS_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x0a5a   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   state of registering at dyndns.com, see detailed description  
 
  Write   %   l_serv   %  
 
Payload Structure
State
1 Byte
8
State
the current state of the process of registering the device at dyndns.com
Values:
successfully updated0
updated with unchanged cfg1
dyndns username or password wrong2
not fully qualified domain name (e.g. not in form host.dyndns.org)3
wrong host name for this dyndns user account4
too many hosts in last update5
host name is blocked by dyndns for update abuse6
no user agent submitted or http method not permitted7
dyndns server error dns related8
dyndns server error maintenance related9
update not done due to misconfiguration252
fatal error during update process253
update in process254
switched off255
CONF_DYNDNS_LAST_REGISTER
  Tag code    NumDes    Message    SNMP Support  
  0x0a5b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   data of last successful registration at dyndns.com, 8 bytes, first DWORD: register time in secs since 2000, second DWORD: last registered IP  
 
  Write   p_octet   l_serv   data of last successful registration at dyndns.com, 8 bytes, first DWORD: register time in secs since 2000, second DWORD: last registered IP  
 
CONF_DYNDNS_FORCE_REGISTER_NOW
  Tag code    NumDes    Message    SNMP Support  
  0x0a5c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   l_serv   writing forces registering at dyndns.com / reading checks if forcing is allowed (has not been done since bootup)  
 
  Write   t_octet   l_serv   writing forces registering at dyndns.com / reading checks if forcing is allowed (has not been done since bootup)  
 
CONF_AUTODETECT_REPLY_GROUP
  Tag code    NumDes    Message    SNMP Support  
  0x0956   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the multicast group to which (when set) to VJ will listen for multicast autodetect requests  
 
  Write   t_dword   l_serv   set the multicast group to which (when set) to VJ will listen for multicast autodetect requests on port 1800; when set to an invalid multicast address, the default address of 225.86.67.83 is used  
 
CONF_UNSOLICITED_AUTODETECT_REPLY_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0957   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the time in seconds, when the VJ shall send out unsolicited autodetect reply to the RCP port(off when set to 0)  
 
  Write   t_dword   l_serv   set the time in seconds, when the VJ shall send out unsolicited autodetect reply to port 1800 (off when set to 0); uses broadcast, and multicast if AUTODETECT_REPLY_GROUP is set  
 
CONF_DISCOVER_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0976   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   get the discover port  
 
  Write   t_word   l_serv   set the discover port  
 
CONF_LOCAL_HTTP_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0954   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   get the local HTTP port for browser access  
 
  Write   t_word   l_serv   set the local HTTP port for browser access (NOTE: it is not allowed to turn both, HTTP and HTTPS, of at the same time)  
 
CONF_LOCAL_HTTPS_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a0e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   get the local HTTPS port for browser access  
 
  Write   t_word   l_serv   set the local HTTPS port for browser access (NOTE: it is not allowed to turn both, HTTP and HTTPS, of at the same time)  
 
CONF_RCP_SERVER_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a17   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   get the local RCP server TCP port number  
 
  Write   t_word   l_serv   set the local RCP server TCP port number, allowed: 0 or 1756 (Reboot necessary)  
 
CONF_TELNET_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a18   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   get the local Telnet TCP port number  
 
  Write   t_word   l_serv   set the local Telnet TCP port number, allowed: 0 or 23 (Reboot necessary)  
 
CONF_RTSP_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a63   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   reads the LocalRtspPort  
 
  Write   t_dword   l_serv   sets the local Rtsp port (0: Rtsp off)  
 
CONF_ENABLE_UPNP
  Tag code    NumDes    Message    SNMP Support  
  0x0ade   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flags   noprot   0: Upnp disabled; 1: Upnp enabled  
 
  Write   flag   l_serv   0: Upnp disabled; 1: Upnp enabled  
 
CONF_DHCP_VAL
  Tag code    NumDes    Message    SNMP Support  
  0x00af   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read the DHCP state (0=OFF, 1=ON);  
 
  Write   t_octet   l_serv   set DHCP ip configuration value (0=OFF, 1=ON, 2=ON, but do not kick mechanism now)  
 
CONF_DHCP_ON
  Tag code    NumDes    Message    SNMP Support  
  0x00ad   no   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   read the DHCP ON state  
 
  Write   f_flag   l_serv   enable DHCP ip configuration  
 
CONF_DHCP_OFF
  Tag code    NumDes    Message    SNMP Support  
  0x00ae   no   no   no  
 
  Datatype   Access Level   Description  
  Read   f_flag   noprot   read the DHCP OFF state  
 
  Write   f_flag   l_serv   disable DHCP ip configuration  
 
CONF_DHCP_STABLE
  Tag code    NumDes    Message    SNMP Support  
  0x0ac8   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   read whether DHCP machine is in possession of an IP  
 
  Write   %   l_serv   %  
 
CONF_DHCP_COMPLIANCY
  Tag code    NumDes    Message    SNMP Support  
  0x0ada   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   mode of dhcp operation, 0: use of last-assigned ip during non-available dhcp server allowed; 1: no fallback ips used, more compliant to rfc 2131  
 
  Write   t_octet   l_serv   mode of dhcp operation, 0: use of last-assigned ip during non-available dhcp server allowed; 1: no fallback ips used, more compliant to rfc 2131  
 
CONF_SNMP_SRV_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a25   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   Read the snmp server port  
 
  Write   t_word   l_serv   Set the snmp server port (reset nescessary)  
 
CONF_SNMP_TRAPS_HOST
  Tag code    NumDes    Message    SNMP Support  
  0x00b6   yes   no   yes  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not supported  
 
  Write   void   l_serv   not documented  
 
CONF_SNMP_TRAPS_HOST_STR
  Tag code    NumDes    Message    SNMP Support  
  0x00b7   yes   no   yes  
 
  Datatype   Access Level   Description  
  Read   void   noprot   not documented  
 
  Write   void   l_serv   not documented  
 
CONF_NBR_OF_TRAPS_HOSTS
  Tag code    NumDes    Message    SNMP Support  
  0x029d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   Number of hosts snmp traps can be sent to  
 
  Write   t_dword   l_serv   read only  
 
CONF_SNMP_TRAP_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x0a11   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   List of commands to be posted as snmp trap. See detailed description.  
 
  Write   p_octet   l_serv   List of commands to be posted as snmp trap. see detailed description  
 
Payload Structure
Trap Descriptor 1
4 Bytes
N x 4 Bytes Trap Descriptor N
4 Bytes ...
Trap Descriptor 1 - N
Sequence of:
16 32
RCP Message Code
2 Bytes		 Flags
2 Bytes
8 24
RCP Msg Code
The code of the RCP message that is to be forwarded as SNMP trap.
Flags
Values:
SNMP_TRAP_ENABLED1
CONF_PMPP_ADDRESS
  Tag code    NumDes    Message    SNMP Support  
  0x0ab9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   gets the Pmpp Address (allowed values: 1-63;)  
 
  Write   t_octet   l_serv   sets the Pmpp Address (allowed values: 1-63;)  
 
CONF_PMPP_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x0aba   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   gets the Pmpp Port of the Pmpp server(0: off)  
 
  Write   t_word   l_serv   sets the Pmpp Port of the pmpp server(0: off)  
 
CONF_ISCSI_IP
  Tag code    NumDes    Message    SNMP Support  
  0x09aa   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the iscsi host ip  
 
  Write   t_dword   l_serv   sets the iscsi host ip  
 
CONF_ISCSI_PORT
  Tag code    NumDes    Message    SNMP Support  
  0x09ab   yes (since fw > 4.00)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_word   noprot   numdes 0: connect port, 1: tunnel port, 2: server port  
 
  Write   t_word   l_serv   numdes 0: connect port, 1: tunnel port, 2: server port  
 
CONF_ISCSI_LUN
  Tag code    NumDes    Message    SNMP Support  
  0x09ac   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   gets the iscsi lun  
 
  Write   t_dword   l_serv   sets the iscsi lun  
 
CONF_ISCSI_TARGET_IDX
  Tag code    NumDes    Message    SNMP Support  
  0x09f9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the index of the iscsi target  
 
  Write   t_dword   l_serv   write the index of the iscsi target  
 
CONF_ISCSI_TARGET
  Tag code    NumDes    Message    SNMP Support  
  0x09ad   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   gets the iscsi target name string  
 
  Write   p_string   l_serv   sets the iscsi target string  
 
CONF_ISCSI_TCP_CONNECTIONS
  Tag code    NumDes    Message    SNMP Support  
  0x09ae   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the number of concurrent tcp connections to iscsi target  
 
  Write   t_dword   l_serv   set the number of concurrent tcp connections to iscsi target  
 
CONF_ISCSI_DISCOVERY
  Tag code    NumDes    Message    SNMP Support  
  0x09cc   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   performs a discovery and returns the result in an XML-like string; parameter ip (DWORD) and pwd string (64 char) structure in p_octet  
 
  Write   void   l_serv   not supported  
 
CONF_ISCSI_TARGET_PWD
  Tag code    NumDes    Message    SNMP Support  
  0x09ce   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   l_user   get the password to authenticate at the iSCSI server. FW version >= 4.00: This command returns the password of the first entry of the CONF_ISCSI_AUTH list.  
 
  Write   p_string   l_serv   set the password to authenticate at the iSCSI server. FW version >= 4.00: This command sets the password of the first entry of the CONF_ISCSI_AUTH list. If all characters of the string are the '*', the old stored value is not replaced.  
 
CONF_ISCSI_LOCK_OVERRIDE
  Tag code    NumDes    Message    SNMP Support  
  0x09d2   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   see detailed description  
 
  Write   p_string   l_serv   see detailed description  
 
Payload
A String with the following structure - ip_addr:target_idx:lun
This string identifies the iscsi lun on which the lock is to be overwritten. This option clears its value after a successful override.
Note
The datatype of this command was FLAG and changed to STRING with fw 2.50
CONF_ISCSI_LOCK_RELEASE_ON_LEAVE
  Tag code    NumDes    Message    SNMP Support  
  0x09e4   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   returns wheather the next iSCSI logout should use the release action  
 
  Write   flag   l_serv   advices the iSCSI initiator to release a lock at the target lun when the storage medium transitions away from iSCSI; this option clears its value after a successful release  
 
CONF_ISCSI_INITIATOR_NAME
  Tag code    NumDes    Message    SNMP Support  
  0x09d8   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   returns the used initiator name; only applicable when iSCSI is connected  
 
  Write   void   l_serv   not supported  
 
CONF_ISCSI_INITIATOR_NAME_EXTENTION
  Tag code    NumDes    Message    SNMP Support  
  0x09d9   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   returns the used initiator name extention; used for identification only  
 
  Write   p_string   l_serv   set the used initiator name extention; used for identification only  
 
CONF_ISCSI_SERVER_STATE
  Tag code    NumDes    Message    SNMP Support  
  0x0a2b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the state of the iscsi server (0: server down, 1: server running)  
 
  Write   t_dword   l_serv   set the iscsi server state (0: shutdown server, 1: start server)  
 
NOTE
The iscsi server is also started or stopped when you write the command CONF_STORAGE_LIST. If the storage list is empty or only contains entries with the 'iSCSI export' field set to 'For local use only' (0x00), the server is stopped if it is running cause no targets and luns would be provided. If the list contains at least one entry with the 'iSCSI export' field set to 'Make storage available through iSCSI' (0x01), the server is started, if not already running, to provide the iscsi service.
CONF_ISCSI_MNI
  Tag code    NumDes    Message    SNMP Support  
  0x0aa0   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   monitor iscsi targets.  
 
  Write   p_octet   l_serv   monitor iscsi targets.  
 
Request Payload Structure
Sequence of (max 64):
16 32
Target Descriptor
28 Bytes ...
8 24
Target Descriptor
16 32
Target Address
8 Bytes ...
Action
1 Bytes		 Reserved
3 Byte
Reserved
16 Bytes ...


8 24
Target Address
16 32
Target IP
4 Bytes
Target Index
1 Byte		 Reserved
3 Bytes
8 24
Action
Values:
DELETE0x00
ADD0x01
Response Payload Structure
Sequence of (max 64):
16 32
Target Descriptor
28 Bytes ...
8 24
Target Descriptor
16 32
Target Address
8 Bytes ...
Action
1 Byte		 Status
1 Byte		 Error
1 Byte		 Reserved
1 Byte
Starttime
4 Bytes
Session Status
1 Byte		 Session Error
1 Byte		 Reconnects
2 Byte
Reserved
4 Bytes
Uptime
4 Bytes
8 24
Target Address
See request packet for details.
Action
The value of the request packet. Zero in messages.
Status
Values:
FAIL0x00
SUCCESS0x01
Error
Values:
ISCSI_MNI_ERR_INV_TARG0x01
ISCSI_MNI_ERR_FULL0x02
ISCSI_MNI_ERR_TARG_PRES0x03
ISCSI_MNI_ERR_NOT_FOUND0x04
ISCSI_MNI_ERR_INTERN0x05
When an action request fails, this error field is set. On success or messages, this fild is zero.
ISCSI_MNI_ERR_INV_TARG - if the assigned target address is invalid (e.g. zero).
ISCSI_MNI_ERR_FULL - if the maxium of 64 iscsi targets is reached and a request packet with the ADD action was sent.
ISCSI_MNI_ERR_TARG_PRES - if a request packet if the ADD action was sent and the target address is already monitored.
ISCSI_MNI_ERR_NOT_FOUND - if a request packet if the DELETE action was sent and the target address is not currently monitored.
Target IP
The ip address of the iscsi target.
Target Index
The index of the iscsi target.
Starttime
The time when the monitoring process was started (in seconds since 2000).
Session Status
Values:
OFFLINE0x00
ONLINE0x01
ERROR0x02
Session Error
Values:
ISCSI_ERR_CONNECT0x31
ISCSI_ERR_LOGIN0x34
ISCSI_ERR_INV_TARG_IDX0x35
ISCSI_ERR_PWD0x36
ISCSI_ERR_PROTO0x37
ISCSI_ERR_TARG_NOT_REACH0x38
ISCSI_ERR_NO_MEM0x3a
ISCSI_ERR_SESS_CREATE0x3b
ISCSI_ERR_INV_PARAMS0x3c
ISCSI_ERR_SESS_NOT_FOUND0x3d
ISCSI_ERR_DISCONN0x3e
ISCSI_ERR_TIMEOUT0x3f
ISCSI_ERR_SOCK0x5f
ISCSI_SOCK_CLOSED0x7f
ISCSI_ERR_TCP_CONN_RST0x8f
ISCSI_ERR_IP_ZERO0xa0
Reconnects
The number of times the session was reconnected since the begin of the monitoring process.
Uptime
The number of seconds the session is online.
Use this command to monitor iscsi targets.
If you write this command, all the targets of the request packets are added/delete to the current monitoring list.
If you read this command, you will get the description of all currently monitored iscsi targets in the response packet.
Every time the status of a monitored target changes, a message is sent out with the current status of this target.
CONF_ISCSI_AUTH
  Tag code    NumDes    Message    SNMP Support  
  0x0ab0   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   l_user   see detailed description  
 
  Write   p_octet   l_serv   see detailed description  
 
Payload Structure
Sequence of (BVIP enc/dec: 2, generic_dll: 8):
16 32
Authentication Descriptor
140 Bytes ...
8 24
Authentication Descriptor
16 32
Target Address
8 Bytes ...
Type
4 Bytes
Params
128 Bytes ...
8 24
Target Address
The address of the iscsi target. If this field is set to zero, it is used as the default entry for authenticaion.
16 32
Target IP
4 Bytes
Target Index
1 Byte		 Reserved
3 Bytes
8 24
Type
Values:
NONE0
CHAP1
Params
Type = CHAP.
16 32
User
64 Bytes ...
Password
64 Bytes ...
8 24
User
The CHAP user name that is used for authentication.
Password
The CHAP password that is used for authentication.
NOTE
On a read command, the characters of the password are replaced by the '*'. On a write command, the password is only stored, if not all characters equal the '*' sign. Otherwise the old stored value is retained.
CONF_HD_MAX_NUMBER_OF_PARTITIONS
  Tag code    NumDes    Message    SNMP Support  
  0x0900   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the max number of partitions that can be created  
 
  Write   void   l_user   not supported  
 
CONF_HD_MAX_SLICES_PER_TRACK
  Tag code    NumDes    Message    SNMP Support  
  0x090a   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the max number of time slices in a track  
 
  Write   void   l_user   not supported  
 
CONF_HD_MAX_ALARM_TRACKS_PER_PARTITION
  Tag code    NumDes    Message    SNMP Support  
  0x0919   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get max number of alarm tracks for one partition  
 
  Write   void   l_user   not supported  
 
CONF_HD_PARTITIONS_RECORDING
  Tag code    NumDes    Message    SNMP Support  
  0x091a   yes (1 - primary recording ,2 - secondary recording)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   list of numbers of partitions (DWORDS) or cams in case of span recording with running recording  
 
  Write   void   l_user   not supported  
 
CONF_HD_PARTITION_RECORDING
  Tag code    NumDes    Message    SNMP Support  
  0x0a03   yes (partition or cam for span recording)   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   recording status of partition or cam if span recording for primary recording (1 = running, 0 = not running)  
 
  Write   t_dword   l_user   not supported  
 
CONF_HD_PARTITION_RECORDING_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4d   yes (partition or cam for span recording)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   recording status of this cam for secondary recording (1 = running, 0 = not running)  
 
  Write   t_dword   l_user   not supported  
 
CONF_HD_PARTITION_FILE_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x0901   partition   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   void   l_user   not supported  
 
Payload Structure (sequence of)
16 32
Start Time
4 Bytes
Stop Time
4 Bytes
Flags
32 Bits
File ID
4 Bytes
8 24
Start Time
Seconds since 2000.
Stop Time
Seconds since 2000.
Flags
Values:
Bit 0Recording Runing (actual recording is running on this file or recording not closed regulary)
Bit 1Recording Overwriting (recording takes place in a ring and old recording data will be overwritten)
Bit 2Alarm Input (there are input alarms in this file)
Bit 3Alarm Motion (there are motion alarms in this file)
Bit 4New Alarm (only file info message)
Bit 5Video Loss (there are video loss in this file)
Bit 6Time Recording (changed semantic from earlier versions)
Bit 7Alarm Recording (changed semantic from earlier versions)
Bit 8-15Track Fill Level (fill level in percent, always 100 % on filled ring recording)
Bit 16Alarm Remote (there are virtual/remote alarms in this file, see CONF_HD_MGR_SIGNAL_ALARM)
Bit 17-20Reserved
Bit 21Offline (VRM only)
Bit 22Protected (VRM only)
Bit 23-28Time Zone (Quarter hours)
Bit 29Time Zone Sign
Bit 30-31Reserved
NOTE: If this command is used get to file information on a span formated disk, the Session ID paramter must be set (a connect primitive must have been preceded). The num paramter (partition) has no meaning then, since a span has always only one partition. Alarm Recording und Time Recording flags changed semantic Alarm Recording flag marks a file that includes a pre alarm recording configured by a pre alarm time in the recording profiles, Time Recording flag marks the the files including normal time recording and/or post alarm. That means a closed File including pre and post alarm recordings will always have alarm and time recording flag set.
CONF_HD_PARTITION_PROP
  Tag code    NumDes    Message    SNMP Support  
  0x090b   yes (partition or cam if span recording mode)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_serv   see detailed description (effect takes place on next mounted span) (video type is obsolete, depends on CONF_CODER_VIDEO_TYPE_RESTRICTION settings)  
 
Payload Structure
Number
4 Bytes
Char 1
1 Byte		 62 x 1 Byte Char 64
1 Byte
Total Size
4 Bytes
Reserved
4 Bytes
Video Type
1 Byte		 Reserved
1 Byte		 Storage Type
1 Byte		 Enc. Preset
1 Byte
Number Of Alarm Tracks (obsolete)
4 Bytes
Size Of Alarm Track (obsolete)
4 Bytes
Video input channel
4 Bytes
Encoder index
1 Byte		 Reserved
3 Bytes
Reserved
32 Bytes ...
Char 1 - 64
Name of the partition (obsolete).
Size (obsolete)
In Megabyte
Video Type (obsolete, depends on CONF_CODER_VIDEO_TYPE_RESTRICTION settings)
Values:
No0x00
Mpeg20x01
Mpeg40x03
H2640x04
Storage Type (obsolete)
Values:
Linear0x00
Ring0x01
Enc. Preset
Number of the encoder preset 1 - 8. (obsolete here, can bet set in the recording profiles)
Size Of Alarm Track (obsolete)
In Megabytes.
Video input channel
Bitfield of used video channels (Bit0=channel 1...).
Encoder index
Number of the encoder instance. (obsolete here, can bet set in the recording profiles)
CONF_HD_PARTITION_PROP for Span Recording
This command cannot be set while the recording is running.
CONF_HD_PARTITION_PROP_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4e   yes (cam)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   partition properties for secondary recording, payload as in CONF_HD_PARTITION_PROP  
 
  Write   p_octet   l_serv   partition properties for secondary recording( effect takes place on next mounted span), payload is the same as the command CONF_HD_PARTITION_PROP  
 
CONF_HD_SIZE_MB
  Tag code    NumDes    Message    SNMP Support  
  0x090c   yes (0: default pm, >0: storage medium type)   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the total size of a local storage in megabytes  
 
  Write   -   l_serv   not writable  
 
CONF_HD_PARTITION_GEO
  Tag code    NumDes    Message    SNMP Support  
  0x090d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   obsolete  
 
  Write   p_octet   l_serv   obsolete  
 
CONF_HD_RECORD_SCHEDULE
  Tag code    NumDes    Message    SNMP Support  
  0x0a0b   cam   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read primary recording schedule, see detailed description  
 
  Write   p_octet   l_serv   set primary recording schedule(effect takes place on next mounted span), see detailed description  
 
Payload Structure
Sat. 1
4 Bits		 94 x 4 Bits Sat. 96
4 Bits		 Sun. 1
4 Bits		 94 x 4 Bits Sun. 96
4 Bits
Mon. 1
4 Bits		 94 x 4 Bits Mon. 96
4 Bits		 Tue. 1
4 Bits		 94 x 4 Bits Tue. 96
4 Bits
Wed. 1
4 Bits		 94 x 4 Bits Wed. 96
4 Bits		 Thu. 1
4 Bits		 94 x 4 Bits Thu. 96
4 Bits
Fri. 1
4 Bits		 94 x 4 Bits Fri. 96
4 Bits
Sat. 1 - 96
96 entries of recording profile numbers for Saturday, each represents the recording profile for a 15 min time period. First entry is from 00:00 to 00:15. The following entries are for the following 15 min time periods until 24:00.
Values:
recording off0
recording profile numbers1-10
Sun. 1 - 96
96 entries of recording profile numbers for Sun.
Mon. 1 - 96
96 entries of recording profile numbers for Mon.
Tue. 1 - 96
96 entries of recording profile numbers for Tue.
Wed. 1 - 96
96 entries of recording profile numbers for Wed.
Thu. 1 - 96
96 entries of recording profile numbers for Thu.
Fri. 1 - 96
96 entries of recording profile numbers for Fri.
HD_RECORD_SCHEDULE
This command reads/writes the primary recording schedule for the camera specified by the num parameter. The entries are 4 bit each and represent a recording profile for a 15 min time period(payload 336 bytes total). The recording profiles with same profile number can be different for each camera. See command HD_RECORD_PROFILES. The schedule will be written to the storage medium. In case of ram recording (see CONF_STORAGE_MEDIUM_TYPE), the schedule will be also stored in the config and will be used as default schedule for future ram recordings. In case of span recording mode (see CONF_RECORD_MODE_SPANS) the schedule will be only read from or stored in the config. This schedule is used as default schedule for each span that is mounted by this cam for primary span recording.
CONF_HD_RECORD_SCHEDULE_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a49   cam   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read secondary recording schedule, see detailed description  
 
  Write   p_octet   l_serv   set secondary recording schedule(effect takes place on next mounted span), see detailed description  
 
Payload Structure
Payload structure is the same as in the command HD_RECORD_SCHEDULE
HD_RECORD_SCHEDULE_SECONDARY
This command reads/writes the secondary recording schedule for the camera specified by the num parameter. This command only works for span recording. The entries are 4 bit each and represent a recording profile for a 15 min time period(payload 336 bytes total). The recording profiles with same profile number can be different for each camera. See command HD_RECORD_PROFILES. The schedule will be only read from or stored in the config. This schedule is used as default schedule for each span that is mounted by this cam for secondary span recording.
CONF_HD_RECORD_HOLIDAYS
  Tag code    NumDes    Message    SNMP Support  
  0x0a0c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read holiday schedule list for primary recording, see detailed description  
 
  Write   p_octet   l_serv   write holiday schedule list (effect takes place on next mounted span), see detailed description  
 
Payload Structure
holiday schedule entry 1
52 Bytes ...
N x 52 Bytes
holiday schedule entry N
52 Bytes ...
holiday schedule entry 1 - N
schedule entry specifing a holiday and it's recording schedule. max. 25 entries.
CONF_HD_RECORD_HOLIDAYS
This command reads/writes the Holiday table for the primary recording. On holidays the recording uses the special schedule instead of the standard schedule. The table contains N entries (max. 25) each entry specifies one or more holidays in a row followd by a recording schedule. the payload sends only valid holiday entries, so the size of N depends on the number of valid entries in the table.
Holiday Schedule Entry Structure
day
1 Byte		 month
1 Byte		 year
1 Byte		 number of days
1 Byte
reco 1
4 Bits		 94 x 4 Bits reco 96
4 Bits
day
day of the month, which is a holiday
Values:
invalid0
day of the month1 - 31
month
month of the year
Values:
invalid0
jan1
feb to nov2 - 11
dec12
year
year since 2000
Values:
year 2000 to 22550 - 255
number of days
number of days that follow the specified holiday, which are also scheduled as holidays. If only the specified date is the holiday, this field should be set to 1.
Values:
invalid0
number of days1 - 255
record schedule 1 - 96
this is the recocording schedule containing 96 entries of recording profile numbers for the holiday, each represents the recording profile for a 15 min time period. First entry is from 00:00 to 00:15. The following entries are for the following 15 min time periods until 24:00.
Values:
recording off0
recording profile numbers1 -10
CONF_HD_RECORD_PROFILES
  Tag code    NumDes    Message    SNMP Support  
  0x0a0d   cam   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read recording profiles, see detailed description  
 
  Write   p_octet   l_serv   set recording profiles (effect takes place on next mounted span), see detailed description  
 
Payload Structure
Recording Profile 1
56 Bytes ...
8 x 56 Bytes Recording Profile 10
56 Bytes ...
Recording Profile 1 - 10
10 recording profiles for the cammera specified by the num parameter, see detailed description for a recording profile
HD_RECORD_PROFILES
Read/Write the ten recording profiles for a camera, payload 560 bytes total. The profiles will be written to the storage medium. In case of ram recording (see CONF_STORAGE_MEDIUM_TYPE), the profiles will be also stored in the config and will be used as default profiles for future ram recordings. In case of span recording mode (see CONF_RECORD_MODE_SPANS) the profiles will be only read from or stored in the config. These profiles are used as default profiles for each span that is mounted by this cam for span recording.
recording profile structure
16 32
flags
8 Bits		 video preset nr
1 Byte		 post alarm video preset nr
1 Byte		 encoder index
1 Byte
intra only
1 Byte		 intra only qual post alarm
1 Byte		 profile name
34 Bytes ...
...
...
...
...
...
...
...
... 34 Bytes
pre alarm time
2 Byte		 post alarm time
2 Byte
motion alarm
4 Bytes
alarm input and remote alarm
4 Bytes
video loss alarm
4 Bytes
8 24
flags
Flags:
ALARM_RECORDING0x01flag for alarm recording, if set alarm recording on the alarm tracks will be active
AUDIO_RECORDING_DISABLE0x02flag for audio recording, if set audio will be disabled for recording
META_RECORDING_DISABLE0x04flag for meta recording, if set meta will be disabled for recording
video preset nr
video preset number used for recording
Values:
no recording on this profile0
video preset nr1 - 8
post alarm video preset nr
video preset number used for recording after occurence of an alarm
Values:
not set, uses video preset nr if set0
video preset nr for post alarm1 - 8
encoder index
index of the encoder stream starting with 0
intra only recording
for intra only recording, not supported by all devices
intra only recording quality post alarm
for intra only recording, qualitty after ocurrence of an alarm, not supported by all devices
profile name
profile name is a zero terminated string
pre alarm time
only relevant for alarm recording, if set, this time in seconds is the time the recording will be stored up to the alarm event
post alarm time
if set, this time in seconds is the time after an alarm event for that the post alarm video preset is used if set. After this time elapses, the recording will return to the standard video preset nr, if alarm recording, the recording will also stop the recording on the actual track and start a new one
motion alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 0; Bit 1 <-> Alarm Nbr. 1; ... ... ; Bit 31 <-> Alarm Nbr. 31
alarm input and remote alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 0; Bit 1 <-> Alarm Nbr. 1; ... ... ; Bit 27 <-> Alarm Nbr. 27 for alarm inputs, Bit 28 <-> Virt. Alarm Nbr. 3; ... ... ; Bit 31 <-> Virt. Alarm Nbr. 0 (reverse order) for virtual alarms caused by rcp command CONF_VIRTUAL_ALARM_STATE
video loss alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 0; Bit 1 <-> Alarm Nbr. 1; ... ... ; Bit 31 <-> Alarm Nbr. 31
CONF_HD_RECORD_PROFILES_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a91   cam   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   read recording profiles for secondary recording, payload is the same as in CONF_HD_RECORD_PROFILES  
 
  Write   p_octet   l_serv   set recording profiles for secondary recording (effect takes place on next mounted span) , payload is the same as in CONF_HD_RECORD_PROFILES  
 
CONF_HD_ALARM_MOTION
  Tag code    NumDes    Message    SNMP Support  
  0x0916   yes (partition)   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   alarm motion - obsolete  
 
  Write   flag   l_serv   write alarm motion - obsolete  
 
CONF_HD_ALARM_INPUT
  Tag code    NumDes    Message    SNMP Support  
  0x0917   yes (partition)   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   alarm input - obsolete  
 
  Write   flag   l_serv   write alarm input - obsolete  
 
CONF_HD_MGR_START
  Tag code    NumDes    Message    SNMP Support  
  0x0913   yes (partition or cam)   no   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   return TRUE when manager is on or when primary span recording is on and device is in span recording mode  
 
  Write   flag   l_serv   start the recording manager. Can cause recording if time/alarm recording selected. If in span recording mode the set span recording to on.  
 
CONF_HD_MGR_START_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a46   yes (partition or cam)   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   return TRUE when secondary span recording is on and device is in span recording mode  
 
  Write   flag   l_serv   start the recording manager. Can cause recording if time/alarm recording selected. If in span recording mode the set span recording to on.  
 
CONF_HD_MGR_STOP
  Tag code    NumDes    Message    SNMP Support  
  0x0914   partition or cam   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   return TRUE when manager is off or when primary span recording is off and device is in span recording mode  
 
  Write   flag   l_serv   stop the recording manager. Can cause stop recording if time/alarm recording selected. If in span recording mode the set span recording to off.  
 
CONF_HD_MGR_STOP_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a47   partition or cam   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   return TRUE when secondary span recording is off  
 
  Write   flag   l_serv   set span secondary recording to off.  
 
CONF_HD_MPEG4_ACTIVE
  Tag code    NumDes    Message    SNMP Support  
  0x093c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   signals an active hdd MPEG4 partition  
 
  Write   -   l_serv   not supported  
 
CONF_HD_RECORDING_REPORT
  Tag code    NumDes    Message    SNMP Support  
  0x0a1c   yes (cam)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get recording report from actual primary recording on a cam,  
 
  Write   p_octet   l_serv   not supported  
 
This comand reads the recording report of an actual running recording of a cam. The recording report contains information about RTP and VDP packets as well as VDP allocation of a running recording. The cam is specified by the num parameter.
Version 1
16 32
start_counting_time
4 Bytes
VDP_allocation_no_wait
4 Bytes
VDP_allocation_wait
4 Bytes
VDP_allocation_failed
4 Bytes
8 24
start_counting_time
time, since when the VDP allocation counting was started, this should be the time when the recording had started or since the last clear of the report.
VDP_allocation_no_wait
number of allocated VDPs since start_counting_time without blocking
VDP_allocation_wait
number of allocated VDPs since start_counting_time with blocking a time
VDP_allocation_failed
number of VDPs that couldn't allocated, because waiting for the at the block pool timed out or failed. Means also an rtp packet had to be discarded.
Version 2
16 32
Version
1 Byte		 Reserved
3 Bytes
Start Seconds
4 Bytes
Start Milliseconds
4 Bytes
VDP Allocation No Wait
4 Bytes
VDP Allocation Wait
4 Bytes
VDP Allocation Fail
4 Bytes
Encoder Data
48 Bytes ...
Storage Data
48 Bytes ...
Network Data
48 Bytes ...
Reserved
48 Bytes ...
8 24
Version
Version information.
Start Seconds
Timestamp in seconds since 2000 when the counting of recording data started.
Start Milliseconds
Milliseconds of the timestamp when the counting of recording data started.
VDP Allocation No Wait
Number of VDP allocation operation performed without waiting.
VDP Allocation Wait
Number of VDP allocation operation performed with waiting.
VDP Allocation Fail
Number of VDP allocation operation failed.
Encoder Data
16 32
Video RTP Packet Count
4 Bytes
Video Byte Count
4 Bytes
Reserved
4 Bytes
Audio RTP Packet Count
4 Bytes
Audio Byte Count
4 Bytes
Reserved
4 Bytes
Meta Packet Count
4 Bytes
Meta Byte Count
4 Bytes
Reserved
4 Bytes
Reserved
12 Bytes ...
8 24
Video RTP Packet Count
Number of video RTP packets that are deliverd to the recording.
Video Byte Count
Number of video bytes that are deliverd to the recording.
Audio RTP Packet Count
Number of audio RTP packets that are delivered to the recording.
Audio Byte Count
Number of audio bytes that are deliverd to the recording.
Meta RTP Packet Count
Number of meta RTP packets that are delivered to the recording.
Meta Byte Count
Number of meta bytes that are deliverd to the recording.
Storage Data
16 32
(Video + Audio) VDP Packet Count
4 Bytes
(Video + Audio) Byte Count
4 Bytes
Reserved
4 Bytes
Audio VDP Packet Count
4 Bytes
Audio Byte Count
4 Bytes
Reserved
4 Bytes
Meta VDP Packet Count
4 Bytes
Meta Byte Count
4 Bytes
Reserved
4 Bytes
Reserved
12 Bytes ...
8 24
Video VDP Packet Count
Number of video + audio VDP packets that are written to storage (since fw 4.0 there are vdp packets containing video and audio data mixed, these packets will be counted here and not in the "Audio VDP Packet Count" field).
Video Byte Count
Number of video + audio bytes that are written to storage (since fw 4.0 there are vdp packets containing video and audio data mixed, these packet bytes will be counted here and not in the "Audio Byte Count" field).
Audio VDP Packet Count
Number of audio VDP packets that are written to storage.
Audio Byte Count
Number of audio bytes that are written to storage.
Meta Packet Count
Number of meta VDP packets that are written to storage.
Meta Byte Count
Number of meta bytes that are written to storage.
Network Data
16 32
Bytes Read
4 Bytes
Bytes Write
4 Bytes
Reserved
40 Bytes ...
8 24
Bytes Read
Number of Bytes that are read from storage.
Bytes Write
Number of Bytes that are written to storage.
CONF_HD_RECORDING_REPORT_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4f   yes (cam)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get recording report from actual secondary recording on a cam, payload same as in command CONF_HD_RECORDING_REPORT  
 
  Write   p_octet   l_serv   not supported  
 
CONF_RECORDING_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x0a9b   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get the current recording status,  
 
  Write   p_octet   l_serv   not supported  
 
Request Structure
16 32
Camera
1 Byte		 Recording Index
1 Byte		 Reserved
34 Bytes ...
8 24
Camera
The camera index.
Recording Index
Values:
Primary1
Secondary2
Response Structure
16 32
Camera
1 Byte		 Recording Index
1 Byte		 Status
1 Byte		 Error
1 Byte
Current Recording Span
8 Bytes ...
Reserved
4 Bytes
Datarate
4 Bytes
packet alloc no wait
4 Bytes
packet alloc wait
4 Bytes
packet alloc failed
4 Bytes
recent time period
4 Bytes
8 24
Camera
The camera index.
Recording Index
Values:
Primary1
Secondary2
Status
Values:
OFFLINE1
IDLE2
PEND3
RUNNING4
ERROR5
Error
See error codes of CONF_SPAN_USE_STATUS.
Current Recording Span
The address of the span the camera is recording to.
16 32
IP
4 Bytes
Target Index
1 Byte		 Lun
1 Byte		 Span Index
2 Byte
8 24
IP
The ip address of the storage.
Target Index
In index of the iscsi target.
Lun
The lun indentifier.
Span Index
The index of the span.
Datarate
The datarate that is written to the storage.
packet alloc no wait
recently alloc no wait vdp packets (1.5 kbyte) since recent time period
packet alloc wait
recently alloc wait vdp packets (1.5 kbyte) since recent time period (indicates problems of the recording get its data to the drive)
packet alloc failed
recently alloc failed vdp packets (1.5 kbyte) since recent time period (indicates problems of the recording get its data to the drive, corrupt data stream)
recent time period
time period in which the packet allock counter were counted
CONF_RECORDING_RETENTION_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0a30   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the primary recording retention time for a camera (in seconds).  
 
  Write   t_dword   l_serv   set the primary recording retention time for a camera (in seconds). (effect takes place on next mounted span)  
 
CONF_RECORDING_RETENTION_TIME_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a48   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the secondary recording retention time for a camera (in seconds).  
 
  Write   t_dword   l_serv   set the secondary recording retention time for a camera (in seconds). (effect takes place on next mounted span)  
 
CONF_REMOTE_REC_DEVICE
  Tag code    NumDes    Message    SNMP Support  
  0x0a85   yes (max 8)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_string   noprot   Get the ip address of the remote recording device (max. 50 characters).  
 
  Write   p_string   l_serv   Set the ip address of a remote recording device (max. 50 characters).  
 
CONF_REC_MGNT
  Tag code    NumDes    Message    SNMP Support  
  0x0a89   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   Read the type of the recording management (0 = LOCAL, 1 = VRM, 2 = VRM+ANR, 3 = ONLY LOCAL)  
 
  Write   t_octet   l_serv   Set the type of the recording management (0 = LOCAL, 1 = VRM, 2 = VRM+ANR, 3 = ONLY LOCAL) (not possible to change settings while recording)  
 
CONF_HD_MGR_REC_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x0aae   yes (cam)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_serv   not supported  
 
Payload Structure
16 32
rec state
1 Byte		 rec preset
1 Byte		 enc preset
1 Byte		 flags
1 Byte
8 24
rec state
state of the recording, state OFF not in payload of msg
Values:
OFF0
NO RECORDING1
STAND BY2
PRE ALARM RECORDING3
ALARM RECORDING4
POST ALARM RECORDING5
rec preset
actual used recording preset from 1 to 10 or 0 if no preset is used
enc preset
actual used encoder preset from 1 to 8 or 0 if no preset is used
flags
these flags show the alarm states and the recording mode
Values:
alarm recording mode0x01
input alarm0x02
motion alarm0x04
video loss0x08
virtual alarm0x10
reserved for extension0x80
CONF_HD_MGR_REC_STATUS
This command shows the state for a recording. It can be read and it will be send at state changes. State changes are the change of rec state or rec preset only. Within the Msg there is no distiction between the state OFF and NO RECORDING. That means no msg will be send on the state change between this two states. The msg will never contain the state OFF but the read response maybe. OFF state means the recording is configured to off by set it to stop. NO RECORDING can be caused by many things e.g. no recording on the schedule, no storage present and so on. STAND BY means there is recording on the schedule but not at the moment. The recording scheduler waits for the time to start the recording. All the other states indicating a running recording.
CONF_HD_MGR_REC_STATUS_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0aaf   yes (cam)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   same as CONF_HD_MGR_REC_STATUS but for secondary recording (see cmd CONF_HD_MGR_REC_STATUS)  
 
  Write   p_octet   l_serv   not supported  
 
CONF_HD_FILE_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x091d   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   read not supported (only for messages),  
 
  Write   void   l_serv   not supported  
 
Payload Structure
16 32
start time
32 Bits
end time
32 Bits
flags
32 Bits
file id
32 Bits
span ip
4 Bytes
target idx
1 Byte		 lun
1 Byte		 span idx
16 Bits
cam
1 Byte		 recording idx
1 Byte		 reserved
2 Bytes
8 24
start time
start time in seconds since 2000 of the recording file
end time
end time in seconds since 2000 of the recording file
flags
file info flags, see CONF_HD_PARTITION_FILE_INFO
file id
File ID on the file unique per span
span ip
Span ip address
target idx
target index of the span
lun
lun of the span
span idx
span index
cam
camera from 1 to ...
recording idx
recording index (primary or secondary)
Values:
primary1
secondary2
CONF_HD_FILE_INFO
This message is used for updating actual recording files, it will be send periodically about every second by the recording device, that is running the recording on that file. The message informs about the start and end time changes of an file. For uniqe idetification, the message includes the span address and a file id. it also has the information about the recording cam (attention: in older firmware the file info msg only has the first 4 payload fields(from start time to file id))
CONF_HD_FILE_INFO_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a64   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   void   noprot   read not supported (only for messages), see definition CONF_HD_FILE_INFO  
 
  Write   void   l_serv   not supported  
 
CONF_HD_RELOAD_PARTITION_FILE_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x091e   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   not supported (message signals an obsolete file list (num==partition))  
 
  Write   void   l_serv   not supported  
 
CONF_HD_RECORDING_ACTIVE
  Tag code    NumDes    Message    SNMP Support  
  0x0908   no   yes   yes  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   1: yes 0: no (message only, a request on this command always returns zero)  
 
  Write   -   l_serv   not supported  
 
CONF_HD_REPLAY_START
  Tag code    NumDes    Message    SNMP Support  
  0x0902   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   returns t_int parameter in percent of realtime replay (default +100%); 0 if suspended or stopped; Session ID is needed  
 
  Write   t_int   l_user   start a HD replay at the current position; t_int parameter in percent of realtime replay (default +100%); negative values will result in a reverse replay; Session ID is needed  
 
CONF_HD_REPLAY_STOP
  Tag code    NumDes    Message    SNMP Support  
  0x0903   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   flag   noprot   1=replay is stopped; 0=replay is in progress  
 
  Write   flag   l_user   stop a current HD replay; replay pointer will not be affected; Session ID is needed  
 
CONF_HD_REPLAY_STOP_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0904   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_user   see detailed description  
 
Payload Structure
16 32
Seconds
4 Bytes
Milliseconds
4 Bytes
8 24
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
This command will return a write error if the timeposition is outside a recording set. The Session ID is needed. A value of zero clears the stop marker.
CONF_HD_REPLAY_SEEK_TIME
  Tag code    NumDes    Message    SNMP Support  
  0x0905   no   yes (every second)   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_user   see detailed description  
 
Payload Structure
16 32
Seconds
4 Bytes
Rtp Timestamp
4 Bytes
8 24
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
Rtp Timestamp
Only in message. Rtp timestamp of the first replayed RTP packet of this second.
This command will return a write error if the timeposition is outside a recording set. The Session ID is needed.
CONF_HD_REPLAY_SEEK_IFRAME
  Tag code    NumDes    Message    SNMP Support  
  0x0907   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_int   noprot   obsolete  
 
  Write   t_int   l_user   set the replay pointer to the beginning of the next/last I-Frame(s); parameter t_int counted in frames relative to the current frame; Session ID is needed  
 
CONF_HD_REPLAY_EVENT_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x091f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_user   read only  
 
Payload Structure
16 32
Event Time
4 Bytes
Flags
4 Bytes
8 24
Event Time
Seconds since 2000.
Flags
Values:
Bit 0Motion Alarm
Bit 1Input Alarm
Bit 2Video Loss
Bit 3Virtual alarm (see CONF_VIRTUAL_ALARM_STATE)
CONF_HD_REPLAY_EVENT_INFO
List of recorded alarm events in backward order, since fw 4.0 events are only alarm state changes. Max size of the list is 128 entries. The command needs a valid replay session and the end time in secconds since 2000.
CONF_HD_REPLAY_PARTITION_EVENT_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x091c   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get the last 512 alarm events of the partition (obsolete)  
 
  Write   p_octet   l_user   read only  
 
CONF_HD_REPLAY_MOTION_SAMPLES
  Tag code    NumDes    Message    SNMP Support  
  0x095d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   p_octet   l_user   read only  
 
Payload Structure
16 32
Sec. End
4 Bytes
Sample Interval
4 Bytes
Maximum Sample Bytes
4 Bytes
Bytes Per Sample
4 Bytes
8 24
Sample Interval
Values:
Seconds0
Minutes1
Houres2
Maximum Sample Bytes
Values:
Seconds0
Bytes Per Sample
1, 2, 4, 8. Time is included.
Read motion samples of a recording. Session ID required.
CONF_HD_REPLAY_FAST_INTRA_DELAY
  Tag code    NumDes    Message    SNMP Support  
  0x095e   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get the delay (in 10ms) between the frames in intra only replay mode  
 
  Write   t_dword   l_user   set the delay (in 10ms) between the frames in intra only replay mode  
 
CONF_HD_REPLAY_LIVE
  Tag code    NumDes    Message    SNMP Support  
  0x0963   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   get replay or live mode 0=replay, 1=live (session ID required)  
 
  Write   t_dword   l_user   switch replay or live mode 0=replay, 1=live (session ID required)  
 
CONF_HD_REPLAY_SIZE_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x0906   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   see detailed description  
 
  Write   %   l_user   %  
 
Request Packet
16 32
Starttime
4 Bytes
Stoptime
4 Bytes
8 24
Starttime
In seconds since 2000.
Stoptime
In seconds since 2000.
Reply Packet
16 32
Max Size
8 Bytes ...
Max. Number Of Rtp Packets
11 Bytes ...
8 24
Max Size
In Bytes.
Replay session id required.
CONF_HD_REPLAY_VCD_LAYER
  Tag code    NumDes    Message    SNMP Support  
  0x09c8   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   requested vcd layer 0=no vcd data, 1=layer1 ,2=layer2,..; replay session id required  
 
  Write   t_dword   l_user   requested vcd layer 0=no vcd data, 1=layer1 ,2=layer2,..; replay session id required  
 
CONF_HD_REPLAY_VCD_CONFIG_ID
  Tag code    NumDes    Message    SNMP Support  
  0x0a5f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   requested vcd config ID 0=all vcd data, 1=config1 data, 2=config2 data,..; replay session id required  
 
  Write   t_dword   l_user   requested vcd config 0=all data, 1=config1 data ,2=config2 data,..; replay session id required  
 
CONF_FORMAT_FS
  Tag code    NumDes    Message    SNMP Support  
  0x09d0   storage medium (0=DEFAULT is recording storage device, 1=recording storage device, 2=RAMDISK)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   check the filesystem of a storage device status (0= no device present, 1=FAT32 not supported, 2=no FAT32 present, 3=FAT32 not mounted, 4=device is FAT32 mounting, 5=FAT32 format is running, 6=only FAT32, 7=FAT32 including recording, files 8=FAT32 including recording files and replay tools)  
 
  Write   t_dword   noprot   format a file system (FAT32) and creates files for the recordings and writes the tools for replay depending on the size of the storage device, returns TRUE if the request could be successfully queued, CONF_FORMAT_FS_STATUS messages report the progress and status about the format  
 
CONF_FORMAT_FS_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x09d1   yes (file system nr, 1 - recording storage device, 2 - RAMDISK)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   status and progress of a running format requested by CONF_FORMAT_FS  
 
  Write   p_octet   noprot   status and progress of a running format requested by CONF_FORMAT_FS, see detailed description  
 
Payload Structure
16 32
step
1 Byte		 status
1 Byte		 progress
2 Byte
8 24
step
Which step of the formating (FAT32 Formatting including creating recording files or copy replay tools)
Values:
HD_STEP_FORMAT_FS0x00
HD_STEP_COPY_TOOLKIT0x01
status
reports the state of formatting. The format can be in state of running, failed or successfully finished. The last one is devided in the two states of HD_FORMAT_STATUS_FINISHED which means FAT32 including recording files and replay tools were created and HD_FORMAT_STATUS_SKIPPED which means that only the FAT32 was created because the storage device was not the needed size for recording.
Values:
HD_FORMAT_STATUS_FAILED0xff
HD_FORMAT_STATUS_RUNNING0x00
HD_FORMAT_STATUS_SKIPPED0x01
HD_FORMAT_STATUS_FINISHED0x02
progress
value from 0 to 100 represent the progress of the format including copy replay tools in percent.
Values:
progress in percent0 to 100
CONF_FORMAT_FS_STATUS
the message reports the status and progress of a running format. The formatting takes two steps that is first formating FAT32 including creating the recording files and second copy the replay tools. The progress is reported about the whole formatting. The status reports the state of each formatting step. A successful format should always end with a message with 100 percent progress, step should be copy toolkit and status should be HD_FORMAT_STATUS_FINISHED or HD_FORMAT_STATUS_SKIPPED if the storage device is too small for recording (e.g. RAMDISK). A failed format should finish with a status HD_FORMAT_STATUS_FAILED at any progress and step. After this final messages no futher message will follow.
CONF_FORMAT_FS_SPAN
  Tag code    NumDes    Message    SNMP Support  
  0x09e6   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   format the lun into spans.  
 
  Write   p_octet   l_serv   format the lun into spans. (not allowed while recording on this lun)  
 
Payload Structure
16 32
Server IP
4 Bytes
Target IDX
1 Byte		 Lun IDX
1 Byte		 Span Cnt
2 Byte
Span Size
4 Bytes
8 24
Server IP
The iSCSI server ip address
Values:
Local connected USB diskff.ff.ff.ff
iSCSI Servervalid ip address
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI discover.
Lun IDX
Index of the lun of the specified target.
Span Cnt
Number of spans the lun shall be formated with
Span Size
Size of each span in megabyte. (1 MB = 1024 x 1024 Bytes)
Note
The reply packet will contain the values of the actually formated spans and size. If the product of the span count and the span size in the request packet exceeds the size of the current lun, only as many as possible spans are formatted. If the product is less than the available lun space, the back part of the lun will be unused.
Specific Error Types
SPAN_ERR_INTERNAL0x01
SPAN_ERR_NOT_MNTD0x05
SPAN_ERR_INV_FS0x06
SPAN_ERR_INV_LUN_NFO0x07
SPAN_ERR_RD_ONLY0x0a
SPAN_ERROR_OLD_LUN_NFO0x20
ISCSI_ERROR_CONNECT0x31
ISCSI_ERROR_INV_LUN0x33
ISCSI_ERROR_LOGIN0x34
ISCSI_ERROR_INV_TRG_IDX0x35
CONF_FORMAT_FS_SPANS_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x09f5   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   status and progress of a running format requested by CONF_FORMAT_FS_SPANS, see detailed description  
 
  Write   p_octet   l_serv   status and progress of a running format requested by CONF_FORMAT_FS_SPANS, see detailed description  
 
Payload Structure
16 32
step
1 Byte		 status
1 Byte		 progress
2 Byte
ip
4 Bytes
target_idx
1 Byte		 lun
1 Byte		 reserved
2 Byte
8 24
step
Which step of the formating (FAT32 Formatting including creating spans and clearing span headers)
Values:
HD_STEP_FORMAT_FS0x00
HD_STEP_CLEAR_SPAN_HEADER0x02
status
reports the state of formatting. The format can be in state of running, failed or successfully finished. success means the creation of the fat32 file system and the empty spans or clearing the span headers was successfully.
Values:
HD_FORMAT_STATUS_FAILED0xff
HD_FORMAT_STATUS_RUNNING0x00
HD_FORMAT_STATUS_FINISHED0x02
progress
value from 0 to 100 represent the progress of the format including the creation of the empty recording spans and clearing the header files.
Values:
progress in percent0 to 100
ip
ip of the storage device or lun, that is formatting
target_idx
Target Index of the storage device from 0 to 255.
lun
Lun of the storage device from 0 to max. 255.
reserved
2 Bytes reserved
CONF_FORMAT_FS_SPANS_STATUS
this message reports the status and progress of a running format. The formatting includes the creation of the FAT32 file system (step: HD_STEP_FORMAT_FS) and clearing of the span header files(step: HD_STEP_CLEAR_SPAN_HEADER). The progress is reported about the whole formatting. A successful format should always end with a message with 100 percent progress at step HD_STEP_CLEAR_SPAN_HEADER and status should be HD_FORMAT_STATUS_FINISHED. A failed format should finish with a status HD_FORMAT_STATUS_FAILED at any progress and any step. After these final messages no futher messages will follow. The whole formatting takes two steps HD_STEP_FORMAT_FS and HD_STEP_CLEAR_SPAN_HEADER. First step HD_STEP_FORMAT_FS will run up to 90 percent and will end with a 90 percent progress message and status HD_FORMAT_STATUS_FINISHED if successful. Then the last step HD_STEP_CLEAR_SPAN_HEADER will follow from 90 to 100 percent and will also end with a HD_FORMAT_STATUS_FINISHED status if successfull, which is also as mentioned earlier the final success message.
CONF_SPAN_ADDRESS_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x09e7   yes (1 - primary spanlist, 2 - secondary spanlist)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   See detailed description.  
 
  Write   p_octet   l_serv   See detailed description.  
 
Payload Structure
Span Address 1
8 Bytes ...
126 x 8 Bytes Span Address 128
8 Bytes ...
Span Address 1 - 128
For the structure of a span address so description below.
16 32
Server IP
4 Bytes
Target IDX
1 Byte		 Lun IDX
1 Byte		 Span IDX
2 Byte
8 24
Server IP
The iSCSI server ip address.
Values:
Local connected USB diskff.ff.ff.ff
iSCSI ServerValid IP address
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI discover.
Lun IDX
Index of the lun of the specified target.
Span IDX
Index of the span in the specified lun.
Write request
On a write request, a list of 128 span addresses must be supplied. List entrys that are zero are not used by the unit for recording. The unit uses the supplied ordering of the list and begins with the first entry.
If the device is already recording on spans (a span list is already present on the device), the new list must contain the span addresses, that the unit is currently recording on. The latter information can be obtained by reading the current span address list form the unit and check the corresponding write lock header (if the units IP and MAC address is found this means the unit is recording). If the unit receives a list and the span addresses of the spans the device is currently recording on is not present, the list is rejected (not saved in the configuration) and an error is returned
Read Request
The reply to an read request always contains 128 entrys. This entrys are all zero, if the unit did not already received a span address list.
Specific Error Types
SPAN_ERR_INTERNAL0x01
SPAN_ERR_INV_ADDR_LIST0x04
CONF_SPAN_ADDRESS_LIST_NEW
  Tag code    NumDes    Message    SNMP Support  
  0x0a52   yes (1 - primary spanlist, 2 - secondary spanlist)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   See detailed description of CONF_SPAN_ADDRESS_LIST  
 
  Write   p_octet   l_serv   See detailed description of CONF_SPAN_ADDRESS_LIST (no need to include mounted spans in list)  
 
CONF_SPAN_HDR_ACCESS
  Tag code    NumDes    Message    SNMP Support  
  0x09e8   yes   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Access span header information.  
 
  Write   p_octet   l_serv   Access span header information.  
 
Payload Structure
16 32
Server IP
4 Bytes
Target IDX
1 Byte		 Lun IDX
1 Byte		 Span IDX
2 Byte
Span Header
N Bytes ...
8 24
Server IP
The iSCSI server ip address.
Values:
Local connected USB diskff.ff.ff.ff
iSCSI ServerValid IP address
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI discover.
Lun IDX
Index of the lun of the specified target.
Span IDX
Index of the span in the specified lun.
Span Header
Data of the span header. Length and structure differs for the specified header type. The header type is specified with the numeric descriptor:
Values:
LOCK HEADER0x01
16 32
Lock owner IP
4 Bytes
Lock owner MAC
6 Bytes ...
Reserved
2 Byte
8 24
Lock owner IP
IP address of the unit that holds the write lock of the span.
Lock owner MAC
Hardware address of the unit that holds the write lock of the span
NOTE:
In the request packet, the header values are ignored (may be zero). The reply contains the values read or written.
On write requests, the local IP and MAC addresses are converted to ascii strings and written to the file LCKxxxxx.txt (xxxx = span index) on disk. On read requests, the ascii strings of that file are scanned into binary values and send with the reply.
MANAGER HEADER0x02
16 32
Manager Header Data
N Bytes (max. 1024) ...
8 24
Manager Header Data
Transparent header data of the storage manager
The reply always returns the 1024 Bytes of the manager header file MGRxxxx.txt (xxxx = span index).
UNIT HEADER0x03
16 32
Span owner IP
4 Bytes
Span owner MAC
6 Bytes ...
Span owner Camera
2 Byte
Retention Time
4 Bytes
Modification seal random
4 Bytes
Modification seal time
4 Bytes
Recording
1 Byte		 reserved
3 Bytes
8 24
Span owner IP
IP address of the unit that holds the write lock of the span.
Span owner MAC
Hardware address of the unit that holds the write lock of the span
Span owner Camera
The index of the camera the unit uses for recording.
Retention Time
Retention Time for the recordings on this span in sec since 2000
Modification seal random
random number set on the last modifacation of this span, this random will be set on each write access on any span header or on starting or stopping a recording of a device on this span, there will be also updates while a device is recording in a period of several minutes
Modification seal time
this information is the time of the last modification on this span that causes a modification seal update
Recording
for dual recording, 1 - primary recording, 2 - secondary recording, if this value is not set then default is primary recording
NOTE:
In the read request packet, the header values are ignored (may be zero). In the write requst packet, only the camera field is evaluated, the values for IP and MAC are taken from local configuration. The reply packet contains the values read or written.
On write requests, the local IP and MAC addresses and the supplied camera value are converted to ascii strings and written to the file UNTxxxxx.txt (xxxx = span index) on disk. On read requests, the ascii strings of that file are scanned into binary values and send with the reply.
The modification seal values cannot be set by this command as write request directly, they will be set automatically on span header write requests or on starting or stopping a recording. The content of this fields will be ignored in a write request.
Specific Error Types:
SPAN_ERR_INTERNAL0x01
SPAN_ERR_INV_SPN_IDX0x02
SPAN_ERR_INV_HDR_TYPE0x03
SPAN_ERR_NOT_MNTD0x05
SPAN_ERR_INV_FS0x06
SPAN_ERR_INV_LUN_NFO0x07
SPAN_ERR_BAD_HDR_CKSM0x08
SPAN_ERR_RD_ONLY0x0a
ISCSI_ERROR_CONNECT0x31
ISCSI_ERROR_INV_LUN0x33
ISCSI_ERROR_LOGIN0x34
ISCSI_ERROR_INV_TRG_IDX0x35
CONF_RECORD_MODE_SPANS
  Tag code    NumDes    Message    SNMP Support  
  0x09f6   no   no   yes  
 
  Datatype   Access Level   Description  
  Read   t_octet   noprot   returns 0x00 if span recording is off, 0x01 if on  
 
  Write   t_octet   l_serv   Set span recording mode to on 0x01 or off 0x00 (obsolete, device is always in mode on)  
 
CONF_START_SPAN_RECORD
  Tag code    NumDes    Message    SNMP Support  
  0x09f7   yes (1 - primary recording, 2 - secondary recording)   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   returns the 4 bytes bitmap of span recording for the cameras 4 bytes bitmap (1 : on, 0 : off) for each cam (bit 0 -> cam 1 bit 1 -> cam 2 ...)  
 
  Write   p_octet   l_serv   Start span recording on choosen cameras first 4 bytes bitmap (1 : on, 0 : off) for each cam (bit 0 -> cam 1 bit 1 -> cam 2 ...), last 4 bytes bit mask for setting only choosen cameras (bit 0 -> cam 1 bit 1 -> cam 2 ...)  
 
CONF_SPAN_PARTITION_PROP
  Tag code    NumDes    Message    SNMP Support  
  0x09fa   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   return partition properties for primary span recording (4 bytes) video type (1 byte: 0= NO, 1=MPEG2, 3=MPEG4), reserved (3 byte)  
 
  Write   p_octet   l_serv   set partition properties for primary span recording (4 bytes) video type (1 byte: 0= NO, 1=MPEG2, 3=MPEG4, 4=H264) (obsolete, depends on CONF_CODER_VIDEO_TYPE_RESTRICTION settings), reserved (3 byte), (not supported while recording is running)  
 
CONF_SPAN_PARTITION_PROP_ALARM
  Tag code    NumDes    Message    SNMP Support  
  0x09fb   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   return partition properties for primary span alarm recording (8 bytes) number of alarm tracks max 128(4 byte DWORD), size of an alarm track in MB(4 byte DWORD)  
 
  Write   p_octet   l_serv   set partition properties for primary span alarm recording (8 bytes) number of alarm tracks max 128(4 byte DWORD), size of an alarm track in MB(4 byte DWORD)  
 
CONF_SPAN_PARTITION_PROP_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4b   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   return partition properties for secondary span recording (4 bytes) video type (1 byte: 0= NO, 1=MPEG2, 3=MPEG4), reserved (3 byte)  
 
  Write   p_octet   l_serv   set partition properties for secondary span recording (4 bytes) video type (1 byte: 0= NO, 1=MPEG2, 3=MPEG4, 4=H264) (obsolete, depends on CONF_CODER_VIDEO_TYPE_RESTRICTION settings), reserved (3 byte), not allowed while recording is running  
 
CONF_SPAN_PARTITION_PROP_ALARM_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4c   yes (camera)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   return partition properties for secondary span alarm recording (8 bytes) number of alarm tracks max 128(4 byte DWORD), size of an alarm track in MB(4 byte DWORD)  
 
  Write   p_octet   l_serv   set partition properties for secondary span alarm recording (8 bytes) number of alarm tracks max 128(4 byte DWORD), size of an alarm track in MB(4 byte DWORD)  
 
CONF_SPAN_USE_STATUS
  Tag code    NumDes    Message    SNMP Support  
  0x09f8   cam   yes   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   usage status of a span, see detailed description  
 
  Write   p_octet   l_serv   not supported  
 
Payload Structure
16 32
use status message 1
12 Bytes ...
use status message 2
12 Bytes ...
8 24
use status message 1 - 2
Upto 2 span use status messages. If no span is in use by the camera specified by num, the reply payload size will be 0. In case of the rcp message the payload contains always 1 span use status message.
Span Use Status Message Structure
16 32
error
1 Byte		 status
1 Byte		 cam
2 Bytes
ip
4 Bytes
target_idx
1 Byte		 lun
1 Byte		 span_idx
2 Byte
8 24
error
additional error or status code to the status, for status HD_SPAN_USE_STATUS_ERROR_MOUNT see section "status HD_SPAN_USE_STATUS_ERROR_MOUNT error codes", for status RELEASE and RELEASE_UNUSED see section "status RELEASE error codes"
status
use status of this span
Values:
MOUNTED0x00
RELEASE0x01
RELEASE_UNUSED0x02
ERROR0x03
RECORDING0x04
PENDING_SPAN_REQUEST0x05
HD_SPAN_USE_STATUS_RETENTION_TIME0x06
HD_SPAN_USE_STATUS_ERROR_WRT_UNT_HDR0x10
HD_SPAN_USE_STATUS_ERROR_FORMAT_REC_REGION0x11
HD_SPAN_USE_STATUS_ERROR_MOUNT0x12
HD_SPAN_USE_STATUS_ERROR_RETENTION_TIME0x13
If the status is PENDING_SPAN_REQUEST, the ip will be 255.255.255.255, target index and lun will be 255, and span index will be 65535, which should be interpreted as still unknown, because this cam had requested a span, but it doesn't know yet which span it gets.
cam
which cammera is or was using the reported span
ip
ip of the storage device (ISCSI)
target_idx
Target Index of the storage device from 0 to 255.
lun
Lun of the storage device from 0 to max. 255.
span_idx
Index of the span on the storage device.
CONF_SPAN_USE_STATUS
This messages reports the use status of a span for this device and which cammera for primary recording. If a span was opened for a planned recording, this message will be send with status MOUNTED. If the mounting fails status will be ERROR. If a span was closed after recording status will be RELEASE, if it was closed before a recording ever took place, status will be RELEASE_UNUSED. HD_SPAN_USE_STATUS_RETENTION_TIME status will be send as message if the first time an retention time update took place on the span. In case of a read request the reply payload cantains this status message upto twice. the command can be used to query the actual used spans from a camera specified by the num parameter. the status for a span can be RECORDING, if the cam is actual recording on this span or MOUNTED, if the span is mounted and prepared for a future recording by this camera.
status HD_SPAN_USE_STATUS_ERROR_MOUNT error codes
Values:
none0x00
SPAN_ERROR_INTERNAL0x01
SPAN_ERROR_INV_SPN_IDX0x02
SPAN_ERROR_INV_HDR_TYPE0x03
SPAN_ERROR_INV_ADDR_LIST0x04
SPAN_ERROR_NOT_MNTD0x05
SPAN_ERROR_INV_FS0x06
SPAN_ERROR_INV_LUN_NFO0x07
SPAN_ERROR_BAD_HDR_CKSM0x08
SPAN_ERROR_INV_IDX0x09
SPAN_ERROR_RD_ONLY0x0a
SPAN_ERROR_NO_REC_DAT0x0b
SPAN_ERROR_INV_PART_NFO0x0c
SPAN_ERROR_SPAN_REQUEST_FAILED0x0e
SPAN_ERROR_SPAN_REQUEST_RETENTION_TIME0x0f
ISCSI_ERROR_CONNECT0x31
ISCSI_ERROR_INV_LUN0x33
ISCSI_ERROR_LOGIN0x34
ISCSI_ERR_PWD0x36
ISCSI_ERR_PROTO0x37
ISCSI_ERR_TARG_NOT_REACH0x38
ISCSI_ERR_NO_MEM0x3a
ISCSI_ERR_SESS_CREATE0x3b
ISCSI_ERR_INV_PARAMS0x3c
ISCSI_ERR_SESS_NOT_FOUND0x3d
ISCSI_ERR_DISCONN0x3e
ISCSI_ERR_TIMEOUT0x3f
ISCSI_ERR_SOCK0x5f
ISCSI_ERR_TARG_PM0x6f
ISCSI_SOCK_CLOSED0x7f
ISCSI_ERR_TCP_CONN_RST0x8f
ISCSI_ERR_INTR_NOT_SUPP0x9f
ISCSI_ERR_IP_ZERO0xa0
ISCSI_ERR_OUT_OF_RES0xa1
HDD_ERROR_TIMEOUT0x12
HDD_ERROR_CREATE_FAILED0x22
HDD_ERROR_ACCESS_DENIED0x32
HDD_ERROR_DEVICE_PRESENT_TIMEOUT0x42
HD_PMM_ERROR_LUN_LOCK0x52
HD_PMM_ERROR_COMMON0xf2
status RELEASE error codes
Values:
none0x00
HD_PMM_RELEASE_ERROR_HD_MGR_ERROR0x01
HD_PMM_RELEASE_ERROR_SPAN_LIST_INCONSISTENCY0x02
HD_PMM_RELEASE_ERROR_RECORD_HANDLE_DISMISS_ERROR0x03
HD_PMM_RELEASE_ERROR_BIG_TIME_JUMP0x04
HD_PMM_RELEASE_ERROR_CLOSED_WHILE_MOUNTING0x05
HD_PMM_RELEASE_ERROR_INITIAL_MOUNT_ABORT0x06
HD_PMM_RELEASE_ERROR_INITIAL_MOUNT_UNFINISHED0x07
HD_PMM_RELEASE_ERROR_NEXT_SPAN_NOT_MOUNTED0x08
HD_PMM_RELEASE_ERROR_RECORDING_ERROR0x09
HD_PMM_RELEASE_ERROR_ENCODER_ERROR0x0a
HD_PMM_RELEASE_ERROR_REPLACE0x0b(release was caused by CONF_SPAN_SWITCH command)
HD_PMM_RELEASE_ERROR_SWITCH_REQUEST0x0c(release was caused by CONF_SPAN_SWITCH command)
CONF_SPAN_USE_STATUS_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a4a   cam   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   span use status for secondary recording, payload as in CONF_SPAN_USE_STATUS  
 
  Write   p_octet   l_serv   not supported  
 
CONF_SPAN_PARTITION_FILE_INFO
  Tag code    NumDes    Message    SNMP Support  
  0x0a2d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Read the file info of a span.  
 
  Write   void   l_serv   not supported  
 
Payload Structure
16 32
iSCSI Server IP
4 Bytes
Target IDX
1 Byte		 LUN
1 Byte		 Span IDX
2 Byte
8 24
iSCSI Server IP
The iSCSI server ip address.
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI discover.
LUN
The logical unit.
Span IDX
Index of the span in the specified lun.
Response Structure
For the payload structure of the response see documentation of HD_PARTITION_FILE_INFO.
CONF_EXPORT_SPAN
  Tag code    NumDes    Message    SNMP Support  
  0x0a2e   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Retrieve a span of the devices storage.  
 
  Write   p_octet   l_serv   not supported  
 
Request Payload Structure
16 32
Recording Camera
12 Bytes ...
Lun Addr
8 Bytes ...
Reserved
12 Bytes ...
Overwrite Retention Time
4 Bytes
Reserved
4 Bytes
8 24
Recording Camera
The address of the device the span is assigned to.
16 32
IP
4 Bytes
MAC
6 Bytes ...
Recording Index
1 Byte		 Camera
1 Byte
8 24
IP
The ip address of the recording device.
MAC
The hardware address of the recording device.
Recording Index
1 = Primary Recording, 2 = Secondary Recording
Camera
The camera index.
Lun Addr
The address of the lun a span is desired from.
16 32
IP
4 Bytes
Target IDX
1 Byte		 LUN
1 Byte		 Reserved
2 Byte
8 24
IP
The ip address of the iscsi target.
Target IDX
The index of the target.
LUN
The logical unit number.
Overwrite Retention Time
If this field is set (> 0) and no free spans are available, spans with retention times that are lower or equal to the specified retention time are accounted for export. In this case the recording with the retention time that expires next is overwritten.
Response and Message Payload Structure
16 32
Recording Camera
12 Bytes ...
Span Address
8 Bytes ...
Last Recording
16 Bytes ...
State
1 Byte		 Reserved
3 Bytes
8 24
Recording Camera
The address of the device the span is assigned to (see request payload description for details).
Span Address
The address of the span the device exports. If this field is zero, no span is exported.
16 32
IP
4 Bytes
Target IDX
1 Byte		 LUN
1 Byte		 Span IDX
2 Byte
8 24
IP
The ip address of the iscsi target.
Target IDX
The index of the target.
LUN
The logical unit number.
Span IDX
The index of the span on the lun.
Last Recording
The address of the span the device exports.
16 32
Recording Camera
12 Bytes ...
Retention Time
4 Bytes
8 24
Recording Camera
The id of the camera of the recording that is overwritten. Field is zero, if there was no recording on this span. See request packet for detailed description.
Retention Time
The retention time (seconds since 2000) of the recording that is overwritten.
State
Values:
SUCCESS0x00
NO SPAN AVAILABLE0x01
STORAGE OFFLINE0x02
INVALID SPAN MANAGER ADDRESS0x03
ACCESS DENIED0x04
A list of span manager the recording is using can be obtained by the command CONF_REC_SPAN_MGR.
CONF_CAM_REC_SPANS
  Tag code    NumDes    Message    SNMP Support  
  0x0a8f   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Retrieve the list of recording spans of a camera from a span manager on a managed lun.  
 
  Write   %   l_serv   %  
 
Request Payload Structure
16 32
Recording Camera
12 Bytes ...
Lun Address
8 Bytes ...
8 24
Recording Camera
The address of the camera for which recording spans are to be queried.
16 32
IP
4 Bytes
MAC
6 Bytes ...
Recording Index
1 Byte		 Camera
1 Byte
8 24
IP
The ip address of the recording device.
MAC
The hardware address of the recording device. This field may be zero if you search for recordings without considering the mac.
Recording Index
1 = Primary Recording, 2 = Secondary Recording
Camera
The camera index.
Lun Address
The address of the lun on which recording spans for a camera are searched.
16 32
IP
4 Bytes
Target IDX
1 Byte		 LUN
1 Byte		 Reserved
2 Byte
8 24
IP
The ip address of the iscsi target.
Target IDX
The index of the target.
LUN
The logical unit number.
Response and Message Payload Structure
Recording Camera
12 Bytes ...
Lun Address
8 Bytes ...
N x Span Recording Info
16 Bytes ...
Recording Camera
The address of the recording camera (see request payload description for details).
Lun Address
The address of the lun of the recording spans (see request payload description for details).
Span Recording Info
Recording info about the spans the camera recorded.
16 32
Span Index
2 Byte		 S
1		 Timezone
7 Bits		 Flags
1 Byte
Start Time
4 Bytes
Stop Time
4 Bytes
Reserved
2 Bytes		 File Count
2 Bytes
8 24
Span Index
The span index in the current lun.
S
The timezone sign.
Timezone
Timezone in quarter hours.
Flags
Values:
Bit 0Continous Recording
Bit 1Recording Running
Bit 2Migrated Recording
Start Time
Seconds since 2000.
Stop Time
Seconds since 2000.
File Count
The number of files that are stored in this span.
CONF_REC_SPAN_MGR
  Tag code    NumDes    Message    SNMP Support  
  0x0a36   yes (1 - primary recording, 2 - secondary recording)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot    
 
  Write   p_octet   l_serv    
 
Payload Structure
Sequence of (max 8):
16 32
Span Mananger IP address
4 Bytes
Storage IP address
4 Bytes
Target Index
1 Byte		 Lun
1 Byte		 Reserved
2 Byte
Priority
2 Bytes		 Flags
2 Byte
8 24
Span Mananger IP address
The IP address of the device the span manager is running on.
Storage IP address
The iSCSI IP address of the storage.
Target Index
The iSCSI target index.
Lun
The iSCSI lun of the storage.
Priority
Priority is NOT SUPPORTED yet!
Flags
Values:
OVERWRITE_OLDEST_RECORDINGS0x0001
If the flag OVERWRITE_OLDEST_RECORDINGS is set and no free spans are available on all span manager of the devices recording span manager list, the recording with the retention time that expires next is overwritten.
Use this command to edit the recording span manager list. This list is consulted every time when a device is recording in VRM mode an its span list runs out resources. The entry with the highest priority is picked out of this list, the corresponding span manager is contacted and queried for spans. If the span manager ís not accessable or will not return a span for some reason (maybe it has no more free spans to export), the entry with the next lower priority is picked out of the list.
CONF_SPAN_REC_COPY
  Tag code    NumDes    Message    SNMP Support  
  0x0a55   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   List the currently running span recording copy processes.  
 
  Write   p_octet   l_serv   Copy recordings from a source span to a destination span.  
 
Request Packet Structure
16 32
Source Span
8 Bytes ...
Destination Span
8 Bytes ...
File Index
4 Bytes
Offset
4 Bytes
Duration
4 Bytes
Velocity
4 Bytes
Action
1 Byte		 Flags
1 Byte		 Reserved
2 Byte
Reserved
16 Bytes ...
8 24
Source Span
The address of the span from which the data is to be copied.
16 32
iSCSI IP
4 Bytes
Target Idx
1 Byte		 Lun
1 Byte		 Span Idx
2 Byte
8 24
iSCSI IP
The ip address of the iscsi server
Target Idx
The index of the target on the iscsi server.
Lun
The logical unit.
Span Idx
The index of the span.
Destination Span
The address of the span to which the data is to be copied. For the structure of the span address see the description of the field Source Span.
NOTE: The address of the destination span can be used to uniquely identify the copy process in the system, because it is not possible to run more than one copy on the same destination span simultaneously. If a second copy process is tried to be invoked on the same destination span, this command fails.
File Index
The index of the file in the list obtained by the command CONF_HD_SPAN_PARTITION_FILE_INFO. If this index exceeds the number of entries in the list, the error code ERR_INV_SRC_FILE is returned with the response packet.
Offset
The offset from the beginning of the file in seconds. If this value exceeds the total number of seconds of the file, the error code ERR_FILE_OFF_TOO_BIG is returned with the response packet. A value of 0 accords to a copy from the beginning of the file.
Duration
The number of seconds to copy. If the sum of offset and duration seconds exceeds the number of seconds of the file, the duration seconds are clipped to the maximum number left from the specified offset. The maxium value accords to a copy till the end of the file.
Velocity
The speed (in percent of realtime) at which the copy process runs.
Action
Use this field to control (start/stop) the copy process. Only the Velocity-field can be updated.
Values:
START0x00
UPDATE0x01
STOP0x02
Flags
Additional copy options.
Values:
COPY_UNT_HDR0x01
FMT_REC_REG0x02
APPEND_TO_LAT_REC0x04
MERGE_TO_LAT_REC0x08
If the flag COPY_UNT_HDR is set, the values of the unit header of the source span are copied into the unit header of the destination span.
If the flag FMT_REC_REG is set, all previous recordings on the destination span are deleted. All destination spans with invalid recording regions are formated, too.
If the flag APPEND_TO_LAT_REC is set, the video data is appended to the latest slice in the destination span. If this flag is set with FMT_REC_REG simultaneously, an error is returned.
If the flag MERGE_TO_LAT_REC is set, the the new slice is merged to the latest slice in the destination span. If this flag is set with APPEND_TO_LAT_REC simultaneously, APPEND_TO_LAT_REC is ignored.
Response and Message Packet Structure
16 32
Source Span
8 Bytes ...
Destination Span
8 Bytes ...
File Index
4 Bytes
Offset
4 Bytes
Duration
4 Bytes
Velocity
4 Bytes
Status
1 Byte		 Error
1 Byte		 Reserved
2 Byte
Copy Seconds
4 Bytes
Copied Until
4 Bytes
Kilobytes Copied
4 Bytes
Datarate
4 Bytes
8 24
Source Span
See description of the request packet.
Destination Span
See description of the request packet.
File Index
See description of the request packet.
Offset
See description of the request packet.
Duration
See description of the request packet.
Velocity
See description of the request packet.
Status
Values:
INITIALIZING0x00
COPYING0x01
DONE0x02
CLOSING0x03
ERROR0x04
Error
Set to zero in a request packet. An error code is returned in the response packet, if the creation of the copying process fails.
Values:
ERR_INTERNAL0x01
ERR_MAX_COPY_EXCEED0x02
ERR_NO_ACT_COPY_2_DST0x03
ERR_DST_SPAN_IN_USE0x04
ERR_ACCESS_SRC_SPAN0x05
ERR_ACCESS_DST_SPAN0x06
ERR_FMT_REC_REG0x07
ERR_INV_SRC_FILE0x08
ERR_FILE_OFF_TOO_BIG0x09
ERR_RD_SRC_UNT_HDR0x0A
ERR_WR_DST_UNT_HDR0x0B
ERR_WR_DST_LCK_HDR0x0C
ERR_REPL_OPEN0x0D
ERR_REC_OPEN0x0E
ERR_REPL_START0x0F
ERR_REC_START0x10
ERR_DST_SPAN_FULL0x11
ERR_TIMEOUT0x12
ERR_MERGE_FAILED0x13
Copy Seconds
The number of seconds the copy process is running.
Copied Until
A timestamp (Seconds since 2000) to which the copy process progressed till now.
Kilobytes Copied
The number of kilobytes transferred to the destination span.
NOTE: To determine the network traffic, you have to multiply this value with two.
Datarate
The rate at which data is written to the destination span. NOTE: To determine the network traffic, you have to multiply this value with two.
Read
If the command is to be read, the request packet may be empty. The response packet contains a list of all currently active copy processes and their statistics.
Write
The write request contains parameters for a copy process that is to be started, stopped or updated. Only the following fields can be updated: Duration, Velocity. The response packet to a write command contains the parameters and statistics for that copy process.
CONF_SPAN_SWITCH
  Tag code    NumDes    Message    SNMP Support  
  0x0a53   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   not supported  
 
  Write   p_octet   l_serv   switch spans, see detailed description  
 
Payload Structure
16 32
ip recording span
4 Bytes
target_idx
1 Byte		 lun
1 Byte		 span_idx
2 Byte
ip premounted span
4 Bytes
target_idx
1 Byte		 lun
1 Byte		 span_idx
2 Byte
flags
16 Bits		 recording
1 Byte		 reserved
1 Byte
8 24
ip recording span
the ip of the actual recording span
target_idx
the target index of the actual recording span
lun
the lun of the actual recording span
span_idx
the span index of the actual recording span
ip premounted span
the ip of the premounted span
target_idx
the target index of the premounted span
lun
the lun of the premounted span
span_idx
the span index of the premounted span
flags
these flags are used to specify the behav. of the command
Flags:
FORCE0x0001
CHECK_PREMOUNTED0x0002
REPLACE_PREMOUNTED0x0004
SWITCH_SPAN0x0008
ERROR_CHECK_PREMOUNTED0x4000
ERROR_CHECK_RECORDING0x8000
recording
select a recording
Values:
primary recording1
secondary recording2
CONF_SPAN_SWITCH
This command can be used to influence the span usage of the recording. It is able to cause a replace of the premounted span and or switch to the next premounted span.
The flag SWITCH_SPAN causes the switch to the next span and releasing the actual recording span. Flag REPLACE_PREMOUNTED will cause the release of the premounted span and mounting another one if available. If both flags are activated, the premounted block will be replaced, as soon as a new premounted span is mounted and available, the next step switch to premounted span will be performed.
When performing a switch to next span job, the recording span address in the payload will be checked. If on execution of this job the recording span doesn't match the recording span from the payload, the switch will not be performed. When performing a replace premounted span job, the premounted span address in the payload will be checked. If on execution of this job the premounted span doesn't match the premounted span from the payload, the replace will not be performed. The idea of these checks is to avoid conflicts with the automatic span switching of the recording, that can lead to gaps in the recording and unwanted waste of recording spans. The flag FORCE will skip these checks. Flag CHECK_PREMOUNTED is only relevant for the switch to next span job without replacing the premounted span and without FORCE flag. If this flag is active on switching ton next span, the premounted span parameter in the payload will be matched against the actual premounted span. If no match the switch won't be performed. If this flag including the FORCE flag isn't set on switch, a negative match will be performed on the premounted span.
Warning: A possible conflict, when requesting a replace of the premounted span with an automatic span switch of the recording that causes gaps in the recording is unavoidable. So an excesive usage of replacing premounted spans should be avoided.
CONF_HD_SET_VRM_LOCK
  Tag code    NumDes    Message    SNMP Support  
  0x0a5d   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   not supported  
 
  Write   p_octet   l_serv   Write or clear the vrm lock.  
 
Payload Structure
16 32
IP
4 Bytes
target idx
1 Byte		 lun
1 Byte		 reserved
2 Byte
flags
32 Bits
8 24
IP
IP Address of the storage device
target idx
Target index of the storage device
lun
Lun of the storeage device
flags
flags
Flags:
SET_VRM_LOCK0x01
CONF_HD_SET_VRM_LOCK
This command sets or clears the vrm lock on a lun. If the flag SET_VRM_LOCK is set the vrm lock will be written, otherwise it will be cleared.
CONF_SPAN_FILES_DIR
  Tag code    NumDes    Message    SNMP Support  
  0x0aa1   yes (entry index 1 - 4)   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Read the path entry end exported iscsi addr. (gen dll only)  
 
  Write   p_octet   l_serv   Set path to span files (gen dll only).  
 
Payload Structure (write/in)
Action
4 Bytes
reserved
8 Bytes ...
Path name 1
1 Byte		 N x 1 Byte Path name N
1 Byte
Action
specifies the action, you can set an entry or clear an entry
Values:
clear entry0
set entry1
Path name 1 - N
zero terminated ascii string containing the full path to a span formated storage mounted on windows or directory containing the span files, the path should not end with a '\', payload size must be set, that it includes the zero termination
Payload Structure (read; write/out)
exported ip
32 Bits
target index
1 Byte		 lun
1 Byte		 reserved
2 Byte
error
32 Bits
path 1
1 Byte		 N x 1 Byte path N
1 Byte
exported ip
ip of the exported lun, specified by the directory path.
target index
target index of the exported lun, specified by the directory path.
lun
lun id of the exported lun, specified by the directory path.
error
Error code, in case of set path failed. Is always 0 in the payload of read direction. Only relevant for return payload of write direction.
Values:
no error0
invalid directory path1
invalid lun info file2
common error3
path 1 - N
path to a mounted span formatted storage or directory containing the span files.
CONF_SPAN_FILES
This command allows to set the path to a mounted span formatted storage or directory. You have to send the in payload to set the path. The min payload size is 16 bytes. The max path name length is 1024 bytes including the zero termination. payload size must be set to the size that includes the zero termination but min size is 16 bytes even in case of an empty string (at least zero termination). You can set up to 4 pathes. Use the num param to specify the index of an entry. If you set the path it will check the path. To pass this check, at least a valid Lun info file (INFO.TXT) has to exist. The span are needed later when accessing the storage(e.g header access, replay). The response to the write direction is has the out payload format. If success the error field is zero and the payload includes the set path and the exported lun address. This storage is now accessable by using this address for other commands. if the set failes, the error field is non zero and contains an error code. It is allowed to set path on an index that was already set. The old values will be overwritten, but remember that the effect takes place later, if there are still open references based on the old entry (e.g. running replay, header access).
The cmd can be used for read direction. The response payload contains the export lun address and the path. error code is always zero. If the entry is empty, the path is empty and has only the zero termination.
CONF_STORAGE_REPORT
  Tag code    NumDes    Message    SNMP Support  
  0x09cf   yes (Only span-recording: 1=cam1, 2=cam2, ...)   yes   yes  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get information about the storage device  
 
  Write   p_octet   l_serv   not supported  
 
Request packet
To get information about a storage device, a read packet with no payload must be send to the rcp server.
Response packet
The server reply will have the following structure:
Type
1 Byte		 Availability
1 Byte		 Access Type
1 Byte		 IO Error Type
1 Byte
IO Error Count
4 Bytes
Throughput Read
4 Bytes
Throughput Write
4 Bytes
iSCSI Login Connection 1
4 Bytes
N x 4 Bytes iSCSI Login Connection N
4 Bytes ...
Type
Values:
None0x00
RAM Recording0x03
iSCSI0x04
USB0x05
IDE0x08
Compact Flash0x09
Availability
Values:
Unknown0x00
No0x01
Yes0x02
locked by another device0x03
Access Type
Values:
Unknown0x00
Read Only0x01
Read Write0x02
IO Error Type
Values:
None0x00
Read0x01
Write0x02
IO Error Count
Number of arised I/O errors.
Throughput Read
Kilobytes read from device.
Throughput Write
Kilobytes written to device.
iSCSI Login Connection 1 - N
Fields present only if device type is iSCSI
Sequence of:
16 32
Phase
2 Bytes		 Error
2 Bytes
8 24
Phase
Indicates the phase, the iSCSI client has reached on login.
Error
Indicates the error that happend in that state.
CONF_STORAGE_REPORT_SECONDARY
  Tag code    NumDes    Message    SNMP Support  
  0x0a50   yes (Only span-recording: 1=cam1, 2=cam2, ...)   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   get information about the storage device of secondary recording, payload same as in command CONF_STORAGE_REPORT  
 
  Write   p_octet   l_serv   not supported  
 
CONF_STORAGE_MEDIUM_TYPE
  Tag code    NumDes    Message    SNMP Support  
  0x09d3   no   no   no  
 
  Datatype   Access Level   Description  
  Read   t_dword   noprot   read the storage medium type (None = 0, USB = 5, IDE = 8, CF = 9, SD = 11) (obsolete)  
 
  Write   t_dword   l_serv   set the storage medium type (None = 0, USB = 5, IDE = 8, CF = 9)(obsolete and not usable anymore)  
 
CONF_STORAGE_MEDIUM_AVAIL
  Tag code    NumDes    Message    SNMP Support  
  0x09d4   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   list of dwords with available storage medium types (first dword USB, second dword iSCSI, third dword RAM)  
 
  Write   void   l_serv   not supported  
 
CONF_STORAGE_LIST
  Tag code    NumDes    Message    SNMP Support  
  0x0a37   no   no   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   Read the device storage list.  
 
  Write   p_octet   l_serv   Write the stuff. (, not supported while recording is running)  
 
Payload Structure
Sequence of (max 16):
16 32
Storage Descriptor
20 Bytes ...
8 24
Storage Descriptor
16 32
Storage Type
4 Bytes
IP Address
4 Bytes
Target Index
1 Byte		 Lun
1 Byte		 Fmt Progress
1 Byte		 Utilization
1 Byte
iSCSI export
1 Byte		 Span Manager
1 Byte		 Mgr Status
1 Byte		 Mgr Error
1 Byte
Recording Migration Status
4 Bytes
8 24
Storage Type
The type of the storage.
Values:
FILE0x02
RAM0x03
ISCSI0x04
USB0x05
IDE0x08
CF0x09
IP Address
The IP address of the iscsi server. Set to zero, if the storage type is not iscsi.
Target Index
The target index on the iscsi server. Set to zero, if the storage type is not iscsi.
Lun
The iscsi lun. Set to zero, if the storage type is not iscsi.
Fmt Progress
If the storage is in state formatting, the field indicates the formatting progress in percentage.
Utilization
If the storage is span formatted, this field indicates the amount capacity used (in percentage).
iSCSI export
Values:
For local use only0x00
Make storage available through iSCSI0x01
Span Manager
Values:
Span manager off0x00
Span manager on0x01
Span format lun and start span manager0x02
Migrate lun and start span manager0x03
Mgr Status
The status of the span manager in the response packet. Set to zero in the request packet.
Values:
INACTIVE0x00
STARTING0x01
FORMATING0x02
MIGRATING0x03
OFFLINE0x04
ONLINE0x05
STOPPING0x06
ERROR0x07
Mgr Error
If the span manager status is ERROR, this field contains details of the error that occurred. See command CONF_SPAN_USE_STATUS for possible error codes.
Migration Status
16 32
Stage
1 Byte		 Progress
1 Byte		 Error
1 Byte		 Reserved
1 Byte
8 24
Stage
The current migration stage.
Values:
INIT0x00
FORMAT SPANS0x01
UPDATE HEADER0x02
COPY DATA0x03
DONE0x04
Progress
The progress of the current stage in percentage.
Error Code
A possible error code.
Use this command to configure and manage local or remote storage. The storage list may contain up to 16 entries. If a remote (iscsi) storage is to be managed, the lun address has to be specified. Realize, that if you export an remote storage, the device will have preformance drawbacks cause the ip- and iscsi-stack will be passed through twice. Prefer to access the remote storage directly instead.
The storage devices will be exported through iscsi in the order of this list (storage devices with the 'iSCSI export' field set to 'For local use only' [0x00] are omitted) and the storage will appear in the same place of the target name list of an iscsi discovery on that device.
NOTE
If the storage list is empty or only contains entries with the 'iSCSI export' field set to 'For local use only' (0x00), the iscsi server is stopped, if it is running, cause no targets and luns would be provided. If the list contains at least one entry with the 'iSCSI export' field set to 'Make storage available through iSCSI' (0x01), the iscsi server is started, if not already running, to provide the iscsi service. The iscsi server can be controlled through the command CONF_ISCSI_SERVER_STATE too.
CONF_STORAGE_IO
  Tag code    NumDes    Message    SNMP Support  
  0x0a61   no   yes   no  
 
  Datatype   Access Level   Description  
  Read   p_octet   noprot   List the currently running storage io tasks.  
 
  Write   p_octet   l_serv   Start or stop a storage io task.  
 
Request Packet Structure
16 32
Lun Address
8 Bytes ...
Start Burst Size
4 Bytes
End Burst Size
4 Bytes
Burst Size Duration
4 Bytes
Burst Size Increase
4 Bytes
Repeat
4 Bytes
Maximum Read Rate
4 Bytes
Maximum Write Rate
4 Bytes
Mode
2 Byte		 Flags
2 Byte
ID
4 Bytes
Action
1 Byte		 Reserved
3 Bytes
Reserved
44 Bytes ...
8 24
Lun Address
The address of the storage.
16 32
iSCSI IP
4 Bytes
Target Idx
1 Byte		 Lun
1 Byte		 Reserved or Span Idx
2 Byte
8 24
iSCSI IP
The ip address of the iscsi server
Target Idx
The index of the target on the iscsi server.
Lun
The logical unit.
Span Idx
The index of the span. Only used, if the flag RESTRICT TO SPAN is set.
Start Burst Size
The size in LBAs of the burst the test starts with. This value must be lower or equal to the end burst size.
End Burst Size
The size in LBAs of the burst the test ends with. This value may be clipped to the maximum burst value of the storage.
Burst Size Duration
The number of milliseconds each bust size is read and written.
Burst Size Increase
The number of LBAs the burst size is increased after each burst-duration.
Maximum Read Rate
The maximum datarate that is read in KBit/sec.
Maximum Write Rate
The maximum datarate that is written in KBit/sec.
Repeat
The number of times the test is repeated which means how often the specified burst sequence is run.
Mode
The test may run in the following modes.
Values:
LINEAR0x0000
RANDOM0x0001
RECORDING SIMULATION0x0002
If the mode is set to LINEAR then the test reads/write from/to consecutive lba addresses. If the maximum lba is reached and the STORAGE_IO_FLAG_MAX_LBA_END flag is set, the test stops. Otherwise the test wraps its lba pointer to the beginning of its storage.
If the mode is set to RANDOM then the test reads/write from/to randomly chosen lba addresses of the storage.
If the mode is set to RECORDING SIMULATION then the test tries to simulate the write behavior of a real recording. The following fields of this command are ignored: Start Burst Size, End Burst Size, Burst Size Duration, Burst Size Increase, Repeat, Maximum Read Rate. The burst size is varyed among the maximum write burst of 120 lba addresses.
Flags
Flags to set some options.
Values:
READ ONLY0x0001
WRITE ONLY0x0002
KEEP DATA0x0008
VERIFY WRITE0x0010
EXP BURST INCREASE0x0020
ERROR STOP0x0040
RESTRICT TO SPAN0x0080
ISCSI SESSION EXCLUSIVE0x0100
MAX LBA END0x0200
If the READ ONLY flag is set, only read operations are performed. May not be used simultaneously with the WRITE ONLY flag.
If the WRITE ONLY flag is set, only write operations are performed. May not be used simultaneously with the READ ONLY flag.
If the KEEP DATA flag is set, all lbas that are written are read before so that no recording data should be destroyed. Be careful that no one else writes to this lun simultaneously. In the latter case data on the storage could be lost.
If the VERIFY WRITE flag is set, every lba that was written is read afterwards to verify that the data was correctly written.
If the EXP BURST INCREASE flag is set, the field 'Burst Size Increase' is ignored. Instead the burst size is doubled after each rnu.
If the ERROR STOP flag is set, the tests stops when an io error occurrs.
If the RESTRICT TO SPAN flag is set, the tests only uses the span of the lun, which is specified in the 'Span Idx' field of the lun-address.
If the ISCSI SESSION EXCLUSIVE flag is set, the tests use an exclusive iscsi session which is not shared among other tests.
If the MAX LBA END flag is set, the tests stops when the write pointer reaches the maximum lba address of the lun/span (only in sequential access mode).
ID
Identifier of the storage io. Set to zero when starting a new storage io. Set to the from the start request returned value for stopping a storage io.
Action
Values:
STOP0x00
START0x01
Response and Message Packet Structure
16 32
Lun Address
8 Bytes ...
Start Burst Size
4 Bytes
End Burst Size
4 Bytes
Burst Size Duration
4 Bytes
Burst Size Increase
4 Bytes
Repeat
4 Bytes
Maximum Read Rate
4 Bytes
Maximum Write Rate
4 Bytes
Mode
2 Byte		 Flags
2 Byte
ID
4 Bytes
Status
1 Byte		 Error
1 Byte		 Reserved
2 Bytes
Reapeat Count
4 Bytes
Current Burst Size
4 Bytes
Current Offset
4 Bytes
Current Read Datarate
4 Bytes
Current Write Datarate
4 Bytes
Read Bytes
4 Bytes
Write Bytes
4 Bytes
Read Operations
4 Bytes
Write Operations
4 Bytes
Read Errors
4 Bytes
Write Errors
4 Bytes
8 24
Lun Address
See request packet structure for details.
Start Burst Size
See request packet structure for details.
End Burst Size
See request packet structure for details.
Burst Size Duration
See request packet structure for details.
Burst Size Increase
See request packet structure for details.
Repeat
See request packet structure for details.
Maximum Read Rate
See request packet structure for details.
Maximum Write Rate
See request packet structure for details.
Mode
See request packet structure for details.
Flags
See request packet structure for details.
ID
Identifier of the storage io. This value must be specified on actions other than start.
Status
Values:
STOPPING0x00
STARTING0x01
RUNNING0x02
DONE0x03
ERROR0x04
Error
Values:
INTERNAL0x01
LUN0x02
INVALID PARAMS0x03
READ0x04
WRITE0x05
WRITE VALIDATE0x06
Repeat Count
The number of turns the test repeated so far.
Current Burst Size
The number of LBAs of the current burst.
Current Offset
The current position of the i/o pointer in percentage of the whole storage. This value is not significant in random access mode.
Current Read Datarate
The current read datarate in KBit/s.
Current Write Datarate
The current write datarate in KBit/s.
Read Bytes
The number of bytes that were read since the test was started.
Write Bytes
The number of bytes that were written since the test was started.
Read Operations
The number of read operations successfully performed since the test was started.
Write Operations
The number of write operations successfully performed since the test was started.
Read Errors
The number of read errors since the test was started.
Write Errors
The number of read errors since the test was started.