Repository navigation
Block path
Blocks are dynamically loaded from several locations. They are always loaded from:
-
src/bdsim/blocksholds the standard block set
Other blocks are looked for along the path given by the environment variable BDSIMPATH which is a colon-separated list of folders.
If BDSim(... toolboxes=True), which is the default, it will add these folders to the path
their block libraries:
-
roboticstoolbox/blocksholds robot-specific blocks -
machinevisiontoolbox/blocksholds machine-vision specific blocks
For each folder on the path, all Python files are parsed for blocks, excluding those whose name starts with an underscore (eg. _helpers.py).
The list of dynamically loaded blocks can be seen by
sim.blocks()89 blocks loaded
bdsim.blocks.connections................: ITEM DICT MUX DEMUX INDEX SUBSYSTEM INPORT OUTPORT
bdsim.blocks.continuous.................: INTEGRATOR LTI_SS LTI_SISO DERIV2 DERIV PID
bdsim.blocks.displays...................: SCOPE SCOPEXY SCOPEXY1 ANIMATION
bdsim.blocks.functions..................: SUM PROD GAIN POW CLIP FUNCTION INTERPOLATE
bdsim.blocks.linalg.....................: INVERSE TRANSPOSE NORM FLATTEN SLICE2 SLICE1 DET COND
bdsim.blocks.sampled....................: ZOH INTEGRATOR_S DERIV_S LTI_SS_S LTI_SISO_S PID_S DINTEGRATOR
bdsim.blocks.sinks......................: PRINT STOP EVENT NULL WATCH
bdsim.blocks.sources....................: CONSTANT TIME WAVEFORM PIECEWISE STEP RAMP
bdsim.blocks.spatial....................: POSE_POSTMUL POSE_PREMUL TRANSFORM_VECTOR POSE_INVERSE POSEINTEGRATOR
........................................: DPOSEINTEGRATOR
roboticstoolbox.blocks.arm..............: FKINE IKINE JACOBIAN ARMPLOT JTRAJ CTRAJ CIRCLEPATH TRAPEZOIDAL TRAJ IDYN
........................................: GRAVLOAD_X INERTIA INERTIA_X FDYN FDYN_X
roboticstoolbox.blocks.mobile...........: BICYCLE UNICYCLE DIFFSTEER VEHICLEPLOT
roboticstoolbox.blocks.spatial..........: TR2DELTA DELTA2TR POINT2TR TR2T
roboticstoolbox.blocks.uav..............: MULTIROTOR MULTIROTORMIXER MULTIROTORPLOT
machinevisiontoolbox.blocks.camera......: CAMERA VISJAC_P ESTPOSE_P IMAGEPLANE
This is from main — the hardware I/O blocks (bdsim.blocks.io: ANALOGIN, ANALOGOUT, DIGITALIN,
DIGITALOUT, PWMOUT, TELEMETRY) live on the unmerged feat/realtime branch, see
Real-time overview.
Copyright (c) Peter Corke 2020-
- Home
- API reference (Sphinx)
- Block catalog
- Control Systems Magazine article
- Adding blocks to your model
- Block path
- Connecting blocks
- Compiling
- Running
- Watching a simulation variable
- Simulation results
- Runtime options
- Environment variables
- Discrete-time blocks
- Subsystems
- Figures
- Notebook animation
- Animation and movies
- PID control
- Coding patterns
- Creating a new block
- Blocks, wires and plugs
- Time stepping: integration, animation & events
- Graphics blocks
- Evaluation
- Block parameters
- Runtimes and simulator state
- Type inference and run-time checks
- Typing and stubs
- Block methods and attributes
- Related packages
Under development on feat/realtime branch, planned for release before end of 2026.