upkie  10.1.0
Open-source wheeled biped robots
Namespace List
Here is a list of all documented namespaces with brief descriptions:
[detail level 1234]
 NupkieSoftware for wheeled-biped robots
 NcontrollersFunctions and classes related to balance control
 NcppC++ library to create new spines
 NexceptionsExceptions raised by this project
 NinterfacesSend actions to actuators or simulators
 NbulletBullet utility functions used in the simulation interface
 Ndefault_actionDefault values for servo actions
 NmoteusInterface to moteus controllers used in pi3hat spines
 Npi3hatUtility functions specific to the pi3hat interface
 NobserversState observers available for Upkies
 NsensorsSensors (pure outputs) available for Upkies
 NspineInter-process communication protocol with the spine
 NutilsUtility functions
 NenvsGymnasium environments
 NbackendsBackend implementations for Upkie environments
 NbackendInterface to a backend for Upkie environments
 Ngenesis_backendBackend using the Genesis physics simulator
 Nmock_backendBackend that mimics perfect commands for testing
 Npybullet_backendBackend using PyBullet physics simulation
 NspinePython interface to interact with a spine
 Nspine_backendBackend connected to a simulation or real spine
 Nupkie_base_velocityEnvironment where Upkie is balanced and controlled via base velocity
 Nupkie_envBase class with features shared by all Upkie environments
 Nupkie_gyropodEnvironment where Upkie behaves like a wheeled inverted pendulum with yaw control
 Nupkie_pendulumBackward-compatible pendulum wrapper (no yaw control)
 Nupkie_servosUpkie environment where actions command servomotors directly
 NwrappersWrappers to modify Gymnasium environments
 Nadd_action_to_observationAppend last action vector to the observation vector
 Nadd_lag_to_actionModel lag as a low-pass filter on the action of an environment
 Ndifferentiate_actionAct on the derivative of the action
 Nnoisify_actionAdd noise to the action of an environment
 Nnoisify_observationAdd noise to the observation of an environment
 Nrandom_pushApply a random push at each step with a given probability
 NexceptionsExceptions raised by the Python library
 NloggingCustom logging formatter and logger for the library
 NmodelRobot model parsed from its URDF description
 NutilsUtility functions
 NclampClamping functions
 Nexternal_forceExternal force data structure
 NfiltersBasic digital filters
 NjoystickJoystick class used by mock spines to mimick the C++ Joystick sensor
 Nnested_updateFunctions to work with nested dictionaries
 NraspiFunctions to work on the onboard Raspberry Pi
 Nrobot_stateRobot state with optional randomization
 Nrobot_state_randomizationDomain randomization of robot states
 NrotationsConvert between various rotation representations