samna.boards.common.power

Submodules

Module content

class samna.boards.common.power.PowerMonitor

Bases: pybind11_object

The PowerMonitor class manages power measurements for a board. It supports both single-shot and continuous (automatic) power measurements.

get_source_node(self: samna.boards.common.power.PowerMonitor) → samna.DeviceSourceNode_unifirm_modules_events_measurement

Retrieve the source node for power measurement events.

Returns:

The measurement events appear in this source node.

Return type:

DeviceSourceNode

single_shot_power_measurement(self: samna.boards.common.power.PowerMonitor) → None

Perform a single-shot power measurement.

start_auto_power_measurement(self: samna.boards.common.power.PowerMonitor, arg0: float) → float

Start continuous power measurement at a specified frequency.

The frequency may be discretized, so the actual frequency might differ from the requested one.

Parameters:

frequency (float) – The desired measurement frequency in Hz.

Returns:

The actual frequency in Hz.

Return type:

float

start_reading_thread(self: samna.boards.common.power.PowerMonitor) → None

Start the internal thread responsible for continuously reading power data.

This method is mainly intended for debugging purposes.

stop_auto_power_measurement(self: samna.boards.common.power.PowerMonitor) → None

Stop continuous power measurement.

This function halts the ongoing automatic power measurement process.

stop_reading_thread(self: samna.boards.common.power.PowerMonitor) → None

Stop the internal thread responsible for continuously reading power data.

This method is mainly intended for debugging purposes.