Modules

This page provides an overview of the main modules in the AFL-automation framework.

• API Server
  • AFL.automation.APIServer
    • APIServer
      • APIServer.__init__()
      • APIServer.create_queue()
      • APIServer.reset_queue_daemon()
      • APIServer.advertise_zeroconf()
      • APIServer.run()
      • APIServer.run_threaded()
      • APIServer.add_standard_routes()
      • APIServer.get_info()
      • APIServer.get_quickbar()
      • APIServer.is_server_live()
      • APIServer.get_unqueued_commands()
      • APIServer.get_queued_commands()
      • APIServer.add_unqueued_routes()
      • APIServer.query_driver()
      • APIServer.init_logging()
      • APIServer.index()
      • APIServer.index_new()
      • APIServer.webapp()
      • APIServer.render_unqueued()
      • APIServer.send_1d_plot()
      • APIServer.send_array_as_jpg()
      • APIServer.queue_state()
      • APIServer.driver_status()
      • APIServer.get_queue()
      • APIServer.get_queue_iteration()
      • APIServer.deposit_obj()
      • APIServer.retrieve_obj()
      • APIServer.set_driver_object()
      • APIServer.get_driver_object()
      • APIServer.enqueue()
      • APIServer.reorder_queue()
      • APIServer.remove_items()
      • APIServer.remove_item()
      • APIServer.move_item()
      • APIServer.clear_queue()
      • APIServer.clear_history()
      • APIServer.debug()
      • APIServer.pause()
      • APIServer.halt()
      • APIServer.init()
      • APIServer.login()
      • APIServer.get_server_time()
      • APIServer.login_test()
    • CAStatusPublisher
      • CAStatusPublisher.__init__()
      • CAStatusPublisher.run()
    • AFL.automation.APIServer.Client
      • Client
    • AFL.automation.APIServer.Driver
      • makeRegistrar()
      • Driver
    • AFL.automation.APIServer.DummyDriver
      • DummyDriver
    • AFL.automation.APIServer.DummyOT2Driver
      • DummyDriver
    • AFL.automation.APIServer.LoggerFilter
      • LoggerFilter
    • AFL.automation.APIServer.QueueDaemon
      • QueueDaemon
• Instrument
  • AFL.automation.instrument
    • AFL.automation.instrument.APSDNDCAT
      • APSDNDCAT
    • AFL.automation.instrument.APSUSAXS
      • APSUSAXS
    • AFL.automation.instrument.CDSAXSLabview
      • CDSAXSLabview
      • LabviewConnection
    • AFL.automation.instrument.CHESSID3B
      • CHESSID3B
    • AFL.automation.instrument.DummySAS
      • DummySAS
    • AFL.automation.instrument.FileCamera
      • FileCamera
    • AFL.automation.instrument.GPInterpolator
      • Interpolator
      • ClusteredGPs
    • AFL.automation.instrument.I22SAXS
      • I22SAXS
    • AFL.automation.instrument.NICEConsole
      • NICEConsole
    • AFL.automation.instrument.NICEData
      • NICEData
    • AFL.automation.instrument.NICEDevice
      • NICEDevice
    • AFL.automation.instrument.NetworkCamera
      • NetworkCamera
    • AFL.automation.instrument.NicosScriptClient
      • NicosScriptClient
    • AFL.automation.instrument.OpticalTurbidity
      • OpticalTurbidity
    • AFL.automation.instrument.PySpecClient
      • PySpecClient
    • AFL.automation.instrument.SINQSANS
      • SINQSANS
      • SICSTelnetClient
    • AFL.automation.instrument.SINQSANS_NICOS
      • SINQSANS_NICOS
    • AFL.automation.instrument.ScatteringInstrument
      • ScatteringInstrument
    • AFL.automation.instrument.SeabreezeUVVis
      • SeabreezeUVVis
    • AFL.automation.instrument.SpecScreen_Driver
      • SpecScreen_Driver
    • AFL.automation.instrument.USBCamera
      • USBCamera
    • AFL.automation.instrument.VirtualSANS_data
      • VirtualSANS_data
    • AFL.automation.instrument.VirtualSAS_theory
      • VirtualSAS_theory
    • AFL.automation.instrument.VirtualSpec_data
      • VirtualSpec_data
    • AFL.automation.instrument.scatteringInterpolator
      • Scattering_generator
      • GenerateScattering
• Loading
  • AFL.automation.loading
    • AFL.automation.loading.CetoniMultiPosValve
      • CetoniMultiPosValve
    • AFL.automation.loading.CetoniSyringePump
      • CetoniSyringePump
    • AFL.automation.loading.ChemyxSyringePump
      • ChemyxSyringePump
      • getOpenPorts()
      • parsePortName()
      • ChemyxConnection
    • AFL.automation.loading.DAQC2Sensor
      • DACQC2Sensor
    • AFL.automation.loading.DigitalOutPressureController
      • DigitalOutPressureController
    • AFL.automation.loading.DoubleViciMultiposSelector
      • DoubleViciMultiposSelector
    • AFL.automation.loading.DummyPump
      • DummyPump
    • AFL.automation.loading.FlowSelector
      • FlowSelector
    • AFL.automation.loading.LabJackDigitalOut
      • LabJackDigitalOut
    • AFL.automation.loading.LabJackGPIO
      • LabJackGPIO
    • AFL.automation.loading.LabJackRelay
      • LabJackRelay
      • bitmask_to_dict()
    • AFL.automation.loading.LabJackSensor
      • LabJackSensor
    • AFL.automation.loading.LoadStopperDriver
      • LoadStopperDriver
    • AFL.automation.loading.MultiChannelRelay
      • MultiChannelRelay
    • AFL.automation.loading.NE1kSyringePump
      • NE1kSyringePump
    • AFL.automation.loading.OneSelectorBlowoutSampleCell
      • OneSelectorBlowoutSampleCell
    • AFL.automation.loading.PiGPIO
      • PiGPIO
    • AFL.automation.loading.PiPlatesRelay
      • PiPlatesRelay
    • AFL.automation.loading.PneumaticPressureSampleCell
      • PneumaticPressureSampleCell
    • AFL.automation.loading.PneumaticSampleCell
      • PneumaticSampleCell
    • AFL.automation.loading.PressureController
      • PressureController
    • AFL.automation.loading.PressureControllerAsPump
      • PressureControllerAsPump
    • AFL.automation.loading.PushPullSelectorSampleCell
      • PushPullSelectorSampleCell
    • AFL.automation.loading.RSoXSSolutionSampleCell
      • RSoXSSolutionSampleCell
    • AFL.automation.loading.SainSmartRelay
      • SainSmartRelay
      • usbrelay
    • AFL.automation.loading.SampleCell
      • SampleCell
    • AFL.automation.loading.Sensor
      • Sensor
      • DummySensor1
      • DummySensor2
    • AFL.automation.loading.SensorCallbackThread
      • SensorCallbackThread
      • StopLoadCBv1
      • StopLoadCBv2
      • SimpleThresholdCB
      • LoaderCommunication
    • AFL.automation.loading.SensorPollingThread
      • SensorPollingThread
    • AFL.automation.loading.SerialDevice
      • SerialDevice
    • AFL.automation.loading.SyringePump
      • SyringePump
    • AFL.automation.loading.Tubing
      • Tubing
    • AFL.automation.loading.TwoSelectorBlowoutSampleCell
      • TwoSelectorBlowoutSampleCell
    • AFL.automation.loading.UltimusVPressureController
      • UltimusVPressureController
    • AFL.automation.loading.ViciMultiposSelector
      • ViciMultiposSelector
• Prepare
• Sample
  • AFL.automation.sample
  • AFL.automation.sample_env
    • AFL.automation.sample_env.TemperatureDeck
      • TemperatureDeck
• Shared
  • AFL.automation.shared
    • AFL.automation.shared.DataLabelerWidget
      • DataLabelerWidget
      • DataLabelerModel
      • DataLabelerView
    • AFL.automation.shared.DatasetWidget
      • DatasetWidget
      • DatasetWidget_Model
      • DatasetWidget_View
    • AFL.automation.shared.DiffractionLabeler
      • DiffractionLabeler
      • DiffractionLabelerModel
      • DiffractionLabelerView
    • AFL.automation.shared.MutableQueue
      • MutableQueue
    • AFL.automation.shared.PersistentConfig
      • PersistentConfig
    • AFL.automation.shared.ServerDiscovery
      • RunThread
      • ServerDiscovery
    • AFL.automation.shared.exceptions
      • EmptyException
      • MixingException
      • SerialCommsException
      • NoDeviceFoundException
      • NotFoundError
    • AFL.automation.shared.serialization
      • serialize()
      • is_serialized()
      • deserialize()
    • AFL.automation.shared.units
      • has_units()
      • is_volume()
      • is_molarity()
      • is_mass()
      • is_density()
      • is_concentration()
      • is_dimensionless()
      • get_unit_type()
      • to_quantity()
      • enforce_units()
    • AFL.automation.shared.utilities
      • listify()
      • tprint()
      • makeRegistar()
      • mpl_plot_to_bytes()
      • xarray_to_bytes()
    • AFL.automation.shared.warnings
      • warning_on_one_line()
      • MixWarning
    • AFL.automation.shared.widgetui
      • client_construct_ui()