Technical Users Guide: Float Free 406 S-VDR Memory Capsule
Technical Users Guide: Float Free 406 S-VDR Memory Capsule
VESSEL_____________________________
RLB-35MC
Y1-03-0202
Rev. D
Y1-03-0202 Rev. D
Table of Contents
1. Introduction ............................................................................................................................... 1
2. Specifications ............................................................................................................................. 1
3. Power-Over-Ethernet ............................................................................................................... 2
4. Connecting for Evaluation ....................................................................................................... 3
5. Evaluation Software Program ................................................................................................. 4
5.1. Purpose................................................................................................................................. 4
5.2. Version Compatibility .......................................................................................................... 4
5.3. Setup .................................................................................................................................... 4
5.4. Test ....................................................................................................................................... 5
5.5. Data Upload Mode ............................................................................................................... 6
5.6. Data Download Mode .......................................................................................................... 7
5.7. Ship Configuration ............................................................................................................... 9
5.8. IP Address and Subnet Mask ............................................................................................. 10
6. Communications Command Structure ................................................................................. 11
6.1. Byte Definitions ................................................................................................................. 11
6.2. Header ................................................................................................................................ 12
6.3. Operation Command .......................................................................................................... 12
6.4. Operation Subcommand..................................................................................................... 12
6.5. Reset Write Pointer ............................................................................................................ 13
6.6. CFC Size ............................................................................................................................ 13
6.7. CFC Magnitude .................................................................................................................. 13
6.8. Read Offset ........................................................................................................................ 13
6.9. Error Flags ......................................................................................................................... 13
6.10. Software Version ............................................................................................................. 14
7. Valid Commands ..................................................................................................................... 14
7.1. Write Port 7000:................................................................................................................. 14
7.2. Read Port 7100:.................................................................................................................. 14
7.3. Status Port 7200: ................................................................................................................ 15
8. TCP/IP Communications Data Flow ..................................................................................... 16
9. TCP/IP Communications Data Write Example ................................................................... 17
10. TCP/IP Communications Data Read Examples................................................................. 18
10.1. Data Read All with Read Offset Example ....................................................................... 18
10.2. Data Read All without Read Offset Example .................................................................. 20
10.3. Data Read Example.......................................................................................................... 21
10.4. Read Status Memory Example......................................................................................... 22
11. Ship Configuration................................................................................................................ 23
11.1. Data .................................................................................................................................. 23
11.2. Partition Size .................................................................................................................... 23
11.3. Write Ship Configuration Example ................................................................................. 24
11.4. Read Ship Configuration Example .................................................................................. 25
12. Data Integrity Flags .............................................................................................................. 26
12.1. Bit Definitions .................................................................................................................. 26
12.2. Status Request for Error Flag Word Example ................................................................. 27
12.3. Test Request for Error Flags, CFC Size, and Software Version Example ...................... 28
i Y1-03-0202 Rev. D
13. Change IP Address and Subnet Mask Command Structure ............................................ 29
13.1. Header .............................................................................................................................. 29
13.2. Operation Command ........................................................................................................ 29
13.3. Operation Subcommand................................................................................................... 29
13.4. New IP Address ............................................................................................................... 29
13.5. New Subnet Mask ............................................................................................................ 30
13.6. Setting a New IP Address and Subnet Mask Example .................................................... 31
ii Y1-03-0202 Rev. D
1. Introduction
Power for the capsule is provided over the same Ethernet cable using PoE
(Power over Ethernet). This feature has the advantage in that a separate
power cable is not required.
2. Specifications
1 Y1-03-0202 Rev. D
3. Power-Over-Ethernet
PoE technology brings power, as well as data transfer, to the RLB-35MC via
a standard twisted-pair Ethernet cable. In effect, PoE provides a new
standards-based way for a computer to provide power to a wide variety of
remote equipment in areas where it is physically or financially prohibitive to
offer normal power. The cost savings and reliability improvements involved
in not having to install and maintain power wiring in addition to Ethernet
cabling is especially a key factor onboard ships during an S-VDR installation.
The industry has standardized on the use of 48 VDC as the Injected PoE
voltage. The use of this higher voltage reduces the current flowing through
the CAT5 cable and therefore increases the load capability and increases the
CAT5 cable length limitations.
S-VDR System
+24 VDC
POE Power Injector RLB-35MC Capsule
Power Supply
S-VDR Computer
For evaluation and development, the RLB-35MC kit contains a power supply
which operates from AC power mains 100 250 VAC 50/60 cycle. Also
supplied are two CAT-5 cables for connecting between the power supply and
the RLB-35MC proto assembly. The other RJ-45 cable will connect to the
computer running the evaluation software.
2 Y1-03-0202 Rev. D
4. Connecting for Evaluation
Either the cable between the PC and power supply or the RLB-35MC and
power supply will need to be a CAT-5 cross-over cable. The supplied
green cable included in the kit is a cross-over cable which can be used.
3 Y1-03-0202 Rev. D
5. Evaluation Software Program
5.1. Purpose
The RLB-35MC demo software is for evaluating the RLB-35MC only and
is not meant for use in actual VDR or S-VDR systems.
5.3. Setup
To load the RLB-35MC evaluation software on the testing PC, insert the
software CD and follow the installation instructions. This software uses
4 Y1-03-0202 Rev. D
the Microsoft .NET Framework so it may be necessary to download this
software from the Microsoft website if the test PC does not already
have the Framework software installed. Please note that our demo
software has not been tested on Windows Vista.
5.4. Test
To begin, click the Ping Test Start button and confirm a successful
ping test in the Logging window. If the ping results display a fail
message, communications between the testing PC and the RLB-35MC
has not been established.
Once Ping is working correctly, click the Ping button again to stop the
ping test.
5 Y1-03-0202 Rev. D
Next continue with the Test and the Status buttons and note the
results displayed in the logging text box where the ping results were
listed.
Select menu item Data Upload Mode and note the two options. When
selected a check mark appears to the left of the option.
6 Y1-03-0202 Rev. D
Force RLB-35MC Pointer Reset.
This option will reset the current write location to the beginning of
Main Memory.
Note: To read back the data just written, choose the Download from
beginning of memory to current write location option from the RLB-
35MC Data Receive Setup window, then click the Receive Data
button. See the Demo Data Download Mode Section below.
Writing a File
After the upload mode is selected, click the Send WR Command. The
Send Test File Data can be selected repeatedly to write data to the
Main Memory. Each time this option is selected the user will be
prompted for the name of the file to write to memory. The current
write pointer is advanced each time data is written.
Select menu item Data Download Parameters and note the four
options. When selected a dot appears in the circle to the left of the
option.
Download Megabytes
This option will read a specified number of megabytes of Main Memory.
Enter the number of megabytes to read. The current write address
will be the last address to be read.
7 Y1-03-0202 Rev. D
Download from the beginning of memory to current write location
This option reads the Main Memory area starting at the first address in
the partition and ending at the current write location. This can be
used to read back a compete file when used in conjunction with the
data upload option Force RLB-35MC Pointer Reset.
Reading a File
After the download mode is selected, click the Receive Data button.
Each time this option is selected the user will be prompted for the
name of a file to save the data to.
8 Y1-03-0202 Rev. D
Disconnecting Port 7100
The port is automatically closed by the RLB-35MC after a read.
Change the IP address and/or subnet mask and click the Save button.
The IP address and subnet mask displayed in the lower right corner of
the demo software screen will display the new values. Cycle the
power to the RLB-35MC Memory Board for the new values to take
effect.
10 Y1-03-0202 Rev. D
Forcing the IP Address and Subnet Mask Back to the Default Values
To force the RLB-35MC Memory Board back to its default state with no
user set values in effect and with the default IP address of
192.168.2.100 and subnet mask of 255.255.255.0 reinstated, do the
following:
Operation Subcommand
Operation Command
Software Version
Read Offset LSB
CFC Size MSB
Termination
command
AC 53 CA 35 00 value
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 byte
11 Y1-03-0202 Rev. D
Bytes 0 6, 10, and 11 are part of the command string sent by the
user to the RLB-35MC Memory Board. Bytes 7 9 and 12 14 are
returned by the RLB-35MC Memory Board with the echoed command
string in response to a Test command (E command and 0
subcommand); only bytes 12 and 13 are returned with the command
string in response to a Status command (S command).
6.2. Header
The first four (4) bytes are a fixed value header with hexadecimal
values of AC, 53, CA, 35.
ASCII Hex
Command
Character Value
If main memory, read the read offset specified number MB of data, else
R 0x52
read & return all the data from the specified memory partition.
W 0x57 Write into the specified memory partition
Read all of main memory starting at the specified read offset from the
D 0x44 current write address and ending at the address just before the stating
address
Read main memory from the partitions beginning address to the current
P 0x50
write address
Read all of main memory starting at the partitions beginning address to
F 0x46
the ending address
S 0x53 Request the memory board status
E 0x45 Request the memory board status, CFC size, & software version
ASCII Hex
Definition
Character Value
0 0x30 Test status request
1 0x31 Main memory partition
2 0x32 Configuration memory partition
3 0x33 Status memory partition
12 Y1-03-0202 Rev. D
6.5. Reset Write Pointer
Decimal Hex
Definition
Number Value
Do not reset the current write address pointer of the specified memory
0 0x00
partition.
Reset the current write address pointer of the specified memory partition to
1 0x01
the first address in the partition.
ASCII Hex
Definition
Character Value
G 0x47 Gigabytes
M 0x4D Megabytes
CFC Missing
CFC Data
SDRAM
SRAM
FRAM
FRAM
Spare
Spare
Spare
Spare
Spare
Spare
Spare
Spare
CPU
error flag
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 bit
12 13 byte
Note that all the Error Flags are 0 = PASS and 1 = FAIL except for bit 3, the CFC Missing flag,
where 0 = card present and 1 = card missing.
13 Y1-03-0202 Rev. D
6.10. Software Version
Byte 14 is in ASCII format and indicates the RLB-35MC Memory
Boards software version.
7. Valid Commands
Software Version
Read Offset LSB
CFC Size MSB
Definition
W 1 xx2 001 001 001 001 001 001 001 001 Write received data into main memory starting at the current write address
W 2 001 001 001 001 001 001 001 001 001 Write received data into configuration memory starting at the current write address
1) Dont Cares
2) 0x00 = leave the current write address as is; 0x01 = reset the current write address to the first address in the memory partition
Software Version
Read Offset LSB
CFC Size MSB
Definition
Read main memory starting at the address that is the number of offset MBs behind the current
R 1 001 001 001 001 xx2 xx2 001 001 001
write address and ending at the last address written at the time the command was received.
Read configuration memory starting at the first address and ending at the last address written at
R 2 001 001 001 001 001 001 001 001 001
the time the command was received.
Read status memory starting at the first address and ending at the last address written at the time
R 3 001 001 001 001 001 001 001 001 001
the command was received.
Read all of main memory starting at the address the number of offset MBs ahead of the current
D 1 001 001 001 001 xx3 xx3 001 001 001
write address and ending at the address one less than the read starting address.
Read all of main memory starting at the first address in the partition and ending at the last address
P 1 001 001 001 001 001 001 001 001 001
written at the time the command was received.
Read all of main memory starting at the first address in the partition and ending at the last valid
F 1 001 001 001 001 001 001 001 001 001
address in the partition.
1) Dont Cares
2) Number of MBs of main memory to read behind the current write position
3) Number of MBs offset ahead of the current write position to start reading all of main memory
14 Y1-03-0202 Rev. D
When reading (dumping) all of Main Memory data out of the RLB-35MC
two commands are available. The D command with a 16-bit offset
value represents the number of megabytes ahead of the current
writing position to start reading. For example, if the read offset is 7 MB
and the current write address is 0x2110, the data dump would begin
at 0x2117. All of Main Memorys data would be read ending with the
last read at address 0x2116. If the F command is used the data will
be read back from the first address in the Main Memory partition to the
last address in the partition.
When reading Main Memory data out of the RLB-35MC, an offset value
is made available so that only a portion of the data can be retrieved.
The offset value in this case is the number of megabytes to read. The
read starts at a location the specified number of megabytes behind the
current write position and ends at the write location at the time the
command was received. For example, a download of data that was
stored 14 megabytes ago would be:
Software Version
Read Offset LSB
CFC Size MSB
Definition
S 001 001 001 001 001 001 001 001 001 001 Request the memory board status
E 302 001 001 001 001 001 001 001 001 001 Request the memory board status, CFC size, and software version
1) Dont Cares
2) Must be ASCII zero, 0x30
15 Y1-03-0202 Rev. D
When requesting the RLB-35MC Memory Board status, two commands
are available; both the S and E0 command return the command
with the error flags set as necessary, additionally the E0 command
returns the CFC size and software version.
Client RLB-35MC
Client request a data store in main and sends command
AC,53,CA,35,57,31,00,00,00,00,00,00,00,00,00,00
AC,53,CA,35,57,31,00,00,00,00,00,00,00,00,00,00
16 Y1-03-0202 Rev. D
9. TCP/IP Communications Data Write Example
Start
Command echoed No
back?
Yes
No
End of data?
Yes
Close socket
connection
End
See section 5.3 for how to execute this sequence using our demo software.
17 Y1-03-0202 Rev. D
10. TCP/IP Communications Data Read Examples
10.1. Data Read All with Read Offset Example
Start
Read ALL data from main data partition with a read offset
AC,53,CA,35,44,31,00,00,00,00,00,05,00,00,00,00
Send command
to RLB-35MC
Command echoed No
back?
Yes
No
RLB-35MC closed
socket?
Yes
End
Note that this is the Download ALL capsule data option in the RLB-
35MC Data Receive Setup window, with 5 MB entered as the read
offset.
18 Y1-03-0202 Rev. D
Data read all download with offset example (continued)
Write Read
Pointer Pointer
5Mb Offset
Pointer Advancement
Write Read
Pointer Pointer
Pointers advanced during a
New Data Old Data
read and write condition.
Pointer Advancement
Write Read
Pointer Pointer
Pointers wrap around when
New Data Old Data New Data
reaching top of memory..
Pointer Advancement
Write Read
Pointer Pointer
Read pointer is equal to the
snapshot address at the
New Data Old Data New Data
begin of read. Read exits and
disconnects the port.
Pointer Advancement
19 Y1-03-0202 Rev. D
10.2. Data Read All without Read Offset Example
Start
Read ALL data from main data partition from begin to end.
AC,53,CA,35,46,31,00,00,00,00,00,00,00,00,00,00
Send command
to RLB-35MC
Command echoed No
back?
Yes
No
RLB-35MC closed
socket?
Yes
End
Note that this is the Download the complete memory from start to
end option in the RLB-35MC Data Receive Setup window.
20 Y1-03-0202 Rev. D
10.3. Data Read Example
Start
Command echoed No
back?
Yes
No
Socket closed?
Yes
End
21 Y1-03-0202 Rev. D
10.4. Read Status Memory Example
Start
Send command to
RLB-35MC
Command echoed No
back?
Yes
No
Socket closed?
Yes
End
Note that our demo software does not demonstrate this option.
22 Y1-03-0202 Rev. D
11. Ship Configuration
11.1. Data
An area of data defining the configuration of the S-VDR and the
sensors is written into the final recording medium during
commissioning of the S-VDR. This configuration data is permanently
retained in the final recording and protected from modification other
than by a duly authorized person. Changes to the configuration data
block does not affect the normal recording of the mandatory items.
23 Y1-03-0202 Rev. D
11.3. Write Ship Configuration Example
Start
Command echoed No
back?
Yes
No
End of data?
Yes
Close socket
connection
End
24 Y1-03-0202 Rev. D
11.4. Read Ship Configuration Example
Start
Send command to
RLB-35MC
Command echoed No
back?
Yes
No
Socket closed?
Yes
End
25 Y1-03-0202 Rev. D
12. Data Integrity Flags
12.1. Bit Definitions
Bytes within the command string at offset location 12 and 13 make up
a 16 bit status flag. This 16 bit word can be monitored to determine if
there are any failures or data integrity problems within the RLB-35MC
capsule. If the flag word is at 0x0000, no fail reports have been
detected. A non-zero flag word would mean a failure has been
detected.
RLB-35MC Command Structure
Operational Sub Command
Fixed Command Header
Operation Command
Software Version
Status Flag MSB
Termination
Offset MSB
Offset LSB
(HEX)
The error flags are returned in response to both the S command and
the E command with a 0 subcommand. The CFC size and software
version are also returned for the E command with a 0 subcommand.
0 CPU Test
7 - 15 Not Assigned
26 Y1-03-0202 Rev. D
12.2. Status Request for Error Flag Word Example
Start
No Command echoed
back?
Yes
Yes
Flag Word = 0?
No
RLB-35MC Fail
Close socket
connection
End
Note that the Status button of the demo software demonstrates this
command. The error flags are returned in response to this command.
27 Y1-03-0202 Rev. D
12.3. Test Request for Error Flags, CFC Size, and Software Version Example
Start
No Command echoed
back?
Yes
Yes
Flag Word = 0?
No
RLB-35MC Fail
Close socket
connection
End
Note that the Test button of the demo software demonstrates this
command. The error flags, CFC size, and software version are returned in
response to this command.
28 Y1-03-0202 Rev. D
13. Change IP Address and Subnet Mask Command Structure
The RLB-35MCs IP address and subnet mask can be changed from the
factory set default values of 192.168.2.100 and 255.255.255.0, respectively,
in RLB-35MC Memory Board Software Version B and higher. The command
string is sixteen (16) bytes in length and has the same fixed command
header as the communications command string. The bytes are defined as
seen below:
RLB-35MC Command Structure
Operational Sub Command
Termination
(HEX)
Null
AC 53 CA 35 49 50 xx1 xx1 xx1 xx1 yy2 yy2 yy2 yy2 00 00 Null Termination 0x00
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Byte
1) The new IP address with the MSB of the 4-byte address in byte 6 and the LSB in byte 9
2) The new subnet mask with the MSB of the 4-byte mask in byte 10 and the LSB in byte 13
13.1. Header
The first four (4) bytes are a fixed value header with hexadecimal
values of AC, 53, CA, 35.
Byte
Decimal Notation Hex Notation
Position
6 192 0xC0
7 168 0xA8
8 2 0x02
9 75 0x4B
29 Y1-03-0202 Rev. D
13.5. New Subnet Mask
Bytes 10 13 are the new subnet mask arranged so the MSB of the 4-
byte subnet mask is in byte 10 and the LSB is in byte 13. Below is an
example of a new subnet mask of 255.255.255.252:
Byte
Decimal Notation Hex Notation
Position
10 255 0xFF
11 255 0xFF
12 255 0xFF
13 252 0xFC
Note that the subnet mask should be sent with the IP address even if
only the IP address is being changed.
30 Y1-03-0202 Rev. D
13.6. Setting a New IP Address and Subnet Mask Example
Start
Open socket Set IP Address & Subnet Mask request is on port 7200
Connection on Port
7200
Yes
Command echoed
back?
No
Close socket
connection
End
Note that this is the Configure Capsule IP Address and Subnet Mask option
in our demo software. To make the new settings take effect, cycle power to
the RLB-35MC capsule.
31 Y1-03-0202 Rev. D