Skip to main content

Shell-like interface with Zephyr Devicetree

Project description

DTSh is a Devicetree Source (DTS) files viewer with a shell-like command line interface:

  • navigate and visualize the devicetree

  • search for devices, bindings, buses or interrupts with flexible criteria

  • redirect command output to files (text, HTML, SVG) to document hardware configurations or illustrate notes

  • rich Textual User Interface, command line auto-completion, command history, user themes

$ dtsh build/zephyr/zephyr.dts
dtsh (0.2.2): A Devicetree Shell
How to exit: q, or quit, or exit, or press Ctrl-D

/
> cd &flash_controller

/soc/flash-controller@4001e000
> tree -l
                              Description
                              ─────────────────────────────────────────────────────────────────
flash-controller@4001e000     Nordic NVMC (Non-Volatile Memory Controller)
└── flash@0                   Flash node
    └── partitions            This binding is used to describe fixed partitions of a flash (or…
         ├── partition@0      Each child node of the fixed-partitions node represents…
         ├── partition@c000   Each child node of the fixed-partitions node represents…
         ├── partition@82000  Each child node of the fixed-partitions node represents…
         └── partition@f8000  Each child node of the fixed-partitions node represents…

You can use it with:

  • all DTS files generated by Zephyr at build-time (aka build/zephyr/zephyr.dts)

  • arbitrary DTS files with bindings compatible with Zephyr’s Devicetre bindings syntax

Status

DTSh 0.2.x mirror and package the code base that serves as a proposal to upstream DTSh as a new Zephyr extension to West: RFC - DTSh, shell-like interface with Devicetree

This is the stable and maintained branch: if you have DTSh 0.1.x installed, please upgrade with e.g. pip install -U dtsh.

Please refer to the DTSh project documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dtsh-0.2.2.tar.gz (198.6 kB view hashes)

Uploaded Source

Built Distribution

dtsh-0.2.2-py3-none-any.whl (185.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page