upkie 9.0.1
Open-source wheeled biped robots
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123456]
 NupkieSoftware for wheeled-biped robots
 NcontrollersFunctions and classes related to balance control
 Nmpc_balancerWheel balancing by model predictive control
 Nmpc_balancer
 Nproxqp_workspace
 NcppC++ library to create new spines
 NexceptionsExceptions raised by this project
 CControllerErrorException thrown when a controller fails
 CFilterErrorException for filter errors
 CObserverErrorException thrown when an observer fails
 CPositionCommandErrorException raised when an actuation command is incorrect
 CServoErrorException for filter errors
 CTypeErrorException raised when a deserialized object does not have the right type
 CUpkieErrorBase class for Upkie-related exceptions
 NinterfacesSend actions to actuators or simulators
 NbulletBullet utility functions used in the simulation interface
 NmoteusInterface to moteus controllers used in pi3hat spines
 CBulletInterfaceActuation interface for the Bullet simulator
 CImuDataData from the onboard inertial measurement unit (IMU)
 CImuUncertaintyUncertainty on IMU measurements
 CInterfaceBase class for actuation interfaces
 CMockInterfaceInterface whose internal state perfectly tracks commands
 CPi3HatInterfaceInterface to moteus controllers
 CServoLayoutMap between servos, their busses and the joints they actuate
 CServoPropertiesServo properties
 NobserversState observers available for Upkies
 CBaseOrientationObserve the orientation of the base frame relative to the world frame
 CFloorContactObserve contact between the wheels and the floor
 CHistoryObserverReport high-frequency history vectors to lower-frequency agents
 CObserverBase class for observers
 CObserverPipelineObserver pipeline
 CWheelContactObserve contact between a given wheel and the floor
 CWheelOdometryObserve the relative motion of the floating base with respect to the floor
 NsensorsSensors (pure outputs) available for Upkies
 CCpuTemperatureSensor for CPU temperature readings
 CJoystickSensor for a joystick controller
 CKeyboardSensor for reading Keyboard inputs
 CSensorBase class for sensors
 CSensorPipelineSensor pipeline
 NspineInter-process communication protocol with the spine
 CAgentInterfaceMemory map to shared memory
 CSpineLoop transmitting actions to the actuation and observations to the agent
 CStateMachineSpine state machine
 NutilsUtility functions
 CSynchronousClockSynchronous (blocking) clock
 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
 Ntesting
 CActionObserverEnvTest environment that returns the action as observation
 CConstantObservationEnvTest environment that returns a constant observation
 CMockSpineMock spine interface for testing Upkie environments
 Nupkie_envBase class with features shared by all Upkie environments
 CUpkieEnvBase class with features shared by all Upkie environments
 Nupkie_pendulumEnvironment where Upkie behaves like a wheeled inverted pendulum
 CUpkiePendulumWrapper to make Upkie act as a wheeled inverted pendulum
 Nupkie_servosUpkie environment where actions command servomotors directly
 CUpkieServosUpkie 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
 CFallDetectedRaised when a fall is detected
 CMissingOptionalDependencyRaised when an optional feature lacks a corresponding optional dependency
 CModelErrorRaised when something is wrong in the robot model
 CPerformanceIssueRaised when a performance issue is detected
 CSpineErrorRaised when the spine sets an error flag
 CUpkieExceptionBase class for exceptions raised by Upkie agents
 CUpkieRuntimeErrorRuntime error, for instance an invalid call to a library function
 CUpkieTimeoutErrorRaised when something times out, typically the spine not responding
 NloggingCustom logging formatter and logger for the library
 CSpdlogFormatterCustom logging formatter visually consistent with spdlog
 NmodelRobot model parsed from its URDF description
 Njoint
 CJointJoint properties (see also joint limits)
 Njoint_limit
 CJointLimitJoint limit in configuration and tangent spaces
 Nmodel
 CModelRobot model parsed from its URDF description
 NutilsUtility functions
 NjoystickJoystick class used by mock spines to mimick the C++ Joystick sensor
 CJoystickJoystick class used by mock spines to mimick the C++ Joystick sensor
 Nrobot_stateRobot state with optional randomization
 CRobotStateRobot state (configuration and velocity) with optional randomization
 Nrobot_state_randomizationDomain randomization of robot states
 CRobotStateRandomizationDomain randomization parameters for Upkie's state