Synchronized Energy Harvesting Emulator and Recorder CLI
shepherd-herd ist the command line utility for controlling a group of shepherd nodes remotely through an IP-based network.
shepherd-herd is a pure python package and available on PyPI. Use your python package manager to install it. For example, using pip:
pip install shepherd-herd
All shepherd-herd commands require the list of hosts on which to perform the requested action.
This list of hosts is provided with the
-i option, that takes either the path to a file or a comma-separated list of hosts (compare Ansible
For example, save the following file as
sheep: hosts: sheep0: sheep1: sheep2: vars: ansible_user: jane
Then use shepherd-herd to check if all your nodes are up:
shepherd-herd -i hosts run echo 'hello'
Or, equivalently define the list of hosts on the command line
shepherd-herd -i sheep0,sheep1,sheep2, run echo 'hello'
Here, we just provide a selected set of examples of how to use shepherd-herd.
For a full list of supported commands and options, run
shepherd-herd --help and
shepherd-herd [COMMAND] --help.
Simultaneously start a 30s recording on the nodes defined in the
shepherd-herd -i hosts record -o rec.h5
After recording is done, retrieve the data from all nodes and merge it to one hdf5 file on your local machine for analysis:
shepherd-herd -i hosts retrieve --merge -o rec_merged.h5 rec.h5
Flash a firmware image to the sensor nodes attached to the shepherd nodes:
shepherd-herd -i hosts target flash firmware_img.bin
Reset the sensor nodes:
shepherd-herd -i hosts target reset
Simultaneously start to play back the previously recorded data to the attached sensor nodes and monitor their power consumption and GPIO events:
shepherd-herd -i hosts emulate -i rec.h5 -o load.h5
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size shepherd_herd-0.1.0.tar.gz (6.4 kB)||File type Source||Python version None||Upload date||Hashes View hashes|