CLI for Zenoh
Project description
zenoh-cli
A command line tool for interacting with a Zenoh session
Typical use cases include:
- Tests
- Investigations
- Probing
- As part of a bash pipeline
zenoh-cli
makes use of codecs
for encoding and decoding to and from the wire payloads on the zenoh network bus. By default, zenoh-cli
bundles the following codecs:
- text
- base64
- JSON
A plugin system is in place to allow for easily extending the available codecs in zenoh-cli
, see below.
Installation
pip install zenoh-cli
Usage
usage: zenoh [-h] [--mode {peer,client}] [--connect CONNECT] [--listen LISTEN] [--config CONFIG] [--log-level LOG_LEVEL] {info,network,scout,delete,put,subscribe,get} ...
Zenoh command-line client application
positional arguments:
{info,network,scout,delete,put,subscribe,get}
options:
-h, --help show this help message and exit
--mode {peer,client}
--connect CONNECT Endpoints to connect to. (default: None)
--listen LISTEN Endpoints to listen on. (default: None)
--config CONFIG A path to a configuration file. (default: None)
--log-level LOG_LEVEL
Example output of zenoh network
Extending with codecs for encoding/decoding values
zenoh-cli
comes with a plugin system for easily extending it with custom encoders and decoders (codecs) for the data values. The plugin system makes use of the entrypoints provided by setuptools, see here for details. zenoh-cli
gather plugins from two custom "groups":
zenoh_cli.codecs.encoders
zenoh_cli.codecs.decoders
For an example, see example_plugin
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for zenoh_cli-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c74c3ef7e1f90eb83f41a9f086f82351a614f678cba4a6c2cb7a920af5d7bc1 |
|
MD5 | c0735952f36f90d0e2e7ff1c5f3b1ff0 |
|
BLAKE2b-256 | fcd6a91df4532d397ede5456ca2a08129597971bc20a6b8e0ff8ae80554f0c70 |