User Guide

This user guide is organized by different topics, each having their own guides. Use the left menu to navigate through them.

• Python client
  • Connections and instrument discovery
  • Proxy instruments
    • Parameters and driver methods
    • Submodules keep their structure
    • Values that cross the connection
    • Making custom classes serializable
    • Following the full lifecycle
  • Parameter snapshots
  • Errors and timeouts
• The Server
• GUI Features
• Parameter Manager
• Client Station
• Monitoring
• Configuration Files
  • Server Configuration
    • Example File
    • Instruments Section
      • GUI Configuration
    • GUI Defaults Section
    • Glob Pattern Matching
    • Networking Section
  • Listener Configuration
    • Example File
    • Common Fields
    • InfluxDB-Specific Fields
    • CSV-Specific Fields
  • Starting Services
    • Starting the Server
    • Starting the Listener
• Instrument Monitoring
  • Overview
  • Quick Start Guide
    • Step 1: Instrumentserver setup
    • Step 2: InfluxDB and Grafana
    • Step 3: The Listener
    • Step 4: Grafana Customization
  • The Instrumentserver
    • Config File
    • Starting the Instrument Server
  • The Listener
    • Config File
      • Necessary Parameters for using InfluxDB
      • Necessary Parameters for using CSV
    • Starting the Listener
  • Docker
  • InfluxDB
  • Grafana
    • Notification Templates
    • Creating Alert Conditions in Grafana
      • Creating Slack Bots
      • Creating Alert Conditions from Scratch
• Virtual Instruments
• Chaining Servers