Properties

> pi prop -h
Usage: pi property [-h] SUBCOMMAND ...

Description: Commands related to Properties. These subcommands are used to
add, edit, delete and list information about Properties.

Optional arguments:
  -h, --help            Show this help message and exit

Available sub-commands:
  SUBCOMMAND
    add                 Create a new Property definition.
    delete (del, remove, rm)
                        Delete an existing Property definition.
    edit                Edit an existing Property definition.
    list (ls)           List all matching Properties.

> pi prop add -h
Usage: pi property add [-h] [--template TEMPLATE | identifier]

Description: Create a new Property definition. Only admin users can create
Properties. The command puts the Property specification into a temporary file
and invokes the editor specified by the EDITOR environment variable. Saving
the file adds the Property definition.

Positional arguments:
  identifier            The name of the Property definition being created.

Optional arguments:
  --template TEMPLATE, -t TEMPLATE
                        Use the specified template to add the Property. The
                        template is an ASCII file that defines the Property.
                        This can be used to add Property definitions with a
                        script and avoid the interactive editor. To read the
                        template from STDIN, set TEMPLATE='-'.
  -h, --help            Show this help message and exit

Examples:
# Invoke the editor to create Property definition ohms.
  pi prop add ohms

# Create Property definition using the ohms.info template.
  pi prop add -t ohms.info

# Create Property using redirected STDOUT from script new_prop.py as template.
  new_prop.py | pi prop add --template -

> pi prop delete -h
Usage: pi property delete [-h] [--force] identifier

Description: Delete an existing Property definition. Only admin users can
delete Properties.

Positional arguments:
  identifier   Name of the Property to delete.

Optional arguments:
  --force, -f  Execute delete to completion when Property value is set for
               some IP or IPV (default is to block delete when Property value
               is set on any IP or IPV).
  -h, --help   Show this help message and exit

Examples:
# Delete Property definition ohms which has no value set on any IP or IPV.
  pi prop delete ohms

# Delete Property definition ohms even if its value is set on any IP or IPV.
  pi prop delete --force ohms

> pi prop edit -h
Usage: pi property edit [-h] [--template TEMPLATE] identifier

Description: Edit an existing Property definition. Only admin users can edit
Properties. The command puts the Property specification into a temporary file
and invokes the editor specified by the EDITOR environment variable. Saving
the file edits the Property definition.

Positional arguments:
  identifier            The name of the Property definition to edit.

Optional arguments:
  --template TEMPLATE, -t TEMPLATE
                        Use the specified template to edit the Property. The
                        template is an ASCII file that defines the Property.
                        This can be used to edit Property definition with a
                        script and avoid the interactive editor. To read the
                        template from STDIN, set TEMPLATE='-'.
  -h, --help            Show this help message and exit

Examples:
# Invoke the editor to modify Property definition ohms.
  pi prop edit ohms

# Modify Property definition ohms using the ohms.info template.
  pi prop edit -t ohms.info ohms

# Modify Property ohms using redirected STDOUT from script as template.
  edit_prop.py | pi prop edit -t - ohms

> pi prop list -h
Usage: pi property list [-h]
                        [--format {csv,json,long,table,template} | --verbose]
                        [--model MODEL]
                        [identifier [identifier ...]]

Description: List all matching Properties. A variety of format and filtering
options are supported.

Positional arguments:
  identifier            Filter Properties by name.

Optional arguments:
  --format {csv,json,long,table,template}
                        Return the results using the specified data structure.
                        The template format produces files that can be used by
                        the pi add|edit commands with the --template option.
  --model MODEL         Use the specified report model (table report only).
  --verbose, -v         Alias for --format long.
  -h, --help            Show this help message and exit

> pi prop list
┌───────────────────────┬────────┬──────────┬───────────┬──────────────────────────────────────────┐
│ NAME                  │ TARGET │ TYPE     │ SUFFIX    │ DESCRIPTION                              │
╞═══════════════════════╪════════╪══════════╪═══════════╪══════════════════════════════════════════╡
│ ControllabilityClass  │ IP     │ string   │           │ Controllability Classification           │
│ ExposureClass         │ IP     │ string   │           │ Exposure Classification                  │
│ FUSASpec              │ IP     │ string   │           │ FuSa specification                       │
│ FUSA_spec_rev         │ IP     │ string   │           │ Internal FuSa compliance guideline       │
│                       │        │          │           │ revision                                 │
│ INL_latest            │ IP     │ float    │ ppm       │ Integral Non-Linearity Latest            │
│ INL_rel               │ IPV    │ float    │ ppm       │ Integral Non-Linearity Latest            │
│ INL_target            │ IP     │ float    │ ppm       │ Target Integral Non-linearity            │
│ INL_verif             │ IPV    │ float    │ ppm       │ Integral Non-Linearity Verification      │
│                       │        │          │           │ Result                                   │
│ IPCategory            │ IPV    │ choice   │           │ IP Catetory                              │
│ SNR                   │ IPV    │ float    │ dB        │ Measured Signal to Noise Ratio           │
│ SeverityClass         │ IP     │ string   │           │ Max Severity class                       │
│ Supply_target         │ IP     │ float    │ V         │ Targeted Supply                          │
│ TempHi_target         │ IP     │ float    │ C         │ Target High Temperature                  │
│ TempLow_target        │ IP     │ float    │ C         │ Target Low Temperature                   │
│ architecture          │ IP     │ string   │           │ cortex architecture                      │
│ auth_required         │ IP     │ string   │           │ is authorization required to use the IP  │
│ bus_interface         │ IP     │ choice   │           │ Bus interface protocol                   │
│ external_ip           │ IP     │ string   │           │ Is IP external                           │
│ license_agreement     │ IP     │ string   │           │ License agreement doc                    │
│ license_class         │ IP     │ string   │           │ licensing class for the IP               │
│ license_expire        │ IP     │ datetime │           │ License expiration date                  │
│ license_start         │ IP     │ datetime │           │ License start date                       │
│ vendor_id             │ IP     │ string   │           │ IP vendor ID number                      │
│ vendor_ipid           │ IP     │ string   │           │ IP vendor IP ID number                   │
└───────────────────────┴────────┴──────────┴───────────┴──────────────────────────────────────────┘
Found 24 matching object(s).