Skip to content

Commit

Permalink
Merge pull request #1273 from google/cstirdivant-patch-3
Browse files Browse the repository at this point in the history
Tools docs updates
  • Loading branch information
cstirdivant authored Feb 16, 2024
2 parents 4fedc33 + 46223b9 commit e98555c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ Run `python toolkit.py` and provide the following arguments:

* `--timeout` or `-t` **[Optional]**: The timeout duration in seconds for the telemetry validation test. The default value is 600 seconds, or 10 minutes. If this time limit is exceeded before the validator receives a test pubsub message for each of the entities configured in the given instance config file, the test will fail with an error and report the entities that were not heard from.

6`--report-directory` or `-d` **[Optional]**: Writes instance validation(instance_validation_report.txt) and telemetry validation (telemetry_validation_report.json) reports to the specified `report-directory`. By default, writes instance validation output to the console and telemetry validation output to the current working directory.
6. `--report-directory` or `-d` **[Optional]**: Writes instance validation(instance_validation_report.txt) and telemetry validation (telemetry_validation_report.json) reports to the specified `report-directory`. By default, writes instance validation output to the console and telemetry validation output to the current working directory.

7`--udmi` **[Optional]**: Validates entity metadata as [UDMI](https://github.com/faucetsdn/udmi/). Flag is set to `True` by default; change this parameter to `--udmi=False` when not validating against UDMI.
7. `--udmi` **[Optional]**: Validates entity metadata as [UDMI](https://github.com/faucetsdn/udmi/). Flag is set to `True` by default; change this parameter to `--udmi=False` when not validating against UDMI.

For example, the following input

Expand Down
4 changes: 2 additions & 2 deletions tools/validators/ontology_validator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ The validator is Python-based and takes the following parameters:
* `--modified-ontology-types` or `-m` **[Optional]**: An absolute or relative path to the modified files of the ontology.
* `--interactive` or `-i` **[Optional]**: Enables interactive mode.

The validator can be run as follows: `python3 validator.py -o=Users/foo/ontology/` or `python3 validator.py --original=Users/foo/ontology/`
The validator can be run as follows: `python3 validator.py -o=Users/foo/ontology/yaml/resources` or `python3 validator.py --original=Users/foo/ontology/yaml/resources`

### Ontology Types Extended

If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original=Users/foo/ontology/ --modified-ontology-types=path/to/modified/ontology/types/folder`
If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original=Users/foo/ontology/yaml/resources --modified-ontology-types=path/to/modified/ontology/types/folder`

When using a modified ontology, ensure you follow the folder-naming convention: `digitalbuildings/ontology/yaml`.

Expand Down

0 comments on commit e98555c

Please sign in to comment.