Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 2.29 KB

api.rst

File metadata and controls

95 lines (64 loc) · 2.29 KB
Raw

API

The shepherd API offers high level access to shepherd's functionality and forms the base for the two command line utilities. Note that the API only convers local functionality on a single shepherd node. Use the shepherd-herd command line utility to orchestrate a group of shepherd nodes remotely.

Recorder

The recorder is used to configure all relevant hardware and software and to sample and extract data from the analog frontend.

.. autoclass:: shepherd.Recorder
   :members:
   :inherited-members:

Usage:

# Configure converter for fixed 1.5V input regulation
with Recorder(harvesting_voltage=1.5) as recorder:
    recorder.start()

    for _ in range(100):
        idx, buf = recorder.get_buffer()
        recorder.release_buffer(idx)

Emulator

The emulator is used to replay previously recorded IV data to an attached sensor node.

.. autoclass:: shepherd.Emulator
   :members:
   :inherited-members:

Usage:

# We'll read existing data using a LogReader
lr = LogReader("mylog.h5")
with ExitStack() as stack:
    stack.enter_context(lr)
    emu = Emulator(
        calibration_recording=lr.get_calibration_data(),
        initial_buffers=lr.read_buffers(end=64),
    )
    stack.enter_context(emu)
    emu.start()

    for hrvst_buf in lr.read_buffers(start=64):
        idx, _ = emu.get_buffer()
        emu.put_buffer(idx, hrvst_buf)

LogWriter

The LogWriter is used to store IV data sampled with shepherd to an hdf5 file.

.. autoclass:: shepherd.LogWriter
   :members:

Usage:

with LogWriter("mylog.h5") as log_writer, Recorder() as recorder:
    recorder.start()
    for _ in range(100):
        idx, buf = recorder.get_buffer()
        log_writer.write_buffer(buf)
        recorder.release_buffer(idx)

LogReader

The LogReader is used to read previously recorded data from an hdf5 file buffer by buffer. It can be used with the Emulator to replay recorded data to an attached sensor node.

.. autoclass:: shepherd.LogReader
   :members:

Usage:

with LogReader("mylog.h5") as log_reader:
    for buf in log_reader.read_buffers(end=1000):
        print(len(buf))