This manual is the intellectual
property of Bosch Security Systems 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 Bosch Security Systems.
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. Bosch Security Systems 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.
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
T 1
Action 6 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:
F_FLAG
0x00 (1 Byte)
T_OCTET
0x01 (1 Byte)
T_WORD
0x02 (2 Byte)
T_INT
0x04 (4 Byte)
T_DWORD
0x08 (4 Byte)
P_OCTET
0x0C (N Byte)
P_STRING
0x10 (N Byte)
P_UNICODE
0x14 (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:
Read
0x0
Write
0x1
T
StringTable available. This bit signals, when set, that there is a string table appended to this RCP+ packet which contains IPv6 addresses or host names.
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:
Request
0x00
Reply
0x01
Message
0x02
Error
0x03
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, except the reserved byte. The reserved byte is used as sequence number.
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 first bytes of the payload section contains error cause. If the error code is RCP_ERROR_COMMAND_SPECIFIC, then the command specific error (see RCP command for details) is included in the second byte. The following generic error codes are defined:
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
RCP_ERROR_TIMEOUT
0xd0
RCP_ERROR_NO_LICENCE (used by NVR only)
0xe0
RCP_ERROR_COMMAND_SPECIFIC
0xf0
RCP_ERROR_ADDRESS_FORMAT
0xf1
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.
A list of all defined command specific error codes can be found in the Appendix.
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:
Establish a TCP connection to port 80 at your Videjet
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
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 mechanism. A CGI command set with the requested messages command tag numbers need to
be issued. After issuing a request, the reply returns immediately 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 appropriate number of milliseconds.
Veiled 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 veiled <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
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 needs 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 granted authorization level 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 as for 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 granted authorization level 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.
IPv6
For RCP commands which are defined as T_DWORD or P_OCTET and contain DWORD IP-Addresses
There is a extention to read or write also IPv6 adresses or Hostnames
Where payload must contain a 4 byte index to the trailing list of ip-item0..ip-itemn
The reply XML structure will then have this format:
<rcp>
<command>
<hex>0x0a1f</hex>
<dec>2591</dec>
</command>
<type>T_DWORD</type>
<direction>READ</direction>
<num>0</num>
<idstring />
<payload />
<cltid>0x00ff</cltid>
<result>
<hex>0x00000000</hex>
<dec>0</dec>
<ip-table>
<item>
<idx>0</idx>
<type>IPV6</type>
<str>fd00::55:77</str>
</item>
</ip-table>
</result>
</rcp>
Where payload contains a 4 byte index to the ip-table list for each address contained in the command
if the command datatype is P_OCTET and the command does contain more IP-Adresses then the result will contain multipe item blocks.
Alternative formats for the item blocks are also possible:
<item>
<idx>1</idx>
<type>IPV4</type>
<str>192.168.1.2</str>
</item>
<item>
<idx>2</idx>
<type>NAME</type>
<str>MyHostname.de</str>
</item>
If a list is supplied the ALL addresses MUST be in the list also in the case that they are IPv4 type
Autodetecting Devices
Bosch Security Systems products are being detected on a network using an IP broadcast to either the static UDP port 1757 or to the configurable UDP discover port. The default port number for the configurable discover port is 1800, and it can be modified with the RCP command CONF_DISCOVER_PORT (0x0976). In addition to the possibility to send a scan request packet to the broadcast destination address of 255.255.255.255, the discover port of the devices listens for scan requests sent to the configurable multicast group, which can be set by means of the RCP command CONF_AUTODETECT_REPLY_GROUP (0x0956). The default multicast detect group is 225.86.67.83.
Devices generate and transmit their replies to an autodetect request with a random delay of up to 2 seconds. When implementing your own detection software, please bear in mind that, when calculating the necessary waiting period until all replies are received, additionally to the possible span of max 2 seconds, you need to consider the time necessary to process the reply as well as the time the packet spends on the wire and in propagation devices like switches or routers on its way to and back from the device to be detected.
The scanned devices send their replies either to the source IP address of the request, or to the broadcast address 255.255.255.255. In case the source IP address of the request resides inside the same subnet, that is defined by the scanned device's IP address and it's subnet mask, the reply is addressed to the source IP address in the request. If the originator is not located in the same subnet as the scanned device, the reply is addressed to the broadcast address 255.255.255.255. In case of a scan request sent to the device via the multicast scan group, the reply is addressed to the same multicast group.
An autodetect scan request packet must consist of an autodetect request header, that may or may not be preceeded by an RCP plus protocol header for command id CONF_RCP_AUTODETECT (0xffdc). In case of an existing RCP plus protocol header in the scan request, the length field of the RCP plus protocol header must contain the length of the autodetect request header.
The format for the autodetect request header as well as for the autodetect reply is shown below:
Autodetect Request Header
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_NVR
0x1
NCID_VJ8000
0x2
NCID_VIP10
0x3
NCID_VIP1000
0x4
NCID_VJ400
0x6
NCID_VIP100
0x7
NCID_VJEX
0x8
NCID_VJ1000
0x9
NCID_VJ100
0xA
NCID_VJ10
0xB
NCID_VJ8008
0xC
NCID_VJ8004
0xD (latest unit carrying the old numbering scheme)
EscapeCode
0xF (used to switch over to new detection)
FL
Values:
HARDWARE_TYPE_VIN
0x0
HARDWARE_TYPE_VOUT
0x1
HARDWARE_TYPE_VIN_OUT
0x2
Net
Values:
Bit1
HARDWARE_SYSTEM_OPT_ISDN
Bit3
HARDWARE_SYSTEM_ETHERNET
opt
Values:
Bit1
HARDWARE_OPT_AUDIO
Bit2
HARDWARE_OPT_HDD
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
R
Reserved
M
Values:
Master
0
Slave
1
FL
Flavour
Values:
HARDWARE_TYPE_VIN
0x0
HARDWARE_TYPE_VOUT
0x1
HARDWARE_TYPE_VIN_OUT
0x2
ID
Values:
HARDWARE_ID_VIPX1
0x01
HARDWARE_ID_VIPX2
0x02
HARDWARE_ID_VIPXDEC
0x03
HARDWARE_ID_VJ_X10
0x05
HARDWARE_ID_VJ_X20
0x06
HARDWARE_ID_VJ_X40
0x07
HARDWARE_ID_VJ_X40_ECO
0x08
HARDWARE_ID_VJ_X10_ECO
0x09
HARDWARE_ID_VJ_X20_ECO
0x0A
HARDWARE_ID_IP_PANEL
0x0d
HARDWARE_ID_GEN4
0x0e
HARDWARE_ID_M1600
0x0f
HARDWARE_ID_FLEXIDOME
0x11
HARDWARE_ID_M1600_DEC
0x13
HARDWARE_ID_M1600_XFM
0x15
HARDWARE_ID_AUTODOME
0x16
HARDWARE_ID_NBC_225P
0x1a
HARDWARE_ID_VIPX1_XF
0x1e
HARDWARE_ID_NBC_225W
0x1f
HARDWARE_ID_NBC_255P
0x20
HARDWARE_ID_NBC_255W
0x21
HARDWARE_ID_AUTODOME_EASY_II
0x23
HARDWARE_ID_AUTODOME_EASY_II_E
0x24
HARDWARE_ID_VIPX1_XF_E
0x25
HARDWARE_ID_VJT_X20XF_E_2CH
0x26
HARDWARE_ID_VJT_X20XF_E_4CH
0x27
HARDWARE_ID_VIPX1_XF_W
0x28
HARDWARE_ID_VG5_AUTODOME_700
0x29
HARDWARE_ID_NDC_455_P
0x2a
HARDWARE_ID_NDC_455_P_IVA
0x2b
HARDWARE_ID_NBC_455_P
0x2c
HARDWARE_ID_NBC_455_P_IVA
0x2d
HARDWARE_ID_VG4_AUTODOME
0x2e
HARDWARE_ID_NDC_225_P
0x2f
HARDWARE_ID_NDC_255_P
0x30
HARDWARE_ID_VOT
0x32
HARDWARE_ID_NDC_274_P
0x35
HARDWARE_ID_NDC_284_P
0x36
HARDWARE_ID_NTC_265_PI
0x37
HARDWARE_ID_NDC_265_PIO
0x38
HARDWARE_ID_DINION_720P
0x39
HARDWARE_ID_NDN_822
0x3a
HARDWARE_ID_FLEXIDOME_720P
0x3b
HARDWARE_ID_NDC_265_W
0x3c
HARDWARE_ID_NDC_265_P
0x3d
HARDWARE_ID_NBC_265_P
0x3e
HARDWARE_ID_NDC_225_PI
0x3f
HARDWARE_ID_NTC_255_PI
0x40
HARDWARE_ID_JR_DOME_HD
0x41
HARDWARE_ID_JR_DOME_HD_FIXED
0x42
HARDWARE_ID_EX30_IR
0x43
HARDWARE_ID_GEN5_HD_PC
0x45
HARDWARE_ID_EX65
0x46
HARDWARE_ID_DINION_1080P
0x47
HARDWARE_ID_FLEXIDOME_1080P
0x48
HARDWARE_ID_HD_DECODER
0x49
HARDWARE_ID_GEN5_HD
0x4a
HARDWARE_ID_NER_L2
0x4b
HARDWARE_ID_VIP_MIC
0x4c
HARDWARE_ID_NBN_932
0x4f
HARDWARE_ID_NDN_932
0x50
HARDWARE_ID_VRM
0xfc
HARDWARE_ID_VIDOS_SERVER
0xfd
HARDWARE_ID_VIDOS_MONITOR
0xfe
Net
Values:
Bit1
HARDWARE_SYSTEM_OPT_ISDN
Bit2
reserved
Bit3
HARDWARE_SYSTEM_ETHERNET
Bit4
reserved
opt
Values:
Bit1
HARDWARE_OPT_AUDIO
Bit2
HARDWARE_OPT_HDD
Bit3
reserved
Bit4
reserved
1st Reply Packet
16
32
0x99 1 Byte
0x39 1 Byte
0xa4 1 Byte
0x27 1 Byte
Sequence Number 4 Bytes
Hardware 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" encoding="UTF-8"?>
<root xmlns="OEMExtXX:device-1-0">
<device>
<deviceType>OEMExtXX:device:deviceIDYY</deviceType>
<friendlyName>VideoJet</friendlyName>
<unitName>UnitName</unitName>
<deviceGUID>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</deviceGUID>
<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>
<unitIPv6Address>XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX</unitIPv6Address>
<activeConnections>XX</activeConnections>
<RCPPort>XXXX</RCPPort>
<HTTPPort>XXXX</HTTPPort>
<HTTPSPort>XXXX</HTTPSPort>
<dhcp>X</dhcp>
<cameraFrontendID>XXXX</cameraFrontendID>
<Flags>X</Flags>
<Lines>X</Lines>
<BcJpeg>X</BcJpeg>
<ClusterMember>XXX.XXX.XXX.XXX</ClusterMember>
<ClusterMemberMAC>XX-XX-XX-XX-XX-XX</ClusterMemberMAC>
<ClusterID>X</ClusterID>
</device>
</root>
<root xmlns="OEMExtXX:device-1-0">
XX is the OEM Extension; 0x00 for Bosch Security Systems; OEM specific
<deviceType>OEMExtXX:device:deviceIDYY</deviceType>
XX is the OEM Extension; 0x00 for Bosch Security Systems; 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
<unitIPv6Address>XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX</unitIPv6Address>
XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX is the current IPv6 address of the VideoJet e.g. FD00::1234:5678
<activeConnections>XX</activeConnections>
XX is the number of active media connections of the VideoJet
<RCPPort>XXXX</RCPPort>
XXXX is the current RCP port number the VideoJet is listening to
<HTTPPort>XXXX</HTTPPort>
XXXX is the current HTTP port number the VideoJet is listening to
<HTTPSPort>XXXX</HTTPSPort>
XXXX is the current HTTPS port number the VideoJet is listening to
<dhcp>X</dhcp>
X indicates if dhcp is switched on (1) or off (0)
<cameraFrontendID>XXXX</cameraFrontendID>
XXXX is the ID of the (internal) camera frontend (see also Bicom documentation)
<Flags>X</Flags>
X is the flag value returned by RCP command CONF_CM_DEFAULT_CONFIG
<Lines>X</Lines>
X is the number of video lines the device has
<BcJpeg>X</BcJpeg>
X indicates the ability to deliver JPEGs via the broadcast JPEG retrieval mechanism
<ClusterMember>XXX.XXX.XXX.XXX</ClusterMember>
XXX.XXX.XXX.XXX is the ip address of one of the cluster members; there might be multiple entries including this device
<ClusterMemberMAC>XX-XX-XX-XX-XX-XX</ClusterMemberMAC>
XX-XX-XX-XX-XX-XX is the MAC address of 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
Optional Extension: Targeting Autodetect Scans at devices matching certain criteria
The autodetect process can be targeted at a certain group of devices identified by a defined criteria. This sort of autodetect is device-wise only handled, when sent to the configurable UDP port, whose default port number is 1800. It is not possible via the static autodetect port 1757.
To perform a targeted autodetect scan, an extension needs to be added to the usual autodetect scan command. For these targeted kinds of autodetect scans, it is obligatory that the scan packet consists of an RCP plus protocol header, the autodetect request header and the extension itself.
The bytes of this extension are considered in the length field of a preceeding RCP header.
16
32
Scan Extension Identifier 4 Bytes
Size 4 Bytes
Scan Extension Identifier
The scan extension identifier determines the criteria that needs to be matched by the scanned devices in order to reply to the request.
Currently the following possible criteria are defined:
MAC address
0x1
Size
The Size field of the extension informs about the number of bytes used in the extension.
The number includes the 4 bytes of the Scan Extension Identifier field, the 4 bytes of the Size field itself
and the length of the following payload in bytes.
In case of the MAC address extension, the Size field is followed by one or more MAC addresses of 6 bytes length each.
A scan extension limiting the autodetect scan to 2 devices, the size field of the scan extension should contain a value of 20.
(4 bytes Scan Extension Identifier + 4 bytes Length + 6 bytes first MAC address + 6 bytes second MAC address)
Retrieving thumbnail JPEGs using the Autodetecting Broadcast Mechanism
The Bosch Security Systems products support a mechanism that allows to retrieve thumbnail JPEGs via a broadcast autodetect mechanism. The mechanism requires to send a UDP packet similar to the autodetect scan packet to the configurable autodetect port of the device, whose default port number is 1800. The device replies with a packet containing the thumbnail JPEG. The JPEG retrieval can not be accomplished via the static autodetect port 1757.
Format of the request packet of an autodetect based JPEG request
The request packet triggering the autodetect based JPEG retrieval consists of an RCP plus protocol header and an autodetect based JPEG request header, followed by a MAC list scan extension.
RCP plus protocol header
The RCP plus protocol header's command id field is set to 0x099e (CONF_JPEG). The data type field is set to 0x0c (P_OCTET). The numeric descriptor field identifies the line of the targeted device, from which the JPEG is to be retrieved. The length field of the request indicates the number of payload bytes and therefore is to be set to the length of the autodetect based JPEG request header plus the length of the scan extension (e.g. 12 bytes for autodetect based JPEG request header, 8 bytes for scan extension header and 6 bytes for MAC address = 26 bytes).
Autodetect based JPEG Request Header
The first four bytes of the autodetect based JPEG request header consist of a static magic number, that is always set to the values given in the table below. The sequence number given in the request is returned in the reply, so that replies can be matched to the respective request.
16
32
0x4b 1 Byte
0xa5 1 Byte
0xc3 1 Byte
0x55 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
MAC list scan extension
The autodetect based JPEG request can only be targeted at selected devices. To announce the scope of the request, extending the request packet by a MAC list scan extension, like it is defined in the chapter "Autodetecting Devices" of this document, is obligatory. As the intended use of this JPEG retrieval mechanism is limited to situations where the regular JPEG retrieval mechanisms (HTTP request for the JPEG, RCP request of CONF_JPEG within a regular RCP+ client session, etc.) do not work, the MAC list of the scan extension is limited to 1 MAC address, i.e. only one JPEG from one device can be retrieved at a time.
Format of the reply packet to an autodetect based JPEG request
The reply packet to the request for an autodetect based broadcast JPEG consists of an RCP plus protocol header and an autodetect based JPEG request header, followed by the JPEG data.
RCP plus protocol header
The RCP plus protocol header's command id field is set to 0x099e (CONF_JPEG). The data type field is set to 0x0c (P_OCTET). The numeric descriptor field identifies the line of the targeted device, from which the JPEG was retrieved. The length field of the reply indicates the number of payload bytes and therefore is to be set to the length of the autodetect based JPEG request header plus the length of the JPEG thumbnail.
Autodetect based JPEG Request Header
The autodetect based JPEG request header in the reply is byte for byte a copy of the same header in the respective request.
JPEG thumbnail
The JPEG thumbnail data follows the autodetect based JPEG request header.
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.
This is supported for IPv4 broadcast 255.255.255.255
And also for IPv6 multicast to (link-scope all-hosts multicast) ff02::1
Payload Structure (Basic Version IPv4 only)
16
32
Hardware Address 6 Bytes ...
Reserved 2 Bytes (shold be zero)
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.
Payload Structure (Extended Version IPv4 and IPv6 settings)
16
32
Hardware Address 6 Bytes ...
Version 1 Byte
Ipv6 PrefixLen 1 Byte
IPv4 Address 4 Bytes
IPv4 Subnet Mask 4 Bytes
Gateway IPv4 Address 4 Bytes
IPv6AddrString 64 Bytes
IPv6GatewayAddrString 64 Bytes
8
24
Hardware Address
MAC address of the device.
Version
Version of this command (must be 2)
Ipv6 PrefixLen
IPv6 Prefix length used for the IPv6 Device Address
IPv4 Address
IPv4 Address to set.
IPv4 Subnet Mask
Subnet mask to set.
Gateway IPv4
Gateway IPv4 address to set.
IPv6AddrString
Zero terminated string containig the IPv6 address to set.
Format: e.g. FD00::1234:5678
IPv6GatewayAddrString
Zero terminated string containig the IPv6 gateway address to set.
Format: e.g. FD00::1234:5678
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.
Extension for RCP+ commands containing IPv6 addresses or host names
For transmitting IPv6 addresses or host names in RCP+ Commands there is a string table extension in firmware version 5.50 and later.
The layout of the RCP+ commands remains the same as it was in earlier firmware versions and it is compatible to older clients as long
as only IPv4 Addresses are transmitted.
If IPv6 Addresses are contained in the command then this extension has to be used.
RCP+ Command with string table
RCP Header
RCP Data
String Table Header
String Table Entry 1
String Table Entry 2
...
String Table Entry n
String Table Header
16
32
TableLenBytes 4 Bytes
Version 1 Byte
Reserved 1 Byte
NumEntries 2 Bytes
TableLenBytes
Length of hole string table including this header.
Version
Must be 1.
Reserved
Must be 0.
NumEntries
Number of entries in the table.
String Table Entry
16
32
LenBytes 2 Bytes
Datatype 1 Byte
Reseved 1 Byte
Data Variable lenght
LenBytes
Length of this entry including this header.
Datatype
Type of content:
0 = IPv4 binary encoded value (always 4 bytes)
1 = IPv6 binary encoded value (always 16 bytes)
2 = HostName or IPv4/IPv6 Address String (encoded as zero terminated string)
Reseved
Must be 0.
Data
n bytes of entry data.
Rules for using the table
- The "StringTable" extension is an option.
- If the RCP-Data contain any IP-Address which current(!) value is other than an IPv4 type then the
StringTable option must be used.
- If the RCP-Data does not contain any IP-Address which current(!) value is other than an IPv4 type then the
StringTable option should NOT be used to be compatible with older firmware versions and with commands which
might not (yet) support this feature.
- If the StringTable is used then:
1. The string_table_avail flag must be set to 1 in the RCP+ Header
2. All IP-values within "RCP-Data" must be stored in the string table (also when they are IPv4 values)
3. The DWORD-field in "RCP-Data" (which normally would store the IPv4 value) has to contain an offset-pointer to the
location in the string table where the actual IP-Address-value can be found.
Offset has to be calculated from "Head of StringTable Header" to "Head of StringTable Entry Header" in Bytes.
4. There is only one StringTable allowed in an RCP+ Packet.
5. The len field of the RCP+ Header must NOT include the size of the StringTable.
6. The len field of the TPKT Header (Framing Header) MUST include the size of the StringTable.
(This means: RCP-Packet and StringTable are both content of the same TPKT Packet)
RCP Command Notification
A RCP client can register for a special message CONF_RCP_CMD_NOTIFICATION (0xff23) in order to be informed when any other RCP+ command is written to the device.
The message is sent out at a frequency of maxium 100ms and contains the tag codes of all RCP+ commands with the direction 'write' that have been processed by the device since the last message.
If no RCP+ command was written within this time, no message will be sent. Besides the tag codes the message contains some more information about the commands as described below.
The payload of the message contains one or multiple elements of the following structure (one element for each RCP command).
The maxium number of elements is 32.
Message payload element
16
32
Command Tag 2 Bytes
Datatype 1 Byte
Direction 1 Byte
Action 1 Byte
Reserved 1 Byte
Client ID 2 Bytes
Reserved 4 Bytes
NumDes 2 Bytes
Count 2 Bytes
8
24
Command Tag
Tag code of the RCP command.
Datatype
Datatype of the RCP command (e.g. P_OCTET).
Direction
Direction of the RCP command (currently only WRITE).
Action
Action of the RCP command (currently only REPLY).
Client ID
Client Id of the RCP client that sent the RCP command.
NumDes
Numeric Descriptor (NumDes) parameter value of the RCP command.
Count
Number of times that this RCP command has been processed.
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 Registration
0x01
Hook On Registration
0x02
Hook Back Registration
0x03
Client ID
Unused in Normal Registration. Must be provided in Hook On Registration.
PE
Password and User Delivery Encryption.
Values:
Plain text
0x00
MD5 hash
0x01
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
The client opens up a TCP connection to the VideoJet.
The client sends an RCP registration as mentioned above.
The RCP server (the VideoJet) will respond with the result code and the assigned Client ID.
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.
The client opens up a TCP connection to the VideoJet.
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).
The RCP server (the VideoJet) will check whether the other client is registered properly on the same host.
The RCP server (the VideoJet) will respond with the result code and a NEWLY assigned Client ID.
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:
A 16 character random string for MD5 hash calculation must be requested from the VideoJet (RCP command CONF_RCP_REG_MD5_RANDOM).
A string +random_string+++username:password+ must be formed.
The response MD5 hash over this string must be calculated.
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 failed
0x00
Registration successful
0x01
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 successful
0x01
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
no
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 requested
0x0000
Indefinite lease time; request lease as long as the current registration is valid
0xFFFF
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 denied
0x00
Access to the serial port granted
0x01
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 be 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:
GET
0x00
PUT
0x01
Key transport
0xE0
Media
Values:
Video
0x01
Audio
0x02
Data
0x03
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 does not need to be re-triggered by the command CONF_RCP_CONNECTIONS_ALIVE.
Bit3: Optional signalling for streaming (for correct connection list display)
Bit4: Media key request (when using GET) / Media key is appended at the end of this section (when using PUT)
Bit5: Dry Connect. If this bit is set a replay connection is established (and a session id to control the replay connection is returned). The replay source is not connected. This can be done using the CONF_RCP_CONNECT_SALVO command
Bit6: Transcoder: Set this bit to instanciate and establish a connection to the transcoder
Bit7: Video over ssl: This Bit is set in the response to signal that the device supports "video over ssl".
Bit8: Multi ROI capable: This Bit signals that a client is able to provide a session ID to steer multiple ROIs (region of interrest) with E-PTZ.
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 UDP
0x01
RTP over TCP
0x04
Note: When using RTP over TCP, media channels must be established as described in 'RCP Protocol Procedure / Receiving media data'.
Flags
Values:
Bit1
Substitute 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).
Bit2
Use 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 header
0.0.0.0
VideoJet will take its configured multicast group IP
224.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:
Bit3
MPEG-4 (elementary stream)
Bit4
MPEG-2 (only video)
Bit5
Meta Data (output from motion detector…)
Bit7
H264
Bit8
JPEG
Bit15
Recorded Media
Bit16
MPEG-2 (program stream)
Resolution
Values:
Bit1
QCIF
Bit2
CIF
Bit3
2CIF
Bit4
4CIF
Bit6
QVGA
Bit7
VGA
Bit8
HD720
Bit9
HD1080
Bit10
WD144
Bit11
WD288
Bit12
WD432
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 UDP
0x01
RTP over TCP
0x04
Flags
Values:
Bit1
Substitute 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).
Bit2
Use 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 header
0.0.0.0
VideoJet will take its configured multicast group IP
224.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.
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 Intrinsic
0x02
MTA IP Address
Media Transport Address IP Address
Values:
VideoJet will take address from the incoming TCP header
0.0.0.0
Coder
Informational.
Line
Identifies the Line Input/Output channel for the specified coding engine.
Coding
Values:
Bit1
RCP
Bit15
Recorded 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 Callback
0x06
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:
Bit15
Recorded Media
Resolution
Values:
Bit1
QCIF
Bit2
CIF
Bit3
2CIF
Bit4
4CIF
Bit6
QVGA
Bit7
VGA
Bit8
HD720
Bit9
HD1080
Bit10
WD144
Bit11
WD288
Bit12
WD432
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_INTERNAL
0x01
SPAN_ERR_INV_SPN_IDX
0x02
SPAN_ERR_INV_HDR_TYPE
0x03
SPAN_ERR_NOT_MNTD
0x05
SPAN_ERR_INV_FS
0x06
SPAN_ERR_INV_LUN_NFO
0x07
SPAN_ERR_BAD_HDR_CKSM
0x08
SPAN_ERR_RD_ONLY
0x0a
SPAN_ERR_NO_REC_DAT
0x0b
SPAN_ERROR_INV_PART_NFO
0x0c
ISCSI_ERROR_CONNECT
0x31
ISCSI_ERROR_INV_LUN
0x33
ISCSI_ERROR_LOGIN
0x34
ISCSI_ERROR_INV_TRG_IDX
0x35
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
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:
GET
0x00
PUT
0x01
Media
Values:
Video
0x01
Audio
0x02
data
0x03
Status
Values:
Interface not available (Remark: former version may return this error in case of unknown method/media type)
0x00
Access to this interface granted
0x01
Access to this interface rejected
0x02
Session ID invalid or connection no longer active
0x03
Coding parameters incompatible
0x04
Interface data will be supplied by another media descriptor
0x05
The method field in the header does not carry a known method
0x08
The media field in the header does not carry a known media type
0x09
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 disconnected
0x01
Connection identified by the given Session ID not found on this host
0x02
Cause
Values:
Not closed
0x00
Normal termination
0x01
Abnormal termination
0x02
No response
0x03
Remote host terminated
0x04
Timed out
0x05
Remote login rejected
0x06
No common media channels
0x07
Connection substituted
0x08
Automatic disconnect
0x09
Stop streaming
0x0a
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:
Bit0
Substitute an existing connection
Bit1
Request video mode MPEG-4
Bit2
Request video mode MPEG-2
Bit3
Force the use of TCP as transportation protocol
Bit4
Connect to the HDD to receive a recorded media stream
Bit6
Connect a VCA meta data stream
Bit7
Supress automatic media key exchange
Bit8
Use 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)
Bit9
Request video mode H.264
Bit10
Request video mode JPEG
Bit11
Allow audio mode L16 (setting this bit to 0 uses G711 (default, previous behaviour), setting to 1 allows G.711 and L16 - both with 90kHz timestamp clock)
Bit12
Allow audio mode AAC
Local Coder
This parameter carries the number of the local coder number. A wildcard of ‘0’ will result in first match.
Local Line
This parameter carries the number of the local video line number. A wildcard of ‘0’ will result in first match.
Put Channels
Values:
Bit0
Video
Bit1
Audio
Bit2
Data
Bit3-Bit15
Reserved
Remote Coder
This parameter carries the number of the remote 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 line number (at the destination IP). A wildcard of ‘0’ will result in first match.
Get Channels
Values:
Bit0
Video
Bit1
Audio
Bit2
Data
Bit3-Bit15
Reserved
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 2 Bytes
remote password level 1 Byte
remote password length 1 Byte
remote password 128 Bytes
8
24
Dest. Port
This parameter carries the number of the remote TCP port number used for RCP login.
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
p_octet
l_user
see detailed description
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:
Bit0
Connection is MPEG2 VES
Bit1
Connection is MPEG2 PRG
Bit2
Connection is MPEG4
Bit3
Connection is to HDD replay
Bit4
Connection is started as streaming
Bit5
Connection is using multicast
Bit6
Connection is using TCP for transportation
Bit7
Data stream is encrypted
Bit8
Connection is H.264
Bit9
Connection 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:
Video
0x0001
Audio
0x0002
Serial
0x0003
IO
0x0004
Camera Data
0x0005
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_ENCODER
0x0001
VIDEO_DECODER
0x0002
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_MPEG2
0x0001
VIDEO_COMP_MPEG4
0x0002
VIDEO_COMP_H264
0x0004
VIDEO_COMP_JPEG
0x0008
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_QCIF
0x0001
VIDEO_RESO_CIF
0x0002
VIDEO_RESO_2CIF
0x0004
VIDEO_RESO_4CIF
0x0008
VIDEO_RESO_CUSTOM
0x0010
VIDEO_RESO_QVGA
0x0020
VIDEO_RESO_VGA
0x0040
VIDEO_RESO_HD720
0x0080
VIDEO_RESO_HD1080
0x0100
VIDEO_RESO_WD144
0x0200
VIDEO_RESO_WD288
0x0400
VIDEO_RESO_WD432
0x0800
VIDEO_RESO_HD2592x1944
0x1000
Element Structure
For section type Audio
Type 2 Bytes
Identifier 2 Bytes
Compr 2 Bytes
Type
is one of the following
Values:
AUDIO_ENCODER
0x0001
AUDIO_DECODER
0x0002
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_MPEG2
0x0001
AUDIO_COMP_G711
0x0002
AUDIO_COMP_AAC
0x0004
Element Structure
For section type Serial
Type 2 Bytes
Identifier 2 Bytes
Type
is one of the following
Values:
SERIAL_RS232
0x0001
SERIAL_RS485
0x0002
SERIAL_RS422
0x0004
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_INPUT
0x0001
IO_OUTPUT
0x0002
IO_VIRTUAL_IN
0x0003
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_BILINX
0x0001
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:
Video
0x01
Audio
0x02
Data
0x03
Direction
physical port is
Values:
Input
0x00
Output
0x01
Flags
one or multiple of
Values:
Request compact format
0x00
Reqeust extended format list
0x01
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.263
0x0002
Mpeg4
0x0004
Mpeg2
0x0008
Meta Data
0x0010
H.263-1998
0x0020
H.264
0x0040
Jpeg
0x0080
Recorded Media
0x4000
Mpeg2 PrgStr
0x8000
Coding Current
The current available coding capabilities (definitions see above)
Resolution Capabilities
All resolution capabilities is one or multiple of
Values:
QCIF
0x0001
CIF
0x0002
2CIF
0x0004
4CIF
0x0008
Custom
0x0010
QVGA
0x0020
VGA
0x0040
HD720
0x0080
HD1080
0x0100
WD144
0x0200
WD288
0x0400
WD432
0x0800
HD5M
0x1000
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.711
0x0001
AAC
0x0002
G.711 (8kHz timestamps)
0x0004
L16 (16kHz timestamps)
0x0008
L16
0x0010
Recorded Media
0x4000
Mpeg2 PrgStr
0x8000
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:
RCP
0x0001
Coding Current
The current available coding capabilities (definitions see above)
CodParameter Capabilities
All coding CodParameter capabilities is one or multiple of
Values:
RS232
0x0001
RS485
0x0002
RS422
0x0004
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
 
get 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
 
get 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
 
get 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
 
get 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_RCP_CONNECT_SALVO
Tag code
NumDes
Message
SNMP Support
0xff13
yes (0 - nothing, 1 to 4 refering to entries of CONF_ADD_REMOTE_DEVICE)
no
no
Datatype
Access Level
Description
Read
%
l_live
 
%
Write
p_octet
l_live
see detailed description
Payload Structure
flags 8 Bits
line 8 Bits
reserved 8 Bits
relative coder 8 Bits
port 16 Bits
ssl port 16 Bits
reserved 4 Bytes
url len 16 Bits
url ...
url (url len) bytes ...
pwd len 16 Bits
pwd ...
pwd (pwd len) bytes...
flags
bit 0: live video,
bit 1: use TCP to get live video
line
line from 1 to max lines (line 0 is mapped to line 1)
relative coder
relative coder number from 1 to ... (coder number 0 is mapped to coder number 1)
port
port
ssl port
ssl port
url len
length of the following url (actual limit is 64)
url
url for the connection salvo, ascii string including zero termination
pwd len
length of the following password (actual limit is 64)
pwd
password for the salvo connection, ascii string including zero termination
CONF_RCP_CONNECT_SALVO
A replay connection can be established in two steps: 1) build up a "dry" (replay) connection by setting the flag in the CONNECT_PRIMITIVE request. A Rcp connection is established and a session id to control the connection is returned. Data is not sent out as long as no source is connected. 2) connect a source to the connection (only implemented for replay) using this RCP_CONNECT_SALVO_COMMAND with the provided session id. The connection will retrieve the data from the specified device If a source is already connected a second call of this command will replace the first connection. The num parameter can be used to refere to an entry from CONF_ADD_REMOTE_DEVICE (num 1 to 4). In that case only a shorter payload (line and relative coder) is required. All other parameters will be taken from the CONF_ADD_REMOTE_DEVICE command. For port and ssl port the first two ports of a CONF_ADD_REMOTE_DEVICE entry will be used in that order. If the num parameter is set to zero, all other parameters are required and used if the connection is a remote device. If num is zero and the short payload (line and rel coder) is also used, it is asumed, that the local device is addressed.
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
yes
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_SERIAL_NUMBER
Tag code
NumDes
Message
SNMP Support
0x0ae7
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns the serial number of the device
Write
%
l_serv
%
CONF_CTN
Tag code
NumDes
Message
SNMP Support
0x0aea
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
read the CTN of the device
Write
p_string
l_serv
not supported
CONF_DEVICE_TYPE_IDS
Tag code
NumDes
Message
SNMP Support
0x0b07
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read the device type ids (hexadecimal). 1st DWORD: Product ID; 2nd DWORD: Variant ID; 3rd DWORD: (Bicom) Frontend Family ID
Write
void
l_serv
not supported
CONF_SUPPORTED_UPLOAD_TARGETS
Tag code
NumDes
Message
SNMP Support
0x0b19
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns all supported upload targets for this platform (List of n DWORDs)
Write
p_octet
l_serv
not supported
CONF_DEVICE_CAPABILITIES
Tag code
NumDes
Message
SNMP Support
0x0b60
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns capabilities of the device in a tagged format
Write
p_octet
noprot
not supported
Payload Structure
16
32
num Entries 4 Bytes
tag1 2 Byte
length1 2 Byte
payload1 length1 bytes
...
tagN 2 Byte
lengthN 2 Byte
payloadN lengthN bytes
CONF_DEVICE_CAPABILITIES
lists device capabilities in a tagged format.
num Entries
The total number of tagged entries.
tags
The following tags are defined:
DEVICE_TYPE: 1:encoder, 2: camera, 3:transcoder, 4:vrm 0: other
PTZ_CAMERA: ptz capabilities yes/no; This command returns ptz capabilities if the device is a dome camera, if bilinx is supported and a bilinx camera is connected to
the device or if a serial dome protocol is set
ROI_CAMERA: region of interest yes/no
AUTOTRACKER: autotraker yes/no
NBR_VIDEO_IN: number of video inputs
NBR_TRANSCODER: number of transcoders
NBR_AUDIO_IN: number of audio inputs
NBR_AUDIO_OUT: number of audio outputs
AUDIO_OPTIONS: bit0 line in, bit1 line out, bit2 mic bit3 loadspeaker (see CONF_AUDIO_OPTIONS)
E-PTZ: eptz supported or not
IMAGE_PIPE_FEATURES: returns the information that is provided by bicom command 0x0502 (ServerID 4)
BEST_FACE: 1 device supports CONF_BEST_FACE 0 device doesn't support CONF_BEST_FACE
length
The length of the payload. The payload of a tag must be in network byte-order.
CONF_DEVICE_OPERATION_MODE_VERSIONS
Tag code
NumDes
Message
SNMP Support
0x0b61
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
information about device operation_modes, see
Write
p_octet
noprot
not supported
Response Payload Structure
operation mode version info 1 X[1] Bytes ...
N x X[i] Bytes
operation mode version info N X[N] Bytes ...
operation mode version info 1 - N
A list of operation mode version info structures.
type 1 Byte
specific information N Bytes ...
type
type of the operation mode version info structure.
Values:
recording configuration version
0x01
specific information
specific information depending on the type.
operation mode version info: recording configuration version structure
0x01 1 Byte
variant 1 Byte
version 2 Bytes
variant
Varian of the recording configuration.
Values:
profile configuration mode
0
Configuration has to be done by command CONF_HD_RECORD_PROFILES
stream configuration mode
1
Configuration has to be done by command CONF_HD_RECORD_PROFILES_V2
version
Version of the recording configuration. Current version is 1.
CONF_DEVICE_OPERATION_MODE_VERSIONS
This command can be used to get a hint for changes between firmware versions or differences between device types concerning handling or way of configuration of the devices for several aspects. In order to parse the response payload, first check the first byte of a operation mode version info structure, which is the type and depending on the type read the remaining payload of the structure. Do this again for all following operation mode version info structures until the end of the response payload.
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 or configured to active
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 or configured to active
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 or configured to active
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 or configured to active
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 or configured to active
CONF_TIME_SEC
Tag code
NumDes
Message
SNMP Support
0x002b
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 or configured to active
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 ("xxx.xxx.xxx.xxx", or URL) used to sync time from
Write
p_string
l_serv
sets the ntp server ip (as string; "xxx.xxx.xxx.xxx" or URL) to sync time from
CONF_NTP_SYNC_MODE
Tag code
NumDes
Message
SNMP Support
0x031e
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
returns mode which is used by time server, time server(0), SNTP server(1), off(2)
Write
t_dword
l_serv
selects mode which is used to sync time on this machine, time server(0) SNTP server(1), off(2)
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_ACCOUNT_SETTINGS
Tag code
NumDes
Message
SNMP Support
0x0b5e
yes (index of the account 1...4)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
gets the account information: 4 bytes types (0: no; 1: ftp; 2: dropbox),32 bytes: name, 64 bytes username (ftp only), 32 bytes password (ftp only), 64 bytes path, 64 bytes optional url (e.g ip of the ftp server, unused for dropbox)
Write
p_octet
l_serv
stores the account information: 4 bytes types (0: no; 1: ftp; 2: dropbox), 32 bytes name, 64 bytes username (ftp only), 32 bytes password (ftp only), 64 bytes path, 64 bytes optional url (e.g ip of the ftp server, unused for dropbox)
CONF_NBR_OF_ACCOUNTS
Tag code
NumDes
Message
SNMP Support
0x0b62
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
gets the max number of accounts
Write
t_dword
l_serv
not supported
CONF_DROPBOX_AUTH_ADDR
Tag code
NumDes
Message
SNMP Support
0x0b81
account idx
Message only
no
Datatype
Access Level
Description
Read
%
noprot
 
%
Write
p_octet
noprot
gets the url that should be used to login at dropbox (payload url)
CONF_DROPBOX_AUTH_STATUS
Tag code
NumDes
Message
SNMP Support
0x0b82
account idx
yes
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
gets authentication status (0: not authenticated, 1: authenticated, 2: authentication session timed out, 3: failed)
Write
t_octet
noprot
gets authentication status (0: not authenticated, 1: authenticated, 2: authentication session timed out, 3: failed)
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
returns if video over ssl is supported or not (0: disabled)
Write
t_dword
l_user
enables/disables video over ssl (0:disabled)
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
yes
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
noprot
 
100 if booted, 50: waiting for camera frontend
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_HEATER_MODE
Tag code
NumDes
Message
SNMP Support
0x0b0c
no
no
no
Datatype
Access Level
Description
Read
t_octet
l_user
 
read the heater mode - 0: off, 1: on, 2: auto
Write
t_octet
l_serv
write the heater mode - 0: off, 1: on, 2: auto
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
no
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_GLOBAL_PARAMETERS
Tag code
NumDes
Message
SNMP Support
0x0b68
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
reads the VCA global parameters, payload is beyond the scope of this document
Write
p_octet
l_serv
sets the VCA global 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 viproc component names
Write
p_string
l_serv
list of viproc component names
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 possible (e.g. not a dome camera)
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
no
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
no
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
-
Payload Structure
16
32
Alarm Flags 2 Byte
Detector Flags 2 Byte
ConfigId 1 Byte
8
24
40
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.
Alarm Flags
Values:
0x8000
Motion flag
0x4000
global change flag
0x2000
signal too bright flag
0x1000
signal too dark flag
0x0800
signal too noisy flag
0x0400
image too blurry flag
0x0200
signal loss flag
0x0100
reference image check failed flag
0x0080
invalid configuration flag
These bits can be combined by using the bitwise or-operator.
Detector
State of the detectors. 0x0001 corresponds to detector one, 0x0002 to detector two and so on.
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,
Write
p_octet
l_serv
-
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:
Bit01
Frequency band 0-220 Hz
Bit02
Frequency band 110-360 Hz
Bit03
Frequency band 220-500 Hz
Bit04
Frequency band 360-690 Hz
Bit05
Frequency band 500-890 Hz
Bit06
Frequency band 690-1110 Hz
Bit07
Frequency band 890-1375 Hz
Bit08
Frequency band 1110-1690 Hz
Bit09
Frequency band 1375-2030 Hz
Bit10
Frequency band 1690-2420 Hz
Bit11
Frequency band 2030-2875 Hz
Bit12
Frequency band 2420-3400 Hz
Bit13
Frequency band 2875-4000 Hz
Bit14
Entire 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 8
OnOff 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
 
-
Write
p_unicode
l_serv
-
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
yes
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_VCA_FRAME_RESOLUTION
Tag code
NumDes
Message
SNMP Support
0x0814
video line
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
read the current frame resolution of the video line (internal usage only)
Write
t_dword
l_serv
read the current frame resolution of the video line (internal usage only)
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
This command writes the vca device capabilities for the viproc
algorithm (internal usage only!). Note, that the read operation is NOT supported.
The current Version is 0x15072010.
The payload has a tag structure which is as follows:
4
5
6
6+Length1
Version 4 Bytes
Tag1 1 Byte
Length1 1 Byte
Payload1 Length1 Bytes
Tag2 1 Byte
Length2 1 Byte
Payload2 Length2 Bytes
...
0 2 Bytes
where Version is set to the current date (day, month, year), if a new tag is introduced.
Num Value
The num value of the RCP command selects the video line to which
the device capabilities belong.
Return Value
The read operation is NOT supported.
A write operation is successful, if the RCP+ command succeeds. Otherwise it fails.
The following payload example contains a capability device, that a reference image is on the current device not available.
4
5
6
7
9
Version 4 Bytes
Tag1 1 Byte
Length1 1 Byte
Payload1 1 Byte
0 2 Bytes
0x15
0x07
0x20
0x10
0x01
0x01
"0x01"
0x00
0x00
CONF_VCA_TASK_RUNNING_STATE
Tag code
NumDes
Message
SNMP Support
0x0a96
yes (camera line input number)
yes
no
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_SELECT_VCA_SCALER
Tag code
NumDes
Message
SNMP Support
0x0ae5
video line
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
not supported
Write
t_dword
l_serv
force to use a specific input buffer from ambarella (first byte selects buffer for luma and second for chroma)
CONF_TRANSPARENT_DATA_OVER_IP
Tag code
NumDes
Message
SNMP Support
0x0af2
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
set IP-address and port to accept transparent data, first, 4 bytes define the IP-address (0 represents off) and second, two bytes are the defined port
Write
p_octet
l_serv
set IP-address and port to accept transparent data, first, 4 bytes define the IP-address (0 represents off) and second, two bytes are the defined port
CONF_AUTO_TRACKER_TRACK_OBJECT
Tag code
NumDes
Message
SNMP Support
0x0b2d
video line (starts with 1)
yes
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
Get the object id of the currently tracked object. Zero is returned if no object is tracked.
Write
t_dword
l_user
send the object id to start tracking
CONF_MODE_AUTO_TRACKER
Tag code
NumDes
Message
SNMP Support
0x0b40
video line (starts with 1)
yes
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
Get the autotracker mode (Modi: OFF=0, AUTO=1, CLICK=2).
Write
t_octet
l_user
Sets the autotracker mode (Modi: OFF=0, AUTO=1, CLICK=2). The CLICK mode has to be rewritten after 10sec; otherwise, the mode shall switch back to AUTO
CONF_STATUS_AUTO_TRACKER
Tag code
NumDes
Message
SNMP Support
0x0b86
-
yes
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
Gets current mode of auto tracker.
Write
t_octet
l_user
Gets current mode of auto tracker.
CONF_SENSITIVITY_OBJECT_BASED_VCA
Tag code
NumDes
Message
SNMP Support
0x0b31
video line
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
reads the sensitivity of the object based VCA algorithm (of active config profile), if not an object based VCA algorithm is running the command returns with an error
Write
t_octet
l_serv
sets the sensitivity of the object based VCA algorithm in the active config profile, if not an object based VCA algorithm is running the command returns with an error
CONF_VIPROC_SENSITIVE_AREA
Tag code
NumDes
Message
SNMP Support
0x0b78
video line
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
sets the sensitive area of the object based VCA algorithm in the active (or last loaded) config profile, see detailed description
Write
t_octet
l_serv
sets the sensitive area of the object based VCA algorithm in the active (or last loaded) config profile
Payload Structure
16
32
Width 2 Byte
Height 2 Byte
Cells X 1 Byte
Cells Y 1 Byte
Step X 1 Byte
Step Y 1 Byte
Start X 1 Byte
Start Y 1 Byte
Bitmask n Byte
Bitmask ...
8
24
This command reads/sets the sensitivity mask of the viproc algorithm. Please use the read functionality to get the dimensions. If no viproc algorithm is running the command fails.
Width
Image width of the viproc algorithm.
Width
Image height of the viproc algorithm.
Cells X/Y
Number of cells in X/Y direction.
Step X/Y
Number of cell size in X/Y direction.
Start X/Y
Offset of bit mask from upper left corner.
Bitmask
Bitstream which signals which cell is activated or not. Upper left cell is the first going to the left and then down.
Example: A 3x3 mask with cross activated
oxo
xxx
oxo
has the following binary 0x010111010b or hexadecimal 0xba00h structure. Alignment bits can be set to zero but will be ignored.
CONF_REFERENCE_IMAGE_CHECK_INFO_MESSAGE
Tag code
NumDes
Message
SNMP Support
0x0b42
video line
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
1st Byte (Bit 7: check failed, Bit 6: No info available (reference image check was not enabled or reference image has not enough contours to perform reference image check), Bits 5-0: reserved), 2nd Byte: correlation, 3rd Byte: correlation threshold, 4th-5th Byte: seconds to alarm;
Write
p_octet
l_serv
not supported
CONF_IVA_COUNTER_VALUES
Tag code
NumDes
Message
SNMP Support
0x0b4a
video line
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
see detailed description
Write
p_octet
l_serv
reset all counters
This command, which is at the same time a message, is used to retrieve the list of configured counters with the their current values. The output has the following structure:
Initially the number of configured counters is set. Afterwards for each counter the data consisting of counter id, counter type, counter name in unicode and counter value is provided.
Request payload structure
Number of Counters 1 Byte
Data of Counter i 70 Byte
Data of Counter i + 1 70 Byte
... 70 Byte
Number of Counters
This values gives the number of counters available in the payload. In the subsequent the data
of each counter are sequentially provided.
Data of Counter
16
Id 1 Byte
Type 1 Byte
Name 64 Byte
Value 4 Byte
8
528
Id
Each counter has a unique id.
Type
Not supported yet.
Name
A unique name can be assigned to a counter, which is stored in unicode (maximum: 32 characters).
Value
The current counter value (DWORD).
CONF_CAMERA_POS_INFO
Tag code
NumDes
Message
SNMP Support
0x0b6a
video line (starts with 1)
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Write
p_octet
l_serv
Payload Structure
16
32
pan angle 2 Byte
tilt angle 2 Byte
roll angle 2 Byte
reserved 2 Byte
pos x 4 Byte
pos y 4 Byte
pos z 4 Byte
8
24
pos
Local coordinate system in signed values.
CONF_GEO_POS_INFO
Tag code
NumDes
Message
SNMP Support
0x0b6b
video line (starts with 1)
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Write
p_octet
l_serv
Payload Structure
16
32
latitude 4 Byte
longitude 4 Byte
height above sealevel 4 Byte
north angle 4 Byte
8
24
CONF_BEST_FACE
Tag code
NumDes
Message
SNMP Support
0x0b6e
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Write
p_octet
l_serv
Payload Structure
16
32
enable 1 Byte
reserved 1 Byte
accountId 1 Byte
pictureFormat 1 Byte
targetObjectWidth 4 Bytes
reserved 12 Bytes ...
8
24
enable
0: best face is disabled
1: best face is enabled
reserved
accountId
Select account which is used as target for the detected faces for detailed information’s see CONF_ACCOUNT_SETTINGS
pictureFormat
Select file format 0: Jpeg 1: YUV420 2: TIFF (YUV420)
targetObjectWidth
Configure maximum face width in pixel 0 means auto no scaling is necessary delivers best performance
reserved
Must be written as zero
CONF_BEST_FACE
Allows the upload of detected faces to an ftp server or drop box account.
CONF_SYSUPTIME
Tag code
NumDes
Message
SNMP Support
0x00b9
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
read the system uptime in seconds
Write
t_dword
l_serv
read the system uptime in seconds
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_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, 3:=h26x_2nd stream
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
yes
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
only in generic: set vrm instance (0 <= ClusterId < 32)
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 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_BLOCK_BASED_STORAGE
Tag code
NumDes
Message
SNMP Support
0x0adf
no
no
no
Datatype
Access Level
Description
Read
p_octet
l_priv
 
not supported
Write
p_octet
l_priv
read or write 512 byte memory blocks of flash (service for 3rd party modules like imgage-pipe dll or fpga)
Payload Structure
16
32
Domain 4 Bytes
Operation 4 Bytes
PageIndex 4 Bytes
PageCount 4 Bytes
Padding 16 Bytes ...
Payload n x 512 Bytes ...
8
24
Domain
Identifies the memory area to be accessed.
Each module may have its own areas.
The areas and their size have to be predefined by the firmware.
Some may be permanent and some may get erased by the factory reset button.
Operation
Type of operation to be performed
Values:
BBSS_OP_READ
0
BBSS_OP_WRITE
1
PageIndex
Index of the first 512 byte page to be accessed
Values:
Index
0..n-1
PageCount
Number of 512 byte pages to be accessed
Padding
Padding up to a total hdr size of 32 bytes
Values:
Should be zero
0
Payload
n * 512 bytes payload to be read or written
Description
Read or write n blocks of 512 bytes to flash.
All single blocks can be simply overwritten. A explicit erase is not required.
Write is atomic on block basis which means that also in case of power-loss-while-write either the consistent
old version or the new version of a single block is read back next time after reboot
therefore doublebuffering is not required.
CONF_POE_GRANTED_POWER
Tag code
NumDes
Message
SNMP Support
0x0ae6
no
yes
yes
Datatype
Access Level
Description
Read
t_word
noprot
 
read the current poe power granted by switch / midspan in tenths of Watts
Write
%
noprot
%
CONF_INSTALLER_SEQUENCE
Tag code
NumDes
Message
SNMP Support
0x0b0f
cam
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
0: installer sequence is deactivated; 1: installer sequence is allowed
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) if recording is running and the iframe distance is 0, the iframe distance of the preet will be patched to a recording suitable value.
CONF_MPEG4_CURRENT_PARAMS_TRANSCODER
Tag code
NumDes
Message
SNMP Support
0x0b4e
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
sessionID references the replay session; 0:= no transcoding; 1-8: video preset of the transcoder
Write
t_dword
l_user
sessionID references the replay session; 0:= no transcoding; 1-8: video preset of the transcoder
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.263
0x0002
Mpeg 4
0x0004
Mpeg 2
0x0008
H.264
0x0040
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, sessionID to address session based video params
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, sessionID to address session based video params
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 or configured to active and the preset is used on the recording schedule), sessionID to address session based video params
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 ,...), sessionID to address session based video params
sets the spatial resolution (0=QCIF, 1=CIF, 2=2CIF, 3=4CIF, 4=(1/2 D1), 5=(2/3D1), 6=QVGA, 7=VGA, 8=WD144 (256x144), 9=WD288 (512x288), 10=WD432 (768x432), 12=720P for selected preset, sessionID to address session based video params
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 (if the recording is running and the preset in on the recording schedule, the preset will keep its old iframe distance)
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 max quantizer (9-51,0=auto) for selected preset
Write
t_dword
l_serv
sets the P frame max 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, sessionID to address session based video params
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_QUANT_ADJ_BACKGROUND
Tag code
NumDes
Message
SNMP Support
0x0624
profile preset
no
no
Datatype
Access Level
Description
Read
t_int
noprot
 
gets the quality difference (H.264 QP Units; -51..+51) between normal and background regions
Write
t_int
l_serv
sets the quality difference (H.264 QP units; -51..+51) between normal and background regions
CONF_MPEG4_AVC_QUANT_ADJ_OBJECTS
Tag code
NumDes
Message
SNMP Support
0x0625
profile preset
no
no
Datatype
Access Level
Description
Read
t_int
noprot
 
gets the quality difference (H.264 QP Units; -51..+51) between normal and object regions
Write
t_int
l_serv
sets the quality difference (H.264 QP units; -51..+51) between normal and object regions
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_BITRATE_AVERAGING_PERIOD
Tag code
NumDes
Message
SNMP Support
0x0622
profile preset
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get the (maximum) period in seconds for bitrate averaging (0=no bitrate averaging)
Write
t_dword
l_serv
sets the (maximum) period in seconds for bitrate averaging (0=no bitrate averaging)
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
yes
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_VIDEO_ENCODER_ENCODED_BYTES
Tag code
NumDes
Message
SNMP Support
0x0af6
coder instance
no
yes
Datatype
Access Level
Description
Read
t_dword
noprot
 
Get encoded bytes (32 Bit Counter) since bootup. Only supported for h.264 and Jpeg encoder.
Write
t_dword
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_ENC_CURRENT_RESOLUTION
Tag code
NumDes
Message
SNMP Support
0x0b4b
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the current resolution (width + height) in pixel of an encoder (relative to line). First two bytes of payload (line+coder) need to be specified as request payload. 1st Byte: video line (needs to be set when reading); 2nd Byte: encoder (needs to be set when reading); 3.+4. Byte: width; 5.+6. Byte: height; 7.+8. Byte reserved
Write
p_octet
l_serv
not supported
CONF_ENC_PROFILE_BASIC_PARAMS
Tag code
NumDes
Message
SNMP Support
0x0b2e
profile preset
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get basic parameters of an encoder profile preset. 1st DWORD: Resolution (parameter values see CONF_MPEG4_RESOLUTION); 2nd DWORD: Skip Ratio (values see CONF_MPEG4_FRAME_SKIP_RATIO); 3rd DWORD: Target bit rate (values see CONF_MPEG4_BANDWIDTH_KBPS); 4th DWORD: Maximum bit rate (values see CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT)
Write
p_octet
l_serv
set basic parameters of an encoder profile preset and apply them instantly. 1st DWORD: Resolution (parameter values see CONF_MPEG4_RESOLUTION); 2nd DWORD: Skip Ratio (values see CONF_MPEG4_FRAME_SKIP_RATIO); 3rd DWORD: Target bit rate (values see CONF_MPEG4_BANDWIDTH_KBPS); 4th DWORD: Maximum bit rate (values see CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT)
CONF_ROI
Tag code
NumDes
Message
SNMP Support
0x0b48
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
see detailed description
Write
p_octet
l_live
see detailed description
Select region of interest. The Session-ID identifies the video coder.
Payload Structure
16
32
hPos 2 Bytes
vPos 2 Bytes
size 2 Bytes
reserved 2 Bytes
hPos / vPos
Center position of the cropping window in relative coordinates (0..32768).
E.g. (0, 0) is upper left; (16384, 16384) is the center of the original image.
size
Size of the cropping window in relative coordinates (0..32768). The aspect ratio will be preserved.
CONF_VIDEO_ENC_TEMP_QUANT_ADJ
Tag code
NumDes
Message
SNMP Support
0x0626
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get temporary encoding quality adjustment see
Write
p_octet
l_live
temporary encoding quality adjustmens see
Payload Structure
16
32
e 1
deltaQp 7 Bits
reserved 24 Bits
left 16 Bits
right 16 Bits
top 16 Bits
bottom 16 Bits
8
24
enable
Values:
enable temporary quality adjustments
1
disable temporary quality adjustments
0
deltaQp
Intended quality adjustment in H.264 QP units. If enable is 0, this field must also be set to 0. Otherwise the allowed range is -51..51 with negative values indicating higher quality and positive ones lower quality
reserved
set to 0
left
relative position of the left edge of the adjustment region within the complete encoded image
right
relative position of the right edge of the adjustment region within the complete encoded image
top
relative position of the upper edge of the adjustment region within the complete encoded image
bottom
relative position of the lower edge of the adjustment region within the complete encoded image
Description
The encoder, to which the quality adjustment is to be applied is identified via the RCP session.
The area, in which the qualtiy is adjusted is characterized by the position of the edges of a rectangle within a virtual coordinate system with a nominal range of [0..+32768]x[0..32768] for the complete encoded picture (0=top/left edge, 32768=bottom/right edge). The actually adjusted area will be enlarged as needed by the encoder.
Note, that the payload may contaion only first octet, if enable is set to 0
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; use session ID to read transcoder stamping configuration
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; use session ID to configure transcoder stamping
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 Stamp
0x0001
Name Stamp row 1
0x0002
Name Stamp row 2
0x0003
Alarm Stamp
0x0004
Info Stamp
0x0005
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 recording isn't active and configured to off
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 ) NOTE: this command will be depricated; use VIDEO_H264_ENC_BASE_OPERATION_MODE instead
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; NOTE: this command will be depricated; use VIDEO_H264_ENC_BASE_OPERATION_MODE instead
CONF_VIDEO_H264_ENC_CONFIG
Tag code
NumDes
Message
SNMP Support
0x0ad2
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the profile for each h.264 encoder per line for each time. DWORD 1: Mode, 0=live mode, 1-10: schedule number; DWORD 2: profile for first stream, DWORD 3: profile for second stream...
Write
p_octet
l_serv
set the profile for each h.264 encoder per line for each time. DWORD 1: Mode, 0=live mode, 1-10: schedule number; DWORD 2: profile for first stream, DWORD 3: profile for second stream... (if recording on that cam isn't running, the setting for live mode(0) will take place imidiatly)
CONF_VIDEO_H264_ENC_CONFIG_DEFAULTS
Tag code
NumDes
Message
SNMP Support
0x0b4d
cam
no
no
Datatype
Access Level
Description
Read
%
noprot
 
%
Write
t_dword
l_serv
set the default profile for each h.264 encoder per line for each time. Payload: Mode, 0=live mode, 1-10: recording schedule number. (if recording on that cam isn't running, the setting for live mode(0) will take place imidiatly)
CONF_VIDEO_H264_ENC_CONFIG_BULK
Tag code
NumDes
Message
SNMP Support
0x0ad9
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the profiles for each h.264 encoder per line for each time; this request will supply all Modes 0-10 in one reply; returns: DWORD 1: NbrOfStreamsPerMode, remaining payload 11x payload of VIDEO_H264_ENC_CONFIG
Write
p_octet
l_serv
set the profiles for each h.264 encoder per line for each time; this request must supply all Modes 0-10 in one request; DWORD 1: NbrOfStreamsPerMode, remaining payload 11x payload of VIDEO_H264_ENC_CONFIG
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
Tag code
NumDes
Message
SNMP Support
0x0ad3
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the base operation mode of the h.264 encoders per line. first DWORD stream 1, second DWORD stream 2...; 0=copy other stream, 1=compatibility mode to H2.64 BP+ (bitrate limited), 3: h.264 MP SD, 4: h.264 MP fixed 720p, 5: h.264 MP fixed 720p full framerate, 6: h.264 MP fixed 1080p, 7: h264 MP fixed 720p skip=3, 8: h264 MP fixed 720p skip=4, 9: h264 MP fixed 1080p skip=7, 10: h.264 MP SD ROI PTZ, 11: h.264 MP HD 2592x1944, 12: h.264 MP SD upright format (cropped), 13: h.264 MP SD 4CIF resolution 4:3 format (cropped), 14: h.264 MP SD (max 288p) dual stream with independent ROI PTZ
Write
p_octet
l_serv
set up the base operation mode of the h.264 encoders per line. first DWORD stream 1, second DWORD stream 2...; 0=copy other stream, 1=compatibility mode to H2.64 BP+ (bitrate limited), 3: h.264 MP SD, 4: h.264 MP fixed 720p, 5: h.264 MP fixed 720p full framerate, 6: h.264 MP fixed 1080p, 7: h264 MP fixed 720p skip=3, 8: h264 MP fixed 720p skip=4, 9: h264 MP fixed 1080p skip=7, 10: h.264 MP SD ROI PTZ, 11: h.264 MP HD 2592x1944, 12: h.264 MP SD upright format (cropped), 13: h.264 MP SD 4CIF resolution 4:3 format (cropped), 14: h.264 MP SD (max 288p) dual stream with independent ROI PTZ
CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS
Tag code
NumDes
Message
SNMP Support
0x0af9
line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the base operation mode capability list of the h.264 encoders per line. The list contains all possible mode combinations for all streams. 1st DWORD is number of streams (n). Then the combinations follow paired in n DWORDS. Possible modes: see CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
Write
p_octet
l_serv
not supported
CONF_VIDEO_H264_ENC_CURRENT_PROFILE
Tag code
NumDes
Message
SNMP Support
0x0ad4
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns the current active profile number for the h.264 streams (first DWORD: stream 1, second DWORD: stream 2...)
Write
-
l_serv
not supported
CONF_JPEG_STREAM_SETUP
Tag code
NumDes
Message
SNMP Support
0x0ad5
Message : no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns the configuration of the JPEG encoder; DWORD 1:resolution (0=QCIF, 1=CIF, 2=2CIF, 3=4CIF, 6=QVGA, 7=VGA for selected preset), DWORD 2: fps in mHz, DWORD 3: quality (0=auto, 1(worst)..100(best))
Write
p_octet
l_serv
Description : write the configuration of the JPEG encoder; DWORD 1:resolution (0=QCIF, 1=CIF, 2=2CIF, 3=4CIF, 6=QVGA, 7=VGA, 12=720P, 14=1080P, 15=5MP for selected preset), DWORD 2: fps in mHz, DWORD 3: quality (0=auto, 1(worst)..100(best))
CONF_TCP_RATE_CONTROL
Tag code
NumDes
Message
SNMP Support
0x0b4c
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
enables/disables tcp rate control
Write
t_dword
l_serv
enables/disables tcp rate control
CONF_TCP_BANDWIDTH_CHECK
Tag code
NumDes
Message
SNMP Support
0x0b64
no
no
no
Datatype
Access Level
Description
Read
t_dword
l_serv
 
get tcp bandwith check max duration in ms, sessionID to address session based params
Write
t_dword
l_serv
set tcp bandwith check max duration in ms, sessionID to address session based params
CONF_TCP_BANDWIDTH_CHECK_RESULT
Tag code
NumDes
Message
SNMP Support
0x0b66
no
yes
no
Datatype
Access Level
Description
Read
p_octet
l_serv
 
get result of tcp_bandwidth_check (session id required), 4bytes error, 4bytes kbps
Write
p_octet
noprot
not supported
CONF_SEI_ENABLE
Tag code
NumDes
Message
SNMP Support
0x0b6d
no
no
no
Datatype
Access Level
Description
Read
t_octet
l_serv
 
read SEI configuration from transcoder replay connections; session ID is required; 0=off, 1=on
Write
t_octet
l_serv
configure SEI for transcoder replay connections; session ID is required; 0=off, 1=on
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_LOW_LIGHT_MIN_FPS
Tag code
NumDes
Message
SNMP Support
0x0ad8
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
min allowed frame rate for video sensor if low light mode is active value in mHz
Write
t_dword
l_serv
min allowed frame rate for video sensor if low light mode is active value in mHz
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_SAMPLING_MODE
Tag code
NumDes
Message
SNMP Support
0x0aa3
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Write
p_octet
l_serv
Payload Structure
16
32
SamplingMode 4 Bytes
SamplingRateInmHz 4 Bytes
ExposureTimeInuSec 4 Bytes
BandingFilterConfig 4 Bytes
8
24
SamplingMode
0=Auto (exposure time is selected by camera)1=Manual ( if possible exposure time selected by ExposureTimeInuSec is used)
2=Banding filter (avoid banding effect caused by light sources with a flicker frequency of 2 x BandingFilterConfig)
SamplingRateInmHz
Defines the sampling rate in mHz
ExposureTimeInuSec
Defines the exposure time in uSec (1/1000000 Sec)
BandingFilterConfig
Defines the net frequency in mHz, avoids flickering of the camera if a light source is used which flickers with net frequency
Common usage for write:
First read VID_IN_SAMPLING_MODE to get actual defined values, change the values which should be changed and write VID_IN_SAMPLING_MODE
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)
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, 3=VGA, 4=720P, 5=1080P, 6=QVGA
Write
t_dword
l_serv
set the VI norm 0=Autodetect; 1=PAL; 2=NTSC
CONF_VIDEO_INPUT_FORMAT_EX
Tag code
NumDes
Message
SNMP Support
0x0b10
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the VI format. 1st Byte Mode: 0=Fixed, 1=Autodetect; 2nd Byte Video format; 18 Bytes reserved. Available video formats are 0=no, 1=PAL, 2=NTSC, 3=VGA, 4=720P, 5=1080P, 6=QVGA, 7=720P25, 8=720P30, 9=720P50, 10=720P60, 11=1080P25, 12=1080P30, 13=2592x1944P12
Write
p_octet
l_serv
set the VI format. 1st Byte Mode: 0=Fixed, 1=Autodetect; 2nd Byte Video format (in case of fixed mode); 18 Bytes reserved. Available video formats are 1=PAL, 2=NTSC, 3=VGA, 6=QVGA, 7=720P25, 8=720P30, 9=720P50, 10=720P60, 11=1080P25, 12=1080P30, 13=2592x1944P12
The actual payload of this command consist of a sequence of variable length records, each specifying a region and a corresponding category to be used during encoding. The region is characterized by a mandatory rectangle and optionally a shape. Up to 8 regions and in total up to 96 32-bit data for shapes are supported, however the shape data are not yet interpreted and reserved for future firmware versions.
Normally the "background" category is used for unimportant parts of the scene and the "object" category for important ones. For this two categories, specific quality adjustments can be defined via the encoding profile of every encoder.
An area not belonging to any region is implicitly assigned to the "Default" category with no specific adjustments.
The forth category is currently assigned via the VIDEO_ENC_TEMP_QUANT_ADJ command separately for each encoder.
Note, that by using overlapping regions, more than one category can be assigned to some areas of the scene. In this case the category with the best quality adjustment for an encoder takes preceedence. Therefore it may be usefull to assign the "Default" category explicitly to some regions.
Record Structure
16
32
reserved 14 Bits
ex 2
reserved 5 Bits
ca 2
s 1
r 1
N 7 Bits
left edge 16 Bits
right edge 16 Bits
upper edge 16 Bits
lower edge 16 Bits
reserved shape data 1 32 Bits
reserved shape data 2 32 Bits
reserved shape data 3 32 Bits
...
reserved shape data N 32 Bits
8
24
reserved
set to 0
exclude
This bitmask indicates for which encoders this area shall NOT be used. The bits are allocated according to the the relative coder number starting with the rightmost bit (LSB) for the relative coder number 1.
reserved
set to 0
category
By default the complete scene is assumed to belong to the "default" category.
Values:
Default
0
Background
1
Objects
2
Reserved
3
shrink
Depending on the encoding resolution, the quality may only be adjusted on quite a coarse grid. This bit allows to specifiy whether the required rounding shall be performed by shrinking or enlarging the specified region.
Values:
enlarge as needed
0
shrink as needed
1
reserved
set to 0
N
This field indicates the number of 32-bit items defining the optional shape of this region and therefore also specifies indirectly the total size of this record (12 + N * 4 octets). For compatibility with future version of this RCP PLUS specification, clients SHOULD set this item to 0 for any region which they define or modify, but keep it and the corresponding shape data unmodified for regions they don't change.
reserved shape data 1, 2, ..., N
N 32-bit items reserved for shape data. For compatibility with future versions of this RCP PLUS specification, current implementations SHOULD include these data unmodified for regions they don't change. However for new or changed regions, they SHOULD not include any shape data.
Coordinate System
The rectangles and the future shapes are specified via a virtual coordinate system with a nominal range of 0..32768 x 0..32768 for the usable sensor area (or incoming video).
list of supported layouts; payload is a list of n WORDs. One WORD per supported layout (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
yes
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 signals
0
composite sync signal
1
illegal
2
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:
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 signals
0
composite sync signal
1
illegal
2
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:
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:
unsupported
0
supported
1
compSync
bitmask of supported composite sync
signals:
Values:
h-sync active high, v-sync active high
1
h-sync active low, v-sync active high
2
h-sync active high, v-sync active low
4
h-sync active low, v-sync active low
8
sepSync
bitmask of supported separate sync signals:
Values:
h-sync active high, v-sync active high
1
h-sync active low, v-sync active high
2
h-sync active high, v-sync active low
4
h-sync active low, v-sync active low
8
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.
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
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported
Write
p_octet
l_serv
access to the OSD via RCP command
Up to version 4.50, this command only applies to decoders to display text onto the video output.
The num field carries the video output number. A value of 0 indicates that the text should be displayed on all screens.
Remind that the num value numbering scheme takes quad mode into account for the lines where quad is possible,
even if quad mode is not active. (E.g. to have an OSD stamped into the fourth line of a VIP X1600 XFMD,
you need to use num value of 10). To delete previously submitted strings, send an empty string (not space characters!).
From version 4.50 on this command applies to encoders as well. In that case, the encoder will embed the text
information into the RTP data stream to be overlayed by the receiving decoder.
The attribute and flag fields are not applicable to the decoder's video output. The num field applies to the video input number.
Payload Structure
ID 2 Byte
len 2 Byte
x 1 Byte
y 1 Byte
reserved 2 Bytes ...
attributes 4 Bytes
flags 4 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
attributes
Values:
Bit 11
Centered display (0=off, 1=on)
Bit 13-15
Fontsize (0=small, 1=big)
flags
Values:
Bit 0
Interpret text as unicode characters (UTF-16)
String 1 - N
The string value which should be displayed
CONF_OSD_POS
Tag code
NumDes
Message
SNMP Support
0x0ae0
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
access to the OSD via RCP command
Write
p_octet
l_serv
access to the OSD via RCP command
Set or get the position of OSD objects (see CONF_OSD_ACCESS). For "write" the num field carries the video number; 0 indicates that the string positions on all video lines will be set.
WRITE
Payload Structure
ID 2 Byte
x 1 Byte
y 1 Byte
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
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)
READ
Payload Structure (request)
ID 2 Byte
Payload Structure (reply)
ID 2 Byte
x 1 Byte
y 1 Byte
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
x
X-Position (0...255) where the string is located (0 is left)
y
Y-Position (0...255) where the string is located (0 is up)
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 output. Range: 0 to AUDIO_OUTPUT_MAX
Write
t_dword
l_serv
sets level of audio output. Range: 0 to AUDIO_OUTPUT_MAX
CONF_AUDIO_ON_OFF
Tag code
NumDes
Message
SNMP Support
0x000c
no
no
no
Datatype
Access Level
Description
Read
flag
noprot
 
0 = audio mode is not set, 1 = audio mode is set
Write
flag
l_serv
set 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, 2=Mute (only supported by arm based products)
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
yes
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_VIPROC_RE_TASK_NAMES
Tag code
NumDes
Message
SNMP Support
0x0b2b
video line
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read the current rule engine task names which corresponds to line output: 2Bytes: 1Bit - IVA, 2Bit - Flow, 3Bit - Motion; 2 Bytes: num tasks; 1Byte: taskId; 1Byte: taskType (not defined yet); 64 OCTETS: task name in unicode
Write
p_octet
l_serv
does NOT work (task names are set by the cmd CONF_VCD_OPERATOR_PARAMS)
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
t_octet
noprot
 
get the default connection mode: 0=MPEG2, 1=MPEG4, 2=MPEG4/AVC, 3=JPEG
Write
t_octet
l_serv
sets 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 (no video signal detected at video input)
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
yes
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_SET_VIRTUAL_ALARM_ID
Tag code
NumDes
Message
SNMP Support
0x0b41
virtual alarm line 1 - 4
yes
no
Datatype
Access Level
Description
Read
p_unicode (max 32 unicode characters)
noprot
 
not supported
Write
p_unicode (max 32 unicode characters)
l_serv
set virtual alarm to active and record unicode string in meta data stream (alarm text search)
CONF_NBR_OF_VIRTUAL_ALARMS
Tag code
NumDes
Message
SNMP Support
0x0aed
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
number of virtual alarm inputs
Write
t_dword
l_priv
not supported
CONF_MANIPULATION_ALARM_STATE
Tag code
NumDes
Message
SNMP Support
0x0af0
manipulation alarm nbr
yes
no
Datatype
Access Level
Description
Read
flag
noprot
 
0=manipulation alarm off; 1=manipulation alarm on
Write
flag
l_priv
not supported
CONF_NBR_OF_MANIPULATION_ALARMS
Tag code
NumDes
Message
SNMP Support
0x0af1
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
number of manipulation alarms
Write
t_dword
l_priv
not supported
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
toggle the logical level of a relay output (0->1; 1->0) (notice: a flag payload value is not necessary, i.e. ignored)
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
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_SERIAL_ACTS_ACCESS_RIGHTS
Tag code
NumDes
Message
SNMP Support
0x0b1a
no
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
returns access rights of ACTS/OSRD commands which are sent via transparent data. 0: user rights (mainly PTZ) (default), 1: service rights (change settings)
Write
t_octet
l_serv
set access rights of ACTS/OSRD commands which are sent via transparent data. 0: user rights (mainly PTZ) (default), 1: service rights (change settings)
CONF_BICOM_COMMAND
Tag code
NumDes
Message
SNMP Support
0x09a5
no
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported
Write
p_octet
l_user
Sends a BICOM read or write command to the local camera frontend, see detailed description . Notice: for some BICOM commands an access level higher than 'l_user' is needed. For details about this see Appendix 'Bicom Command Access Levels' of this document.
Bicom message over RCP command
Payload Structure
Without Lease Time
8
24
40
48
Flags 1 Byte
Bicom Server ID 2 Byte
Object ID 2 Byte
Operation 1 Byte
Bicom Payload n Bytes
With Lease Time
8
24
56
Flags 1 Byte
Lease time 2 Bytes
Lease time id 4 Bytes
Bicom Server ID 2 Byte
Object ID 2 Byte
Operation 1 Byte
Bicom Payload n Bytes
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
Lease_Time_Available (Set to 1 if a lease time is included in the request)
Bit 3
unused set to 0
Bit 4
unused set to 0
Bit 5
unused set to 0
Bit 6
Flags_Available (Must be always set to 1)
Bit 7
Lease time
Time period in seconds the access should be blocked for other clients.
Lease time id
Random number generated by the client. If a lease time > 0 is provided with the first access, further accesses during the lease time are only possible if the same lease time id is provided.
Bicom Server ID
Server ID, e.g. 0x0002 for "Device Server" (See BICOM application documentation)
Object ID
Object ID, e.g. 0x0100 for "Type" (See BICOM application documentation)
Server ID, e.g. 0x0004 for "Camera Server" (See BICOM application documentation)
Object ID
Object ID, e.g. 0x0190 for "Colour" (See BICOM application documentation)
Operation
See BICOM application documentation
Values:
EVENT
0x70 - 0x7F
Bicom Payload
Bicom Payload
Example
RCP message
00 04
Server ID = 4 ("Camera server")
01 90
Object "Colour"
70
Operation EVENT
00 00
2 Byte unsigned short: Colour mode is "B/W"
CONF_BICOM_SRV_CONNECTED
Tag code
NumDes
Message
SNMP Support
0x0a19
no
yes
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 0
Request audio TX (listen at decoder side)
Bit 1
Request 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_V6_STRING
Tag code
NumDes
Message
SNMP Support
0x0b11
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
IPv6 Gateway IP string or domain name
Write
p_string
l_serv
IPv6 Gateway IP string or domain name
CONF_IP_V6_PREFIX_LEN
Tag code
NumDes
Message
SNMP Support
0x0b05
no
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
get unit's IPv6 address prefix length
Write
t_octet
l_serv
get unit's IPv6 address prefix length
CONF_IP_V6_STR
Tag code
NumDes
Message
SNMP Support
0x0b06
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
IPv6 String or domain name
Write
p_string
l_serv
IPv6 String or domain name
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/ipv6
Write
t_dword
l_serv
set dns server ip/ipv6
CONF_DNS_SERVER_IP_STRING
Tag code
NumDes
Message
SNMP Support
0x0b49
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
get dns server ip/ipv6
Write
p_string
l_serv
set dns server ip/ipv6
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
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.
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)
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_WLAN_SSID
Tag code
NumDes
Message
SNMP Support
0x0943
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
read the WLAN ssid
Write
p_string
l_serv
write the WLAN ssid
CONF_WLAN_WPA_PSK
Tag code
NumDes
Message
SNMP Support
0x0ac3
no
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
read the WPA pre shared key
Write
p_string
l_serv
write the WPA pre shared key
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_WLAN_SCAN
Tag code
NumDes
Message
SNMP Support
0x0ac6
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Performs a WLAN network scan, see detailed description
Write
l_serv
not supported
Payload Structure
16
32
Number of Entries 4 Bytes
Sequence of:
SSID 32 Bytes
MAC Address 6 Bytes
Strength 4 Bytes
Channel 4 Bytes
Flags 4 Bytes
16
32
SSID
Name of Network.
MAC Address
MAC Address of AccessPoint.
Strength
Signal Strength [0;5]
Channel
Channel used by AccessPoint [0; 14]
Flags
Values:
Bit0
WEP encryption supported
Bit1
WPA encryption supported
Bit2
WPA2 encryption supported
CONF_WLAN_LINK_TEST
Tag code
NumDes
Message
SNMP Support
0x0b23
no
no
no
Datatype
Access Level
Description
Read
t_int
l_serv
 
Test WLAN setup (try ability to associate to AP with current settings and return result 0=error, 1=success)
Write
l_serv
not supported
CONF_WLAN_OPERATING_MODE
Tag code
NumDes
Message
SNMP Support
0x0ac7
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Gets the operating mode of WLAN (0="off", 1="auto")
Write
t_octet
l_serv
Sets the operating mode of WLAN (0="off", 1="auto")
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_WLAN_REGION_CODE
Tag code
NumDes
Message
SNMP Support
0x0acf
no
no
no
Datatype
Access Level
Description
Read
t_word
noprot
 
Gets the region code for WLAN adapter (0x10="US", 0x20="CA", 0x30="EU", 0x31="SPN", 0x32="FR", 0x40="JPN", 0x41="JPN")
Write
t_word
l_serv
Sets the region code for WLAN adapter (0x10="US", 0x20="CA", 0x30="EU", 0x31="SPN", 0x32="FR", 0x40="JPN", 0x41="JPN")
CONF_WLAN_LINK_QUALITY
Tag code
NumDes
Message
SNMP Support
0x0b1c
no
no
no
Datatype
Access Level
Description
Read
t_int
noprot
 
read WLAN link signal level
Write
l_serv
not supported
CONF_SOCKET_KNOCKER_MODE
Tag code
NumDes
Message
SNMP Support
0x0b5c
-
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get mode of the socket knocker: 0=off, 1=on, 2=auto
Write
t_dword
l_serv
switch socket knocker on/off: 0=off, 1=on, 2=auto
CONF_SOCKET_KNOCKER_DESTINATION
Tag code
NumDes
Message
SNMP Support
0x0aee
destination number (starting with 1)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get socket knocker destination and connection configuration. See detailed description for payload structure
Write
p_octet
l_serv
specifiy socket knocker destination and connection configuration. See detailed description for payload structure
Payload Structure
16
32
port 2 Bytes
ssl 1 Byte
nbr of sockets 1 Byte
reserved 4 Bytes
url ...
port
destination port
ssl
provide ssl socket: 0=no ssl, 1=ssl
nbr of sockets
number of idle sockets to distribute. As soon as a socket is used, a new one is provided.
reserved
reserved for future use. Set to zero.
url
destination url. Zero-terminated ascii string. Currently max. 128 characters (incl. zero termination).
CONF_FTP_PWD
Tag code
NumDes
Message
SNMP Support
0x0b1b
SessionId (see CONF_START_CLIENT): optional parameter to identifiy a already existing ftp client session
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
gets the working directory of the configured ftp server
Write
p_string
l_serv
gets the working directory of the configured ftp server
CONF_ACCOUNT_LIST
Tag code
NumDes
Message
SNMP Support
0x0b1d
SessionId (see CONF_START_CLIENT): optional parameter to identifiy a already existing ftp client session
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
gets a list of currently available files and folders in the specified folder seperated by "\n". Argument: folder
Write
p_string
l_serv
gets a list of currently available files and folders in the specified folder seperated by "\n". Argument: folder
CONF_ACCOUNTS_CREATE_FOLDER
Tag code
NumDes
Message
SNMP Support
0x0b6c
SessionId (see CONF_START_CLIENT): optional parameter to identifiy a already existing client session
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
creates a new folder. Argument: folder name
Write
p_octet
l_serv
creates a new folder. Argument: folder name
CONF_ACCOUNTS_DELETE_FOLDER
Tag code
NumDes
Message
SNMP Support
0x0b6f
SessionId (see CONF_START_CLIENT): optional parameter to identifiy a already existing client session
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
deletes a folder. Argument: folder name
Write
p_octet
l_serv
deletes a folder. Argument: folder name
CONF_FTP_CWD
Tag code
NumDes
Message
SNMP Support
0x0b1e
SessionId: optional parameter to identifiy a already existing ftp client session
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
changes the working directory
Write
p_string
l_serv
changes the working directory
CONF_FTP_CDUP
Tag code
NumDes
Message
SNMP Support
0x0b1f
SessionId: optional parameter to identifiy a already existing ftp client session
no
no
Datatype
Access Level
Description
Read
p_string
noprot
 
changes to parent directory
Write
p_string
l_serv
changes to parent directory
CONF_START_CLIENT
Tag code
NumDes
Message
SNMP Support
0x0b20
no
no
no
Datatype
Access Level
Description
Read
t_word
noprot
 
starts a ftp client session, might be needed for commands like CONF_FTP_CDUP, CONF_FTP_CWD, CONF_FTP_LIST, CONF_FTP_PWD. This session stays alive for 5 min. It can be should be shut down using CONF_FTP_STOP_CLIENT.
Write
t_word
l_serv
starts a ftp client session, might be needed for commands like CONF_FTP_CDUP, CONF_FTP_CWD, CONF_FTP_LIST, CONF_FTP_PWD. This session stays alive for 5 min. It can be should be shut down using CONF_FTP_STOP_CLIENT.
CONF_STOP_CLIENT
Tag code
NumDes
Message
SNMP Support
0x0b21
SessionId
no
no
Datatype
Access Level
Description
Read
t_word
noprot
 
shut down the ftp session indified via the num parameter, might be needed for commands like CONF_FTP_CDUP, CONF_FTP_CWD, CONF_FTP_LIST, CONF_FTP_PWD
Write
t_word
l_serv
shut down the ftp session , might be needed for commands like CONF_FTP_CDUP, CONF_FTP_CWD, CONF_FTP_LIST, CONF_FTP_PWD
gets the user defined ftp file name for the first recording or live instance:
Write
p_octet
l_serv
sets the user defined ftp file name for the first recording or live instance:
CONF_ACCOUNT_LOGIN_TEST
Tag code
NumDes
Message
SNMP Support
0x0b36
-
no
no
Datatype
Access Level
Description
Read
t_int
noprot
 
checks if a login to the specified ftp server is possible (return value: 0: ok, 1: Connect failed, 2: invalid user or password, 3: set directory failed, 4: general error, 5: List failed (needed to select directory))
get post alarm time (in seconds) for DiffServ alarm values
Write
t_word
l_serv
set post alarm time (in seconds) for DiffServ alarm values. (Only if DiffServ alarm values are specified and therefore DiffServ values are changed during an alarm).
CONF_IPV4_FILTER
Tag code
NumDes
Message
SNMP Support
0x0b3c
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read the list of 2 allowed pairs of one IPv4 address and a corresponding IPv4 mask (addresses and masks in network byte order; filled completely with 0.0.0.0 entries, if disabled; in case only first entry is used, the second is filled with 0.0.0.0 / 0.0.0.0, order is address1, mask1, address2, mask2)
Write
p_octet
l_serv
write the list of 2 allowed pairs of one IPv4 address and a corresponding IPv4 mask (addresses and masks in network byte order; filled completely with 0.0.0.0 entries, if disabled; in case only first entry is used, the second is filled with 0.0.0.0 / 0.0.0.0, order is address1, mask1, address2, mask2)
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 updated
0
updated with unchanged cfg
1
dyndns username or password wrong
2
not fully qualified domain name (e.g. not in form host.dyndns.org)
3
wrong host name for this dyndns user account
4
too many hosts in last update
5
host name is blocked by dyndns for update abuse
6
no user agent submitted or http method not permitted
7
dyndns server error dns related
8
dyndns server error maintenance related
9
update not done due to misconfiguration
252
fatal error during update process
253
update in process
254
switched off
255
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)
read enable or disable state for sending status update emails on Dyndns status change (0: off (default), 1: on)
Write
t_octet
l_serv
enable or disable sending status update emails on Dyndns status change (0: off (default), 1: on)
CONF_DYNDNS_MAIL_SMTP_SRV_IP_STR
Tag code
NumDes
Message
SNMP Support
0x0b72
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read address of SMTP server to be used for for Dyndns status mail transmission
Write
p_string
l_serv
set address of SMTP server to be used for for Dyndns status mail transmission
CONF_DYNDNS_MAIL_SMTP_LOGIN
Tag code
NumDes
Message
SNMP Support
0x0b73
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read login for SMTP server to be used for for Dyndns status mail transmission
Write
p_string
l_serv
set login for SMTP server to be used for for Dyndns status mail transmission
CONF_DYNDNS_MAIL_SMTP_PASS
Tag code
NumDes
Message
SNMP Support
0x0b74
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read password for SMTP server to be used for for Dyndns status mail transmission
Write
p_string
l_serv
set password for SMTP server to be used for for Dyndns status mail transmission
CONF_DYNDNS_MAIL_DEST_EMAIL_ADDR
Tag code
NumDes
Message
SNMP Support
0x0b75
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read destination email address to be used for for Dyndns status mail transmission
Write
p_string
l_serv
set destination email address to be used for for Dyndns status mail transmission
CONF_DYNDNS_MAIL_SENDER_NAME
Tag code
NumDes
Message
SNMP Support
0x0b76
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read senders name to be used for for Dyndns status mail transmission
Write
p_string
l_serv
set senders name to be used for for Dyndns status mail transmission
CONF_DYNDNS_MAIL_TEST_SEND
Tag code
NumDes
Message
SNMP Support
0x0b77
no
no
no
Datatype
Access Level
Description
Read
%
l_serv
 
%
Write
t_octet
l_serv
send test mail with current Dyndns status to configured destination
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 (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_GET_RTSP_SESSION_ID
Tag code
NumDes
Message
SNMP Support
0x0ae8
random value from (Rtsp Session setup)
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
gets the rcp session id of the rtsp session (identified by the random value )
Write
t_dword
l_serv
not supported
CONF_TCP_FWD
Tag code
NumDes
Message
SNMP Support
0x0b2f
yes (Forwarder index 1...max, max=4: devices, max=32: generic)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
reads the Settings of the tcp forwarder per device (WORD http listener port, WORD http forwarder port, WORD https listener port, WORD https forwarder port, string: ip)
Write
p_octet
l_serv
writes the Settings of the tcp forwarder per device (WORD http listener port, WORD http forwarder port, WORD https listener port, WORD https forwarder port, string: ip)
CONF_PREPARE_FOR_RECORDING
Tag code
NumDes
Message
SNMP Support
0x0b51
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported, see detailed description
Write
p_octet
l_serv
see detailed description
Payload Structure
rmt dev idx 16 Bits
rec idx 16 Bits
flags 8 Bits
storage/lun cnt 8 Bits
strg/lun idx 1 8 Bits
N x 8 Bits
strg/lun idx N 8 Bits
rmt dev idx
index of a remote device entry configured by CONF_ADD_REMOTE_DEVICE from 1 to n. Value 0 means the local device.
rec idx
recording index
Values:
primary recording
1
secondary recording
2
flags
command specific flags
Values:
remote managed storage
0x01
storage/lun cnt
number of following index enties for storages/luns (max. 8)
strg/lun idx 1 - N
this is the index of an as managed configured storage or the lun index of local storage of the remote device. (1 - n, n = storage/lun cnt)
CONF_PREPARE_FOR_RECORDING
This command is used to prepare a remote device for recording via a another device (e.g remote recording on a transcoder). Normally the remote device will be configured to record on one or more (upto 8) local managed storage, which is already configured by the command CONF_STORAGE_LIST. The Storage can be a local storage on the remote device or any storage on the local device. This is choosen by the flag "remote managed storage". If this flag is set, the storage/lun idx refers the lun index of a local storage on the remote device. Otherwise it is the index from the storage list of the local device. The preparation will be the configuration of the micro vrm on the recording device and in case of remote recording constellation, it will allow the remote recording on the storage managing device.
specific errors
0x01
no local storage configured
0x02
remote dev config error
0x03
local dev config error
0x04
remote dev offline
0x05
common errors
0x06
remote dev vrm managed
0x07
iscsi auth config error
CONF_ADD_REMOTE_DEVICE
Tag code
NumDes
Message
SNMP Support
0x0b52
entry index(1...4)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read entry of remote devices, see detailed description
Write
p_octet
l_serv
add entry of remote devices, see detailed description
Payload Structure
mac ...
mac 6 bytes
reserved 2 bytes
line cnt 16 Bits
max coder per line 16 Bits
nbr of port entries 32 Bits
forwarder entry 1 4 Bytes
. . .
forwarder entry N 4 Bytes
url len 16 Bits
url ...
url (url len) bytes ...
pwd len 16 Bits
pwd ...
pwd (pwd len) bytes ...
device name len 16 Bits
device name ...
device name (device name len) bytes ...
mac
mac of the device (will be stored only as information in config)
line cnt
max lines of the device (will be stored only as information in config)
max coder per line
max number of coder instances per line (will be stored only as information in config)
nbr of port entries
number of forward port entries following this field (actual limited to 2)
forwarder entry 1 - N
forwarder port entry (see payload description)
url len
length of the following url (actual limit is 64)
url
url for the connection to the remote device, ascii string including zero termination
pwd len
length of the following password (actual limit is 64)
pwd
password for the connection, ascii string including zero termination
device name len
length of the following device name (actual limit is 64)
device name
device name of the remote device, ascii string including zero termination
forwarder entry
16
32
remote port 16 Bits
forwarder port 16 Bits
8
24
remote port
port of the remote device
forwarder port
local port which forwards all data to the remote port
ADD_REMOTE_DEVICE
Adds a device with forwarder ports, all data to/from the forwarder ports will be forwarded to/from the configured device port. It is allowed to store complete zeroed forwarder/remote port entries. For entries which are referenced by CONF_RCP_CONNECT_SALVO command num param, it it nessessary, that the first forward port entry contains the http port and the second one the https port. If one of these ports shall not be used, at least a zeroed entry (remote/forwarder port to zero) has to be placed. The max lines and coder per lines are just information, which will be stored together in the config. To delete an entry, send an empty or zeroed payload.
CONF_UPNP_SEARCH_IP_CONN_SERVICE
Tag code
NumDes
Message
SNMP Support
0x0b59
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
searches for devices that support the upnp WANIPConnection service. Returns a list of devices entries (64 bytes addr, 64 bytes name)
Write
p_octet
l_serv
not supported
CONF_UPNP_TCP_FWD
Tag code
NumDes
Message
SNMP Support
0x0b5a
index of the remote device (1...4)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported
Write
p_octet
l_serv
configures port forwarding in a upnp device that support the WANIPConnection:1 service. Input 64 bytes: address of the WANIPConnection:1 service in the router (returned by CONF_UPNP_SEARCH_IP_CONN_SERVICE).
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
t_dword
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
p_string
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_ENABLED
1
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_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_SYSCONTACT
Tag code
NumDes
Message
SNMP Support
0x00ba
no
no
yes
Datatype
Access Level
Description
Read
p_string
noprot
 
read the system contact required in SNMP
Write
p_string
l_serv
write the system contact required in SNMP
CONF_SYSLOCATION
Tag code
NumDes
Message
SNMP Support
0x00bb
no
no
yes
Datatype
Access Level
Description
Read
p_string
noprot
 
read the system location required in SNMP
Write
p_string
l_serv
write the system location required in SNMP
CONF_SNMP_READ_COMMUNITY
Tag code
NumDes
Message
SNMP Support
0x0b16
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read the community string for snmp read access
Write
p_string
l_serv
write the community string for snmp read access
CONF_SNMP_WRITE_COMMUNITY
Tag code
NumDes
Message
SNMP Support
0x0b17
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read the community string for snmp write access
Write
p_string
l_serv
write the community string for snmp write access
CONF_SNMP_TRAP_COMMUNITY
Tag code
NumDes
Message
SNMP Support
0x0b18
no
no
no
Datatype
Access Level
Description
Read
p_string
l_serv
 
read the community string used in snmp traps
Write
p_string
l_serv
write the community string used in snmp traps
CONF_STREAMING_GATEWAY_CONFIG
Tag code
NumDes
Message
SNMP Support
0x0b24
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read streaming gateway configuration, see detailed description
Write
p_octet
l_serv
write streaming gateway configuration, see detailed description
Payload Structure
gateway line 16 Bits
gateway stream 8 Bits
action 8 Bits
protocol 8 Bits
version 8 Bits
connection 8 Bits
reserved 8 Bits
manufacturer id 32 Bits
device type 32 Bytes ...
...
optional parameters 1 M Bytes
N x M Bytes
optional parameters N M Bytes ...
gateway line
local line of streaming gateway id
gateway stream
local stream of streaming gateway starting with 0 for the first stream
action
action for write direction, choose between add camera and remove camera, in case of remove camera, except this field, "gateway line", "gateway stream" and "version" all other fields in the payload are irrelevant
Values:
add camera
0
remove camera
1
protocol
choose protocol type
Values:
none
0
onvif
1
jpeg
2
bosch
3
rtsp
4
rtsp h263
5
rtsp h264
6
rtsp jpeg
7
version
version of the command, current version is 1
connection
connection type
Values:
udp unicast
0
udp multicast
1
tcp
2
manufacturer id
distinguish between bosch cameras and foreign cameras
Values:
unknown
0
bosch
1
device type
max 32 ascii characters including zero termination
optional parameters 1 - N
optional additional parameters, if nessessary depends on the camera
STREAMING_GATEWAY_CONFIG
This command is used to read and write the configuration of the streaming gateway. For the read direction only "gateway line" and "gateway stream" parameter are relevant for the send diretion. The reply payload will contain the full parameter set. For write direction use the full parameter set to configure a streaming gate camera, if the action is "add camera". Depending on the camera type and connection type, additional optional parameters are nessessary. E.g. the device simulator is able to connect to another bosch camera or device specified by the url ([ip]:[port]/[line (1,2,...)]/[coder idx (1,2,...)]). E.g. with url "10.1.10.20:80/1/1" it connects to the device on ip 10.1.10.20 and port 80 on the first line and the first video encoder.
Payload Structure for optional parameters
16
32
type 16 Bits
size 16 Bits
payload N Bytes ...
...
8
24
optional parameters
the optional parameters contain additional parameters. Depending on the camera type and connection, these parameters may be nessessary (e.g. url for connecting a remote device).
type
type of the optional parameters
Values:
none
0
url
1
stream
2
camera token
3
profile token
4
size
size in bytes of the following payload region excluding the "type" and "size" field. Has to be 4 byte aligned.
payload
payload for the additional parameter, structure depends on the "type"
url
zero terminated ascii string containing the url of the remote camera. Length of the string including zero termination is limited by the "length" of the optional parameter
stream
remote camera line
16 bit network order
remote camera stream
8 bit
reserved
8 bit
camera token
see detailed description for camera token
profile token
see detailed description for profile token
CONF_STREAMING_GATEWAY_ACTIVE_LINES
Tag code
NumDes
Message
SNMP Support
0x0b25
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get the number of configured streaming gateway lines
Write
t_dword
l_serv
not supported
CONF_STREAMING_GATEWAY_MAX_LINES
Tag code
NumDes
Message
SNMP Support
0x0b26
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get the max number of configurable streaming gateway lines
Write
t_dword
l_serv
not supported
CONF_ISCSI_IP
Tag code
NumDes
Message
SNMP Support
0x09aa
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
deprecated in fw > 4.00
Write
t_dword
l_serv
deprecated in fw > 4.00
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
 
deprecated in fw > 4.00
Write
t_dword
l_serv
deprecated in fw > 4.00
CONF_ISCSI_TARGET_IDX
Tag code
NumDes
Message
SNMP Support
0x09f9
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
deprecated in fw > 4.00
Write
t_dword
l_serv
deprecated in fw > 4.00
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
deprecated in fw > 4.00
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
 
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. deprecated! use CONF_ISCSI_AUTH
Write
p_string
l_serv
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. deprecated! use CONF_ISCSI_AUTH
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:
DELETE
0x00
ADD
0x01
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:
FAIL
0x00
SUCCESS
0x01
Error
Values:
ISCSI_MNI_ERR_INV_TARG
0x01
ISCSI_MNI_ERR_FULL
0x02
ISCSI_MNI_ERR_TARG_PRES
0x03
ISCSI_MNI_ERR_NOT_FOUND
0x04
ISCSI_MNI_ERR_INTERN
0x05
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:
OFFLINE
0x00
ONLINE
0x01
ERROR
0x02
Session Error
Values:
ISCSI_ERR_CONNECT
0x31
ISCSI_ERR_LOGIN
0x34
ISCSI_ERR_INV_TARG_IDX
0x35
ISCSI_ERR_PWD
0x36
ISCSI_ERR_PROTO
0x37
ISCSI_ERR_TARG_NOT_REACH
0x38
ISCSI_ERR_NO_MEM
0x3a
ISCSI_ERR_SESS_CREATE
0x3b
ISCSI_ERR_INV_PARAMS
0x3c
ISCSI_ERR_SESS_NOT_FOUND
0x3d
ISCSI_ERR_DISCONN
0x3e
ISCSI_ERR_TIMEOUT
0x3f
ISCSI_ERR_SOCK
0x5f
ISCSI_SOCK_CLOSED
0x7f
ISCSI_ERR_TCP_CONN_RST
0x8f
ISCSI_ERR_IP_ZERO
0xa0
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
Flags 1 Bytes
Target Port 2 Bytes
8
16
32
Target IP
The ip address of the iscsi target. If this field is set to -1 (0xFFFFFFFF), this descriptor is used for all remaining iscsi ips, for that no explicit descriptor is provided (default).
Target Index
The target index of the iscsi target. If this field is set to -1 (0xFF), this descriptor is used for all remaining iscsi targets with the same ip, for that no explicit descriptor is provided (default).
Flags
Values:
http tunnel
0x01
not for target
0x02
Target Port
The port of the iscsi target. If this value is set to zero, the port configured in CONF_ISCSI_PORT is used.
NOTE
For an iscsi session, all authentication descriptors are searched for the target address. If this address is found, the authentication information is used.
If that descriptor is not found, but the array contains a descriptor with the same ip and the target index set to default (0xFF), the information in this record is used instead.
If that descriptor is not found, but the array contains an descriptor with the ip address set to default (0xFFFFFFFF), the information in this record is used instead.
If that descriptor is not found, no authentication will be performed for that iscsi session.
Type
Values:
NONE
0
CHAP
1
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_ISCSI_SEG_SIZE
Tag code
NumDes
Message
SNMP Support
0x0aff
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
Maximum segment size for ISCSI transfers (should be a 2^n value like 8192, 16384 or 65536)
Write
t_dword
l_serv
Maximum segment size for ISCSI transfers (should be a 2^n value like 8192, 16384 or 65536)
CONF_ISCSI_DATARATE
Tag code
NumDes
Message
SNMP Support
0x0b00
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
KBit/s the ISCSI should transmit as maximum (0:=no limit send all data at once)
Write
t_dword
l_serv
KBit/s the ISCSI should transmit as maximum (0:=no limit send all data at once)
CONF_ISCSI_LOWERDATARATE
Tag code
NumDes
Message
SNMP Support
0x0b47
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
KBit/s the ISCSI lower Limit for the Iscsi Data rate Throttling
Write
t_dword
l_serv
KBit/s the ISCSI lower Limit for the Iscsi Data rate Throttling
CONF_ISCSI_READDATARATE
Tag code
NumDes
Message
SNMP Support
0x0b3a
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
KBit/s the ISCSI should read as maximum (0:=no limit send all data at once)
Write
t_dword
l_serv
KBit/s the ISCSI should read as maximum (0:=no limit send all data at once)
Track Fill Level (fill level in percent, always 100 % on filled ring recording)
Bit 16
Alarm Remote (there are virtual/remote alarms in this file, see CONF_HD_MGR_SIGNAL_ALARM)
Bit 16
Audio (there are audio data in this file)
Bit 16
Meta (there are meta data in this file)
Bit 17-20
Reserved
Bit 21
Offline (VRM only)
Bit 22
Protected (VRM only)
Bit 23-28
Time Zone (Quarter hours)
Bit 29
Time Zone Sign
Bit 30-31
Reserved
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. The File ID always increases on span recording regions if new files will be created.
CONF_HD_PARTITION_PROP
Tag code
NumDes
Message
SNMP Support
0x090b
yes (cam)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
obsolete
Write
p_octet
l_serv
(obsolete) see detailed description (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:
No
0x00
Mpeg2
0x01
Mpeg4
0x03
H264
0x04
Storage Type (obsolete)
Values:
Linear
0x00
Ring
0x01
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
 
obsolete, payload as in CONF_HD_PARTITION_PROP
Write
p_octet
l_serv
(obsolete)partition properties for secondary recording, 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
no
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
no
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 imidiately), 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 off
0
recording profile numbers
1-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 recording schedule for all cameras (primary and secondary 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 written to the storage medium. 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 device for recording.
CONF_HD_RECORD_SCHEDULE_SECONDARY
Tag code
NumDes
Message
SNMP Support
0x0a49
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
obsolete, only on global schedule for primary and secondary recording
Write
p_octet
l_serv
obsolete, only on global schedule for primary and secondary recording on all cams
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 imidately), 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:
invalid
0
day of the month
1 - 31
month
month of the year
Values:
invalid
0
jan
1
feb to nov
2 - 11
dec
12
year
year since 2000
Values:
year 2000 to 2255
0 - 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:
invalid
0
number of days
1 - 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 off
0
recording profile numbers
1 -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 imidiatly), 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
not used 1 Byte
reserved 5 Bit
Back Up Account 2 Bit
internal used 1 Bit
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
16:11 04.10.2011
8
24
flags
Flags:
ALARM_RECORDING_PRE_ALARM_RING
0x01
flag for alarm recording, if set alarm recording on the alarm tracks will be active and pre alarm will be recorded into a ring on the storage
AUDIO_RECORDING_DISABLE
0x02
flag for audio recording, if set audio will be disabled for recording
META_RECORDING_DISABLE
0x04
flag for meta recording, if set meta will be disabled for recording
ALARM_FILE_BACKUP
0x08
flag for alarm file backup, if set alarm file back up will be active
ALARM_RECORDING_PRE_ALARM_BUFFER
0x10
flag for alarm recording, if set alarm recording on the alarm tracks will be active and pre alarm will be recorded into the recording buffer and will be flushed on alarm
ALARM_RECORDING_PRE_ALARM_AUTO
0x11
both flags for alarm recording, first the prealarm recordes into the recording buffer, if the prealarm time is to high for the buffer size, it starts recording into a ring on storage
video preset nr
video preset number used for recording
Values:
no recording on this profile
0
video preset nr
1 - 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 set
0
video preset nr for post alarm
1 - 8
encoder index
index of the encoder stream starting with 0
back up account
Backup account Number from 0 (first account) to 3(fourth account), for choosing the back up account in case activated ALARM_FILE_BACKUP flag
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 imidiatly) , payload is the same as in CONF_HD_RECORD_PROFILES
CONF_HD_RECORD_PROFILES_V2
Tag code
NumDes
Message
SNMP Support
0x0ad0
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read recording profiles
Write
p_octet
l_serv
write recording profiles
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_V2
Read/Write the ten recording profiles for a camera, payload 560 bytes total. The profiles will be written to the device configuration. 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
stream config nr 1 Byte
post alarm stream config nr 1 Byte
encoder index 1 Byte
post alarm profile 1 Byte
reserved 5 Bit
Back Up Account 2 Bit
internal used 1 Bit
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_RECORDING_PRE_ALARM_RING
0x01
flag for alarm recording, if set alarm recording on the alarm tracks will be active and pre alarm will be recorded into a ring on the storage
AUDIO_RECORDING_DISABLE
0x02
flag for audio recording, if set audio will be disabled for recording
META_RECORDING_DISABLE
0x04
flag for meta recording, if set meta will be disabled for recording
ALARM_FILE_BACKUP
0x08
flag for alarm file backup, if set alarm file back up will be active
ALARM_RECORDING_PRE_ALARM_BUFFER
0x10
flag for alarm recording, if set alarm recording on the alarm tracks will be active and pre alarm will be recorded into the recording buffer and will be flushed on alarm
ALARM_RECORDING_PRE_ALARM_AUTO
0x11
both flags for alarm recording, first the prealarm recordes into the recording buffer, if the prealarm time is to high for the buffer size, it starts recording into a ring on storage
stream config nr
stream configuration number used for recording
Values:
no recording on this profile
0
stream configuration nr for pre alarm
1 - 2
I-frames only from stream 1 for pre alarm
3
post alarm stream config nr
stream configuration used for recording after occurence of an alarm
Values:
not set, uses stream config nr if set
0
stream configuraton nr for post alarm
1 - 2
I-frames only from stream 1 for post alarm
3
encoder index
index of the encoder stream starting with 0
post alarm profile
encoder profile for postalarm, only some values of the profile will be used to modify the uses encoder profile for the post alarm stream
Values:
not set, no modification of the actual enc profile
0
encoder profile nr for post alarm configuration
1 - 8
back up account
Backup account Number from 0 (first account) to 3(fourth account), for choosing the back up account in case activated ALARM_FILE_BACKUP flag
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_V2_SECONDARY
Tag code
NumDes
Message
SNMP Support
0x0ad1
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get recording profiles for secondary recording, payload is the same as in CONF_HD_RECORD_PROFILES_V2
Write
p_octet
l_serv
set recording profiles for secondary recording, payload is the same as in CONF_HD_RECORD_PROFILES_V2
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 (cam)
yes
no
Datatype
Access Level
Description
Read
flag
noprot
 
return TRUE when manager is on or when primary span recording is on
Write
flag
l_serv
start/stop the recording manager and set config to recording on:1/off:0. Can cause recording if time/alarm recording selected.
CONF_HD_MGR_START_SECONDARY
Tag code
NumDes
Message
SNMP Support
0x0a46
yes (cam)
yes
no
Datatype
Access Level
Description
Read
flag
noprot
 
return TRUE when secondary span recording is on
Write
flag
l_serv
start/stop the recording manager and set config to recording on:1/off:0. Can cause recording if time/alarm recording selected.
CONF_HD_MGR_STOP
Tag code
NumDes
Message
SNMP Support
0x0914
cam
no
no
Datatype
Access Level
Description
Read
flag
noprot
 
return TRUE when manager is off or when primary span recording is off
Write
flag
l_serv
stop/start the recording manager and set config to primary recording off:1/on:0.
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
stop/start the recording manager and set config to secondary recording off:1/on:0.
CONF_HD_MPEG4_ACTIVE
Tag code
NumDes
Message
SNMP Support
0x093c
no
no
no
Datatype
Access Level
Description
Read
flag
noprot
 
(obsolete) 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 50 Bytes ...
...
8
24
Camera
The camera index.
Recording Index
Values:
Primary
1
Secondary
2
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
packets recorded high 4 Bytes
packets recorded low 4 Bytes
packets lost high 4 Bytes
packets lost low 4 Bytes
8
24
Camera
The camera index.
Recording Index
Values:
Primary
1
Secondary
2
Status
Values:
OFFLINE
1
configured for not recording
IDLE
2
(obsolete)
PEND
3
trying to connect storage or waiting for block list from vrm
RUNNING
4
storage connected and recording running or prepared for recording
ERROR
5
error on storage ocurred
REC_SRC_ERROR
6
error of recorder source(encoder)
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
packets recorded high
high part (32 bits network order) of a 64 bit counter for all recorded packets of this recording since device start up (packets counted by "packet alloc no wait" and "packet alloc wait" not included)
packets recorded low
low part (32 bits network order) of a 64 bit counter for all recorded packets of this recording since device start up (packets counted by "packet alloc no wait" and "packet alloc wait" not included)
packets lost high
high part (32 bits network order) of a 64 bit counter for all packets, which couldn't be recorded by this recording since device start up (packets counted by "packet alloc failed" not included)
packets lost low
low part (32 bits network order) of a 64 bit counter for all packets, which couldn't be recorded by this recording since device start up (packets counted by "packet alloc failed" not included)
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_MAX_RECORDING_RETENTION_TIME
Tag code
NumDes
Message
SNMP Support
0x0b5b
yes (camera)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the max recording retention time for a camera (in seconds), see detailed description
Write
p_octet
l_serv
set the max recording retention time for a camera (in seconds), see detailed description
Payload Structure
16
32
max retention time 4 Bytes
rec idx 2 Byte
reserved 2 Byte
8
24
max retention time
max retention in seconds, 0 or values bigger than about 32 years (value >= 1009152000) means maximum, in case of in payload for read direction, this field can be ignored and treaded as reserved field
rec idx
recording index
Values:
primary recording
1
secondary recording (active low)
2
CONF_RECORDING_MAX_RETENTION_TIME
This command sets the max retention time for recording identified by the rec idx and the camera in the num parameter starting from 1. For read direction a inpayload is required with same format as described above, except the max retention time field can be ignored. The max retention time will be stored as absolute local time in seconds since 2000 in each span unit header. It will be used to clear a recording span when this time expires. If a max retention time is configured unequal 0 and less than maximum, the recording time on a span is limited to a one day time span. If this limit is reached by the recording, a span switch will be triggered.
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 or iqn of the remote recording device (max. 50 characters).
Write
p_string
l_serv
Set the ip(ipv4 only) address or the iqn (starting with "iqn." or * for wildcard) of a remote recording device (max. 50 characters) on one entry ore use any free entry by num = 0, the ip/iqn will be not added in that case if it is already in the list. To clear a entry send a empty string(zero termination only) on a valid index(1 - 8)
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 (obsolete), 4 = DUAL VRM)
Write
t_octet
l_serv
Set the type of the recording management (0 = LOCAL, 1 = VRM, 2 = VRM+ANR, 3 = ONLY LOCAL (obsolete), 4 = DUAL VRM) (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:
OFF
0
NO RECORDING
1
STAND BY
2
PRE ALARM RECORDING
3
ALARM RECORDING
4
POST ALARM RECORDING
5
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 mode
0x01
input alarm
0x02
motion alarm
0x04
video loss
0x08
virtual alarm
0x10
reserved for extension
0x80
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:
primary
1
secondary
2
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
yes cam
yes
no
Datatype
Access Level
Description
Read
flag
noprot
 
1: yes 0: no (message only, a request on this command always returns zero)
Start recording on choosen cams, payload needs a variable count pairs of 32 bit fiels for cam state (posibble states: 1 : on, 0 : off) and 32 bit fiels for cam selection mask, this mask will layed over the state bit field and can be used to choose the cams specific cams, other cams will be ignored, each bit field pair represents 32 cams: first pair - cam 1 to cam 32, second pair -cam 33 to cam 64 and so on
Write
p_octet
l_serv
Start recording on choosen cams, payload needs a variable count pairs of 32 bit fields for cam state (posibble states: 1 : on, 0 : off) and 32 bit fiels for cam selection mask, this mask will layed over the state bit field and can be used to choose the cams specific cams, other cams will be ignored, each bit field pair represents 32 cams: first pair - cam 1 to cam 32, second pair -cam 33 to cam 64 and so on
CONF_SET_REC_BUFFER_SIZE
Tag code
NumDes
Message
SNMP Support
0x0ae1
yes (line)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get size of recording buffer in bytes (Bosch streaming gateway only) first 4 bytes : DWORD rec_idx second 4 bytes : DWORD size in bytes(return direction)
Write
p_octet
l_serv
set size of recording buffer in bytes (restart of recording nessessary) (Bosch streaming gateway only, default 5 MB) first 4 bytes : DWORD rec_idx second 4 bytes : DWORD size in bytes
CONF_AUDIO_REC_FORMAT
Tag code
NumDes
Message
SNMP Support
0x0ae9
no
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
get audio format for recording (0: NO, 1: G711, 2: L16, 3: AAC)
Write
t_octet
l_serv
set audio format for recording (0: NO, 1: G711, 2: L16, 3: AAC) (running recording has to be stopped and restarted in order to become effective)
This command can be used to set or read the IP address, port and user and to set the password of the managing VRM and the backup VRM. The command cannot be used for reading the VRM password, it will return the string "********" instead.
Payload Structure
16
32
ip 4 Bytes
port 16 Bits
flags 8 Bits
reserved 1 Byte
user 32 Bytes ...
password 32 Bytes ...
backup ip 4 Bytes
backup port 16 Bits
reserved 16 Bits
8
24
ip
IP address of the managing VRM
port
Port of the managing VRM
flags
Additional flags
Values:
USE_SSL
0x01
user
VRM user: Max 31 ASCII character string with zero termination. If the user is shorter than 31 characters, the remaining bytes need to be filled up with 0x00 values.
password
VRM password: Max 31 ASCII character string with zero termination. If the password is shorter than 31 characters, the remaining bytes need to be filled up with 0x00 values.
backup ip
IP address of the backup VRM
backup port
Port of the backup VRM
CONF_REC_STORAGE_REQ_CFG
Tag code
NumDes
Message
SNMP Support
0x0b30
yes (recording index: 1 - primary, 2 - secondary)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read error tollerance parameter for storage requests from recording (4 bytes, 2 words) (1st word retry in network order 0xffff for retry always, 2nd word timeout seconds in network order 0 for default timeout 0xffff for never timeout
Write
p_octet
l_serv
set error tollerance parameter for storage requests from recording (4 bytes, 2 words) (1st word retry in network order 0xffff for retry always, 2nd word timeout seconds in network order 0 for default timeout 0xffff for never timeout
CONF_RECORDING_BUFFER_LEVEL
Tag code
NumDes
Message
SNMP Support
0x0b70
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
returns the levels in percent of the recording rate control based on the recording buffer fill-level: 4 bytes: level off (if the fill level is below that value the rate control will be turned off), 4 bytes: level on (if the fill level is above that value the rate control will be turned on), (set both values to 0 to disable the rate control). This features is enabled per default on TI devices with 10% (off) and 30% (on)
Write
p_octet
l_serv
returns the levels in percent of the recording rate control based on the recording buffer fill-level: 4 bytes: level off (if the fill level is below that value the rate control will be turned off), 4 bytes: level on (if the fill level is above that value the rate control will be turned on), (set both values to 0 to disable the rate control). This features is enabled per default on TI devices with 10% (off) and 30% (on)
CONF_HD_REPLAY_START
Tag code
NumDes
Message
SNMP Support
0x0902
no
yes
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)
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
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 frame/last I-Frame(s); parameter t_int -1 back to last iframe, 1 to next 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
This command returns a 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. The events start from the given end time
(first 4 bytes of payload) in secconds since 2000. If the payload consists of 8 bytes and the bytes 5-8 are filled with
the value 0xeeeeeeee the extended event structure is used in the response payload.
Payload Structure
16
32
n Events n*m Bytes
8
24
Event Structure
Simple Event Structure
16
32
Event Time 4 Bytes
Flags 4 Bytes
8
24
Extended Event Structure
16
32
Upper X 1 Byte
Upper Y 1 Byte
Lower X 1 Byte
Lower Y 1 Byte
Event Time in secs 4 Bytes
residual milliseconds 2 Bytes
reserved 2 Bytes
Flags 4 Bytes
8
24
Event Time
Seconds since 2000.
Flags
Values:
Bit 0
Motion Alarm
Bit 1
Input Alarm
Bit 2
Video Loss
Bit 3
Virtual alarm (see CONF_VIRTUAL_ALARM_STATE)
Upper X,Y and Lower X,Y
Specifies a bounding box (upper left corner and lower right corner). If an object can be associated with
the alarm then the bounding box will be around this object otherwise the whole image is the bounding box.
The values are normalized to the image size and are between 0 and 255.
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:
Seconds
0
Minutes
1
Houres
2
Maximum Sample Bytes
Values:
Seconds
0
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_FAST_INTRA_FPS
Tag code
NumDes
Message
SNMP Support
0x0ac2
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get max frames per second for intra only replay mode
Write
t_dword
l_user
set max frames per second for intra only replay mode (0 = default)
CONF_HD_REPLAY_LIVE
Tag code
NumDes
Message
SNMP Support
0x0963
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
get replay connection live mode
Write
t_dword
l_user
set a replay connection to live mode (only supported with transcoder) 1:=on, 0:= off replay commands like start or seek terminate the live mode
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
p_octet
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 ...
Min. Number Of Rtp Packets (will tend to be more) 4 Bytes ...
8
24
Max Size
In Bytes.
Replay session id required. Start time and stop time has to be within one file.
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_HD_REPLAY_FORENSIC_SEARCH_SETUP
Tag code
NumDes
Message
SNMP Support
0x0b0a
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
setup a forensic search
Write
p_octet
l_user
setup a forensic search, see detailed description
This command is related to a replay session. The replay session will start a forensic search with the provided ruelengine script. The return payload consists of a 4 byte
ForensicSearch ID which can be refound in the corresponding message (HD_REPLAY_FORENSIC_SEARCH_RESULT).
In the case of an error the RCP_ERROR_COMMAND_SPECIFIC error is returned with an error code (see HD_REPLAY_FORENSIC_SEARCH_RESULT) followed by an additional text.
Error Response Structure
RCP_ERROR_COMMAND_SPECIFIC 1 Byte
Error type 1 Byte
Error text n Byte
Error type
Name
Value
e_ForensicSearchErrorNone
0x00
e_ForensicSearchErrorScriptTooLong
0x01
e_ForensicSearchErrorInternal
0x02
e_ForensicSearchErrorNoRuleSelected
0x03
e_ForensicSearchErrorREConfiguration
0x04
e_ForensicSearchErrorSyntax
0x05
e_ForensicSearchErrorMemory
0x06
Error text
The error text is a detailed description of the error. E.g. for syntax errors the line of the script and error type are mentioned.
Payload Structure
16
32
Begin [s] 4 Byte
End [s] 4 Byte
reserved 4 Byte
Script length 2 Byte
Script mode 1 Byte
ProfileId 1 Byte
Layer Mode 1 Byte
Flags 1 Byte
Layer mask 2 Byte
Ruleengine script script length
...
8
24
Begin[s]
Defines begin of forensic search in seconds since 2000 (local time).
End[s]
Defines end of forensic search in seconds since 2000 (local time).
Max events
Maximal number of events per message (see HD_REPLAY_FORENSIC_SEARCH_RESULT).
The value is between 0 and 64. If 0 (default) is given than the maximal number of events is set to 64.
If the value is greater than 64 it will be limitted to 64.
Script length
Length of the script.
Script mode
The mode defines the script description
Mode 0x0
Comprising the whole rule engine configuration, see rcp command: VCD_OPERATOR_PARAMS
Mode 0x1
Rule engine script only
ProfileId
Profile id search is supported. Profile id equal null means a full search, if a profile id is given. Then only the recordings with this profile is searched.
Layer Mode
If 1 then the user defined layer mask, see below, is used. If 0 then the layer mask is ignored and the default layers are used.
Flags
0x01
Flag Send:
Send layer data
0x02
Flag Verbose:
Additional printouts
0x04
Flag Cache Data:
Collects compressed VCD data, next search will use collected VCD packets
0x08
Flag Clear Cache:
Collected VCD packets will be deleted, next search will start new replay
Layer Mask
The layer mask is only used if layer mode is set to 1.
Ruleengine script
If the script mode is selected to mode 0x01 (rule engine script only) one of these examples can be used as a valid script.
Example 1 ("Any motion/flow/object in Field"):
Field #1 := { Point(50, 50) Point(100, 50) Point(100, 100) Point(50, 100) };
FlowDetector #1 := { Field #1 };
MotionDetector #1 := { Field #1 };
external SimpleState #1 := DetectedFlow #1;
external SimpleState #2 := DetectedMotion #1;
external ObjectState #1 := InsideField #1;
For more details, read the Bosch Query Language Specification.
CONF_HD_REPLAY_FORENSIC_SEARCH_CANCEL
Tag code
NumDes
Message
SNMP Support
0x0b50
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
-
Write
t_dword
l_user
cancel a forensic search, t_dword is the search id (result of search setup), session id is required
CONF_HD_REPLAY_FORENSIC_SEARCH_RESULT
Tag code
NumDes
Message
SNMP Support
0x0b0b
no
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
results of a forensic search (msg only)
Write
p_octet
l_user
results of a forensic search (msg only), see detailed description
This command is a messages command. It successively delivers the results of a forensic search request.
Payload Structure
16
32
Forensic Search ID 4 Byte
Sequence Number 2 Byte
Nbr of Evts (n) 1 Byte
Last Message 1 Byte
Progress Time 4 Byte
Timezone 1 Byte
Event type 1 Byte
Reserved 2 Byte
n Forensic Search Events n * m byte
8
24
Forensic Search ID
With the forensic search ID this event message can be assigned to the corresponding search request.
Sequence Number
The sequence number is increasing and missing packets can be detected.
Last Message
The last message byte is signalling that the search has been accomplished with this message.
Progress Time
This time informs about the progress of the search. The time is given in seconds since 1-1-2000 (local time). This time is updated every second (search time) and forces to throw this message. Hence, it can be expected that at least every second a message will be thrown.
Timezone
Timezone in quarter hours.
Event type
Different events can be sent by this message. Error messages include only one event per message.
Object Event
0x00
Error Event
0x01
Object Event
16
32
Begin of event in seconds since 2000 4 Byte
Residual ms of begin time 2 Byte
Rule ID 1 Byte
Reserved 1 Byte
Event duration in ms 4 Byte
Object ID 4 Byte
Bounding Box 4 Byte
8
24
Begin
The beginning of the event is provided in local time in seconds since 2000 and milliseconds.
Duration
Duration of the event in ms.
Rule ID
The Rule ID informs which rule is related to this event.
Object ID
Object ID which has caused the alarm.
Bounding Box
Bounding box of object in normalized coordinates from 0 to 255. First, the upper left point is encoded then the lower right point of the bounding box.
The coordinate (0,0) is the upper left corner of the image and the point (255,255) is the lower right corner of teh image. The bounding box is from the begin time.
Error Event
Error type 1 Byte
Error text 64 Byte
Error types
Name
Value
e_ForensicSearchErrorNone
0x00
e_ForensicSearchErrorInternal
0x02
e_ForensicSearchErrorNoMetaData
0x07
e_ForensicSearchErrorDataDoesNotMatch
0x08
Error text
The error text is a detailed description of the error. E.g. for syntax errors the line of the script and error type are mentioned.
CONF_HD_REPLAY_PREFETCH_JPEGS
Tag code
NumDes
Message
SNMP Support
0x0b55
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
write only
Write
p_octet
l_user
sessionID required, 16bytes header (1byte jpeg quality 0-100, 1byte reserved, 2bytes jpeg height in pixel, 12bytes reserved), N times seconds_since_2000 (each 4bytes)
CONF_HD_REPLAY_CUSTOM_SETTINGS
Tag code
NumDes
Message
SNMP Support
0x0b56
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read replay custom settings, see detailed,
Write
p_octet
l_user
set replay custom settings, see detailed,
Payload Structure
16
32
flags 32 Bits
flags mask 32 Bits
kbps max 32 Bits
time shift 32 Bits
8
24
flags
flag field for configuring custom behavior of an replay session
Values:
patch rtp hdr
0x00000001
dont send dummy pkt
0x00000002
h264 only
0x00000004
auto start
0x00000008
no rcp message
0x00000010
set kbps max
0x00000020
L16 to G711
0x00000040
use UTC
0x00000080
add rtp hdr extension
0x00000100
patch pic id
0x00000200
set time shift
0x00000400
transcode
0x00000800
ignore start and end of files
0x00001000
aac 16 khz rtp clock
0x00002000
flags mask
mask for the flag field, it is used to set only choosen values without changing the other values. To set a choosen value in the flag field, the corresponding flag in the flags mask has to be set also. All other setting will be left unchanged
kbps max
set the max send data rate in kbit per seconds, "set kbps max" flag has to be set in order to change that value.
time shift
set time shift in seconds, "set time shift" flag has to be set in order to change that value.
CONF_HD_REPLAY_CUSTOM_SETTINGS
This command is used to configure the behaviour of an existing replay session. A valid replay session id has to be provided.
CONF_BACKUP
Tag code
NumDes
Message
SNMP Support
0x0af4
cam
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported
Write
p_octet
l_user
see detailed description
Payload Structure
16
32
From2000 4 Bytes
To2000 4 Bytes
account 4 Bytes
recordingIndex 4 Bytes
remoteCamera 1 Byte
transcode 1 Byte
transcoderPreset 1 Byte
reserved 1 Byte
replaySpeed 4 Bytes
objectID 4 Bytes
reserved 4 Bytes
backup filename 16 Bytes
8
24
From2000
Start time of the backup in seconds since 2000
To2000
Stop time of the backup in seconds since 2000
account
index of the account that should be used for backup (see CONF_ACCOUNT_SETTINGS).
recordingIndex
index of the recording to be backuped (0 or 1)
remoteCamera
0 - local Camera, 1 to 4 refering to entries of CONF_ADD_REMOTE_DEVICE
transcode
optional field that defines if the video should be transcoded before backup (used by Transcoder Devices) only
transcoderPreset
optional field that defines the preset used by transcoding (used by Transcoder Devices) only
reserved
reserved
replaySpeed
optional field that defines the replay speed (used by Transcoder Devices only). Use the same values as for CONF_HD_REPLAY_START
objectID
tbd
reserved
reserved for future use
filename
backup filename: filename in arbitrary order of:
%b begin date/time, %e end date/time, %c camera name, %i export job id, %f file nbr, %a alarm description, %dSubDirectory sub directory to write; optionally seperated by "_" or "-".
Exampe: %b_%c would result e.g in a filename 20111017_14-29-26_camera1.mp4
CONF_BACKUP
starts an mp4 backup file of the specified replay range and store it on a account.
The CONF_BACKUP_STATUS message is sent periodiacllay to inform about the backup progress.
The command returns an 1 byte backup id that can be used to identify the backup in the message.
CONF_BACKUP_MAX_KBPS
Tag code
NumDes
Message
SNMP Support
0x0af5
account number (1...4) or 0 for http backup
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
gets the maximum datarate for the backup
Write
t_dword
l_user
sets the maximum datarate for the backup (in kbps)
CONF_BACKUP_STATUS
Tag code
NumDes
Message
SNMP Support
0x0af8
Backup Session ID (if set to 0 a list of all backup sessions is returned)
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
list the status of a backup sessions:
Write
p_octet
l_user
not supported
This command returns a list of the current backups. The list contains the following sequence:
Payload Structure
16
32
Backup ID 4 Bytes
RCP Session ID 4 Bytes
Start Time 4 Bytes
End Time 4 Bytes
Transfered Bytes 8 Bytes ...
File Count 16 Bits
File Nbr 16 Bits
File part 16 Bits
reserved 16 Bits
Current time 4 Bytes
Ppm Current File 4 Bytes
Backup Errrors 4 Bytes
RTP packet loss 4 Bytes
MP4 box errors 4 Bytes
Account errors 4 Bytes
Cam 16 Bits
RecIdx 16 Bits
account 1 Bytes
backup ID 1 Bytes
reserved 2 Bytes
link 128 Bytes
8
24
Backup ID
Backup Session ID
RCP Session ID
corresponding RCP Session ID
Start Time
Start Time of the Backup in Seconds since 2000
End Time
End Time of the Backup in Seconds since 2000
Current Time
the current Time of the backup
Transfered Bytes
transfered bytes
File Count
number of files to backup
File Nbr
Current file to backup
File part
if a larger Backup file is split into multiple parts this value tells the current part
reserved
reserved
Ppm Current File
status in ppm of the current backup
Backup errors
backup errors: The following errors are defined:
Error during backup
0x02
Backup canceled
0x04
Start of backup failed
0x05
RTP packet loss
number of lost packets
MP4 box errors
errors in the mp4 converter.
Account error
The last Account error. The following errors are defined:
NO_ERROR
0x00
NO_IP
0x01
CONNECT_FAILED
0x02
SETDIR_FAILED
0x03
WRITE_FAILED
0x04
Cam
camera
RecIdx
Recording Index
account
the index of the account used for backup (see CONF_ACCOUNT_SETTINGS and CONF_BACKUP)
backup ID
the backup id that is returned by the CONF_BACKUP command. This id can be used to link the backup started by CONF_BACKUP with this status message
link
a direct link to the backup mp file. The message contains the link if it is available
CONF_BACKUP_STOP
Tag code
NumDes
Message
SNMP Support
0x0b58
yes, Backup Session ID
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
not supported
Write
t_dword
l_user
cancels an ongoing backup job
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
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_FS
0x00
HD_STEP_COPY_TOOLKIT
0x01
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_FAILED
0xff
HD_FORMAT_STATUS_RUNNING
0x00
HD_FORMAT_STATUS_SKIPPED
0x01
HD_FORMAT_STATUS_FINISHED
0x02
progress
value from 0 to 100 represent the progress of the format including copy replay tools in percent.
Values:
progress in percent
0 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
Flags(optional) 1 Byte
reserved 3 Byte
8
24
Server IP
The iSCSI server ip address
Values:
Local connected USB disk
ff.ff.ff.ff
iSCSI Server
valid 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)
Flags
these flags are optional, if no flags are set (default), no span format will be executed
REPAIR_FS (repair file system without clearing spans)
0x01
CLEAR_SPANS_ONLY (only clear the spans)
0x02
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. Size of the write payload is at least 12 bytes, if the optional flags are uses the payload has to be at least 16 bytes.
Specific Error Types
SPAN_ERR_INTERNAL
0x01
SPAN_ERR_NOT_MNTD
0x05
SPAN_ERR_INV_FS
0x06
SPAN_ERR_INV_LUN_NFO
0x07
SPAN_ERR_RD_ONLY
0x0a
SPAN_ERROR_OLD_LUN_NFO
0x20
ISCSI_ERROR_CONNECT
0x31
ISCSI_ERROR_INV_LUN
0x33
ISCSI_ERROR_LOGIN
0x34
ISCSI_ERROR_INV_TRG_IDX
0x35
Note: A list of all defined error types can be found in the Appendix.
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_FS
0x00
HD_STEP_CLEAR_SPAN_HEADER
0x02
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_FAILED
0xff
HD_FORMAT_STATUS_RUNNING
0x00
HD_FORMAT_STATUS_FINISHED
0x02
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 percent
0 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.
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 disk
ff.ff.ff.ff
iSCSI Server
Valid 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 max n (n=512) 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. The order of the supplied list is the preferred order, not the guaranted order. There are some cases, in which the device changes the use order (e.g. one target not reachable).
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 up to n (n=512) entrys. The response in case of an empty span list is one zeroed span entry.
Message
A message of this cmd tag will be send always, if somone sets the span address lists by using rcp set spans list commands or if the span list is cleared by indirectly by changing other settings of the device (e.g. rec mgmt).
Specific Error Types
SPAN_ERR_INTERNAL
0x01
SPAN_ERR_INV_ADDR_LIST
0x04
Note: A list of all defined error types can be found in the Appendix.
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 disk
ff.ff.ff.ff
iSCSI Server
Valid 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 HEADER
0x01
16
32
Lock owner IP 4 Bytes
Lock owner MAC 6 Bytes ...
Cluster ID 1 Byte
Reserved 1 Byte
Lock owner URL 128 Bytes ...
...
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
Cluster Id
Cluster id of the recorder 1 - n, default value is 0 if not set, should be treated as cluster id 1
Lock owner URL
url (ipv4 or ipv6) 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 IPv4 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 HEADER
0x02
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 HEADER
0x03
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
Cluster ID 1 Byte
reserved 2 Bytes
Max Retention Time 4 Bytes
Lock owner URL 128 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
Cluster Id
Cluster id of the recorder 1 - n, default value is 0 if not set, should be treated as cluster id 1
Max Retention Time
Max Retention Time for the recordings on this span in sec since 2000, 0 means no max retention time
Lock owner URL
url (ipv4 or ipv6) of the unit that used the span
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 IPv4 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_INTERNAL
0x01
SPAN_ERR_INV_SPN_IDX
0x02
SPAN_ERR_INV_HDR_TYPE
0x03
SPAN_ERR_NOT_MNTD
0x05
SPAN_ERR_INV_FS
0x06
SPAN_ERR_INV_LUN_NFO
0x07
SPAN_ERR_BAD_HDR_CKSM
0x08
SPAN_ERR_RD_ONLY
0x0a
ISCSI_ERROR_CONNECT
0x31
ISCSI_ERROR_INV_LUN
0x33
ISCSI_ERROR_LOGIN
0x34
ISCSI_ERROR_INV_TRG_IDX
0x35
Note: A list of all defined error types can be found in the Appendix.
CONF_RECORD_MODE_SPANS
Tag code
NumDes
Message
SNMP Support
0x09f6
no
no
no
Datatype
Access Level
Description
Read
t_octet
noprot
 
obsolete, returns always 0x01 for on
Write
t_octet
l_serv
obsolete, device is always in mode on and cannot be changed
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), audio type (1 byte: 0= NO, 1=G711, 2=L16, 3=AAC) reserved (2 byte)
Write
p_octet
l_serv
(obsolete and not supported anymore)
CONF_SPAN_PARTITION_PROP_ALARM
Tag code
NumDes
Message
SNMP Support
0x09fb
yes (camera)
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
obsolete and not supported anymore
Write
p_octet
l_serv
obsolete and not supported anymore
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
(obsolete and not supported anymore)
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
 
obsolete and not supporded anymore
Write
p_octet
l_serv
obsolete and not supported anymore
CONF_SPAN_USE_STATUS
Tag code
NumDes
Message
SNMP Support
0x09f8
cam
yes
no
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
err/spec code 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/special code
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", for status MOUNTED see section "status MOUNTED special codes"
status
use status of this span
Values:
MOUNTED
0x00
RELEASE
0x01
RELEASE_UNUSED
0x02
ERROR
0x03
RECORDING
0x04
PENDING_SPAN_REQUEST
0x05
HD_SPAN_USE_STATUS_RETENTION_TIME
0x06
HD_SPAN_USE_STATUS_RELEASE_REMOUNT_INTENDED
0x07
HD_SPAN_USE_STATUS_ERROR_WRT_UNT_HDR
0x10
HD_SPAN_USE_STATUS_ERROR_FORMAT_REC_REGION
0x11
HD_SPAN_USE_STATUS_ERROR_MOUNT
0x12
HD_SPAN_USE_STATUS_ERROR_RETENTION_TIME
0x13
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.
Status HD_SPAN_USE_STATUS_RELEASE_REMOUNT_INTENDED means, the cam has released the block but has left the span lock, because it will try to remount the span later. The span is stored in the span history for remount(see CONF_SPAN_HISTORY).
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:
none
0x00
SPAN_ERROR_INTERNAL
0x01
SPAN_ERROR_INV_SPN_IDX
0x02
SPAN_ERROR_INV_HDR_TYPE
0x03
SPAN_ERROR_INV_ADDR_LIST
0x04
SPAN_ERROR_NOT_MNTD
0x05
SPAN_ERROR_INV_FS
0x06
SPAN_ERROR_INV_LUN_NFO
0x07
SPAN_ERROR_BAD_HDR_CKSM
0x08
SPAN_ERROR_INV_IDX
0x09
SPAN_ERROR_RD_ONLY
0x0a
SPAN_ERROR_NO_REC_DAT
0x0b
SPAN_ERROR_INV_PART_NFO
0x0c
SPAN_ERROR_SPAN_REQUEST_FAILED
0x0e
SPAN_ERROR_SPAN_REQUEST_RETENTION_TIME
0x0f
SPAN_ERROR_REMOUNT_REFUSED
0x10
ISCSI_ERROR_CONNECT
0x31
ISCSI_ERROR_INV_LUN
0x33
ISCSI_ERROR_LOGIN
0x34
ISCSI_ERR_PWD
0x36
ISCSI_ERR_PROTO
0x37
ISCSI_ERR_TARG_NOT_REACH
0x38
ISCSI_ERR_NO_MEM
0x3a
ISCSI_ERR_SESS_CREATE
0x3b
ISCSI_ERR_INV_PARAMS
0x3c
ISCSI_ERR_SESS_NOT_FOUND
0x3d
ISCSI_ERR_DISCONN
0x3e
ISCSI_ERR_TIMEOUT
0x3f
ISCSI_ERR_SOCK
0x5f
ISCSI_ERR_TARG_PM
0x6f
ISCSI_SOCK_CLOSED
0x7f
ISCSI_ERR_TCP_CONN_RST
0x8f
ISCSI_ERR_INTR_NOT_SUPP
0x9f
ISCSI_ERR_IP_ZERO
0xa0
ISCSI_ERR_OUT_OF_RES
0xa1
HDD_ERROR_TIMEOUT
0x12
HDD_ERROR_CREATE_FAILED
0x22
HDD_ERROR_ACCESS_DENIED
0x32
HDD_ERROR_DEVICE_PRESENT_TIMEOUT
0x42
HD_PMM_ERROR_LUN_LOCK
0x52
HD_PMM_ERROR_INVALID_ACCESS
0x62
HD_PMM_ERROR_LUN_MGMT_FILE_NOT_FOUND
0x72
HD_PMM_ERROR_LUN_WRITE_PROTECTED
0x82
HD_PMM_ERROR_COMMON
0xf2
status RELEASE error codes
Values:
none
0x00
RELEASE_ERROR_HD_MGR_ERROR
0x01
RELEASE_ERROR_SPAN_LIST_INCONSISTENCY
0x02
RELEASE_ERROR_RECORD_HANDLE_DISMISS_ERROR
0x03
RELEASE_ERROR_BIG_TIME_JUMP
0x04
RELEASE_ERROR_CLOSED_WHILE_MOUNTING
0x05
RELEASE_ERROR_INITIAL_MOUNT_ABORT
0x06
RELEASE_ERROR_INITIAL_MOUNT_UNFINISHED
0x07
RELEASE_ERROR_NEXT_SPAN_NOT_MOUNTED
0x08
RELEASE_ERROR_RECORDING_ERROR
0x09
RELEASE_ERROR_ENCODER_ERROR
0x0a
RELEASE_ERROR_REPLACE
0x0b
(release was caused by CONF_SPAN_SWITCH command)
RELEASE_ERROR_SWITCH_REQUEST
0x0c
(release was caused by CONF_SPAN_SWITCH command)
RELEASE_ERROR_SPAN_TIME_LIMIT_REACHED
0x0d
(one day limit per span, if max retention configured)
status MOUNTED special codes
Values:
standard mount
0x00
HD_MOUNT_CODE_REMOUNTED
0x01
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
Start Time (optional) 4 Bytes
Stop Time (optional) 4 Bytes
maxEntries (optional) 4 Bytes
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.
Start Time
Seconds since 2000, optional, if missing, default is 0
Stop Time
Seconds since 2000, optional, if missing, default is unlimited
maxEntries
Max Number of entries, optional, if missing, default is max. 256 files which is also the max. limit for this value
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.
The address of the device the span is assigned to, only in message payload(see request payload description for details).
Storage Managing Host
The address of the device the span was handed out, only in reply payload(hint: in older versions of that command, the recording camera info was send instead).
16
32
reserved 4 Bytes
MAC 6 Bytes ...
reserved 2 Bytes
8
24
MAC
The hardware address of the device, which handed out the span.
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:
SUCCESS
0x00
NO SPAN AVAILABLE
0x01
STORAGE OFFLINE
0x02
INVALID SPAN MANAGER ADDRESS
0x03
ACCESS DENIED
0x04
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
p_octet
l_serv
not supported.
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.
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_RECORDINGS(obsolete)
0x0001
If 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 and 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. If at least one span manager for primary recording is configured, all entries of managed vrm (configured by CONF_MANAGING_VRM) will be deleted.
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:
START
0x00
UPDATE
0x01
STOP
0x02
Flags
Additional copy options.
Values:
COPY_UNT_HDR
0x01
FMT_REC_REG
0x02
APPEND_TO_LAT_REC
0x04
MERGE_TO_LAT_REC
0x08
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:
INITIALIZING
0x00
COPYING
0x01
DONE
0x02
CLOSING
0x03
ERROR
0x04
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_INTERNAL
0x01
ERR_MAX_COPY_EXCEED
0x02
ERR_NO_ACT_COPY_2_DST
0x03
ERR_DST_SPAN_IN_USE
0x04
ERR_ACCESS_SRC_SPAN
0x05
ERR_ACCESS_DST_SPAN
0x06
ERR_FMT_REC_REG
0x07
ERR_INV_SRC_FILE
0x08
ERR_FILE_OFF_TOO_BIG
0x09
ERR_RD_SRC_UNT_HDR
0x0A
ERR_WR_DST_UNT_HDR
0x0B
ERR_WR_DST_LCK_HDR
0x0C
ERR_REPL_OPEN
0x0D
ERR_REC_OPEN
0x0E
ERR_REPL_START
0x0F
ERR_REC_START
0x10
ERR_DST_SPAN_FULL
0x11
ERR_TIMEOUT
0x12
ERR_MERGE_FAILED
0x13
ERR_DST_FMT_VERSION
0x14
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
yes (cam)
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:
FORCE
0x0001
CHECK_PREMOUNTED
0x0002
REPLACE_PREMOUNTED
0x0004
SWITCH_SPAN
0x0008
TARGET_RETREAT
0x0010
TARGET_REINTRODUCE
0x0020
ERROR_CHECK_PREMOUNTED
0x4000
ERROR_CHECK_RECORDING
0x8000
recording
select a recording
Values:
primary recording
1
secondary recording
2
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. Before replacing the premounted span, the actual recording span will be checked, if the replace could get in conflict with a device internal triggered span switch. In that case the whole Span switch command will fail with rcp error RCP_ERROR_TRY_LATER, no switch or replace 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. The TARGET_RETREAT Bit means, than a complete retreate from this target is intended, the span history will be modified in order to avoid a remount on that target. That state will stay active for that target until the device records on a new target and adds a span from the new target to the history, or if the span history will be cleared or the the target will be reintroduced with the bit TARGET_REINTRODUCE. The TARGET_REINTRODUCE Bit is needed to undo a TARGET_RETREAT action, which is specialy in the case needed, when a device shall return to a target, from that it had retreated erlier and no recording took place on another target between these events. In that case the remount feature for that target is still disabled. The TARGET_REINTRODUCE Bit will reenable the remount feature for that target without the nessessarity of clearing the whole span history.
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_LOCK
0x01
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 - 32768)
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 entry
0
set entry
1
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 error
0
invalid directory path
1
invalid lun info file
2
common error
3
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 32768 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_SPAN_HISTORY
Tag code
NumDes
Message
SNMP Support
0x0ace
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
read span history
Write
p_octet
l_serv
clear span history or add a span history entry
Payload Structure
cam 16 Bits
rec idx 16 Bits
action 16 Bits
cnt 16 Bits
span address 1 8 Bytes ...
N x 8 Bytes
span address N 8 Bytes ...
cam
camera line from 1 to max cam
rec idx
recording index from 1 to 2
action
action to do in this command, the command can show the span history, clear the complete history, add a new entry to the history, or show the remount span
Values:
show (read direction only)
0
add(write direction only)
1
clear(write direction only)
2
show remount(read direction only)
3
cnt
number of span address following in this command payload. For action show you can specifie the max number of span history entries to show for in payload. the reply payload will then return a max. of this number of span address. max 8.
span address 1 - N
range of span address from 0 to cnt, maximum 8.
span address content (8 bytes)
ip address
4 bytes
target index
1 byte
lun
1 byte
span index
2 bytes
CONF_SPAN_HISTORY
This command is used by the device to store the span history in the device config, that means it adds (action add) an span adress entry to the config, for each recorded span. The history can be seen by read commando and action show. The history can be cleared by sending a action clear command.
CONF_ACCESS_LUN_MGMT_FILE
Tag code
NumDes
Message
SNMP Support
0x0ae2
yes
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
Access span header information.
Write
p_octet
l_serv
Access lun management information.
Payload Structure
16
32
ip 32 Bits
targ idx 8 Bits
lun 8 Bits
reserved 6 Bytes ...
data n Bytes(max 504 bytes)
8
24
ip
ip address of the lun
targ idx
target index of the lun
lun
lun
data
user data to read/write from/to the lun mgmt file
CONF_ACCESS_LUN_MGMT_FILE
This command can be used to acces the lun managment file. This exists only on span formatted luns, which were formatted by firmware /generic dll versions, that are able to create this file. Older versions cannot do this. The file name is "lunmgmt.bin". the max size which can be stored is 504 bytes. The in payload for reading or writing this command has to be at least a size of 12 bytes and includes the lun address for read/write from/to lun mgmt file. The response on the read direction includes the user data from the lun mgmt file. The data length will be the remayning bytes from the respons payload size minus the lun address and the reserved bytes (12 bytes together). Same in write direction. The payload size determines the number of bytes to write to the lun mgmt file(max 504 bytes).
CONF_FLUSH_LUN_INFO_CACHE
Tag code
NumDes
Message
SNMP Support
0x0b09
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported
Write
p_octet
l_serv
flush the lun info cache of lun: 4 bytes IP as DWORD in network byte order, 1 byte target idx, 1 byte lun, 2 bytes reserved (if ip is 0.0.0.0 or 255.255.255.255 or the payload is less than 6 bytes it is asumed as wildcard, the whole cache will be flushed)
CONF_DELETE_CAM_REC_SPANS
Tag code
NumDes
Message
SNMP Support
0x0b5d
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported.
Write
p_octet
l_serv
Delete recording spans of a camera from a span manager on a managed lun.
Request Payload Structure
16
32
Recording Camera 12 Bytes ...
Lun Address 8 Bytes ...
From 8 Bytes ...
To 8 Bytes ...
Flags 8 Bytes ...
8
24
Recording Camera
The address of the camera for which recording spans are to be deleted.
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 will be deleted.
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.
From
Start time of the interval in Seconds since 2000 local time for deleting.
To
End time of the interval in Seconds since 2000 local time for deleting.
Flags
Values:
Bit 0
delete enclosed spans only
Bit 1
force delete
DELETE_CAM_REC_SPANS
This command is used for deleting spans of a specific recording line and index containing recordings between a given time interval. The flag "delete enclodes spans only" chooses wether a span shall be deletet if it is completetly enclosed by the time interval or if it only overlaps the interval. The flag "force delete" will delete all spans of the cam independend of the state of the span. That means even if the cam is still recording on a span, the span will be deleted. So use this option very carefully, as it could lead to inconsitencies. If the command return successfully, it doesn't mean, that the deletion is completetd, it just tells the caller, that a asychonous job for deletion was invoked. The command has to be send to the storage lun managing device.
Lower size limit of used vcd cache buffer on recording spans in 64 kb units per 1 GB span. Allowed values from 1 to 4096, 0 to disable cache.
upper size limit
Upper size limit of used vcd cache buffer on recording spans in 64 kb units per 1 GB span. Allowed values from 1 to 4096, 0 to disable cache.
CONF_HDD_VCD_CACHE_SIZE
This command can be used to configure the size of the vcd cache on a span for recording. The size parameters are rellativ to 1 GB span size. If recording is running on soans with diffrent sizes than 1 GB, the values will be internally scaled to the propper size, so it will also work for diffrent span sizes. The usage of a vcd cache on spans will cause space overhead on a storage, so it is possible to switch it of by setting both values to 0. If enabled, the recording will use these values to adjust the size of the vcd cache on spans. The used adjusted sizes will be than limited by these two values, upper limit and lower limit. The adjusment starting value will be between these to values. While recording, the uses space for cached vcd data will be measured and after each span switch, the size will be adjusted by using the measurement values for new mounted spans in order to avoid overhead. It is also possible to set a fix size for the vcd cache by this command by setting the upper and lower limit to equal values. The default value for the command is 1 for lower limit and 128 for upper limit. For read direction an input payload is needed same as the described payload but only line and rec idx are required, the remaining part of the payload can be clipped away.
CONF_STORAGE_REPORT
Tag code
NumDes
Message
SNMP Support
0x09cf
yes (1=cam1, 2=cam2, ...)
yes
no
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:
None
0x00
RAM Recording
0x03
iSCSI
0x04
USB
0x05
IDE
0x08
Compact Flash
0x09
Availability
Values:
Unknown
0x00
No
0x01
Yes
0x02
locked by another device
0x03
Access Type
Values:
Unknown
0x00
Read Only
0x01
Read Write
0x02
IO Error Type
Values:
None
0x00
Read
0x01
Write
0x02
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 (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
 
(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 (None = 0, USB = 5, IDE = 8, CF = 9, IMG File = 10, SD = 11)
Write
void
l_serv
not supported
CONF_STORAGE_LIST
Tag code
NumDes
Message
SNMP Support
0x0a37
no
yes
yes
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 3 Bytes
Storage threshold 1 Byte
8
24
Storage Type
The type of the storage.
Values:
FILE
0x02
RAM
0x03
ISCSI
0x04
USB
0x05
IDE
0x08
CF
0x09
SD
0x0b
IP Address
The IP address of the iscsi server. Will be ignored, if the storage type is not iscsi.
Target Index
The target index on the iscsi server. Will be ignored, if the storage type is not iscsi.
Lun
The iscsi lun. Will be ignored, 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 only
0x00
Make storage available through iSCSI
0x01
Span Manager
Values:
Span manager off
0x00
Span manager on
0x01
Span format lun and start span manager
0x02
Migrate lun and start span manager
0x03
Mgr Status
The status of the span manager in the response packet. Set to zero in the request packet.
Values:
OFF
0x00
ON
0x01
FORMATING
0x02
MIGRATING
0x03
ALARM THRESHOLD (msg only)
0x04
ALARM OVERWRITE (msg only)
0x05
OFFLINE (read payload only)
0x04
ONLINE (read payload only)
0x05
STOPPING
0x06
ERROR
0x07
WRITE PROTECTION
0x08
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
Stage 1 Byte
Progress 1 Byte
Error 1 Byte
8
24
Stage
The current migration stage.
Values:
INIT
0x00
FORMAT SPANS
0x01
UPDATE HEADER
0x02
COPY DATA
0x03
DONE
0x04
Progress
The progress of the current stage in percentage.
Error Code
A possible error code.
Storage threshold
This is the threshold of free storage in percent and means that at least this amount of memory should be free. A Message of this command will be send always, this treshold is crossed in eiher direction.
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.
This command will be send as msg (can also be send as snmp trap with same pyload) in case of crossing the storage threshold with Mgr status ALARM THRESHOLD or in case of overwriting recording, that is still protected by unexpired retention time with mgr status ALARM OVERWRITE.
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. The modes RECORDING SIMULATION, LATENCY and REPLAY SIMULATION use different fields in the request packet which are not documented yet.
Values:
LINEAR
0x0000
RANDOM
0x0001
RECORDING SIMULATION
0x0002
LATENCY
0x0003
REPLAY SIMULATION
0x0004
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.
Flags
Flags to set some options.
Values:
READ ONLY
0x0001
WRITE ONLY
0x0002
KEEP DATA
0x0008
VERIFY WRITE
0x0010
EXP BURST INCREASE
0x0020
ERROR STOP
0x0040
RESTRICT TO SPAN
0x0080
ISCSI SESSION EXCLUSIVE
0x0100
MAX LBA END
0x0200
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:
STOP
0x00
START
0x01
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:
STOPPING
0x00
STARTING
0x01
RUNNING
0x02
DONE
0x03
ERROR
0x04
Error
Values:
INTERNAL
0x01
LUN
0x02
INVALID PARAMS
0x03
READ
0x04
WRITE
0x05
WRITE VALIDATE
0x06
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.
CONF_DATA_COPY_JOB_START
Tag code
NumDes
Message
SNMP Support
0x0b32
no
no
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
not supported ,
Write
p_octet
l_serv
start copy job,
Payload Structure
16
32
source descriptor 16 to n Bytes ...
...
destination descriptor 16 to n Bytes ...
...
8
24
source descriptor
specifies the copy source (see src/dest descriptor payload)
destination descriptor
specifies the copy destination (see src/dest descriptor payload)
CONF_DATA_COPY_JOB_START
This command starts a copy job, given by first the source descriptor and second the destination descriptor. If starting the job was ok, the status will be reported by CONF_DATA_COPY_JOB_STATUS messages or can be querried by the same comand. The return payload structure is the same as the CONF_DATA_COPY_JOB_STATUS payload and contains the job id on success. This id can be used for stopping the job, query the state or to identify it in the status messages payload.
source/destination descriptor structure
16
32
offset 32 Bits
len 32 Bits
type 16 Bits
type spec. params len (4 byte aligned) 16 Bits
type specific parameter n Bytes
...
8
24
offset
the offset in lba sized units ( = 512 bytes)
len
amount of data to copy in lba sized units ( = 512 bytes), not relevant for destination descriptor
Values:
full copy
0
len
1 to n
type
type of the source or destination
Values:
interface test
0
span on iscsi
1
file
2
raw iscsi lun
3
type spec. params len
length of the following additional parameters
type specific parameter
additional parameter for specifing the source or destination depending on the type of the source or destination (see description for specific parameters below).
interface test
Fakes the access to a sorce/destination and can be used for example to test the interface and copy job engine. No further parameters are needed.
specific parameter structure for "span on iscsi"
16
32
ip 32 Bits
target 8 Bits
lun 8 Bits
span index 16 Bits
file type 1 Byte
reserved 1 Byte
timeout 16 Bits
8
24
ip
IPv4 address of an iscsi lun
target
Target index
lun
lun index
span index
span index
file type
type to specify, which part of the span has to be copied
Values:
lock header
1
unit header
2
manager header
3
recording data
4
timeout
request timeout in seconds, can be used to tollerate iscsi connection poblems
Values:
default, using default iscsi timeouts
0
possible values
1 - 65534
never timeout
65535
span on iscsi
Access to a span on an iscsi lun. This type can be used for example to copy a span. The parts of a span (unit, lock, mgr header, data) has to be copied in seperate copy jobs. Parameter length is 12 bytes.
specific parameter structure for "file"
16
32
file path n Bytes ...
...
8
24
file path
zero terminated ascii string specifing the path and file name of a source/destination
file
Access to a file. Can be used for example to copy a span to a file. If the file is the source, it has to exist. If the file is destination it will be created if it doesn't exist. Parameter length is the path length including zero termination and stuffing bytes in order to be 4 byte aligned. Size is at least 4 bytes.
specific parameter structure for "raw iscsi lun"
16
32
ip 32 Bits
target 8 Bits
lun 8 Bits
timeout 16 Bits
8
24
ip
IPv4 address of an iscsi lun
target
Target index
lun
lun index
timeout
request timeout in seconds, can be used to tollerate iscsi connection poblems
Values:
default, using default iscsi timeouts
0
possible values
1 - 65534
never timeout
65535
raw iscsi lun
Access to a complete iscsi lun. This type can be used for example to make a one to one copy of a complete lun. Parameter length is 8 bytes.
CONF_DATA_COPY_JOB_STOP
Tag code
NumDes
Message
SNMP Support
0x0b33
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
not supported
Write
t_dword
l_serv
requests stop on a data copy job if exists, otherwise fails, payload: job id
CONF_DATA_COPY_JOB_STATUS
Tag code
NumDes
Message
SNMP Support
0x0b34
no
yes
no
Datatype
Access Level
Description
Read
p_octet
noprot
 
get the status of a copy job,
Write
p_octet
l_serv
write not supported (only for read and messages),
Payload Structure
16
32
job id 32 Bits
state 8 Bits
reserved 3 Bytes
progress 32 Bits
full data amount 32 Bits
8
24
job id
Id of a data copy job
state
state of the copy job
Values:
initializing
0
running
1
finished
2
failed
3
stopped
4
progress
Progress in lba units (= 512 bytes)
full data amount
Full data amount in lba units (= 512 bytes) of the copy job. Progress has to reach this value in order to finish successfully.
CONF_DATA_COPY_JOB_STATUS
This message reports the status of the copy job and will be send on each status change or several times while in state "running". The status can also be queried by sending this command in read direction.
CONF_HTTP_LIVE_BITRATE
Tag code
NumDes
Message
SNMP Support
0x0b45
no
no
no
Datatype
Access Level
Description
Read
t_dword
noprot
 
Get the bitrate in kBit the HTTP Live Streaming has allocated buffers for
Write
t_dword
l_serv
Set the bitrate in kBit the HTTP Live Streaming should allocate buffers for (max bitrate given in init gen)
CONF_HTTP_LIVE_AUDIO
Tag code
NumDes
Message
SNMP Support
0x0b46
no
no
no
Datatype
Access Level
Description
Read
f_flag
noprot
 
Audio is enabled for HTTP Live Streaming yes or no
Write
f_flag
l_serv
Audio enabled for HTTP Live Streaming yes or no
Appendix - Bicom Command Access Levels
The default protection level for BICOM / AUX commands is
'bl_user' for get-operations (get, getMax, getMin) and 'bl_service' for all other operations.
All BICOM / AUX commands which have a protection level different from the default
are listed in the following tables. 'bl_priv' means that the command is not accessible at all.
Device Server objects
ObjectID
Operation
Level
0x0160
BICOM_OP_GET
BL_SERVICE
Camera Server objects
ObjectID
Operation
Level
0x01B0
0x82 /*MoveCont*/
BL_USER
0x01B0
0x84 /*MoveMom*/
BL_USER
0x01F0
0x82 /*MoveCont*/
BL_USER
0x01F0
0x84 /*MoveMom*/
BL_USER
0x0430
BICOM_OP_SET
BL_PRIV
0x0430
BICOM_OP_SET_GET
BL_PRIV
PTZ Server objects
ObjectID
Operation
Level
0x0101
BICOM_OP_SET
BL_USER
0x0101
BICOM_OP_SET_GET
BL_USER
0x0103
0x81 /*Shot*/
BL_USER
0x0104
0x81 /*Shot*/
BL_USER
0x0110
BICOM_OP_SET
BL_USER
0x0110
0x82 /*MoveContFixSpeed*/
BL_USER
0x0110
0x83 /*MoveFixSpeedForPeriod*/
BL_USER
0x0110
0x85 /*MoveContVarSpeed*/
BL_USER
0x0110
0x88 /*MoveMomVarSpeed*/
BL_USER
0x0110
0x89 /*MoveContVarFinSpeed*/
BL_USER
0x0111
BICOM_OP_SET
BL_USER
0x0111
BICOM_OP_SET_GET
BL_USER
0x0112
BICOM_OP_SET
BL_USER
0x0112
BICOM_OP_SET_GET
BL_USER
0x0113
BICOM_OP_SET
BL_USER
0x0113
BICOM_OP_SET_GET
BL_USER
0x0114
BICOM_OP_SET
BL_USER
0x0114
BICOM_OP_SET_GET
BL_USER
0x0115
BICOM_OP_SET
BL_USER
0x0115
BICOM_OP_SET_GET
BL_USER
0x0116
BICOM_OP_SET
BL_USER
0x0116
BICOM_OP_SET_GET
BL_USER
0x011B
0x81 /*Shot*/
BL_USER
0x011C
0x81 /*Shot*/
BL_USER
0x011D
0x81 /*Shot*/
BL_USER
0x011E
0x81 /*Shot*/
BL_USER
0x0160
0x80 /*Record*/
BL_USER
0x0160
0x81 /*PlaybackCont*/
BL_USER
0x0160
0x82 /*PlaybackSingle*/
BL_USER
0x0160
0x83 /*Stop*/
BL_USER
0x0170
0x80 /*Record*/
BL_USER
0x0170
0x81 /*PlaybackCont*/
BL_USER
0x0170
0x82 /*PlaybackSingle*/
BL_USER
0x0170
0x83 /*Stop*/
BL_USER
0x01A1
BICOM_OP_SET
BL_USER
0x01A1
BICOM_OP_SET_GET
BL_USER
0x01A2
BICOM_OP_SET
BL_USER
0x01A2
BICOM_OP_SET_GET
BL_USER
0x01A2
0x0D /*GetHorizon*/
BL_USER
0x01A2
0x0E /*GetVerticalDown*/
BL_USER
0x2000
0x80 /*Store*/
BL_USER
0x2000
0x81 /*Shot*/
BL_USER
.
0x80 /*Store*/
BL_USER
.
0x81 /*Shot*/
BL_USER
0x2FF0
0x80 /*Store*/
BL_USER
0x2FF0
0x81 /*Shot*/
BL_USER
CA Server objects
ObjectID
Operation
Level
IO Server objects
ObjectID
Operation
Level
0x0800
BICOM_OP_SET
BL_USER
0x0800
BICOM_OP_SET_GET
BL_USER
0x0810
BICOM_OP_SET
BL_USER
0x0810
BICOM_OP_SET_GET
BL_USER
0x0820
BICOM_OP_SET
BL_USER
0x0820
BICOM_OP_SET_GET
BL_USER
0x0830
BICOM_OP_SET
BL_USER
0x0830
BICOM_OP_SET_GET
BL_USER
AUX numbers
Number
Level
1
BL_USER
2
BL_USER
7
BL_USER
8
BL_USER
50
BL_USER
51
BL_USER
52
BL_USER
53
BL_USER
65
BL_USER
78
BL_USER
81
BL_USER
82
BL_USER
83
BL_USER
84
BL_USER
100
BL_USER
101
BL_USER
SHOT numbers
Number
Level
1-99
BL_USER
101
BL_USER
102
BL_USER
SET numbers
Number
Level
1-99
BL_USER
Appendix - specific error codes
Each rcp command can generate an generic RCP fault as described in the chapter "Rcp Protocol Procedure".
Additional command specific error codes are defined. If an command specific error occurs the Response is 2 bytes long. The first byte is set to RCP_ERROR_COMMAND_SPECIFIC (0xf0), the second byte is set to the specific fault.
The following command specific errors are defined: