XM-014232-PC
31
ITEM FILES
The item files contain the commands used to configure the system. The commands are simply added
to the file in the same format as the command line control utility. For clarity, multiple item files can be
included in the .json definition, each specifying a sub-set of commands relating to a particular function
or aspect. Example item files for common configurations are provided in the
data-
partition/input
directory of the release package. For example, the
agc_bypass.txt
item file
bypasses the AGC for both output channels contains the following commands:
SET_ADAPT_CH0_AGC 0
SET_ADAPT_CH1_AGC 0
SET_GAIN_CH0_AGC 1
SET_GAIN_CH1_AGC 1
4.2.2.
GENERATING A DATA PARTITION FOR CUSTOM APPLICATIONS
It is recommended that in order to create a custom Data Partition, an existing set of .json and item files
is used as a template and modified as required. The release package contains example .json and item
files for this purpose.
NOTE: The following process requires the use of Python 3. Installation is covered in
Required Tools
section.
The required additional control commands should be stored in an appropriately named text file inside
the
data-partition/input
subdirectory. For example a file named
aec_bypass.txt
could be
added containing the collected commands:
SET_BYPASS_AEC 1
NOTE: Only commands which are required to be set with non-default values need to be included in
the item file list.
These text files are then included in the custom JSON description.
In the above example, the
aec_bypass.txt
is added to to a JSON description,
bypass_AEC.json
as shown below:
...
"item_files": [
...
{
"path": "input/aec_bypass.txt",
"comment": ""
}
...
]
...
NOTE: Remember that the execution order of the commands and input files can affect the behaviour
of the device. For example, commands to configure USB and I
2
S should be added at the beginning of
the data image.
Finally, to generate the custom data partition, the command below should be run from the
data-
partition
directory:
python3 xvf3510_data_partition_generator.py <build_type>.json
The generator script produces two data image files; one for factory programming and one for device
upgrade in a directory named
output
.
