File Access Control

Name

FileSelector

Standard

Description

Select a file to read/write.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

NoFile

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Description

NoFile

No file selected

Bitstream

Enables bitstream access

Application

Enables application access

Xml

Enables GenICam XML access

DSNULUT1

Enables DSNU LUT 1 access¹

DSNULUT2

Enables DSNU LUT 2 access¹

PRNULUT1

Enables PRNU LUT 1 access¹

PRNULUT2

Enables PRNU LUT 2 access¹

SensorFile

Enables Sensor File access

GammaLUT

Enables Gamma LUT access

UserSet1

Enables User set 1 access

UserSet2

Enables User set 2 access

UserSet3

Enables User set 3 access

UserSet4

Enables User set 4 access

UserSet5

Enables User set 5 access

UserSet6

Enables User set 6 access

UserSet7

Enables User set 7 access

UserSet8

Enables User set 8 access

LightCtrlSet1

Enables Light controller set 1 access (Not for allPIXA Evo)

PackageDescriptionFile

Enables Package Description File access

MemoryFile

Enables memory file access

IOAnalyzerEventFile

Enables IO Analyzer Event File access

LogFile

Firmware logging (For debugging purposes)

CustomerFile

File for customer or application specific data. It can be any file content. The file size is 1MB.

Name

FileOperationSelector[FileSelector]

Standard

Description

Select an operation which shall be performed on a file.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

NoOperation

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Description

Notes

NoOperation

Selects no operation

-

Open

Open a file

Fails if a file is already opened.

Close

Close a file

When this command is executed, the file is verified and internally copied. This is a time-consuming process.

A file is always closed, even if an error occurs.

The File Operation Status is set appropriately. Therefore Success indicates a successful file update and Failure an erroneous update.

If a Fatal Error occurs, the File Operation Status is set to Fatal Error. In this case you must not switch off the camera if the file type is one of the following:

• Bitstream
• Application
• XML
• Bootfile (sensorfile)

For these files, please try to download the file again to avoid damage!
For other files you may switch off the camera.

In general, make sure to always use consistent packages as delivered by chromasens and do not mix files from different packages!

Read

Read a file

-

Write

Write a file

-

Name

FileOperationExecute[FileOperationSelector]

Standard

Description

Executes the selected file operation.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

{0,1}

Default value

1

Availability

ALL

Notes

To check whether the operation is finished, read the value of the FileOperationExecute command periodically. If the value is not equal to the commands value of the node in the xml, the command has finished execution.

Error behavior

See the device error code documentation.

Name

FileOpenMode

Standard

Description

Select an open mode.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

NoOpenMode

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Description

Notes

NoOpenMode

No open mode selected

-

Read

Open a file in read-only mode

-

Write

Open a file in write-only mode

With this open mode no read command is permitted.

In addition, if the FileAccessOffset is set after a write command occurred, the new value of the FileAccessOffset must be at least new_FileAccessOffset = (old_FileAccessOffset+ old_FileAccessLength).

Name

FileAccessOffset[FileOperationSelector]

Standard

Description

Controls the starting position of the access in the file.

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

≥0

Default value

0

Availability

ALL

Notes

The unit is Byte. Please see Write for restrictions.

Error behavior

See the device error code documentation.

Name

FileAccessLength[FileOperationSelector]

Standard

Description

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

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

≥0

Default value

0

Availability

ALL

Notes

The unit is Byte. Please see Write for restrictions.

Error behavior

See the device error code documentation.

Name

FileOperationResult[FileOperationSelector]

Standard

Description

The number of the successfully read/written bytes of the last file operation.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

0

Availability

ALL

Notes

-

Error behavior

-

Name

FileOperationStatus[FileOperationSelector]

Standard

Description

Status of recent operation.

Interface

Enumeration

Access mode

Read only

Adjustable

while grabbing

-

Value range

See enum entries table below.

Default value

Success

Availability

ALL

Notes

-

Error behavior

-

Name

Description

Notes

Success

The last operation succeeded

-

Failure

The last operation failed

-

FatalError

If this error occurs, do not switch off the device and repeat the update immediately! Otherwise, the system may refuse to boot next time!

A fatal error occurred during the last operation. Please see the Close command for more information.

Name

FileSize[FileSelector]

Standard

Description

Represents the size of the selected file in bytes.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

0

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

FileChecksum[FileSelector]

Custom

Description

The checksum of a file.

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

≥0

Default value

0

Availability

ALL

Notes

This feature must be set by the user after the file is opened and before the file is closed if a file is uploaded to the camera. Only if the checksum feature corresponds to the checksum calculated internally by the camera, the file download succeeds. For reading operations there is no need to set the checksum feature.

Calculation:

The checksum is an unsigned 32-bit value. It is the sum of all 4-Byte words (Little Endian) of the file. If a files size is not a multiple of four, the “missing” bytes are interpreted as zero.

Pseudo code for calculation:

u32 file[N]

u32 checksum = 0

checksum += file[0]

checksum += file[1]

…

checksum += file[N-1]

Error behavior

See the device error code documentation.

Name

FileAccessBuffer

Standard

Description

This buffer is used for the GenICam file update mechanism.

Interface

Register

Size

65536

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

-

Availability

ALL

Default value

-

Notes

See the device error code documentation.