wlauto.instrumentation.energy_probe package

Module contents

class wlauto.instrumentation.energy_probe.EnergyProbe(device, **kwargs)[source]

Bases: wlauto.core.instrumentation.Instrument

aliases = AC([])
artifacts = AC([])
core_modules = []
description = 'Collects power traces using the ARM energy probe.\n\n This instrument requires ``caiman`` utility to be installed in the workload automation\n host and be in the PATH. Caiman is part of DS-5 and should be in ``/path/to/DS-5/bin/`` .\n Energy probe can simultaneously collect energy from up to 3 power rails.\n\n To connect the energy probe on a rail, connect the white wire to the pin that is closer to the\n Voltage source and the black wire to the pin that is closer to the load (the SoC or the device\n you are probing). Between the pins there should be a shunt resistor of known resistance in the\n range of 5 to 20 mOhm. The resistance of the shunt resistors is a mandatory parameter\n ``resistor_values``.\n\n .. note:: This instrument can process results a lot faster if python pandas is installed.\n '
finalize(*args, **kwargs)
initialize(*args, **kwargs)
kind = 'instrument'
name = 'energy_probe'
parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <function list_of_numbers>, 'mandatory': None, 'name': 'resistor_values', 'constraint': None, 'default': [], 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'labels', 'constraint': None, 'default': [], 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'device_entry', 'constraint': None, 'default': '/dev/ttyACM0', 'allowed_values': None, 'global_alias': None, 'override': False})"])
validate(*args, **kwargs)