File Access

File Access

The file access interface allows access to the cameras file system.

It provides access to the cameras user set files, LUT files and a user definable file.

Usage of the file access features and registers should not be attempted directly. Instead access the file system through the file access interface of the host application.

There are three user set files (UserSetDefault, UserSet0, and UserSet1). The user set files are treated differently than the other files in the system. When uploaded these files modify the user set setting within the camera. If the user set file is from an older version of the camera or a different model, the user sets within the file are converted to the appropriate user sets for the new firmware. The file is then replaced with the updated user set file. If the file contains user sets that are not appropriate for the firmware version on the camera, they are ignored and discarded. If the file has been modified in any way, the file is discarded and regenerated. UserSetDefault is read-only and cannot be modified.

The UserFile1 is a user definable file.

The SerialPort0 is a file that can be transferred via the serial port.

While a file is open within the file access interface, the camera is not able to start acquisition. Also, the FileAccessExecute command is disabled when the camera is in acquisition mode. Care should be taken to not leave any file open within the camera's file system as it disables the start acquisition register without any feedback as to why.

Summary Table

Name	Interface	Access	Visibility	Description
File Selector	IEnumeration	RW	Guru	Selects which file is being operated on. This must be set before performing any file operations.
File Operation Selector	IEnumeration	RW	Guru	Sets operation to execute on the selected file when the execute command is given.
Save File To Camera	IBoolean		Guru
File Operation Execute	ICommand	WO	Guru	This is a command that executes the selected file operation on the selected file.
File Open Mode	IEnumeration	RW	Guru	The mode of the file when it is opened. The file can be opened for reading, writting or both. This must be set before opening the file.
File Access Buffer	IRegister	RW	Guru	Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
File Access Offset	IInteger	RW	Guru	Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.
File Access Length	IInteger	RW	Guru	Controls the Length of the mapping between the device file storage and the FileAccessBuffer.
File Operation Status	IEnumeration	RO	Guru	Represents the file operation execution status.
File Operation Result	IInteger	RO	Guru	Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.
File Size	IInteger	RO	Guru	Represents the size of the selected file in bytes.
File System Command	IEnumeration	RW	Guru	Specifies the low level file system command to execute.
File System Command Execute	ICommand	WO	Guru	This is a command that executes the selected file system command.
File System Command Result	IStringReg

File Access Features

File Selector

Selects which file is being operated on. This must be set before performing any file operations.

Property	Value
Name	FileSelector
Interface	IEnumeration
Access	RW
Visibility	Guru

Enumeration Values
UserSetDefault
UserSet0
UserSet1
UserFile1
InjectedImage
SerialPort0
InferenceNetwork
InferenceLabels

File Operation Selector

Sets operation to execute on the selected file when the execute command is given.

Property	Value
Name	FileOperationSelector
Interface	IEnumeration
Access	RW
Visibility	Guru

Enumeration Values
Open
Close
Read
Write
Delete

Save File To Camera

Property	Value
Name	FileWriteToFlash
Interface	IBoolean
Access
Visibility	Guru

File Operation Execute

This is a command that executes the selected file operation on the selected file.

Property	Value
Name	FileOperationExecute
Interface	ICommand
Access	WO
Visibility	Guru

File Open Mode

The mode of the file when it is opened. The file can be opened for reading, writting or both. This must be set before opening the file.

Property	Value
Name	FileOpenMode
Interface	IEnumeration
Access	RW
Visibility	Guru

Enumeration Values
Read
Write
ReadWrite

File Access Buffer

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

Property	Value
Name	FileAccessBuffer
Interface	IRegister
Access	RW
Visibility	Guru

File Access Offset

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

Property	Value
Name	FileAccessOffset
Interface	IInteger
Access	RW
Unit	B
Visibility	Guru

File Access Length

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

Property	Value
Name	FileAccessLength
Interface	IInteger
Access	RW
Unit	B
Visibility	Guru

File Operation Status

Represents the file operation execution status.

Property	Value
Name	FileOperationStatus
Interface	IEnumeration
Access	RO
Visibility	Guru

Enumeration Values
Success
Failure
Overflow

File Operation Result

Represents the file operation result. For Read or Write operations, the number of successfully read/written bytes is returned.

Property	Value
Name	FileOperationResult
Interface	IInteger
Access	RO
Unit
Visibility	Guru

File Size

Represents the size of the selected file in bytes.

Property	Value
Name	FileSize
Interface	IInteger
Access	RO
Unit	B
Visibility	Guru

File System Command

Specifies the low level file system command to execute.

Property	Value
Name	FileSystemCommand
Interface	IEnumeration
Access	RW
Visibility	Guru

Enumeration Values
NoCommand
SaveDdrToFlash

File System Command Execute

This is a command that executes the selected file system command.

Property	Value
Name	FileSystemCommandExecute
Interface	ICommand
Access	WO
Visibility	Guru

File System Command Result

Property	Value
Name	FileSystemCommandResult
Interface	IStringReg
Access
Visibility