devices: add a short description in devices/index.rst

API Reference

Add a short description of what dummy and general are in devices/index.rst

attribute

attributeLogger

device

deviceBaumerLaserSensor

deviceChannel

deviceClient

deviceCv2

deviceEpos

deviceFileServer

deviceFileSync

deviceGalil

deviceGalilMotor

deviceInficonQcm

deviceKaraboBridge

deviceKohzu

Example of yaml configuration

Kohzu0: &Kohzu0 !Device:kamzik3.devices.deviceKohzu.DeviceKohzu
   device_id: Kohzu0
   host: 192.168.83.94
Kohzu0_axis_0: &Kohzu0_axis_0 !Device:kamzik3.devices.deviceKohzu.DeviceKohzuChannel
    device: *Kohzu0
    channel: 0
    device_id: Motor
    config:
     attributes:
       !!python/tuple [Encoder resolution, Value]: 50 nm
       !!python/tuple [Step resolution, Value]: 500 nm
       !!python/tuple [Encoder calc den, Value]: 1
       !!python/tuple [Encoder calc num, Value]: 10
       !!python/tuple [Position, Tolerance]: [0.5um, 0.5um]
       !!python/tuple [Referencing method, Value]: 4
       !!python/tuple [Position +limit, Value]: 10 mm
       !!python/tuple [Position -limit, Value]: -10 mm
       !!python/tuple [Maximum velocity, Value]: 10000

deviceLexium

deviceLogParser

deviceMaxiGauge

deviceOsLibrary

devicePeakTech

devicePi

devicePicoscale

devicePort

deviceProbusV

devicePublisher

deviceSavedAttributes

deviceScreenGrabber

deviceServer

deviceSession

deviceSmaractMcs1

deviceSmaractMcs2

deviceSmarpodEcm

deviceSocket

deviceTango

Example of yaml configuration

Lambda: !Device:kamzik3.devices.deviceTango.DeviceTango
    path: tango://mll-lambda.desy.de:10000/mll/lambda/01
    config:
      poll_attributes:
        - [SaveFileName, 300]
        - [FileStartNum, 300]
        - [SaveFilePath, 500]
        - [EnergyThreshold, 1000]
        - [ShutterTime, 1000]
        - [FilePreExt, 1000]
        - [FramesPerFile, 1000]

deviceThermoCube

deviceVirtualDirectory

deviceWorker

deviceZled

observer

subject