3. User’s Guide

Contents:

• 3.1. Installation
  • 3.1.1. Preamble
  • 3.1.2. Setting up a new environment
  • 3.1.3. Installing PyMoDAQ
    • 3.1.3.1. Qt5 backend
    • 3.1.3.2. Linux installation
  • 3.1.4. Creating shortcuts on Windows
  • 3.1.5. Plugin Manager
  • 3.1.6. What about the Hardware
    • 3.1.6.1. Serial/GPIB based hardware
    • 3.1.6.2. Library based hardware
    • 3.1.6.3. Python Versions
• 3.2. How to Start
  • 3.2.1. From command line tool:
    • 3.2.1.1. Load installed scripts
    • 3.2.1.2. Execute a given python file
  • 3.2.2. Create windows’s shortcuts:
• 3.3. Configuration
  • 3.3.1. Configs from Managers
  • 3.3.2. PyMoDAQ configuration for default values
  • 3.3.3. Plugins configuration for default values
• 3.4. DashBoard and Control Modules
  • 3.4.1. DashBoard
    • 3.4.1.1. Introduction
    • 3.4.1.2. Menu Bar Description
    • 3.4.1.3. Multiple hardware from one controller
  • 3.4.2. Control Modules
    • 3.4.2.1. DAQ Move
      • 3.4.2.1.1. Introduction
      • 3.4.2.1.2. Hardware initialization
      • 3.4.2.1.3. Positioning
      • 3.4.2.1.4. Advanced positioning
      • 3.4.2.1.5. Settings
        • 3.4.2.1.5.1. Main Settings
        • 3.4.2.1.5.2. Multiaxes controller
        • 3.4.2.1.5.3. Bounds
        • 3.4.2.1.5.4. Scaling
        • 3.4.2.1.5.5. Other settings
      • 3.4.2.1.6. Grabing the actuator’s value
    • 3.4.2.2. DAQ Viewer
      • 3.4.2.2.1. Introduction
      • 3.4.2.2.2. Settings
        • 3.4.2.2.2.1. Toolbar
        • 3.4.2.2.2.2. Hardware initialization
        • 3.4.2.2.2.3. Main settings
      • 3.4.2.2.3. Data Viewers
      • 3.4.2.2.4. Other utilities
      • 3.4.2.2.5. Saving data
        • 3.4.2.2.5.1. Snapshots
        • 3.4.2.2.5.2. Continuous Saving
• 3.5. Extensions
  • 3.5.1. DAQ Scan
    • 3.5.1.1. Introduction
    • 3.5.1.2. Main Control Window
    • 3.5.1.3. Scan Flow
      • 3.5.1.3.1. Selecting detectors and actuators
      • 3.5.1.3.2. Selecting the type of scan
      • 3.5.1.3.3. Selecting the data to render live
    • 3.5.1.4. Various settings
      • 3.5.1.4.1. Toolbar
      • 3.5.1.4.2. Menu Bar Description
      • 3.5.1.4.3. Settings
        • 3.5.1.4.3.1. General Settings
        • 3.5.1.4.3.2. Saving: Dataset and scans
    • 3.5.1.5. Scanner
      • 3.5.1.5.1. Scan1D
      • 3.5.1.5.2. Scan2D
      • 3.5.1.5.3. Sequential
      • 3.5.1.5.4. Tabular
        • 3.5.1.5.4.1. Tabular Linear/Manual case
        • 3.5.1.5.4.2. Tabular Linear/Polylines case
        • 3.5.1.5.4.3. Tabular Adaptive case
      • 3.5.1.5.5. Adaptive
        • 3.5.1.5.5.1. Bounds
        • 3.5.1.5.5.2. Feedback
        • 3.5.1.5.5.3. Loss
    • 3.5.1.6. Navigator
    • 3.5.1.7. Scan Batch Manager
  • 3.5.2. DAQ Logger
    • 3.5.2.1. Introduction
    • 3.5.2.2. Main Control Window
    • 3.5.2.3. H5 saving
    • 3.5.2.4. SQL Database saving
  • 3.5.3. PID Module
    • 3.5.3.1. Introduction
      • 3.5.3.1.1. First example: a boiler
      • 3.5.3.1.2. The PID Model
    • 3.5.3.2. Demonstration with a virtual beam steering system
      • 3.5.3.2.1. Preset configuration
      • 3.5.3.2.2. PID module
      • 3.5.3.2.3. PID configuration
      • 3.5.3.2.4. Automatic control of the setpoints
    • 3.5.3.3. How to write my own PID application?
      • 3.5.3.3.1. Package structure for a PID application
      • 3.5.3.3.2. Detector/actuator plugins
      • 3.5.3.3.3. How to write a PID model?
    • 3.5.3.4. PID module internals
      • 3.5.3.4.1. Files locations
      • 3.5.3.4.2. Packages
      • 3.5.3.4.3. General structure of the module
      • 3.5.3.4.4. The PID loop
  • 3.5.4. H5Browser
  • 3.5.5. Console
• 3.6. Useful Modules
  • 3.6.1. Introduction
  • 3.6.2. Data Viewers
    • 3.6.2.1. 0D Viewer
    • 3.6.2.2. 1D Viewer
    • 3.6.2.3. 2D Viewer
    • 3.6.2.4. ND Viewer
  • 3.6.3. Module Manager
    • 3.6.3.1. Scan Selector
    • 3.6.3.2. Module Manager
  • 3.6.4. H5Saver
  • 3.6.5. Preset manager
  • 3.6.6. Overshoot manager
  • 3.6.7. ROI manager
  • 3.6.8. DAQ_Measurement
  • 3.6.9. Navigator
  • 3.6.10. Remote Manager
  • 3.6.11. ChronoTimer
• 3.7. TCP/IP communication
  • 3.7.1. With PyMoDAQ
  • 3.7.2. On another software
  • 3.7.3. PyMoDAQ TCP/IP Communication protocol
    • 3.7.3.1. Serializing objects
    • 3.7.3.2. Making sure messages are complete:
    • 3.7.3.3. Sending and receiving commands (or message):
    • 3.7.3.4. Sending and receiving Datas:
    • 3.7.3.5. Custom client: how to?