Welcome to qosst-hal’s documentation!

QOSST HAL, HAL for Hardware Abstraction Layer, holds the interface class for the different hardware used in the QOSST software.

This project is part of QOSST.

Warning

This package only provides the abstract classes for the abstraction layer and does not provide any actual implementation of the hardware. Will some implementations might have been release, they are not part of this software.

Introduction

• Getting started
  • Hardware requirements
    • Operating System
    • Python version
  • Installing the software
• Role of the HAL
• Implementing your own hardware class
  • General idea
  • QOSSTHardware
  • Required methods
    • ADC
    • Amperemeter
    • DAC
    • DACADC
    • Laser
    • Modulator bias controller
    • Polarisation Controller
    • Powermeter
    • Powersupply
    • Switch
    • VOA
    • Voltmeter
  • need_modules

API

• Base
• ADC
• Amperemeter
• DAC
• DACADC
• Laser
• Modulator Bias Control
• Polarisation controller
• Powermeter
• Power supply
• Switch
• VOA
• Voltmeter
• Utils

Community

• Contributing
• License