RCP Plus

Reference

(RCP Version 3)

Specification

Transport Protocol

Table Of Contents

Remote Control ProtocolPlus Protocol Header Layout

Tag

Data Type

Version

R/W

C

T

Action

Reserved

Client ID

Session ID

Numeric Descriptor ID

Payload Length

Packetizing in the TCP Stream

Table Of Contents

Version

Reserved

Length

RCP Protocol Procedure

Table Of Contents

Request / Reply

Messages

RCP Errors

RCP over a HTTP tunnel

Table Of Contents

1. Establish a TCP connection to port 80 at your Videjet
2. Send the string "GET /rcp_tunnel HTTP/1.0\r\n\r\n" (as HEX string: 0x47 0x45 0x54 0x20 0x2f 0x72 0x63 0x70 0x5f 0x74 0x75 0x6e 0x6e 0x65 0x6c 0x20 0x48 0x54 0x54 0x50 0x31 0x2e 0x30 0x0d 0x0a 0x0d 0x0a)
3. Proceed in the same manner as a normal RCP connection

Receiving media data

Autodetecting Devices

Table Of Contents

Autodetect Request Header

Sequence Number

Reply Port

Additional information on hardware versions

32-Bit Hardware version Former Scheme

ID

R

FL

Net

Opt

32-Bit Hardware version New Scheme

Esc

R

M

FL

ID

Net

Opt

1st Reply Packet

Sequence Number

Hardware Address

ID

Device IP

Subnet Mask

Gatway IP

Flavor

Connections

ID new

2nd Reply Packet

Optional Extension: Targeting Autodetect Scans at devices matching certain criteria

Scan Extension Identifier

Size

Retrieving thumbnail JPEGs using the Autodetecting Broadcast Mechanism

Format of the request packet of an autodetect based JPEG request

RCP plus protocol header

Autodetect based JPEG Request Header

Sequence Number

Reply Port

MAC list scan extension

Format of the reply packet to an autodetect based JPEG request

RCP plus protocol header

Autodetect based JPEG Request Header

JPEG thumbnail

Setting an IP Address using Broadcast Mechanism

Table Of Contents

Payload Structure (Basic Version IPv4 only)

Hardware Address

Reserved

IP Address

Subnet Mask

Gateway Address

Payload Structure (Extended Version IPv4 and IPv6 settings)

Hardware Address

Version

Ipv6 PrefixLen

IPv4 Address

IPv4 Subnet Mask

Gateway IPv4 Address

IPv6AddrString

IPv6GatewayAddrString

RCP over CGI

Table Of Contents

Command

Data Type

Direction

Num

Payload

• The payload as readable string for payload type P_STRING
• The payload as octet array with no spaces preceeded with 0x for payload type P_OCTET and P_UNICODE
• The payload value in hex or decimal notion for all other payload types

idstring

sessionid

Message handling

Message

CollectMS

MsgDomainID

Authentication

Using http authentication

Using session cookie

IPv6

Request or setting of system or network parameters using Broadcast Mechanism

Table Of Contents

Hardware Address

Command ID

Payload Length

Payload

Extension for RCP+ commands containing IPv6 addresses or host names

Table Of Contents

RCP+ Command with string table

String Table Header

TableLenBytes

Version

Reserved

Num Entries

String Table Entry

Length

Datatype

Reserved

Data

Rules for using the table

• The "StringTable" extension is an option.
• If the RCP-Data contain any IP-Address which current(!) value is other than an IPv4 type then the StringTable option must be used.
• If the RCP-Data does not contain any IP-Address which current(!) value is other than an IPv4 type then the StringTable option should NOT be used to be compatible with older firmware versions and with commands which might not (yet) support this feature.
• If the StringTable is used then:
  1. The string_table_avail flag must be set to 1 in the RCP+ Header
  2. All IP-values within "RCP-Data" must be stored in the string table (also when they are IPv4 values)
  3. The DWORD-field in "RCP-Data" (which normally would store the IPv4 value) has to contain an offset-pointer to the location in the string table where the actual IP-Address-value can be found. Offset has to be calculated from "Head of StringTable Header" to "Head of StringTable Entry Header" in Bytes.
  4. There is only one StringTable allowed in an RCP+ Packet.
  5. The len field of the RCP+ Header must NOT include the size of the StringTable.
  6. The len field of the TPKT Header (Framing Header) MUST include the size of the StringTable. (This means: RCP-Packet and StringTable are both content of the same TPKT Packet)

RCP Command Notification

Table Of Contents

Message payload element

Command Tag

Datatype

Direction

Action

Client ID

NumDes

Count

CONF_ACCOUNT_LIST

Table Of Contents

CONF_ACCOUNT_LOGIN_TEST

Table Of Contents

CONF_ACCOUNT_SETTINGS

Table Of Contents

CONF_ACCOUNT_SETTINGS_V2

Table Of Contents

Payload Structure

Tag-Structure

Length

Tag

Tag 1: ACCOUNT_TAG_TYPE

Tag 2: ACCOUNT_TAG_NAME

Tag 3: ACCOUNT_TAG_URL

Tag 4: ACCOUNT_TAG_LOGIN

Tag 5: ACCOUNT_TAG_PASSWORD

Tag 6: ACCOUNT_TAG_PATH

Tag 7: ACCOUNT_TAG_FLAGS

Tag 8: ACCOUNT_TAG_ACCESS_KEY

Tag 9: ACCOUNT_TAG_SECRET_KEY

Tag 10: ACCOUNT_TAG_BUCKET_NAME

Tag 11: ACCOUNT_TAG_REGION

Tag 12: ACCOUNT_TAG_CAMERA_ID

Tag 13: ACCOUNT_TAG_FILE_DURATION

Tag 14: ACCOUNT_TAG_STREAM_NAME

Tag 15: ACCOUNT_TAG_KBPS

Tag 16: ACCOUNT_TAG_GROUP

Tag 17: ACCOUNT_TAG_CLOUD_WATCH_ENABLED

Tag 18: ACCOUNT_TAG_KMS_ENABLED

Tag 19: ACCOUNT_TAG_KMS_KEY_ID

CONF_ACCOUNT_STATUS

Table Of Contents

CONF_ACCOUNTS_CREATE_FOLDER

Table Of Contents

CONF_ACCOUNTS_DELETE_FOLDER

Table Of Contents

CONF_DROPBOX_AUTH_ADDR

Table Of Contents

CONF_DROPBOX_AUTH_STATUS

Table Of Contents

CONF_DROPBOX_AUTH_V2

Table Of Contents

CONF_DROPBOX_TOKEN_V2

Table Of Contents

CONF_FTP_CDUP

Table Of Contents

CONF_FTP_CWD

Table Of Contents

CONF_FTP_FILE_NAME

Table Of Contents

CONF_FTP_PWD

Table Of Contents

CONF_FTP_SERVER_PORT

Table Of Contents

CONF_NBR_OF_ACCOUNTS

Table Of Contents

CONF_START_CLIENT

Table Of Contents

CONF_STOP_CLIENT

Table Of Contents

CONF_ALARM_INPUT_CAPABILITIES

Table Of Contents

Description

Payload Structure

Count

Capabilities

Supervised

Reserved

CONF_ALARM_INPUT_LH_VAL

Table Of Contents

CONF_ALARM_INPUT_SUPERVISED

Table Of Contents

CONF_EVENT_SCRIPT

Table Of Contents

CONF_HD_MGR_SIGNAL_ALARM

Table Of Contents

CONF_INPUT_PIN_NAME

Table Of Contents

CONF_INPUT_PIN_STATE

Table Of Contents

CONF_MANIPULATION_ALARM_STATE

Table Of Contents

CONF_MOTION_ALARM_STATE

Table Of Contents

CONF_NBR_OF_ALARM_IN

Table Of Contents

CONF_NBR_OF_ALARM_OUT

Table Of Contents

CONF_NBR_OF_MANIPULATION_ALARMS

Table Of Contents

CONF_NBR_OF_MOTION_DETECTORS

Table Of Contents

CONF_NBR_OF_VIRTUAL_ALARMS

Table Of Contents

CONF_SET_VIRTUAL_ALARM_ID

Table Of Contents

CONF_VIDEO_ALARM_STATE

Table Of Contents

CONF_VIRTUAL_ALARM_PARAMETER

Table Of Contents

Description

Payload Structure

flags

alarm content handle

pre alarm time

post alarm time

user data len

user data

CONF_VIRTUAL_ALARM_STATE

Table Of Contents

CONF_ALARM_CONNECT_TO_IP

Table Of Contents

CONF_ALARM_CONNECT_TO_IP_STR

Table Of Contents

CONF_ALARM_CONNECTION_DESTINATION_PORT

Table Of Contents

CONF_ALARM_CONNECTION_USE_SSL

Table Of Contents

CONF_AUTO_DISCONNECT_TIME

Table Of Contents

CONF_CONNECT_URL

Table Of Contents