Files
frappy/doc/source/reference.rst
Markus Zolliker 10a61aa760 T controller tutorial and improve documentation
add tutorial for Berlin hands-on workshop

+ improve the documentation (hints for structure welcome)
+ remove 'optional' parameter property
  (is not yet used - should not appear in doc)
+ added test property in frappy_demo.cryo alters Parameter class
  ('test' property appears in Parameter doc)

Change-Id: I3ea08f955a92f72451fd23a5ff00d1185c7fb00e
2023-02-13 15:58:39 +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.Done

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