Skip to content

Reference

Look things up here: what a word means, every key of the files a session reads, the variables it sets, where it writes its logs, the API and the release notes.

Glossary

  • Glossary: the words the documentation uses, each defined once

Files

Hook points

  • Hook points: the moments a session calls its hook providers at, their order, and what a failure does

Command line

Environment

Log files

  • Log files: where a session writes its records, and what a record looks like

API by task

To Look up
declare the components of a session Declaring components
check what a component must have What a component is held to
act at a moment of the build Hook points
change one step of the build Build steps
share a value, or ask the session for one redsun.injection, redsun.registry
connect a signal to a slot redsun.ports
describe a plan and build its controls redsun.presenter, Qt widgets
run a plan, or one that runs until stopped redsun.engine
place a view in the window Placements
keep a setting between runs Settings
choose where files go redsun.path_provider
launch or attach to a service redsun.services
serve a fastcs controller over shared memory and build its device redsun.services.sharedbox, redsun.device.sharedbox
test a plugin's components and services redsun.testing
log from a component redsun.log
catch what a session raises redsun.errors

API by module

Find a class or a function by the module you import it from.