Files
frappy/doc/source/reference.rst
Markus Zolliker e741404d0b simplify configuration of IO modules
As the communicator class needed for a module can be specified,
in the configuration we do not need to specifiy it explicitly.

A new configurator function IO() is introduced for this, defining
names and uri only.

- update also configuration reference and a tutorial example
- update get_class function to accept attributes of classes like
  'frappy_demo.lakshore.TemperatureSensor.ioClass' and import from
  modules other than frappy... like 'test.test_iocfg.Mod'.
- add ioClass to the example class for the temperature controller
  tutorial

Change-Id: I3115371d612f14024e43bc6d38b642e1d27b314d
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/38071
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2026-02-11 13:40:32 +01:00

2.8 KiB

Reference

Core

For convenience everything documented on this page may also be imported from the frappy.core module.

Module Base Classes

frappy.modules.Module

frappy.modules.Readable

frappy.modules.Writable

frappy.modules.Drivable

Parameters, Commands and Properties

frappy.params.Parameter

frappy.params.Command

frappy.properties.Property

frappy.modules.Attached

Access method decorators

frappy.rwhandler.nopoll

Datatypes

frappy.datatypes.FloatRange

frappy.datatypes.IntRange

frappy.datatypes.BoolType

frappy.datatypes.ScaledInteger

frappy.datatypes.EnumType

frappy.datatypes.StringType

frappy.datatypes.TupleOf

frappy.datatypes.ArrayOf

frappy.datatypes.StructOf

frappy.datatypes.BLOBType

frappy.datatypes.DataTypeType

frappy.datatypes.ValueType

frappy.datatypes.NoneOr

frappy.datatypes.OrType

frappy.datatypes.LimitsType

Communication

frappy.modules.Communicator

frappy.io.IOBase

frappy.io.StringIO

frappy.io.BytesIO

frappy.io.HasIO

frappy.lib.asynconn.AsynTcp

frappy.lib.asynconn.AsynSerial

frappy.rwhandler.ReadHandler

frappy.rwhandler.CommonReadHandler

frappy.rwhandler.WriteHandler

frappy.rwhandler.CommonWriteHandler

Exception classes

frappy.errors