Skip to content

Commit

Permalink
Merge pull request #144 from klauer/doc_screenshots
Browse files Browse the repository at this point in the history
DOC: a few more README screenshots
  • Loading branch information
klauer committed Sep 20, 2022
2 parents a13ac4a + 58b0c97 commit 7124496
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,55 @@ See per-parameter values:
See database lint:

.. image:: https://github.com/pcdshub/whatrecord/raw/assets/screenshot_14.png


Other Screenshots
-----------------

Use ``whatrecord deps --graph`` to inspect IOCs/modules with ``make`` and
generate a dependency graph of modules:

.. image:: https://github.com/pcdshub/whatrecord/raw/assets/screenshot_16.png

Use ``whatrecord graph`` to graph state notation language ``.st`` file
logic:

.. image:: https://github.com/pcdshub/whatrecord/raw/assets/screenshot_17.png

.. image:: https://github.com/pcdshub/whatrecord/raw/assets/screenshot_18.png

Use an external tool like ``jq`` to sift through information from whatrecord's
JSON output:

.. code::
$ whatrecord parse whatrecord/tests/iocs/db/pva/iq.db | jq '.records[] | [.name, .record_type, .fields.OUT.value]'
[
"$(PREFIX)Rate",
"ao",
"$(PREFIX)dly_.ODLY NPP"
]
[
"$(PREFIX)Delta",
"ao",
null
]
...
$ whatrecord parse whatrecord/tests/iocs/db/pva/iq.db | jq '.records[] | [ .name, .info["Q:group"]]'
[
"$(PREFIX)Rate",
null
]
[
"$(PREFIX)Phase:I",
{
"$(PREFIX)iq": {
"phas.i": {
"+type": "plain",
"+channel": "VAL"
}
}
}
]
...

0 comments on commit 7124496

Please sign in to comment.