Contents

Introduction

• Introduction
  • What can Malcolm do?
  • How is the documentation structured?
    • Configuring Malcolm to work with your hardware
    • Controlling Malcolm via comms protocols
  • Installation Guide
    • Using pipenv
    • Using pip

Tutorials

• Hello World Tutorial
  • Launching a Malcolm Process
  • Connecting a second Malcolm Process
  • Defining a Block
  • Defining a Part
  • Conclusion
• Counter Tutorial
  • Creating Attributes in a Part
  • Visualising the Block with the GUI
  • Conclusion
• Motion Tutorial
  • Creating Device Blocks
  • Controller for Device Blocks
  • Adding functionality to a ManagerController
  • How it looks in the GUI
  • Deleting Blocks
  • Load/Save
  • Conclusion
• Detector Tutorial
  • Specifying Scan Points
  • Creating Runnable Device Blocks
  • Controller for Runnable Device Blocks
  • Adding functionality to a RunnableController
  • Hooking into configure()
  • Passing Infos back to the Controller
  • Hooking into run()
  • Hooking into seek(), abort() and reset()
  • Running the demo
  • Conclusion
• Scanning Tutorial
  • Block Hierarchy
  • Creating the Blocks
  • Scan Block
  • Hooking a Simple Device Block into a Scan
  • Hooking into configure()
  • Hooking into run()
  • Running a Scan
  • Conclusion
• AreaDetector Tutorial
  • Acquisition Strategy
  • Creating the Blocks
  • Device Block
  • Hardware Blocks
  • Template Designs
  • Scan Block Design
  • Running a Scan
  • Conclusion
• PMAC Master Tutorial
  • Strategy
  • EPICS Prerequisites
  • Make a Malcolm directory for a beamline
  • Define the Process Definition
  • Define a PMAC Block
  • Define a scan Block
  • Expose Blocks in a module
  • Setup the Devices
  • Setup the Scan
  • Conclusion
• PandA Master Tutorial
  • Strategy
    • Position Compare
    • Motion Gate
  • Adding to the scan Block
  • Setup the Devices
  • Setup the Scan
  • Conclusion

Reference

• Glossary
  • Attribute
  • Block
  • ClientComms
  • Context
  • Controller
  • Design
  • Device Layer
  • Exports
  • Future
  • Hardware Layer
  • Hook
  • Include
  • Info
  • Initial Design
  • Method
  • mri
  • Part
  • Process
  • Process Definition
  • Scan Layer
  • ServerComms
  • Tags
  • Template Design
• Block Structure
• Message Structure
  • Get
  • Put
  • Post
  • Subscribe
  • Unsubscribe
  • Return
  • Error
  • Update
  • Delta
• Supported Tags
  • Widget Tag
  • Linked Value Tag
  • Badge Value Tag
  • Port Tag
    • Port types
    • Source Port Tag
    • Sink Port Tag
  • Group Tag
  • Config Tag
  • Method Return Unpacked Tag
  • Version Tag
  • Hidden Method Tag
• State Sets and Hooks
  • StatefulController
  • ManagerController
  • RunnableController
• Infos
  • builtin module Infos
  • scanning module Infos
  • web module Infos
• Datasets and Detectors
• Trajectory Scan Triggering
  • PMAC-based Triggering
  • Using the PandA for Triggering
• Contributing
  • Setup
  • Running the tests
  • Code Styling
  • Pipfile.lock
  • Documentation
    • Building the docs
  • Coding Conventions
  • Release Checklist
• Change Log
  • 6.3 - 2024-03-15
  • 6.2.1 - 2022-11-09
  • 6.2 - 2022-08-24
  • 6.1 - 2022-05-31
  • 6.0 - 2022-05-11
  • 5.4 - 2022-03-30
  • 5.3 - 2022-03-18
  • 5.2 - 2022-01-05
  • 5.1 - 2021-12-16
  • 5.0 - 2021-11-30
  • 4.6 - 2021-08-17
  • 4.5 - 2021-04-27
  • 4.4 - 2021-03-02
  • 4-3-1 - 2020-09-18
  • 4-2b8 - 2020-04-17
  • 4-2b6 - 2020-02-10
  • 4-2b5 - 2020-01-27
  • 4-2b4 - 2019-12-04
  • 4-2b3 - 2019-11-28
  • 4-2b2 - 2019-11-27
  • 4-2b1 - 2019-11-27
  • 4-1-1 - 2019-11-18
  • 4-1 - 2019-09-26
  • 4-0 - 2019-07-05
  • 4-0b2 - 2019-06-20
  • 4-0b1 - 2019-05-03
  • 3-5-1 - 2019-07-26
  • 3-5 - 2019-06-17
  • 3-4-1 - 2019-05-08
  • 3-4 - 2019-03-28
  • 3-3 - 2019-02-19
  • 3-2 - 2019-01-21
  • 3-0 - 2019-01-04
  • 3-0b2 - 2018-12-05
  • 3-0b1 - 2018-12-04
  • 3-0a9 - 2018-12-03
  • 3-0a8 - 2018-11-30
  • 3-0a7 - 2018-11-27
  • 3-0a6 - 2018-11-05
  • 3-0a5 - 2018-10-17
  • 3-0a4 - 2018-09-24
  • 3-0a3 - 2018-07-25
  • 3-0a2 - 2018-07-17
  • 3-0a1 - 2018-07-16
  • 2-3-1 - 2018-06-07
  • 2-3 - 2018-05-31
  • 2-2 - 2018-03-29
  • 2-1 - 2017-08-30
  • 2-0a6 - 2016-10-03
  • 2-0a5 - 2016-10-03
  • 2-0a4 - 2016-09-20
  • 2-0a3 - 2016-08-31
  • 2-0a2 - 2016-08-30
  • 2-0a1 - 2016-08-15

API

• malcolm.core
• malcolm.yamlutil
• malcolm.modules
  • ADAndor
    • blocks
    • parts
  • ADAndor3
    • blocks
  • ADCore
    • blocks
    • includes
    • infos
    • parts
    • util
  • ADEiger
    • blocks
    • parts
  • ADEthercat
    • blocks
    • parts
  • ADMerlin
    • blocks
  • ADOdin
    • blocks
    • parts
  • ADPandABlocks
    • blocks
    • controllers
    • includes
    • parts
    • util
  • ADPco
    • blocks
  • ADPilatus
    • blocks
  • ADSimDetector
    • blocks
  • ADTetrAMM
    • blocks
    • parts
  • ADTucsen
    • blocks
    • parts
  • adUtil
    • blocks
    • parts
  • aravisGigE
    • blocks
  • asyn
    • parts
  • builtin
    • blocks
    • controllers
    • defines
    • hooks
    • infos
    • parameters
    • parts
    • util
  • ca
    • parts
    • util
  • demo
    • blocks
    • parts
    • util
  • dtacq
    • blocks
  • pandablocks
    • blocks
    • controllers
    • parts
    • util
  • pmac
    • blocks
    • includes
    • infos
    • parts
    • util
  • profiling
    • blocks
    • parts
  • pva
    • blocks
    • controllers
  • scanning
    • blocks
    • controllers
    • hooks
    • infos
    • parts
    • util
  • system
    • blocks
    • controllers
    • defines
    • parts
  • web
    • blocks
    • controllers
    • hooks
    • infos
    • parts
    • util
  • xmap
    • blocks
    • parts
  • xspress3
    • blocks
    • parts
  • zebra
    • blocks
• External modules

Appendix

• Index