Skip to content

Directory Structure

Jörn Malzahn edited this page Jul 17, 2018 · 1 revision

The Compliant Joint Toolbox, is organized in the following directories:

examples

A set of MATLAB and Simulink examples demonstrating various functionalities. The toolbox features a small GUI application to comfortably select and run examples.

lib

Core MATLAB classes and Simulink blocks that come with the Real-Time compatible Simulink library - controllers, models and observers.

model

Mathematical implementation of the various linear actuator models and nonlinear dynamics effects and their components. If you wish to apply the features of the Compliant Joint Toolbox with to your custom actuator model structure, study the files located here and use them as a template for your dynamics models (for experienced users).

param

Holds parameter files for several example actuators. They serve as a good starting point to organise your own actuator parameter files.

templates

Templates used by the joint builder to build actuator classes.

tools

Various tools for calculating observers, gains, transfer functions and plotting.

unit_tests

Unit tests to verify correct functioning of the library. If you wish to know, if the Compliant Joint Toolbox runs fine on your system, run the script `runAllTests.m' in this directory. If any of the tests do not pass, please let us know!

build

The joint builder will create a directory, where it stores all class definition files. It defaults to the 'build' directory in the current working directory.