libstp.foundation

Python bindings for libstp-foundation

Classes

ChassisVelocity

Feedforward

MotorCalibration

PIDController

A PID controller for managing control loops.

PidGains

Pose

Functions

debug(→ None)

Log a message with severity level debug

error(→ None)

Log a message with severity level error

info(→ None)

Log a message with severity level info

initialize_logging(→ None)

Initialize and enable the logging system

initialize_timer(→ None)

Initialize the timer for elapsed time logging

warn(→ None)

Log a message with severity level warn

Module Contents

class libstp.foundation.ChassisVelocity
class libstp.foundation.ChassisVelocity(arg0: float, arg1: float, arg2: float)
vx: float
vy: float
wz: float
class libstp.foundation.Feedforward
class libstp.foundation.Feedforward(kS: float, kV: float, kA: float)
kA: float
kS: float
kV: float
class libstp.foundation.MotorCalibration
class libstp.foundation.MotorCalibration(ff: Feedforward, pid: PidGains, ticks_to_rad: float, vel_lpf_alpha: float)
ff: Feedforward
pid: PidGains
ticks_to_rad: float
vel_lpf_alpha: float
class libstp.foundation.PIDController(Kp: float, Ki: float, Kd: float)

A PID controller for managing control loops.

This class provides methods for tuning and executing a PID control loop with configurable proportional, integral, and derivative gains.

calculate(error: float) float

Calculate the PID output for a given error.

Parameters:

error (float) – The current error in the system.

Returns:

The calculated PID output, clamped to the specified range.

Return type:

float

class libstp.foundation.PidGains
class libstp.foundation.PidGains(kp: float, ki: float, kd: float)
kd: float
ki: float
kp: float
class libstp.foundation.Pose
position: numpy.ndarray[numpy.float32[3, 1]]
property heading: float
libstp.foundation.debug(message: str) None

Log a message with severity level debug

libstp.foundation.error(message: str) None

Log a message with severity level error

libstp.foundation.info(message: str) None

Log a message with severity level info

libstp.foundation.initialize_logging() None

Initialize and enable the logging system

libstp.foundation.initialize_timer() None

Initialize the timer for elapsed time logging

libstp.foundation.warn(message: str) None

Log a message with severity level warn