|
4) Backup Control Commands
Full Backup Command
A) BACKUP_ALL
Feature: Customize full backup from a specific memory card folder to a specific hard drive folder.
Format: BACKUP_ALL <memory card path name> <hard drive path name> <backup preview source> <preview mode> <verification mode> <backup speed>
Parameters:
| Parameters |
Description |
| <memory card path name> |
a memory card folder's absolute path name. It can be the root folder of the memory card |
| <hard drive path name> |
the hard drive folder's absolute path name. It cannot be the root folder of the hard drive |
| |
|
| <backup preview source> |
|
| SOURCE |
preview files from the memory card |
| TARGET |
previews files from the hard drive |
| NONE |
no previews |
| |
|
| <preview mode> |
|
| SINGLE |
display single image previews |
| TILE |
display 60 x 60 pixels image tile previews |
| NONE |
no previews |
| |
|
| <verification mode> |
|
| REALTIME |
perform real time CRC data verification |
| HDD |
compares checksum with hard drive data |
| CARD |
compares checksum with memory card data |
| BOTH |
compares checksum with both hard drive and memory card data |
| |
|
| <backup speed> |
|
| UDMA66 |
high speed backup at 40MB/s |
| HYPER |
low speed backup at 16MB/s |
Return Value:
| Return Value |
Description |
| $BACKUP_RESULT |
if backup is successful, will return "OK"
if not successful, it will return "ERROR" |
| $TRANSFER_SIZE |
the total memory size of files successfully transferred in bytes |
| $TRANSFER_NUMBER |
the total number of files successfully transferred |
| $TRANSFER_TIME |
the total time taken to for the transfer in seconds |
Partial Backup Command
B) CLEAR_FILTER
Feature: Remove the backup filter
Format: CLEAR_FILTER
Parameters: None
Return Value: None
C) SET_FILTER_EXT
Feature: Set a file extension filter. Device will not backup files with unspecified extensions.
Format: SET_FILTER_EXT <extension>
Parameters: <extension> must contain only three characters
Return Value: None
Example: SET_FILTER_EXT CR2
D) SET_FILTER_SIZE
Feature: Set a file size filter. Device will not backup files with file sizes outside the set range.
Format: SET_FILTER_SIZE <file minimum size> <file maximum size>
Parameters: <file minimum size> and <file maximum size> must be in bytes
Return Value: None
Example: SET_FILTER_SIZE1000 5000
E) SET_FILTER_DATE
Feature: Set a file date (year/month/day) filter. Device will not backup files dated outside the set range.
Format: SET_FILTER_DATE <year><start date><end date>
Parameters:
| Parameters |
Description |
| <year> |
YYYY format e.g. 1980~2079 |
| <start date > |
MMDD format |
| <end date > |
MMDD format |
Return Value: None
Example: SET_FILTER_DATE 2009 0101 1231
F) SET_FILTER_TIME
Feature: Set a file time (hour/minute) filter. Device will not backup files timed outside the set range.
Format: SET_FILTER_TIME <start time> <end time>
Parameters: <start time> and <end time> must be in HHMM format
Return Value: None
Example: SET_FILTER_TIME 0000 2359
G) BACKUP_PART
Feature: Perform partial backup based on abovementioned filter settings, from a specific memory card folder to a specific hard drive folder
Format: BACKUP_PART <memory card path name> <hard drive path name> <backup preview source> <preview mode> <verification mode> <backup speed>
Parameters:
| Parameters |
Description |
| <memory card path name> |
a memory card folder's absolute path name. It can be the root folder of the memory card |
| <hard drive path name> |
the hard drive folder's absolute path name. It cannot be the root folder of the hard drive |
| |
|
| <backup preview source> |
|
| SOURCE |
preview files from the memory card |
| TARGET |
previews files from the hard drive |
| NONE |
no previews |
| |
|
| <preview mode> |
|
| SINGLE |
display single image previews |
| TILE |
display 60 x 60 pixels image tile previews |
| NONE |
no previews |
| |
|
| <verification mode> |
|
| REALTIME |
perform real time CRC data verification |
| HDD |
compares checksum with hard drive data |
| CARD |
compares checksum with memory card data |
| BOTH |
compares checksum with both hard drive and memory card data |
| |
|
| <backup speed> |
|
| UDMA66 |
high speed backup at 40MB/s |
| HYPER |
low speed backup at 16MB/s |
Return Value:
| Return Value |
Description |
| $BACKUP_RESULT |
if backup is successful, will return "OK"
if not successful, it will return "ERROR" |
| $TRANSFER_SIZE |
the total memory size of files successfully transferred in bytes |
| $TRANSFER_NUMBER |
the total number of files successfully transferred |
| $TRANSFER_TIME |
the total time taken to for the transfer in seconds |
Incremental Backup Command
A) BACKUP_INC
Feature: Run Incremental Backup Command.
First, system will compare the folders in memory card and external hard disk drive.
Then, it will backup any file or folder that has changed in memory card to the selected folder in external hard disk drive.
Format: BACKUP_INC <memory card path name> <hard drive path name>
<backup preview source> <preview mode> <verification mode> <backup speed>
Parameters:
| Parameters |
Description |
| <memory card path name> |
a memory card folder's absolute path name. It can be the root folder of the memory card |
| <hard drive path name> |
the hard drive folder's absolute path name. It cannot be the root folder of the hard drive |
| |
|
| <backup preview source> |
|
| SOURCE |
preview files from the memory card |
| TARGET |
previews files from the hard drive |
| NONE |
no previews |
| |
|
| <preview mode> |
|
| SINGLE |
display single image previews |
| TILE |
display 60 x 60 pixels image tile previews |
| NONE |
no previews |
| |
|
| <verification mode> |
|
| REALTIME |
perform real time CRC data verification |
| HDD |
compares checksum with hard drive data |
| CARD |
compares checksum with memory card data |
| BOTH |
compares checksum with both hard drive and memory card data |
| |
|
| <backup speed> |
|
| UDMA66 |
high speed backup at 40MB/s |
| HYPER |
low speed backup at 16MB/s |
Return Value:
| Return Value |
Description |
| $BACKUP_RESULT |
if backup is successful, will return "OK"
if not successful, it will return "ERROR" |
| $TRANSFER_SIZE |
the total memory size of files successfully transferred in bytes |
| $TRANSFER_NUMBER |
the total number of files successfully transferred |
| $TRANSFER_TIME |
the total time taken to for the transfer in seconds |
Feature Restriction:
If single folder contains more than 8192 of items, it will stop function.
If needed backup folder is more than 8192, it wil stop function.
Synchronized Command
A) SYNC_ANALYZE
Feature: Run comparison between two folders.
Format: SYNC_ANALYZE <initial folder path name> <appointed folder path name>
Parameters:
| Parameters |
Description |
| <initial folder path name> |
Specific folder path name on internal hard disk drive |
| <appointed folder path name> |
Specific folder path name on memory card or external hard disk drive |
Return Value:
| Return Value |
Description |
| $SYNC_INT2EXT_FILES |
the amount of files in initial folder is more than in appointed folder |
| $SYNC_INT2EXT_SIZE |
the memory size in initial folder is larger than in appointed folder |
| $SYNC_INT2EXT_SECTORS |
the number of sectors in initial folder is more than in appointed folder |
| $SYNC_EXT2INT_FILES |
the number of files in appointed folder is more than in initial folder |
| $SYNC_EXT2INT_SIZE |
the memory size in appointed folder is larger than in initial folder |
| $SYNC_EXT2INT_SECTORS |
the number of sectors in appointed folder is more than in initial folder |
B) SYNC_COPY
Feature: Perform Synchronized Copy.
First, system will run comparison between the folders in memory card and external hard disk drive.
Any changes of file or folder in memory card will be copied to the selected folder in external hard disk drive.
Format: SYNC_COPY<initial folder path name> <appointed folder path name> <
the total number of sectors in synchronized copy> <copy speed>
Parameters
| Parameters |
Description |
| <initial folder path name> |
source of synchronized folder path name |
| <appointed folder path name> |
appointed synchronized folder path name |
| <the total number of sectors in synchronized copy> |
running the total number of sectors in synchronized copy soon |
| <copy speed> |
HYPER: low speed synchronized copy at 16MB/s
UDMA66: high speed synchronized copy at 40MB/s |
Return Value:
| Parameters |
Description |
| $SYNC_RESULT |
if copy is successful, will return "OK"
if not successful, it will return "ERROR" |
| $TRANSFER_SIZE |
the total memory size of file successfully synchronized in bytes |
| $TRANSFER_NUMBER |
the total number of files successfully synchronized |
| $TRANSFER_TIME |
the total time taken to for the synchronized in seconds |
Note:
Please perform SYNC_ANALYZE before running any SYNC_COPYcommand.
Every single command of SYNC_COPY will run one way synchronized copy from "source" to "appointed" folder.
Please check on the references from SYNC BiD LS.SDL for detail information.
If total needed synchronized folders is more than 16384, the feature will stop function.
|