File syn_control_stats.h¶

FileList > control > syn_control_stats.h

Performance monitoring and "Tuning Scorecard" for control loops. More...

#include <stdbool.h>
#include <stdint.h>

Classes¶

Type	Name
struct	SYN_ControlReport Human-readable performance report.
struct	SYN_ControlStats Raw accumulators for control performance analysis.

Public Functions¶

Type	Name
void	syn_control_stats_report (const SYN_ControlStats * stats, SYN_ControlReport * report) Calculate a report from the current accumulators.
void	syn_control_stats_reset (SYN_ControlStats * stats) Reset all accumulators.
void	syn_control_stats_update (SYN_ControlStats * stats, int32_t error, int32_t output) Update stats with a new sample.

Detailed Description¶

This module provides a way to quantify the performance of a control loop beyond simple error tracking. It measures precision, efficiency, and mechanical stress (jitter).

Public Functions Documentation¶

function syn_control_stats_report¶

Calculate a report from the current accumulators.

void syn_control_stats_report (
    const SYN_ControlStats * stats,
    SYN_ControlReport * report
)

Parameters:

stats Stats instance.
report Output report structure.

function syn_control_stats_reset¶

Reset all accumulators.

void syn_control_stats_reset (
    SYN_ControlStats * stats
)

Parameters:

stats Stats instance to reset.

function syn_control_stats_update¶

Update stats with a new sample.

void syn_control_stats_update (
    SYN_ControlStats * stats,
    int32_t error,
    int32_t output
)

Parameters:

stats Stats instance.
error Current servo error (target - measured).
output Current motor output (-100 to 100, or raw counts).

The documentation for this class was generated from the following file src/syntropic/control/syn_control_stats.h