RCP Plus
Reference
(RCP Version 3)
Specification
Firmware version major 5 minor 93 build 26
|
Copyright |
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. © Copyright 2001-2013 Bosch Security Systems |
|
|
|
|
Note |
This manual was compiled with the greatest of care and all information double checked. At the time of printing the description was complete and correct. Because of the further development of products, the content of the manual might change without prior notice. 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. |
Table Of Contents
Transport Protocol
The transport protocol for this remote control must be TCP. All VideoJets will establish a TCP listen socket on port 1756. Any remote control must be sent to this port.
Multiple RCP connections from the same endpoints are allowed. The maximum number of RCP connections on a single endpoint is limited to 50 connections at the same time.
Alternatively, a connection can be made using a HTTP tunnel. See this chapter for details.
Remote Control ProtocolPlus Protocol Header Layout
Version 3 (VIP, VideoJet and VipX Series and VIP110Version 6.0 and higher). The RCP Plus protocol header consists of 16 Bytes. The begin of the payload section is now on DWORD boundary.
| 16 | 32 | ||||||||||||||||||||||||||||||
| Tag 2 Bytes |
Data Type 1 Byte |
Version 4 Bits |
R/W 4 Bits |
||||||||||||||||||||||||||||
| C 1 |
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
|
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:
| |||
| |||
| |||
|
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
- Send the string “GET /rcp_tunnel HTTP/1.0\r\n\r\n” (as HEX string: 0x47 0x45 0x54 0x20 0x2f 0x72 0x63 0x70 0x5f 0x74 0x75 0x6e 0x6e 0x65 0x6c 0x20 0x48 0x54 0x54 0x50 0x31 0x2e 0x30 0x0d 0x0a 0x0d 0x0a)
- 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 relative 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).
The coder numbers that have to be used to establish the media tunnels is a relative one that isn't unique when using video as media type. The video and meta data can have the same relative coder number and have the same media type. In that case the optional index parameter might be used to distinguish the media channels:
GET /media_tunnel/SSSSSSSS/CC/DD/LL/CO?index=n HTTP/1.0\r\n\r\n
where n is the number of the initial connect primitive channel position starting at 1.
E.g the ConnectPrimitive request contains a Get Video, a Get Audio and a Get Meta section, then the index for video would be 1, the index for audio 2 and the index for meta would be 3.
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:
|
type
Values:
| |
| |
| |
| |
| |
| |
|
direction
Values:
| |
|
num
Values:
|
payload
Values:
| |
| |
|
Optional CGI parameters:
idstring
Values:
|
sessionid
Values:
|
Multiple parameters are passed in CGI manner with '&' in between two parameter-value pairs.
A sample request to readout the units hardware version will look like
http://ip.ip.ip.ip/rcp.xml?command=0x002e&type=P_STRING&direction=READ
The reply XML structure will then have this format:
<rcp>
<command>
<hex>0x002e</hex>
<dec>46</dec>
</command>
<type>T_DWORD</type>
<direction>READ</direction>
<num>0</num>
<idstring />
<payload />
<cltid>0x00ff</cltid>
<result>
<hex>0xf0000f43</hex>
<dec>4026535747</dec>
</result>
</rcp>
The upper part contains the request, the <result> contains the reply. Numerical values are presented in <hex> and <dec>, strings, unicodes and p_octet in <str> sections.
<cltid> shows the client number assiged by the RCP+ server.
Message handling
RCP+ messages will be processed and received by the CGI client using a poll 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.
In order to ensure correct assignment of messages in case several clients are polling for messages or if a polling client uses different socket connections, a unique
message domain ID (CGI parameter 'msgdomainID') should be provided. Messages are then collected separately for each ID and can be uniquely assigned to the polling
client even if requesting via different socket connections.
Valid CGI commands to control messages:
message
Values:
|
collectms
Values:
|
msgdomainID
Values:
|
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
http://ip.ip.ip.ip/rcp.xml?message=0xffcc&collectms=5000
The reply XML structure will then have this format:
<message_list>
<stats>
<msgcnt>2</msgcnt>
<over>0</over>
<clip>0</clip>
<poll>1</poll>
</stats>
<cltid>0x002a</cltid>
<msg>
<no>1</no>
<command>0xffcc</command>
<num>0</num>
<sessionID>0x7063001f</sessionID>
<hex>0xa00a0034000000000101000001010001</hex>
</msg>
<msg>
<no>2</no>
<command>0xffcc</command>
<num>0</num>
<sessionID>0x70630020</sessionID>
<hex>0xa00a0034000000000101000001010001</hex>
</msg>
</message_list>
Authentication
The RCP+ server 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
e.g. URL:
http://ip.ip.ip.ip/rcp.xml?command=0x0a1f&type=T_DWORD&direction=WRITE&payload=0x00000000&ip-item0=fd00::55:77
or
http://ip.ip.ip.ip/rcp.xml?command=0x0a1f&type=T_DWORD&direction=WRITE&payload=0x00000000&ip-item0=MyHostname.de
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
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.
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
FL
Values:
| |||
| |||
|
Net
Values:
| |||
|
opt
Values:
| |||
|
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:
| |||
|
FL
Flavour
Values:
| |||
| |||
|
ID
Values:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
Net
Values:
| |||
| |||
| |||
|
opt
Values:
| |||
| |||
| |||
|
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> <deviceCapabilities>XXXXXXXXXX...XX</deviceCapabilities> </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 <deviceCapabilities>XXXXXXXXXX...XX</deviceCapabilities> XXXXXXXXXX...XX is the binary payload of the reply to the command CONF_DEVICE_CAPABILITIES (each byte is printed with %2x) and can help to identify the availability of features or the capabilities of this device. The number of bytes given in this section can vary depending on the device and the firmware version.
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:
Currently the following possible criteria are defined:
|
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
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
Format: e.g. FD00::1234:5678
IPv6GatewayAddrString
Zero terminated string containig the IPv6 gateway address to set.
Format: e.g. FD00::1234:5678
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)
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)
- 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:
| |||
| |||
|
Client ID
Unused in Normal Registration. Must be provided in Hook On Registration.
PE
Password and User Delivery Encryption.
Values:
| |||
|
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:
| |||
|
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:
| |||
|
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.
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:
| |||
|
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:
| |||
|
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 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 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 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, 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:
| |||
| |||
|
Media
Values:
| |||
| |||
|
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: Media over ssl: This Bit is set in the response to signal that the device supports "media 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.
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: Media over ssl: This Bit is set in the response to signal that the device supports "media 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MEP
Media Encapsulation Protocol.
Values:
Note: When using RTP over TCP, media channels must be established as described in 'RCP Protocol Procedure / Receiving media data'.
Flags
Values:
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
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:
Resolution - (obsolete, not checked any more)
Values:
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MEP
Media Encapsulation Protocol.
Values:
Flags
Values:
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
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:
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.
Note: Audio packetzing
For audio G.711, the encapsulation of bitstream RTP packets are required to be 640 bytes (equvalent of 80ms samples).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MEP
Media Encapsulation Protocol.
Values:
MTA IP Address
Media Transport Address IP Address
Values:
Coder
Informational.
Line
Identifies the Line Input/Output channel for the specified coding engine.
Coding
Values:
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MEP
Media Encapsulation Protocol.
Values:
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:
Resolution - (obsolete, not checked any more)
Values:
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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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:
| |||
|
Media
Values:
| |||
| |||
|
Status
Values:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
|
Cause
Values:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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.
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
|
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 |
Flags 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.
Flags
Values:
remote password level
remote user: password level: 1-user, 2-service, 3-live, 0-no protection (optional parameter)
remote password length
remote user: password length (optional parameter)
remote password
remote user: password (optional parameter)
Reply / Read / Message
The reply to this command will present the same packet format as the outgoing. The result will contain the really established channels.
A message will be generated if all requested channels are established; if a channel fails, the appropriate bit will be cleared in the channel section.
CONF_ACTIVE_CONNECTION_LIST
Payload Structure
Sequence of:
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:
Session ID
Session identifier.
Remote Coder
The remote connected coder (relative to line), (absolute) transcoder if connection is using transcoder
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
CONF_RCP_CONNECTIONS_ALIVE
CONF_CAPABILITY_LIST
Reply payload Structure
Version
current version of the capabilities (0x0001)
NbSection
Number of following sections
Section Structure
Type
Type of Element
Values:
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
is one of the following
Values:
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.
In case of transcoders this numeric descriptor is informative only. It is not necessary to address the entity directly (use the relevant rcp commands instead).
Compression
is one or multiple of the following
Values:
InputNo
InputNo is the number of the physical input from which the entity gets or puts its video. In case of transcoder this value is unused and set to 0;
Resolution
is one or multiple of the following
Values:
Notice: this list is not further maintained/extended. If additional resolutions are supported, the VIDEO_RESO_CUSTOM value is set
and the available resolutions can be obtained via the command CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS.
Element Structure
For section type Audio
Type
is one of the following
Values:
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:
Element Structure
For section type Serial
Type
is one of the following
Values:
Identifier
is the RCP numeric descriptor to use to address the entity.
Element Structure
For section type IO
Type
is one of the following
Values:
Identifier
is the RCP numeric descriptor to use to address the entity.
Element Structure
For section type Camera Data
Type
is one of the following
Values:
InputNo
InputNo is the number of the physical video input.
CONF_RCP_CODER_LIST
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
MediaType
Values:
Direction
physical port is
Values:
Flags
one or multiple of
Values:
Compact format reply payload Structure
CoderNbr 1 - N
List of the absolute coder numbers
Extended format video reply payload structure
Sequence of
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
Coding Current
The current available coding capabilities (definitions see above)
Resolution Capabilities
All resolution capabilities is one or multiple of
Values:
Resolution Current
The current available resolution capabilities (definitions see above)
Extended format audio reply payload structure
Sequence of
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
Coding Current
The current available coding capabilities (definitions see above)
Extended format data reply payload structure
Sequence of
CoderNbr
The absolute coder number
Coding Capabilities
All coding capabilities is one or multiple of
Values:
Coding Current
The current available coding capabilities (definitions see above)
CodParameter Capabilities
All coding CodParameter capabilities is one or multiple of
Values:
CodParameter Current
The current available coding capabilities (definitions see above)
CONF_PUBLISH_MEDIA_KEYS
CONF_CRYPT_KEYAUDIO_ENC
Payload Structure
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
CONF_CRYPT_KEYVIDEO_ENC
Payload Structure
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
CONF_CRYPT_KEYAUDIO_DEC
Payload Structure
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
CONF_CRYPT_KEYVIDEO_DEC
Payload Structure
Key
The 16 Byte Masterkey for AES encryption/decryption of data
Comments:
CONF_CRYPT_KEY_GENERATE_ALL
CONF_RCP_CONNECT_SALVO
Payload Structure
flags
bit 0: live video,
bit 1: use TCP to get live video,
bit 2: internal used,
bit 3: replay live only,
bit 4: internal used,
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, if the special url starting with "trackid://" is used, the following decimal value is the VRM Track ID (e.g. "tackid://15096")
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_MUTE_MEDIA_CHANNEL
CONF_STREAM_EXCLUSIVE_CHECK
CONF_UNIT_NAME
CONF_UNIT_ID
CONF_CAMNAME
CONF_CAMNAME2
CONF_CAMNAME_LINES
CONF_HARDWARE_VERSION
CONF_SOFTWARE_VERSION
CONF_BOOTLOADER_VERSION
CONF_FW_MIN_VERSION
CONF_SERIAL_NUMBER
CONF_CTN
CONF_DEVICE_TYPE_IDS
CONF_SUPPORTED_UPLOAD_TARGETS
CONF_DEVICE_GUID
CONF_DEVICE_CAPABILITIES
Payload Structure
CONF_DEVICE_CAPABILITIES
lists device capabilities in a tagged format.
num Entries
The total number of tagged entries.
tags
The following tags are defined:
length
The length of the payload. The payload of a tag must be in network byte-order.
CONF_DEVICE_OPERATION_MODE_VERSIONS
Response Payload Structure
operation mode version info 1 - N
A list of operation mode version info structures.
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_SOFT_VARIANT_ID
CONF_SOFT_VARIANT_ID_OPTIONS
CONF_IDCHIP_VERSION
CONF_IDCHIP_CERTIFICATE
CONF_IDCHIP_AUTHENTICATE
CONF_TRANSCODER_INFORMATION
Payload Structure
sequence of
tag
Values:
len
len of data
data
len bytes of data
CONF_STARTPAGE_BACKGROUND_URL
CONF_STARTPAGE_LOGO_URL
CONF_STARTPAGE_PRESENTATION_SWITCHES
CONF_DYNAMIC_HTML_NAME
CONF_DYNAMIC_HTML_DATA
CONF_BROWSER_LANGUAGE_VAL
CONF_BROWSER_DATETIME_FORMAT_VAL
CONF_DATE_WDAY
CONF_DATE_DAY
CONF_DATE_MONTH
CONF_DATE_YEAR
CONF_TIME_HRS
CONF_TIME_MIN
CONF_TIME_SEC
CONF_TIMEZONE
CONF_UTC_ZONEOFFSET
CONF_NTP_SERVER_IP_STR
CONF_NTP_SYNC_MODE
CONF_DAY_LIGHT_SAVE_TIME_TABLE
CONF_DAY_LIGHT_SAVE_TIME
CONF_FORCE_TIME_SET
CONF_SYSTEM_DATETIME_V2
CONF_PASSWORD_SETTINGS
CONF_REMOTE_PASSWORD
CONF_ACCOUNT_SETTINGS
CONF_NBR_OF_ACCOUNTS
CONF_DROPBOX_AUTH_ADDR
CONF_DROPBOX_AUTH_STATUS
CONF_ACCOUNT_STATUS
CONF_MASTERPWD_CHALLENGE
CONF_STREAM_SECURITY_V2
CONF_STREAM_SECURITY_OPTIONS
CONF_VIDEO_OVER_SSL
CONF_NBR_OF_TEMP_SENS
CONF_TEMP_SENS
CONF_REDUNDANT_POWER
CONF_POWER_SUPPLY
CONF_NBR_OF_FANS
CONF_FAN_SPEED
CONF_MINIMUM_FAN_SPEED
CONF_BOOT_STATE
CONF_UPLOAD_PROGRESS
Payload Structure
Progress
informs about current progress of an upload or possible error states
Values
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
CONF_FAN_CTRL
CONF_VIPROC_ID
CONF_RULE_ENGINE_ID
CONF_VIPROC_ONOFF
CONF_VIPROC_CUSTOM_PARAMETERS
CONF_VIPROC_CUSTOM_PARAMETERS_TAGS
CONF_VIPROC_GLOBAL_PARAMETERS
CONF_VIPROC_DLL_NAME
CONF_VIPROC_DLL_NAME_LIST
CONF_VIPROC_DLL_RELOAD
CONF_VIPROC_SAVE_REFERENCE_IMAGE
CONF_VIPROC_REFERENCE_IMAGE_FILENAME
CONF_START_VIPROC_CONFIG_EDITING
CONF_STOP_VIPROC_CONFIG_EDITING
CONF_CONT_VIPROC_CONFIG_EDITING
CONF_VIPROC_SCENE
CONF_NUMBER_OF_VIPROC_CONFIGS
CONF_ACTIVE_VIPROC_CONFIG
CONF_LOADED_VIPROC_CONFIG
CONF_VIPROC_CONFIG_NAME
CONF_LIST_OF_VIPROC_SCENES
CONF_VIPROC_TAGGED_CONFIG
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:
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.
CONF_VIPROC_TAGGED_CONFIG_INTERNAL
CONF_VIPROC_ALARM
Payload Structure
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:
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
Payload Structure
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:
Bit15-32 are unused and should be zero.
CONF_AUPROC_CONFIG
Payload Structure
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:
CONF_AUPROC_MELPEGEL
Payload Structure
CONF_AUPROC_NAME
CONF_VIPROC_ALARM_MASK
CONF_VIPROC_CONFIG_CHANGE_IN_RECORDING
CONF_VIPROC_MODE
CONF_VIPROC_WEEKLY_SCHEDULE
CONF_VIPROC_HOLIDAYS_SCHEDULE
CONF_PTZ_CONTROLLER_AVAILABLE
CONF_ENABLE_VCA
CONF_VIPROC_ALARM_AGGREGATION_TIME
CONF_VIPROC_ALARM_EXT_AGGREGATION_TIME
CONF_VIPROC_MOTION_DEBOUNCE_TIME
CONF_VCA_FRAME_RESOLUTION
CONF_VIPROC_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:
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:
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.
Tags
Values:
REF_IMAGE_NOT_AVAILABLE -- Tag: 0x01 Length: 0x01 Payload: 0x00/ 0x01
Example
The following payload example contains a capability device, that a reference image is on the current device not available.
CONF_VCA_TASK_RUNNING_STATE
CONF_VIPROC_VERSION
CONF_TRANSPARENT_DATA_OVER_IP
CONF_AUTO_TRACKER_TRACK_OBJECT
CONF_MODE_AUTO_TRACKER
CONF_STATUS_AUTO_TRACKER
CONF_SENSITIVITY_OBJECT_BASED_VCA
CONF_VIPROC_SENSITIVE_AREA
Payload Structure
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.
Height
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
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
CONF_IVA_COUNTER_VALUES
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
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
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
Payload Structure
pos
Local coordinate system in signed values.
CONF_GEO_POS_INFO
Payload Structure
CONF_BEST_FACE
Payload Structure
enable
0: best face is disabled
1: best face is enabled
reserved
Must be written as zero
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
targetObjectWidth
Configure maximum face width in pixel 0 means auto no scaling is necessary delivers best performance
time out
Time out in seconds. If the time out is set to 0 the best face of the tracking process will be posted when the face has left the scene.
Defines a timeout for the maximum delay which is introduced till a face is posted. After a face is posted the tracking is restarted.
Example:
Face is in scene for 50 sec t = [0s,50s]
timeout is configured to 10 s
best face of [0s,10s] is posted
best face of [10s,20s] is posted
best face of [20s,30s] is posted
best face of [30s,40s] is posted
best face of [40s,50s] is posted
reserved
Must be written as zero
CONF_BEST_FACE
Allows the upload of detected faces to an ftp server or drop box account.
CONF_WRITE_XML_TO_VCD
CONF_SYSUPTIME
CONF_OEM_DEVICE_NAME
CONF_OEM_EXT_ID
CONF_OEM_DEVICE_DOMAIN
CONF_DEFAULTS
CONF_FACTORY_DEFAULTS
CONF_BOARD_RESET
CONF_BOOT_DEFAULT_APP
CONF_VIDEO_ENC_PRIO
CONF_LED_BLINKING
CONF_JPEG
CONF_CLUSTER_GROUP_SETTING
CONF_CLUSTER_ID
CONF_APP_OPTION
CONF_APP_OPTION_UNIT_ID
CONF_APP_OPTION_SET
CONF_CPU_LOAD_IDLE
CONF_CPU_LOAD_CODER
CONF_CPU_LOAD_CODER_INST
CONF_CPU_LOAD_VCA
CONF_STORAGE_LOAD
CONF_CPU_LOAD
CONF_CPU_COUNT
CONF_SANITY_CHECK
CONF_ONVIF_STREAM_MODE
CONF_ONVIF_STREAM_URI_EX
CONF_NIGHT_MODE_STATE
CONF_BLOCK_BASED_STORAGE
Payload Structure
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:
PageIndex
Index of the first 512 byte page to be accessed
Values:
PageCount
Number of 512 byte pages to be accessed
Padding
Padding up to a total hdr size of 32 bytes
Values:
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
CONF_INSTALLER_SEQUENCE
CONF_UPLOAD_HISTORY
CONF_STATIC_SERVER_URL
CONF_GB28181
Payload Structure
Enable
1: Enable GB28181 client 0: Disable
H264 Stream Cfg
if 1, use h264 elementary stream (including startcodes) directly packed
into RTP packets (non-RFC conform, but needed for GB28181 test tool)
Reserved
Must be written as 0
Heart beat time out
Define heart beat time out in seconds max. one day min. 5 seconds
Registration time out
Define registration time out in seconds max. one day min. 5 seconds
Server port
currently 5060 or 5511 can be used (server and device port must be equivalent server port is also used for device port)
Device Port
currently 5060 or 5511 can be used (server and device port must be equivalent server port is also used for device port)
Server URL
URL of GB28181 server
CONF_MPEG_AUDIO_SAMPLING_FREQ
CONF_MPEG4_CURRENT_PARAMS
CONF_MPEG4_CURRENT_PARAMS_TRANSCODER
CONF_MPEG4_CURRENT_PARAMS_REL_CODER
Payload Structure
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:
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
CONF_MPEG4_BANDWIDTH_KBPS
CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT
CONF_MPEG4_BANDWIDTH_KBPS_HARD_LIMIT
CONF_MPEG4_INTRA_FRAME_DISTANCE
CONF_MPEG4_FRAME_SKIP_RATIO
CONF_MPEG4_RESOLUTION
CONF_MPEG4_FIELD_MODE
CONF_MPEG4_DEFAULTS
CONF_MPEG4_I_FRAME_QUANT
CONF_MPEG4_P_FRAME_QUANT
CONF_MPEG4_PARAMS_MAX_NUM
CONF_MPEG4_AVC_I_FRAME_QUANT
CONF_MPEG4_AVC_P_FRAME_QUANT
CONF_MPEG4_AVC_P_FRAME_QUANT_MIN
CONF_MPEG4_AVC_DELTA_IPQUANT
CONF_MPEG4_AVC_QUANT_ADJ_BACKGROUND
CONF_MPEG4_AVC_QUANT_ADJ_OBJECTS
CONF_MPEG4_AVC_DEBLOCKING_ENABLE
CONF_MPEG4_AVC_DEBLOCKING_ALPHA
CONF_MPEG4_AVC_DEBLOCKING_BETA
CONF_MPEG4_AVC_CHROMA_QUANT_OFF
CONF_MPEG4_AVC_CODING_MODE
CONF_MPEG4_AVC_GOP_STRUCTURE
CONF_MPEG4_AVC_CABAC
CONF_VIDEO_BITRATE_AVERAGING_PERIOD
CONF_VIDEO_QUALITY
CONF_JPEG_BANDWIDTH_KBPS
CONF_JPEG_BANDWIDTH_KBPS_SOFT_LIMIT
CONF_JPEG_BANDWIDTH_KBPS_HARD_LIMIT
CONF_VID_ENCODER_ON
CONF_VIDEO_ENCODER_STATUS
CONF_VIDEO_ENCODER_STATUS_EXT
CONF_VIDEO_ENCODER_ENCODED_BYTES
CONF_ENC_GET_SPS_AND_PPS
CONF_ENC_CURRENT_RESOLUTION
CONF_ENC_PROFILE_BASIC_PARAMS
CONF_ROI
Select region of interest. The Session-ID identifies the video coder.
Payload Structure
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
Payload Structure
enable
Values:
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_DPTZ_DYNAMIC_CAPS
CONF_FLIP_MIRROR
CONF_VCA_SHAPES
CONF_ENC_STAMPING_PROPERTIES
Payload Structure
UTF16CharsPerLine
UTF16 chars per line
CamNameLines
Number of stamping lines available at CONF_CAMNAME_LINES
AlarmStampingLines
Number of alarm stamping lines
TimeStampSupport
1 time stamping support
TimeStampRes
Time stamp resolution, 1 also ms stamping is supported
TranspStampSupport
1 transparent stamping is supported
reserved
Reserved
CONF_NAME_STAMP_VAL
CONF_TIME_STAMP_VAL
CONF_TIME_STAMP_RESOLUTION
CONF_ALARM_DISP_VAL
CONF_ALARM_STRING
CONF_INFO_STAMP_VAL
CONF_STAMP_ATTR_NAME
Payload Structure
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 must be written as 0
attributes: (Use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
Values:
CONF_STAMP_ATTR_TIME
Payload Structure
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 must be written as 0
attributes: (Use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
Values:
CONF_STAMP_ATTR_ALARM
Payload Structure
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 must be written as 0
attributes: (Use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
Values:
CONF_STAMP_ATTR_INFO
Payload Structure
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 must be written as 0
attributes: (Use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
Values:
CONF_STAMP_WIDTH
Payload Structure
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:
Width
Width of the stamping in pixels (hex)
CONF_VIDEO_CURRENT_PARAMS_CODNBR
CONF_MAX_NBR_OF_ENC_STREAMS
CONF_WATERMARK
CONF_CODER_VIDEO_OPERATION_MODE
CONF_CODER_VIDEO_OPERATION_OPTION
CONF_VIDEO_H264_ENC_CONFIG
CONF_VIDEO_H264_ENC_CONFIG_DEFAULTS
CONF_VIDEO_H264_ENC_CONFIG_BULK
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS
CONF_VIDEO_H264_ENC_CURRENT_PROFILE
CONF_JPEG_STREAM_SETUP
CONF_TCP_RATE_CONTROL
CONF_TCP_BANDWIDTH_CHECK
CONF_TCP_BANDWIDTH_CHECK_RESULT
CONF_SEI_ENABLE
CONF_PIC_INFO
CONF_REQ_FAST_UPDATE
CONF_MPEG4_INTRA_FRAME_REQUEST
CONF_LOW_LIGHT_MIN_FPS
CONF_VID_IN_CONTRAST
CONF_VID_IN_SATURATION
CONF_VID_IN_BRIGHTNESS
CONF_VID_IN_SAMPLING_MODE
Payload Structure
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
CONF_VID_IN_RGB_GAIN
CONF_VID_IN_MIRROR
CONF_VIDEO_TERMINATION_RESISTOR_ON
CONF_VIDEO_TERMINATION_RESISTOR_OFF
CONF_VIDEO_INPUT_FORMAT
CONF_VIDEO_INPUT_FORMAT_EX
CONF_VIDEO_INPUT_FORMAT_EX_OPTIONS
CONF_INPUT_SOURCE_VAL
CONF_NBR_OF_VIDEO_IN
CONF_PRIV_MSK
CONF_VIDEO_STATIC_SCENE_REGIONS
Payload Structure
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
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:
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:
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).
CONF_VIN_BASE_FRAMERATE
CONF_ILLUMINATION_MODE
CONF_MAINS_FREQUENCY
CONF_VIDEO_OUT_STANDARD
CONF_VIDEO_OUT_STANDARD_FORCE
CONF_VIDEO_OUT_CROPPING
CONF_VIDEO_OUT_DISPLAY_FORMAT
CONF_MONITOR_NAME
CONF_VID_DECODER_ON
CONF_LOGO
CONF_DEC_SHOW_FREEZE
CONF_DECODER_MODE
CONF_DECODER_LAYOUT_LIST
CONF_DECODER_LAYOUT
CONF_VIDEO_OUT_STANDARD_SPEC
Payload Structure
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:
vsync mode
polarity of vertical sync signal
Values:
sync signals
Values:
reserved
reserved for future extensions
Notes
In order to be selectable via CONV_VIDEO_OUT_STANDARD or
CONV_VIDEO_OUT_CURRENT_SPEC, the corresponding parameters must
comply with the currently active output device limits (see
CONF_VIDEO_OUT_MONITOR_SPEC).
The resulting scan line frequency can be calculated by:
f_hsync = pixelClock / (width+border_lft+border_rgt+retrace_width)
The resulting vertical refresh frequency can be calculated by
f_vsync=f_hsync/(height+border_top+border_bot+retrace_height)
Negative values for sync_start and/or vsync_start are not guaranteed
to work.
Depending on the hardware, the actual border colour may be different from the selected one and even different between the border around the active screen and the border between the subscreens in split screen mode.
Not all sync mode combinations are supported by the hardware.
The values returned on read may be different from the values set
via the last write access, even if the supplied values are within
the range supported by the output display as configured via
CONF_VIDEO_OUT_MONITOR_SPEC.
CONF_VIDEO_OUT_CURRENT_SPEC
Payload Structure
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:
vsync mode
polarity of vertical sync signal
Values:
sync signals
Values:
reserved
reserved for future extensions
Notes
In order to be selectable via CONV_VIDEO_OUT_STANDARD or
CONV_VIDEO_OUT_CURRENT_SPEC, the corresponding parameters must
comply with the currently active output device limits (see
CONF_VIDEO_OUT_MONITOR_SPEC).
The resulting scan line frequency can be calculated by:
f_hsync = pixelClock / (width+border_lft+border_rgt+retrace_width)
The resulting vertical refresh frequency can be calculated by
f_vsync=f_hsync/(height+border_top+border_bot+retrace_height)
Negative values for sync_start and/or vsync_start are not guaranteed
to work.
Depending on the hardware, the actual border colour may be different from the selected one and even different between the border around the active screen and the border between the subscreens in split screen mode.
Not all sync mode combinations are supported by the hardware.
The values returned on read may be different from the values set
via the last write access, even if the supplied values are within
the range supported by the output display as configured via
CONF_VIDEO_OUT_MONITOR_SPEC.
CONF_VIDEO_OUT_MONITOR_SPEC
Payload Structure
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:
compSync
bitmask of supported composite sync
signals:
Values:
sepSync
bitmask of supported separate sync signals:
Values:
reserved
reserved for future extensions
Notes
In addition to the specified limits, default modes corresponding
to the respective physical connector (e.g. standard VGA timing
on a VGA connector, PAL/NTSC on BNC) are typically also assumed
to be supported by the display device. The device will only allow
video output timings (see CONF_VIDEO_OUT_CURRENT_SPEC,
CONF_VIDEO_OUT_STANDARD) within these limits and may use the
mentioned default timings as fallback values.
CONF_VIDEO_OUT_OVERSCAN
CONF_DECODED_FRAMES
CONF_NBR_OF_VIDEO_OUT
CONF_DECODER_DELAY
CONF_DECODING_ERROR
Payload Structure
ID
Values:
CONF_STAMP_ATTR_DEC_FREEZE
CONF_STAMP_DEC_FREEZE_STRING
CONF_STAMP_ATTR_NO_LINK
CONF_STAMP_NO_LINK_STRING
CONF_ENABLE_OSD
CONF_OSD_ACCESS
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!).
Payload Structure
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
len
Length of the complete payload in bytes. Maximum length is 64 bytes.
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:
flags
Values:
String 1 - N
The string value which should be displayed
CONF_OSD_POS
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
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)
Payload Structure (reply)
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
CONF_AUDIO_OUTPUT_LEVEL
CONF_AUDIO_ON_OFF
CONF_AUDIO_STARTUP_SOUND
CONF_AUDIO_INPUT
CONF_AUDIO_OUTPUT
CONF_AUDIO_INPUT_MAX
CONF_AUDIO_OUTPUT_MAX
CONF_AUDIO_MIC_LEVEL
CONF_AUDIO_MIC_MAX
CONF_AUDIO_LOUDSPEAKER_ON_OFF
CONF_AUDIO_OPTIONS
CONF_AUDIO_INPUT_PEEK
CONF_AUDIO_OUTPUT_PEEK
CONF_NBR_OF_AUDIO_OUT
CONF_NBR_OF_AUDIO_IN
CONF_ALARM_INPUT_LH_VAL
CONF_INPUT_PIN_NAME
CONF_ALARM_INPUT_SUPERVISED
CONF_VCD_OPERATOR_PARAMS
CONF_VIPROC_RE_TASK_NAMES
This command reads out the task names of the current configured rule engine.
Response Structure
Algorithm type
Number of tasks
Number of configured user tasks.
Task id
Id of the user task. Defines the alarm bit of the CONF_VIPROC_ALARM message.
Task type
Task name
The task name is UTF8 encoded and maximal 64 byte.
This command adds or deletes or replaces tasks of the rule engine script. The read command reads all tasks contained in the script (also inactive tasks).
The write command adds tasks which are not already included in the script and replaces tasks whose task id is already defined in the script.
If a rule cannot be established, e.g. because of an already existing task id or something else, the command returns with an error.
The command applies always on the active configuration. A VCA profil has to be loaded (see CONF_VIPROC_MODE).
Payload Structure
Task ID
Unique ID that identifies the tasks and defines the alarm flag in the message CONF_VIPROC_ALARM which will be triggered when this task has been hit.
Flags
Length
Length of task description starting with rule id. This length allows to skip the task when reading.
Rule ID
The rule id selects the rule which will be established.
These rules are supported at the moment:
Geometric Primitive ID
The Geometric Primitive ID defines to which geometric primitive (field or line or route) the task refers to. For line crossing
and following route a geometric primitive has to be assigned. The tasks Inside Field, Flow in Field, and Motion in Field
accepts 0xFFFF for the geometric primitive id. This has the meaning that the detector is applied over the whole screen.
reserved
Reserved fields should be set to zero.
Task Name Length
The length of the task name is given in bytes. Termination is included.
Task Name
The task name is stored in utf-8 encoding. The maximal length of the task name is 64 bytes.
Option
Additionally options can be added to a task. The options are tag based.
Table of supported options.
Activity
The activity options defines a range between 0 and 100 percent.
Direction
The direction option is given in degrees. The maximum diretion has to greater than the minimum direction. E.g. Direction(315,405) is valid and Direction(315,45) is invalid.
Size
The size option is in precentage of the image size and is stored in one byte.
CONF_VIPROC_RE_SUPPORTED_TASKS
This command reads/writes geometric primitives (e.g. line or field) from/to the rule engine script.
The read command returns all currently set geometric primitves. The write command adds or deletes or replaces a list
of geometric components. The reply of the write command contains a list of all currently set geometric primitives.
The command applies always on the active configuration. A VCA profil has to be loaded (see CONF_VIPROC_MODE).
Response Structure
Supported Geometric Primitive Types
Flags
Length
This is the length of the following geometric primitive description in bytes (including Geometric Primitive ID and Debounce Time).
Geometric Primitive ID
THe Geometric Primitive ID is used to reference this geometric primitive within tasks.
Each geometric primitive type has its own ID counting, e.g. there may be a line with ID 1 and a field with ID 1.
Debounce Time
Each Geometric Primitive has a debounce time. The debounce time is specified in units of 1/256 seconds.
However, not all Geometric Primitives make use of the debounce time (e.g. route). In this case the
debounce time shall be set to zero.
Geometric Primitive Description
The Geometric Primitive Description comprises a detailed description of the specified geometric primitive type.
These descriptions are shown in detail below. If the deletion flag is set this description can be omitted.
Field
Field ID
Identification number of the field which can be referenced in rules.
Debounce time
Inside mode
inside_mode specifies which part of an object must lie in the area. The value is a bitwise ORed combination of the
following values representing the object points:
Area mode
area_mode specifies when the event is triggered. The value is a bitwise ORed combination of the following values:
reserved
shall be zero.
Num of Vertices
Number of vertices specifies how many vertices the polygon specifying the image area has.
vertex_x[ i ] and vertex_y[ i ]
vertex_x[ i ] and vertex_y[ i ] are the positions of the vertices of the polygon. The coordinates are normalized to 0x8000, i.e. (0,0) is the upper left corner of the image
and (0x8000,0x8000) is the lower right corner of the image.
Line
Direction mode
Direction_mode specifies the directions for which an event is triggered. If the direction_mode is 0, any crossing is reported.
If the direction_mode is 1, only crossings from left to right are reported. If the direction_mode is 2, only crossings from
right to left are reported.
reserved
shall be zero.
Num of Vertices
This value specifies the number of vertices of the polyline. The current rule engine delivered with firmware 3.0 accepts only
simple lines with 2 vertices.
vertex_x[ i ] and vertex_y[ i ]
vertex_x[ i ] and vertex_y[ i ] are the positions of the vertices of the polygon. The coordinates
are normalized to 0x8000, i.e. (0,0) is the upper left corner of the image
and (0x8000,0x8000) is the lower right corner of the image.
Route
Direction Mode
The Direction Mode specifies the directions which accepted by the detector. If the direction_mode is 0, any object movement
within the route is accepted. If the direction_mode is 1, only movements from the first vertex towards the last vertex
are accepted. If the direction_mode is 2, only movements from the last vertex towards the first vertex are accepted.
Max Gap
The maximum gap specifies the largest gap between two visited parts of the route before the object is accepted by the detector.
Min Percentage
The minimum percentage specifies how much of the route an object must have visited before the object is accepted by the detector.
Num of Vertices
Number of vertices specifies the number of vertices of the route. The current rule engine accepts up to 8 vertices.
vertex_x[ i ] and vertex_y[ i ]
vertex_x[ i ] and vertex_y[ i ] are the positions of the vertices of the polygon. The coordinates are normalized
to 0x8000, i.e. (0,0) is the upper left corner of the image and (0x8000,0x8000) is the lower right corner of the image.
vertex_d[ i ]
vertex_d[ i ] is the width of the route at vertex i. This value is normalized in respect to the image width.
A value 0x8000 means a distance of the image width. E.g. 0x4000 is half the image width.
CONF_VIPROC_RE_SUPPORTED_GEO_PRIMITIVES
CONF_CAMERA_MOTION_ALARM_VAL
CONF_ALARM_CONNECT_TO_IP_STR
CONF_ALARM_CONNECT_TO_IP
CONF_NBR_OF_ALTERNATIVE_ALARM_IPS
CONF_AUTO_DISCONNECT_TIME
CONF_DEFAULT_CONNECTION_MODE
CONF_STD_MEDIA_CONNECTION_DIRECTION
CONF_STD_MEDIA_ENCAPSULATION_PROTOKOL
CONF_DEFAULT_CAM
CONF_ALARM_CONNECTION_DESTINATION_PORT
CONF_ALARM_CONNECTION_USE_SSL
CONF_CONNECT_URL
CONF_VIDEO_ALARM_STATE
CONF_INPUT_PIN_STATE
CONF_MOTION_ALARM_STATE
CONF_RELAY_OUTPUT_STATE
CONF_NBR_OF_ALARM_IN
CONF_NBR_OF_ALARM_OUT
CONF_NBR_OF_MOTION_DETECTORS
CONF_HD_MGR_SIGNAL_ALARM
CONF_VIRTUAL_ALARM_STATE
CONF_SET_VIRTUAL_ALARM_ID
CONF_NBR_OF_VIRTUAL_ALARMS
CONF_MANIPULATION_ALARM_STATE
CONF_NBR_OF_MANIPULATION_ALARMS
CONF_VIRTUAL_ALARM_PARAMETER
Payload Structure
flags
Flags:
alarm content handle
handle for the alarm(required for deactivation or retrigger, returned in reply on activation) non zero value or zero for wild card in case of deactivate
pre alarm time
pre alarm time in seconds
post alarm time
post alarm time in seconds
user data len
length in bytes of the following user data, max 4000 bytes
user data
user data which will be recorded repeatedly, as long as the alarm is aktive or while within the post alarm time of the alarm
VIRTUAL_ALARM_PARAMETER
This command is used to trigger a virtual alarm along with parameters for alarm recording. The alarm can be activated, deactivated or triggered as single shot, which is an activate and deactivate within on command. Its also possible to trigger a silent alarm, by setting the activate and deactivate flag to zero. This works like a single shot alarm, the user data will be recorded and backups between the recordings will be scheduled, but the virtual alarm won't be triggered. If silent alarm is used, the num parameter doesn't choose the virtual alarm number, but it is mapped directly to the recording line. The command can have user data which can be recorded as meta data along to the video data. Also the pre and post alarm time can be specified but is only valid, if the alarm recording is done via backuped recording setup and the Flag ALARM_IGNORE_ALARM_TIME_PARAMETER isn't set. This will cause an alarm backup from the recording (primary or secondary, depending on the virtual alarm configuration and encoder index configuration) with this parameter, but the pre alarm time is limited by the max pre alarm time which is the same as the configured prealarm time of the secondary recording on the internal storage. It is also limited by the storage space of the internal storage. The max pre alarm time is also the delay for the recording. That means the recording of the alarm file triggered by an alarm will be started after this delay expires. Until that time the records of that file are only available on the internal storage. When a new alarm is triggered by activate, the reply returns an alarm content handle (only on activation, not on single shot). The limit for open content handle at the same time per line (includes also deactivated alarms or alarm shots within the post alarm time) is 32. This handle can be used to deactivate the alarm later by sending this command with the handle in the payload or it can be used to retrigger the alarm with new user data. For retrigger the playload looks the same as for activate, except a valid handle is required. Only for deactivation or retrigger of the alarm, the handle is required for in payload. A valid handle is a non zero handle, if the handle is set to zero, it will be interpreted as wild card on deactivate, which will deactivate/close all active handles or as invalid. In case of activate, a new handle will be opened and returned in the reply, if the handle is invalid/zero. If a handle(or all handles) will be deactivated/closed, it will decay with the post alarm time. An alarm can also used on first activation to add the "protected" attribute to the file, which includes the record data of the alarm. The limit for pending intervals for protection are limited to 32 per line. Pending is an interval in the time from the occurence of the protecting alarm and the backup of the alarm record data.
CONF_PIR_SENSITIVITY
CONF_PIR_STATUS
CONF_RELAIS_NAME
CONF_RELAIS_SWITCH
CONF_SERIAL_PORT_APP_VAL
CONF_SERIAL_PORT_RATE
CONF_SERIAL_PORT_BITS
CONF_SERIAL_PORT_STBITS
CONF_SERIAL_PORT_PAR
CONF_SERIAL_PORT_MODE_VAL
CONF_SERIAL_PORT_HD_MODE_VAL
CONF_SERIAL_PORT_HANDSHAKE
CONF_SERIAL_ACTS_ACCESS_RIGHTS
CONF_BICOM_COMMAND
Bicom message over RCP command
Payload Structure
Without Lease Time
With Lease Time
Flags
Transmission-Flags
Values:
Lease time
Time period in seconds the access should be blocked for other clients.
NOTE: this field has to be signaled in little endian mode.
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)
Operation
See BICOM application documentation
Values:
Bicom Payload
Bicom Payload
Example
RCP Request
RCP Reply
Bicom event over RCP message
Payload Structure
Bicom Server ID
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:
Bicom Payload
Bicom Payload
Example
RCP message
CONF_BICOM_SRV_CONNECTED
CONF_BICOM_UPLOAD_PACKET
CONF_BICOM_SUBCOMPONENTS_LIST
CONF_KBD_CONFIG_CAMERA
Payload Structure
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
Payload Structure
IP
Decoder/Monitor IP
Line
Video output line
Coder
Relative coder number (relative to line)
CONF_KBD_CONNECT_PARAMS
Payload Structure
Flags (optional)
Values:
CONF_KBD_PASSWORD_CAMERA
CONF_KBD_PASSWORD
CONF_KBD_CONFIG_SALVO
Payload Structure
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
CONF_KBD_SET_ALARM
CONF_MAC_ADDRESS
CONF_IP
CONF_IP_STR
CONF_SUBNET
CONF_SUBNET_STR
CONF_GATEWAY_IP_V6_STRING
CONF_IP_V6_PREFIX_LEN
CONF_IP_V6_STR
CONF_STATELESS_IP_V6_PREFIX_LEN
CONF_STATELESS_IP_V6_STR
CONF_GATEWAY_IP_STR
CONF_DNS_SERVER_IP
CONF_DNS_SERVER_IP_STRING
CONF_ETH_LINK
CONF_ETH_LINK_STATUS
CONF_ETH_LINK_TROUGHPUT
CONF_ETH_TX_PKT_BURST
CONF_NBR_OF_EXT_ETH_PORTS
CONF_NBR_OF_EXT_ETH_COPPER_PORTS
CONF_NBR_OF_EXT_ETH_FIBER_PORTS
CONF_ENABLE_TRAFFIC_LED
CONF_SND_MSS
CONF_SND_MSS_ISCSI
CONF_EAP_IDENTITY
CONF_EAP_ENABLE
CONF_EAP_PASSWORD
CONF_SWITCH_TRUNKING
CONF_SWITCH_LACP_ENABLE
CONF_SWITCH_LACP_KEY
CONF_SWITCH_RSTP_PRIO
CONF_SWITCH_RSTP_HELLO_TIME
CONF_SWITCH_RSTP_MAX_AGE
CONF_SWITCH_RSTP_FWD_DELAY
CONF_SWITCH_RSTP_VERSION
CONF_SWITCH_RSTP_PORT_ENABLE
CONF_SWITCH_RSTP_PORT_EDGE
CONF_SWITCH_RSTP_PORT_PATHCOST
CONF_BACKPLANE_TYPE
CONF_BACKPLANE_FW_VERSION
CONF_SWITCH_IGMP_IP
CONF_SWITCH_IGMP_SNOOPING_ENABLE
CONF_SWITCH_MAC_IS_SET
CONF_REBOOT_SWITCH
CONF_WLAN_SSID
CONF_WLAN_WPA_PSK
CONF_PORT_FC_MODE
CONF_WLAN_SCAN
Payload Structure
Sequence of:
SSID
Name of Network.
MAC Address
MAC Address of AccessPoint.
Strength
Signal Strength [0;5]
Channel
Channel used by AccessPoint [0; 14]
Flags
Values:
CONF_WLAN_LINK_TEST
CONF_WLAN_OPERATING_MODE
CONF_SWITCH_POST_UPDATE_ACTION
CONF_WLAN_REGION_CODE
CONF_WLAN_LINK_QUALITY
CONF_WLAN_WPS_SETUP
CONF_WLAN_WPS_STATUS
CONF_SOCKET_KNOCKER_MODE
CONF_SOCKET_KNOCKER_DESTINATION
Payload Structure
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_SOCKET_KNOCKER_STATUS
Payload Structure
state
current status of socket knocker
Values:
reason
reason for current state
Values:
reserved
reserved for future use.
CONF_FTP_SERVER_PORT
CONF_FTP_PWD
CONF_ACCOUNT_LIST
CONF_ACCOUNTS_CREATE_FOLDER
CONF_ACCOUNTS_DELETE_FOLDER
CONF_FTP_CWD
CONF_FTP_CDUP
CONF_START_CLIENT
CONF_STOP_CLIENT
CONF_FTP_FILE_NAME
CONF_ACCOUNT_LOGIN_TEST
CONF_DIFF_SERV_VAL
CONF_DIFF_SERV_POST_ALARM_TIME
CONF_IPV4_FILTER
CONF_DHCP_INTERNAL_WRITE_IP_SETTINGS
CONF_MULTICAST_GROUP_IP_STR
CONF_MULTICAST_GROUP_IP
CONF_MULTICAST_MPEG4_PORT_STR
CONF_MULTICAST_MPEG4_PORT
CONF_MULTICAST_AUDIO_PORT_STR
CONF_MULTICAST_AUDIO_PORT
CONF_MULTICAST_TTL
CONF_IGMP_VERSION
CONF_STREAMING_VAL
CONF_VIDEO_ENC_STREAMING
CONF_AUDIO_ENC_STREAMING
CONF_START_MULTICAST_STREAMING
CONF_AUDIO_STREAMING_ENCODING
CONF_JOIN_STREAM_NOW
CONF_DYNDNS_SERVER
CONF_DYNDNS_TIMEOUT
CONF_DYNDNS_SERVER_REPLY
CONF_DYNDNS_HOST_NAME
CONF_DYNDNS_USER_NAME
CONF_DYNDNS_PASSWORD
CONF_DYNDNS_ENABLE
CONF_DYNDNS_STATE
Payload Structure
State
the current state of the process of registering the device at dyndns.com
Values:
CONF_DYNDNS_LAST_REGISTER
CONF_DYNDNS_FORCE_REGISTER_NOW
CONF_DYNDNS_PROVIDER
CONF_DYNDNS_STATUS_MAIL_ONOFF
CONF_DYNDNS_MAIL_SMTP_SRV_IP_STR
CONF_DYNDNS_MAIL_SMTP_LOGIN
CONF_DYNDNS_MAIL_SMTP_PASS
CONF_DYNDNS_MAIL_DEST_EMAIL_ADDR
CONF_DYNDNS_MAIL_SENDER_NAME
CONF_DYNDNS_MAIL_TEST_SEND
CONF_AUTODETECT_REPLY_GROUP
CONF_UNSOLICITED_AUTODETECT_REPLY_TIME
CONF_DISCOVER_PORT
CONF_LOCAL_HTTP_PORT
CONF_LOCAL_HTTPS_PORT
CONF_RCP_SERVER_PORT
CONF_TELNET_PORT
CONF_RTSP_PORT
CONF_ENABLE_UPNP
CONF_ENABLE_ONVIF
CONF_GET_RTSP_SESSION_ID
CONF_TCP_FWD
CONF_PREPARE_FOR_RECORDING
Payload Structure
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:
flags
command specific flags
Values:
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
CONF_ADD_REMOTE_DEVICE
Payload Structure
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
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
CONF_UPNP_TCP_FWD
CONF_DHCP_VAL
CONF_DHCP_ON
CONF_DHCP_OFF
CONF_DHCP_STABLE
CONF_DHCP_COMPLIANCY
CONF_SNMP_SRV_PORT
CONF_SNMP_TRAPS_HOST
CONF_SNMP_TRAPS_HOST_STR
CONF_NBR_OF_TRAPS_HOSTS
CONF_SNMP_TRAP_LIST
Payload Structure
Trap Descriptor 1 - N
Sequence of:
RCP Msg Code
The code of the RCP message that is to be forwarded as SNMP trap.
Flags
Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| |||
|
protocol
choose protocol type
Values:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
version
version of the command, current version is 1
connection
connection type
Values:
| |||
| |||
|
manufacturer id
distinguish between bosch cameras and foreign cameras
Values:
| |||
|
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:
| |||
| |||
| |||
| |||
|
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 | % | l_serv | % | |||||||
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
Target Address
Action
Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Payload Structure
Sequence of (max 64):
| 16 | 32 | ||||||||||||||||||||||||||||||
| Target Descriptor 28 Bytes ... |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Target Descriptor
Target Address
See request packet for details.
Action
The value of the request packet. Zero in messages.
Status
Values:
Error
Values:
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:
Session Error
Values:
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
Target Address
The address of the iscsi target. If this field is set to zero, it is used as the default entry for authenticaion.
Type
Values:
Params
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) | |||||||
CONF_ISCSI_MAX_CMD_WND
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0b99 | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | Read the value for the X-com.bosch.MaxCmdWindow key at login phase | |||||||
| Write | t_dword | l_serv | Set the value for the X-com.bosch.MaxCmdWindow key at login phase | |||||||
CONF_HD_MAX_NUMBER_OF_PARTITIONS
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0900 | no | no | ||||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | obsolete | |||||||
| Write | void | l_user | not supported | |||||||
CONF_HD_MAX_SLICES_PER_TRACK
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x090a | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | obsolete | |||||||
| Write | void | l_user | not supported | |||||||
CONF_HD_MAX_ALARM_TRACKS_PER_PARTITION
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0919 | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | obsolete | |||||||
| Write | void | l_user | not supported | |||||||
CONF_HD_PARTITIONS_RECORDING
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x091a | yes (1 - primary recording ,2 - secondary recording) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | list of cams with running recording | |||||||
| Write | void | l_user | not supported | |||||||
CONF_HD_PARTITION_RECORDING
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a03 | yes (cam) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | recording status of cam for primary recording (1 = running, 0 = not running) | |||||||
| Write | t_dword | l_user | not supported | |||||||
CONF_HD_PARTITION_RECORDING_SECONDARY
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a4d | yes (cam) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | recording status of this cam for secondary recording (1 = running, 0 = not running) | |||||||
| Write | t_dword | l_user | not supported | |||||||
CONF_HD_PARTITION_FILE_INFO
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0901 | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | returns a list of files of a replay session (session id needed). This command works for local replay only. See detailed description | |||||||
| Write | void | l_user | not supported | |||||||
Request
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| Start Time 4 Bytes |
|||||||||||||||||||||||||||||||
| Stop Time 4 Bytes |
|||||||||||||||||||||||||||||||
| maxEntries 4 Bytes |
|||||||||||||||||||||||||||||||
| Res 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Start Time
Seconds since 2000
Stop Time
Seconds since 2000
maxEntries
Max Number of entries
Res
reserved
Reply
Payload Structure (sequence of)
| 16 | 32 | ||||||||||||||||||||||||||||||
| Start Time 4 Bytes |
|||||||||||||||||||||||||||||||
| Stop Time 4 Bytes |
|||||||||||||||||||||||||||||||
| Flags 32 Bits |
|||||||||||||||||||||||||||||||
| File ID 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Start Time
Seconds since 2000.
Stop Time
Seconds since 2000.
Flags
Values:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
NOTE: Use this command to get to file information of a replay session. The Session ID paramter must be set (a connect primitive must have been preceded). Recording mode can be time recording (1) or alarm recording (2 and 3), only for command CONF_SPAN_PARTITION_FILE_INFO there are seperagte files for pre (2) and post (3) alarm recording. 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:
| |||
| |||
| |||
|
Storage Type (obsolete)
Values:
| |||
|
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:
| |||
|
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:
| |||
|
month
month of the year
Values:
| |||
| |||
| |||
|
year
year since 2000
Values:
|
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:
| |||
|
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:
| |||
|
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
Upto 10 recording profiles (at least 1) for the camera specified by the num parameter, see detailed description for a recording profile
HD_RECORD_PROFILES
Read/Write upto ten recording profiles (at least one) for a camera, payload upto 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. If less than 10 profiles will be written, the remaining profiles stay unchanged.
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 4 Bit |
cont rec backup 1 Bit |
Back Up Account 2 Bit |
internal used 1 Bit |
profile name 34 Bytes ... |
||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... 32 Bytes | pre alarm time 2 Byte |
||||||||||||||||||||||||||||||
| pre alarm time 2 Byte |
post alarm time 2 Byte |
||||||||||||||||||||||||||||||
| motion alarm 4 Bytes |
|||||||||||||||||||||||||||||||
| alarm input and virtual alarm 4 Bytes |
|||||||||||||||||||||||||||||||
| video loss alarm 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
flags
Flags:
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
|
video preset nr
video preset number used for recording
Values:
| |||
|
post alarm video preset nr
video preset number used for recording after occurence of an alarm
Values:
| |||
|
encoder index
index of the encoder stream starting with 0, index 255 is for the backup output
cont rec backup
only for continuous buffered recording, if set the records will be backuped to the recording, its an alternativ way of configuration to using a backup account of typ record, that way no account is wasted in the configuration
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
max pre alarm time
only relevant for backup recording, it needs to know the max pre alarm time, in other cases it should be set to zero
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. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit 31 <-> Alarm Nbr. 32
alarm input and remote alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit n <-> Alarm Nbr. n for alarm inputs (n = number of input alarms),
Bit (32 - m) <-> Virt. Alarm Nbr. m; ... ... ; Bit 30 <-> Virt. Alarm Nbr. 2; Bit 31 <-> Virt. Alarm Nbr. 1 (reverse order) for virtual alarms caused by rcp command CONF_VIRTUAL_ALARM_STATE (m = number of virt. alarms)
video loss alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit 31 <-> Alarm Nbr. 32
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
Upto 10 recording profiles (at least 1) for the camera 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 upto 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. If less than 10 profiles will be written, the remaining profiles stay unchanged.
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 4 Bit |
cont rec backup 1 Bit |
Back Up Account 2 Bit |
internal used 1 Bit |
profile name 34 Bytes ... |
||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... | |||||||||||||||||||||||||||||||
| ... 32 Bytes | max pre alarm time 2 Byte |
||||||||||||||||||||||||||||||
| 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:
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
|
stream config nr
stream configuration number used for recording
Values:
| |||
| |||
|
post alarm stream config nr
stream configuration used for recording after occurence of an alarm
Values:
| |||
| |||
|
encoder index
index of the encoder stream starting with 0, index 255 is for the backup output
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:
| |||
|
cont rec backup
only for continuous buffered recording, if set the records will be backuped to the recording, its an alternativ way of configuration to using a backup account of typ record, that way no account is wasted in the configuration
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
max pre alarm time
only relevant for backup recording, it needs to know the max pre alarm time, in other cases it should be set to zero
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. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit 31 <-> Alarm Nbr. 32
alarm input and remote alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit n <-> Alarm Nbr. n for alarm inputs (n = number of input alarms),
Bit (32 - m) <-> Virt. Alarm Nbr. m; ... ... ; Bit 30 <-> Virt. Alarm Nbr. 2; Bit 31 <-> Virt. Alarm Nbr. 1 (reverse order) for virtual alarms caused by rcp command CONF_VIRTUAL_ALARM_STATE (m = number of virt. alarms)
video loss alarm
The bits represents the activation. Bit 0 <-> Alarm Nbr. 1; Bit 1 <-> Alarm Nbr. 2; ... ... ; Bit 31 <-> Alarm Nbr. 32
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
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
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
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:
| |||
|
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:
| |||
|
Status
Values:
| |||||
| |||||
| |||||
| |||||
| |||||
|
Error
See error codes of CONF_SPAN_USE_STATUS.
Current Recording Span
The address of the span the camera is recording to.
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) (value >= 1009152000) means maximum, no influence on local recording, only for vrm managed recording. (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 | Description : set the secondary recording retention time for a camera (in seconds) (value >= 1009152000) means maximum, no influence on local recording, only for vrm managed recording. (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:
| |||
|
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:
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
| |||
| |||
|
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 | l_user | 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:
| |||
|
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 | l_user | 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) | |||||||
| Write | - | l_serv | not supported | |||||||
CONF_START_RECORD
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0acc | yes (1 - primary recording, 2 - secondary recording) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | 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) | |||||||
CONF_MANAGING_VRM
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0aeb | yes (1 - primary recording, 2 - secondary recording) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_serv | see detailed description | |||||||
| Write | p_octet | l_serv | see detailed description | |||||||
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:
|
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_REC_BUFFER
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0b8f | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | see detailed description | |||||||
| Write | void | l_serv | not supported | |||||||
In Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| cam 2 Byte |
rec idx 2 Byte |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Reply Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| cam 2 Byte |
rec idx 2 Byte |
||||||||||||||||||||||||||||||
| full buffer bytes 4 Bytes |
|||||||||||||||||||||||||||||||
| allocated buffer bytes 4 Bytes |
|||||||||||||||||||||||||||||||
| min buffer bytes 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
cam
camera starting with 1 (in payload)
rec idx
recording index (in payload)
Values:
| |||
|
full buffer bytes
full amount of buffer in bytes for recording on this device
allocated buffer bytes
actual allocated buffer for this recording
min buffer bytes
the minimum amount of buffer the recording would allocate
CONF_HD_REC_BUFFER
This command gets information about the recording buffer size, it includes the full amount of buffer for all recordings, the allocated, and the minimum amount of buffer of the recording specified by the in payload. The "full buffer bytes" is usually preallocated memory at startup and won't change it's size as long as the device is running and is the same for all recordings (except streaming gateway). The "min buffer bytes" is the amount of buffer the device will at least allocate if running. The "allocated buffer bytes" is the amount of buffer the recording has actually allocated. This value can be higher than "min buffer bytes", if nt all possible recrdings are running. The unused buffer of non running recordings will be used by the running ones. If the recording is deaktivated, the value will be 0. When running, the value wil be usually at least "min buffer bytes", but it can be temporary less than that value, if e.g. the recording was started shortly before and another already running recording has allocated the whole buffer. In that case it could take some time free the buffer by the running recording, so the allocated buffer will increase over the time.
CONF_MAX_GOP_LENGTH_VALUE
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0b9d | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | Read the max gop length for recording | |||||||
| Write | t_dword | l_serv | Set the max gop length for recording, 0 means back to default 60 | |||||||
CONF_ALARM_BACKUP_REC_SPEED_LIMIT
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0bb0 | line (1 ...n) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_user | get the speed limit parameter, see detailed description | |||||||
| Write | p_octet | l_serv | set the speed limit parameter, see detailed description | |||||||
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| speed limit 4 Bytes |
|||||||||||||||||||||||||||||||
| data rate limit 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
speed limit
speed limit in percent (0 to 9999, default 9999)
data rate limit
data rate limit in Kbps (0 - no limit, default 0)
CONF_ALARM_BACKUP_REC_SPEED_LIMIT
This command can be used to limit the data traffic caused by backuped recording per line (num parameter 1 to n). This can be done by limiting the data rate and/or the speed in percent(100 percent means backup speed like replay in normal speed), based on the time information of the video data. The backup can be stopped completly, by sending a speed limit by 0 and continued again by sending a non zero speed later. It cannot be stopped by the data rate, a value of 0 for the data rate means to disable the limit for the data rate. The data rate parameter isn't applied immediately, but when the next backup starts.
CONF_BACKUP_RECORDING_STATUS
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0bb4 | line (1 ...n) | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_user | get the backup recording status, see detailed description | |||||||
| Write | p_octet | l_serv | write not supported, see detailed description | |||||||
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| rec idx life 2 Byte |
rec idx backup 2 Byte |
||||||||||||||||||||||||||||||
| free MB 4 Bytes |
|||||||||||||||||||||||||||||||
| backuped MB 4 Bytes |
|||||||||||||||||||||||||||||||
| unbackuped MB 4 Bytes |
|||||||||||||||||||||||||||||||
| lost counter 4 Bytes |
|||||||||||||||||||||||||||||||
| msg trigger 1 Byte |
reserved 3 Byte |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
rec idx life
Recording index of the recording, which is configured for life data recording (0 - none,1 - primary, 2 - secondary)
rec idx backup
Recording index of the recording, which is configured for data backup of the life data recording (0 - none,1 - primary, 2 - secondary)
free MB
Free Storage space in MB for the life data recording
backuped MB
Storage space in MB with records of the life data recording for this line, which are already backuped or which are not required to be backuped
unbackuped MB
Storage space in MB with records of the life data recording for this line, which have to be backuped or potentially required to be backuped, because they are in range of the max pre alarm time
lost counter
Counter for events of records, which had to be backuped and that couldn't be backuped, on deleting or overwriting by newer records
msg trigger
reason for sending this status
Values:
| |||||
| |||||
| |||||
|
CONF_BACKUP_RECORDING_STATUS
This command returns the backup recording status on a line, specified by the num parameter (1 ... n). First it looks for a valid configuration of backup recording. Valid means, there exists a running recording configured to record the life data and a second recording for backup, which copies the data from the life data recording storage to it's recording storage on alarm or continuously. If both "rec idx life" and "rec idx backup" are none zero, there is a valid configuration. Then the following fields inform about the status and progress of the backuped recording. The utilization of the life data recording storage can be calculated in percent with the equation: utilization = ("unbackuped MB" * 100)/("unbackuped MB" + "backuped MB" + "free MB"). The status will be send as message, if the utilization will cross some thresholds. There are two thresholds, the "All Clear" threshold and the "Warning" threshold. These thresholds can be configured with the command CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD (see rcp documentation). Another reason for sending this message will be on deleting or overwriting of records, which had to be backuped but weren't backuped before deletion, or were deleted while still within the maximum retention time range. Every time this event happens, the lost counter will be incremented. This counter will count since device boot.
CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0bb5 | line (1 ...n) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_user | get the thresholds, see detailed description | |||||||
| Write | p_octet | l_serv | set the thresholds, see detailed description | |||||||
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| all clear threshold 1 Byte |
warning threshold 1 Byte |
reserved 2 Byte |
|||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
all clear threshold
threshold for all clear in percent
warning threshold
threshold for warning in percent
CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD
This command configures the thresholds for the CONF_BACKUP_RECORDING_STATUS message. The message will be send, when the storage space utilization will cross the "all clear" threshold by changed utilization from higher to lower utilization or when crossing the "warning" threshold by changed utilization from lower to higher utilization.
CONF_BUFFERED_RECORDING_MODE
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0bcd | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_octet | l_user | get the buffered recording mode: 0 off, 1 on | |||||||
| Write | t_octet | l_serv | set the buffered recording mode: 0 off, 1 on, | |||||||
Payload Structure
| Buffered Rec Mode 1 OCTET |
|||||||||||||||||||||||||||||||
| 8 | |||||||||||||||||||||||||||||||
Buffered Rec Mode
| manual configuration | 0 |
| buffered recording configuration mode | 1 |
CONF_BUFFERED_RECORDING_MODE
This command can be used to configure the buffered recording configuration mode. The default is the manual mode, which is used for standard (single/dual) recording or manually configured buffered recording, which means the primary and secondary recording will be setup to do buffered recording. In case of buffered recording configuration mode, the device recording configuration will be changed internally to an buffered recording setup. The recording will then be configured like a single primary recording via recording profiles but internally the configuration is mapped to a coresponding buffered recording setup. When set to this mode, the secondary recording isn't accessable anymore via recording profile configuration (affected comands: CONF_HD_RECORD_PROFILE, CONF_HD_RECORD_PROFILE_V2, CONF_HD_RECORD_PROFILE_SECONDARY, CONF_HD_PROFILE_V2_SECONDARY) and start/stop configuration(affected commands: CONF_START_RECORD, CONF_START_SPAN_RECORD, CONF_HD_MGR_START, CONF_HD_MGR_START_SECONDARY, CONF_HD_MGR_STOP, CONF_HD_MGR_STOP_SECONDARY). When the mode is changed, the actual recording is stopped.
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.
extended payload Structure (optional, instead of above payload structure; for write direction only)
| 16 | 32 | ||||||||||||||||||||||||||||||
| seconds 4 Bytes |
|||||||||||||||||||||||||||||||
| miliseconds 2 Byte |
flags 1 Byte |
payload 1 Byte |
|||||||||||||||||||||||||||||
| conf_roi: hPos 2 Byte |
conf_roi: vPos 2 Byte |
||||||||||||||||||||||||||||||
| conf_roi: hSize 2 Byte |
conf_roi: vSize 2 Byte |
||||||||||||||||||||||||||||||
| reserved 4 Byte |
|||||||||||||||||||||||||||||||
| reserved 4 Byte |
|||||||||||||||||||||||||||||||
| reserved 4 Byte |
|||||||||||||||||||||||||||||||
| reserved 4 Byte |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
seconds
Absolute time in seconds since 1.1.2000 00:00h.
miliseconds
miliseconds
flags
Values:
| ||||
| ||||
|
payload
one payload byte, conntend depends on the flags field
conf_roi
select region of interest hPos,vPos,hSize,vSize (each entry 2 bytes): starting left upper edge, each 2bytes 0..32768, vSize==0 means keep aspect ratio
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 at least 8 bytes and the bytes 5-8 are filled with
the value 0xeeeeeeee the extended event structure is used in the response payload. Payload size with all optional parameters is 12 bytes (see "In Payload").
The response contains a flag field, containing the alarm flags, which give information about the alarm, which are activated at this event or if all alarms went to off state, if no one of the alarm flags were set. the flags also contains the time zone information with sign and number of quarter hours.
In Payload
| 16 | 32 | ||||||||||||||||||||||||||||||
| search begin time 4 Bytes |
|||||||||||||||||||||||||||||||
| special field 4 Bytes |
|||||||||||||||||||||||||||||||
| earliest time 4 Bytes |
|||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
search begin time
Start time of the search in seconds since 2000. The search will procceed into the past.
special field
Optional parameter, if set to 0xeeeeeeee, the reply will contain data in extended event structure format. Any other value has no meaning yet.
earliest time
Optional parameter, Erliest time in seconds since 2000. The search won't search in record files, which lie before that time. The search will be performed on file which lie completely or partialy within the search interval of earliest time and search begin time. If not set, the default will be 0.
Event Time
Seconds since 2000.
Flags
Values:
| |||
| |||
| |||
| |||
| |||
|
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. The origin of the coordinate system
is the upper left corner of the image.
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:
| |||
| |||
|
Maximum Sample Bytes
Values:
|
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.
CONF_HD_REPLAY_VCD_LAYER
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09c8 | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | requested vcd layer 0=no vcd data, 1=layer1 ,2=layer2,..; replay session id required | |||||||
| Write | t_dword | l_user | requested vcd layer 0=no vcd data, 1=layer1 ,2=layer2,..; replay session id required | |||||||
CONF_HD_REPLAY_VCD_CONFIG_ID
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a5f | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | requested vcd config ID 0=all vcd data, 1=config1 data, 2=config2 data,..; replay session id required | |||||||
| Write | t_dword | l_user | requested vcd config 0=all data, 1=config1 data ,2=config2 data,..; replay session id required | |||||||
CONF_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 ruleengine script.
The return payload consists of a unique 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
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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 |
VCA Profile ID 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).
reserved
This value should be set to zero.
Script length
Length of the script. If the length of the script is zero a default search is performed, i.e. "Detect any object or Detect any Flow or Detect any Motion".
Script mode
The mode defines how the configuration data has to interpreted. See detailed description of configuration data for each case below.
| |||
| |||
| |||
|
VCA Profile ID
VCA profile id search is supported. The recommended profile id is zero resulting in an exhausting search over the given interval.
With a non zero profile id the seacrh speed can be increased because meta data recorded with different a profile are skipped.
Layer Mode
The recommended layer mode value is 0. In this case the layer mask is ignored and the default layers are used.
If 1 then the user defined layer mask, see below, is used. The main purpose for the layer mode is for debugging.
Flags
| ||||
| ||||
| ||||
|
Layer Mask
The layer mask is only used if layer mode is set to 1.
Configuration data
The script mode defines how this data has to be interpreted.
Rule engine configuration
In this mode the configuration data contains the whole rule engine configuration (eg including camera calibration).
For more detailed information see the rcp command: CONF_VCD_OPERATOR_PARAMS.
Rule engine script only
If the script mode is selected to "rule engine script only" the configuration data contains the rule engine script. The script is encoded in plain text.
One of these examples can be used as a valid script.
Example 1 ("Any motion/flow/object in Field"):
Example 2 ("Object in Field"):
Example 3 ("Crossing Line"):
Example 4 ("Following Route")
For more details, read the Bosch Query Language Specification.
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 #3 := InsideField #1;
Example 2 ("Object in Field"):
Field #1 := { Point(50, 50) Point(100, 50) Point(100, 100) Point(50, 100) };
external ObjectState #1 := InsideField #1;
external Event #2 := OnSet ObjectState #1;
Example 3 ("Crossing Line"):
Resolution := { Min(-1,-1) Max(1,1) };
Line #1 := { Point(-0.5, -0.5) Point(0.5, 0.5) DebounceTime(0.50) Direction(1) };
external Event#2 := { CrossedLine #1 };
Example 4 ("Following Route")
Route #2 := { Point(41, 117) Distance(5) Point(51, 87) Distance(9) Point(79, 74) Distance(5) Direction(1) MinPercentage(80) MaxGap(10) };
external Event #3 := { FollowedRoute #2 };
For more details, read the Bosch Query Language Specification.
In field search
A field search is define by two normalized points. Each point is normalized between 0 and 65535. The upper left corner of the image has the coordinates (0,0) and the lower right corner (65535,65535). Additionally, debounce time and intersection mode can be addressed.
| 16 | 32 | ||||||||||||||||||||||||||||||
| Upper left x-coordinate 2 Byte |
Upper left y-coordinate 2 Byte |
||||||||||||||||||||||||||||||
| Lower right x-coordinate 2 Byte |
Lower right y-coordinate 2 Byte |
||||||||||||||||||||||||||||||
| Debounce time 2 Byte |
Field flags 2 Byte |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Debounce time
The debounce time is given in units of 10 ms.
Field flags
| ||||
|
Line crossing search
A line crossing search is define by two normalized points. Each point is normalized between 0 and 65535. The upper left corner of the image has the coordinates (0,0) and the lower right corner (65535,65535).
| 16 | 32 | ||||||||||||||||||||||||||||||
| Upper left x-coordinate 2 Byte |
Upper left y-coordinate 2 Byte |
||||||||||||||||||||||||||||||
| Lower right x-coordinate 2 Byte |
Lower right y-coordinate 2 Byte |
||||||||||||||||||||||||||||||
| Debounce time 2 Byte |
Direction 1 Byte |
Reserved 1 Byte |
|||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Debounce time
The debounce time is given in units of 10 ms.
Direction
One can choose whether any object which passes the line triggers an event or whether only objects which pass from left to right respectively right to left are relevant:
| ||||
| ||||
|
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
| 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
| |||
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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
optional field: if that Id is given a autotracker instance will be started that follows the object (used by Transcoder Devices only)
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 periodicallay 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 |
timezone quarter hours 1 Bytes |
reserved 1 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:
| |||
| |||
| |||
| |||
|
Cam
camera
RecIdx
Recording Index
account
the index of the account used for backup (see CONF_ACCOUNT_SETTINGS and CONF_BACKUP). For backup via http the account is set to 0.
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
timezone quarter hours
signed time zone offset in quarter hours
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 | l_serv | 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 | l_serv | format a file system (FAT32) and creates files for the recordings and writes the tools for replay depending on the size of the storage device, returns TRUE if the request could be successfully queued, CONF_FORMAT_FS_STATUS messages report the progress and status about the format | |||||||
CONF_FORMAT_FS_STATUS
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09d1 | yes (file system nr, 1 - recording storage device, 2 - RAMDISK) | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | status and progress of a running format requested by CONF_FORMAT_FS | |||||||
| Write | p_octet | noprot | status and progress of a running format requested by CONF_FORMAT_FS, see detailed description | |||||||
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| step 1 Byte |
status 1 Byte |
progress 2 Byte |
|||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
step
Which step of the formating (FAT32 Formatting including creating recording files or copy replay tools)
Values:
| |||
|
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:
| |||
| |||
| |||
|
progress
value from 0 to 100 represent the progress of the format including copy replay tools in percent.
Values:
|
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:
| |||
|
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
| |||
|
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
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
|
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:
| |||
| |||
|
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:
|
ip
ip of the storage device or lun, that is formatting
target_idx
Target Index of the storage device from 0 to 255.
lun
Lun of the storage device from 0 to max. 255.
reserved
2 Bytes reserved
CONF_FORMAT_FS_SPANS_STATUS
this message reports the status and progress of a running format. The formatting includes the creation of the FAT32 file system (step: HD_STEP_FORMAT_FS) and clearing of the span header files(step: HD_STEP_CLEAR_SPAN_HEADER). The progress is reported about the whole formatting. A successful format should always end with a message with 100 percent progress at step HD_STEP_CLEAR_SPAN_HEADER and status should be HD_FORMAT_STATUS_FINISHED. A failed format should finish with a status HD_FORMAT_STATUS_FAILED at any progress and any step. After these final messages no futher messages will follow. The whole formatting takes two steps HD_STEP_FORMAT_FS and HD_STEP_CLEAR_SPAN_HEADER. First step HD_STEP_FORMAT_FS will run up to 90 percent and will end with a 90 percent progress message and status HD_FORMAT_STATUS_FINISHED if successful. Then the last step HD_STEP_CLEAR_SPAN_HEADER will follow from 90 to 100 percent and will also end with a HD_FORMAT_STATUS_FINISHED status if successfull, which is also as mentioned earlier the final success message.
CONF_SPAN_ADDRESS_LIST
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09e7 | yes (1 - primary spanlist, 2 - secondary spanlist) | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_serv | See detailed description. | |||||||
| Write | p_octet | l_serv | See detailed description. | |||||||
Payload Structure
| Span Address 1 8 Bytes ... |
|||||||||||||||||||||||||||||||
| (n-2) x 8 Bytes | Span Address n 8 Bytes ... |
||||||||||||||||||||||||||||||
Span Address 1 - n
For the structure of a span address so description below.
Server IP
The iSCSI server ip address.
Values:
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
| |||
|
Note: A list of all defined error types can be found in the Appendix.
CONF_SPAN_ADDRESS_LIST_NEW
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a52 | yes (1 - primary spanlist, 2 - secondary spanlist) | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | See detailed description of CONF_SPAN_ADDRESS_LIST | |||||||
| Write | p_octet | l_serv | See detailed description of CONF_SPAN_ADDRESS_LIST (no need to include mounted spans in list) | |||||||
CONF_SPAN_HDR_ACCESS
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09e8 | yes | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_serv | 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:
| |||
|
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 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 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).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Span owner URL
url (ipv4 or ipv6) of the unit that used the span
Modification MAC
Hardware address of the instance, which modifies the unit header (must be non zero for write direction)
User Data
byte field for any user data (16 bytes)
GUID
GUID (managed by vrm) of the device which recorded on this span (32 bytes)
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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 | |||||||
CONF_START_SPAN_RECORD
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09f7 | yes (1 - primary recording, 2 - secondary recording) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | t_dword | noprot | returns the 4 bytes bitmap of span recording for the cameras 4 bytes bitmap (1 : on, 0 : off) for each cam (bit 0 -> cam 1 bit 1 -> cam 2 ...) | |||||||
| Write | p_octet | l_serv | Start span recording on choosen cameras first 4 bytes bitmap (1 : on, 0 : off) for each cam (bit 0 -> cam 1 bit 1 -> cam 2 ...), last 4 bytes bit mask for setting only choosen cameras (bit 0 -> cam 1 bit 1 -> cam 2 ...) | |||||||
CONF_SPAN_PARTITION_PROP
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x09fa | yes (camera) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_serv | 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 | l_serv | 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 | l_serv | 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 | l_serv | 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 | l_serv | 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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
status RELEASE error codes
Values:
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
| |||||
|
status MOUNTED special codes
Values:
| |||
|
CONF_SPAN_USE_STATUS_SECONDARY
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a4a | cam | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | l_serv | 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
Response Structure
For the payload structure of the response see documentation of HD_PARTITION_FILE_INFO.
CONF_EXPORT_SPAN
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a2e | no | yes | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | Retrieve a span of the devices storage. | |||||||
| Write | p_octet | l_serv | not supported | |||||||
Request Payload Structure
| Recording Camera 12 Bytes ... |
|||||||||||||||||||||||||||||||
| Lun Addr 8 Bytes ... |
|||||||||||||||||||||||||||||||
| Reserved 12 Bytes ... |
|||||||||||||||||||||||||||||||
| Overwrite Retention Time 4 Bytes |
|||||||||||||||||||||||||||||||
| Reserved 4 Bytes |
|||||||||||||||||||||||||||||||
| Url max. 128 Bytes |
|||||||||||||||||||||||||||||||
... |
|||||||||||||||||||||||||||||||
Recording Camera
The address of the device the span is assigned to.
IPv4
The ipv4 address of the recording device. If the device hasn't an ipv4 Adress, this field should be set to invalid (zero ip 0.0.0.0). In that case a valid url has to be provided.
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.
THID/IPv4
The ipv4 address or the THID (Target Host ID) 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.
Url
Url of the the device which requests the span as zero terminated ascii string. Max length is 128 bytes including zero termination. This parameter is optional but is requiered if the device doesn't has an ipv4 address or if the IPv4 adress of the Cam id is not used.
Response and Message Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| Recording Camera/Storage Managing Host 12 Bytes ... |
|||||||||||||||||||||||||||||||
| Span Address 8 Bytes ... |
|||||||||||||||||||||||||||||||
| Last Recording 16 Bytes ... |
|||||||||||||||||||||||||||||||
| State 1 Byte |
Reserved 3 Bytes |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Recording Camera
The address of the device the span is assigned to, 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).
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.
THID/IPv4
The THID (Target Host ID) or ipv4 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.
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:
| |||
| |||
| |||
| |||
|
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.
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.
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.
Span Index
The span index in the current lun.
S
The timezone sign.
Timezone
Timezone in quarter hours.
Flags
Values:
Start Time
Seconds since 2000.
Stop Time
Seconds since 2000.
File Count
The number of files that are stored in this span.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CONF_REC_SPAN_MGR
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0a36 | yes (1 - primary recording, 2 - secondary recording) | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | ||||||||
| Write | p_octet | l_serv | ||||||||
Payload Structure
Sequence of (max 8):
| 16 | 32 | ||||||||||||||||||||||||||||||
| Span Mananger IP address 4 Bytes |
|||||||||||||||||||||||||||||||
| Storage IP address 4 Bytes |
|||||||||||||||||||||||||||||||
| Target Index 1 Byte |
Lun 1 Byte |
Reserved 2 Byte |
|||||||||||||||||||||||||||||
| Priority 2 Bytes |
Flags 2 Byte |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
Span Mananger IP address
The IP address of the device the span manager is running on.
Storage IP address
The iSCSI IP address of the storage.
Target Index
The iSCSI target index.
Lun
The iSCSI lun of the storage.
Priority
Priority is NOT SUPPORTED yet!
Flags
Values:
|
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 | obsolete | |||||||
| Write | p_octet | l_serv | obsolete | |||||||
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
recording
select a recording
Values:
| |||
|
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:
|
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:
| |||
|
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:
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
|
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 | l_serv | 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.
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.
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:
|
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.
CONF_HDD_VCD_CACHE_SIZE
| Tag code | NumDes | Message | SNMP Support | |||||||
| 0x0b79 | no | no | no | |||||||
| Datatype | Access Level | Description | ||||||||
| Read | p_octet | noprot | see detailed description | |||||||
| Write | p_octet | l_serv | see detailed description, | |||||||
Payload Structure
| 16 | 32 | ||||||||||||||||||||||||||||||
| line 16 bit |
rec idx 16 bit |
||||||||||||||||||||||||||||||
| lower size limit 16 bit |
upper size limit 16 bit |
||||||||||||||||||||||||||||||
| 8 | 24 | ||||||||||||||||||||||||||||||
line
Line from 1 to n.
rec idx
Rec index: 1 - primary recording, 2 - secondary recording.
lower size limit
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:
| |||
| |||
| |||
| |||
| |||
|
Availability
Values:
| |||
| |||
| |||
|
Access Type
Values:
| |||
| |||
|
IO Error Type
Values:
| |||
| |||
|
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, SPAN FILES = 12, SD NOT INSERTED = 14, CF NOT INSERTED = 15, IMG FILE NOT INSERTED = 16) | |||||||
| 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
Storage Type
The type of the storage.
Values:
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:
Span Manager
Values:
Mgr Status
The status of the span manager in the response packet. Set to zero in the request packet.
Values:
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.
Flags
Values:
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 lun can be write protected. If this state was recognized, the Mgr Status will inform about this state by the value "WRITE PROTECTION". There are three ways for a storage lun to become write protected here. First to configure explicite the storage lun(Span Mgr) to be in read only mode, second by a defect storage lun, which will cause a fall back into a write protection mode, and third if the storage is set physically to write protection (e.g. user moves the lever on the sd card into the write protection position).
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.
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:
| |||
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
|
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:
| |||
| |||
| |||
| |||
|
Error
Values:
| |||
| |||
| |||
| |||
| |||
|
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:
| |||
|
type
type of the source or destination
Values:
| |||
| |||
| |||
|
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:
| |||
| |||
| |||
|
timeout
request timeout in seconds, can be used to tollerate iscsi connection poblems
Values:
| |||
| |||
|
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:
| |||
| |||
|
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:
| |||
| |||
| |||
| |||
|
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 |
| 0x2000 | 0x83 /*GetPresetInfo*/ | BL_USER |
| . | 0x80 /*Store*/ | BL_USER |
| . | 0x81 /*Shot*/ | BL_USER |
| . | 0x83 /*GetPresetInfo*/ | BL_USER |
| 0x2FF0 | 0x80 /*Store*/ | BL_USER |
| 0x2FF0 | 0x81 /*Shot*/ | BL_USER |
| 0x2FF0 | 0x83 /*GetPresetInfo*/ | BL_USER |
CA Server objects
| ObjectID | Operation | Level |
IO Server objects
| ObjectID | Operation | Level |
| 0x0400 | BICOM_OP_EVENT_START | BL_PRIV |
| 0x0400 | 0x71 | BL_PRIV |
| 0x0400 | 0x72 | BL_PRIV |
| 0x0400 | 0x73 | BL_PRIV |
| 0x0400 | 0x74 | BL_PRIV |
| 0x0400 | 0x75 | BL_PRIV |
| 0x0400 | 0x76 | BL_PRIV |
| 0x0400 | 0x77 | BL_PRIV |
| 0x0400 | 0x78 | BL_PRIV |
| 0x0400 | 0x79 | BL_PRIV |
| 0x0400 | 0x7a | BL_PRIV |
| 0x0400 | 0x7b | BL_PRIV |
| 0x0400 | 0x7c | BL_PRIV |
| 0x0400 | 0x7d | BL_PRIV |
| 0x0400 | 0x7e | BL_PRIV |
| 0x0400 | BICOM_OP_EVENT_END | BL_PRIV |
| 0x0410 | BICOM_OP_EVENT_START | BL_PRIV |
| 0x0410 | 0x71 | BL_PRIV |
| 0x0410 | 0x72 | BL_PRIV |
| 0x0410 | 0x73 | BL_PRIV |
| 0x0410 | 0x74 | BL_PRIV |
| 0x0410 | 0x75 | BL_PRIV |
| 0x0410 | 0x76 | BL_PRIV |
| 0x0410 | 0x77 | BL_PRIV |
| 0x0410 | 0x78 | BL_PRIV |
| 0x0410 | 0x79 | BL_PRIV |
| 0x0410 | 0x7a | BL_PRIV |
| 0x0410 | 0x7b | BL_PRIV |
| 0x0410 | 0x7c | BL_PRIV |
| 0x0410 | 0x7d | BL_PRIV |
| 0x0410 | 0x7e | BL_PRIV |
| 0x0410 | BICOM_OP_EVENT_END | BL_PRIV |
| 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 |
| 201-456 | BL_USER |
SET numbers
| Number | Level |
| 1-99 | BL_USER |
| 201-456 | 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:
Storage specific error codes
Span errors
| SPAN_ERROR_INV_SPN_IDX | 0x02 | |
| 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_CONV_REC | 0x0d | |
| SPAN_ERROR_SPAN_REQUEST_FAILED | 0x0e | |
| SPAN_ERROR_SPAN_REQUEST_RETENTION_TIME | 0x0f | |
| SPAN_ERROR_REMOUNT_REFUSED | 0x10 | |
| SPAN_ERROR_OLD_LUN_NFO | 0x20 |
HDD PMM errors
| HD_PMM_ERROR_TIMEOUT | 0x12 | |
| HD_PMM_ERROR_CREATE_FAILED | 0x22 | |
| HD_PMM_ERROR_ACCESS_DENIED | 0x32 | |
| HD_PMM_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 |
ISCSI errors
| ISCSI_ERR_CONNECT | 0x31 | |
| ISCSI_ERR_INV_LUN | 0x33 | |
| 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_MEMORY | 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_TARGET_NOT_SUPP | 0x40 | |
| ISCSI_ERR_SOCK | 0x5f | |
| ISCSI_ERR_TARG_PM | 0x6f | |
| ISCSI_SOCK_CLOSED | 0x7f | |
| ISCSI_ERR_TCP_CONN_RESET | 0x8f | |
| ISCSI_ERR_INTR_NOT_SUPP | 0x9f | |
| ISCSI_ERR_IP_ZERO | 0xa0 | |
| ISCSI_ERR_OUT_OF_RESOURCES | 0xa1 |