Skip to content

Utility script to create xitem file from design.xml

saikrishnamaddali edited this page Jan 18, 2019 · 6 revisions

Description

The utility script generate_xitem_json.py is used to create xitem.json file from design.xml file.The script extracts the mandatory fields from design.xml and creates a corresponding xitem.json file.

The following tags are directly inferred from the design.xml file in to xitem.json .

<Vendor>em.avnet.com</Vendor>

<Library>examples</Library>

<Name>minized</Name>

<Version>1.2</Version>

<DisplayName>MiniZed Evaluation Platform</DisplayName>

<Description>MiniZed is a single-core Zynq 7Z007S development board. This board targets entry-level Zynq developers with a low-cost prototyping platform</Description>

The properties of xitem along with their direct mapping fields in board xml are as follows.

property in xitem Attribute in board xml
name Name attribute in board tag
display DisplayName attribute in board tag
company Vendor attribute in board tag
revision Version tag
description Description tag

The following fields of xitem json are taken from user :

  1. company_display
  2. author
  3. company_url
  4. category

The following fields of xitem are indirectly inferred from the board.xml:

  1. contributor in xitem (Based on the vendor name in board xml and company url given by user).

Example design has a board dependency from XilinxBoardStore

In case of example design has a board file from XilinxBoardStore as a dependency ,user has to provide the board details to add dependency entry in xitem json.

Commands :

python generate_xitem_json.py -help (To get the details of arguements for script)

python generate_xitem_json.py --design_file <path to design.xml> --author <author_name> --company_display_name <company_display_Name> --company_url <company url> --category <category of example> --dependency_item <dependent board item name> --dependency_item_store <dependent board store name> --dependency_item_revision <dependent board revision> --dependency_item_company <dependent board company> --output_file <path to output file>

Version:

Python Version Supported: 2.7.x

Board Schema File Supported: 1.0

Xitem.json Schema version : 1.0