lisa.energy_meter.Monsoon#

class lisa.energy_meter.Monsoon(target, monsoon_bin=None, tty_device=None, res_dir=None)[source]#

Bases: EnergyMeter

Monsoon Solutions energy meter

Parameters:

monsoon_bin (str) – monsoon binary path
tty_device (str) – TTY device to use

Deprecated since version 2.0.

Monsoon is deprecated and will be removed in version 4.0: LISA energy meters are deprecated, please use devlib instruments or contribute the instrument to devlib

Classes

Configuration class for Monsoon.

Attributes

`INIT_KWARGS_KEY_MAP`	Dictionary of `__init__` parameter names to configuration key path.
`name`

Properties

logger ^inherited

Convenience short-hand for self.get_logger().

Methods

`report()`	Get total energy consumption since last `reset()`.
`reset()`	Reset the energy meter.
`check_init_param()` ^inherited	Take the same parameters as `__init__`, and check their types according to what is specified in the configuration class.
`conf_to_init_kwargs()` ^inherited	Turn a configuration object into a dictionary suitable for passing to `__init__` as `**kwargs`.
`from_conf()` ^inherited	Build an instance of `EnergyMeter` from a configuration object.
`get_logger()` ^inherited	Provides a `logging.Logger` named after `cls`.
`log_locals()` ^inherited	Debugging aid: log the local variables of the calling function.
`sample()` ^inherited	Get a sample from the energy meter.

Classes#

Monsoon.CONF_CLASS#: alias of MonsoonConf

Attributes#

Monsoon.INIT_KWARGS_KEY_MAP = {'monsoon_bin': ['monsoon-bin'], 'tty_device': ['tty-device']}#

Dictionary of __init__ parameter names to configuration key path.

That path is a list of strings to take into account sublevels like ['level-key', 'sublevel', 'foo'].

Monsoon.name = 'monsoon'#

Properties#

property Monsoon.logger#

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

Methods#

Monsoon.report(out_dir, out_energy='energy.json', out_samples='samples.csv')#: Get total energy consumption since last reset()

Monsoon.reset()#: Reset the energy meter

classmethod Monsoon.check_init_param(**kwargs)#

Inherited method, see lisa.conf.Configurable.check_init_param()

Take the same parameters as __init__, and check their types according to what is specified in the configuration class.

classmethod Monsoon.conf_to_init_kwargs(conf)#

Inherited method, see lisa.conf.Configurable.conf_to_init_kwargs()

Turn a configuration object into a dictionary suitable for passing to __init__ as **kwargs.

classmethod Monsoon.from_conf(target, conf, res_dir=None)#

Inherited method, see lisa.energy_meter.EnergyMeter.from_conf()

Build an instance of EnergyMeter from a configuration object.

classmethod Monsoon.get_logger(suffix=None)#

Inherited method, see lisa.utils.Loggable.get_logger()

Provides a logging.Logger named after cls.

classmethod Monsoon.log_locals(var_names=None, level='debug')#

Inherited method, see lisa.utils.Loggable.log_locals()

Debugging aid: log the local variables of the calling function.

abstract Monsoon.sample()#

Inherited method, see lisa.energy_meter.EnergyMeter.sample()

Get a sample from the energy meter.