Developer API

Auto-generated docs from the python source files. When viewing a function or class definition, use the button [source] on the left side to view the related source code itself.

• device package
  • Subpackages
    • device.base package
      • Submodules
  • Submodules
    • device.camera_device module
      • CameraDevice
    • device.camera_run module
      • check_dependencies()
      • get_my_ips()
      • start_encoder_rtmp()
      • start_stream()
    • device.gauge_controller_tpg36x module
      • GaugeController_TPG361
      • GaugeController_TPG362
      • GaugeController_TPG366
      • GaugeController_TPG36x
    • device.interfer_motors module
      • InterferometryMotors
    • device.langmuir_hotprobe module
      • LangmuirHotProbe
    • device.langmuir_motors module
      • LangmuirMotors
    • device.langmuir_probe module
      • LangmuirProbe
    • device.magnets_motors module
      • MagnetsMotors
    • device.magnets_probes module
      • MagnetsProbes
    • device.magnets_ps_switch module
      • PowerSupply_Magnets_SwitchOnOff
    • device.mockup module
      • Discharge
      • MockupDevice
    • device.oscope_ds1074z module
      • Oscope_DS1074Z
    • device.oscope_mso5000 module
      • Oscope_MSO5000
    • device.paschen_motor module
      • Arduino
      • PaschenMotor
    • device.power_supply_ki2290 module
      • PowerSupply_KI2290
    • device.power_supply_langmuir module
      • PowerSupply_Langmuir
    • device.power_supply_magnets module
      • PowerSupply_Magnets
    • device.resonance_controller module
      • ResonanceController
    • device.source_meter_ki2400 module
      • SourceMeter_KI2400
    • device.spectral_dsa800 module
      • SpectralAnalyser_DSA800
    • device.trap_cathode module
      • TrapCathodeHeater
    • device.trap_diganostics module
      • TrapDiagnostics
    • device.trap_hv_supply module
      • TrapHighVoltageSupply
    • device.trap_probe module
      • TrapProbe
    • device.valve_board module
      • InterfaceI2C
      • InterfaceSPI
      • Rules
      • ValveBoard
      • ValveRuleError
• device_client package
  • Submodules
  • device_client.client_camera module
    • connect()
  • device_client.client_interfer_motors module
    • connect()
  • device_client.client_interfer_oscope module
    • connect()
  • device_client.client_langmuir_gauge module
    • connect()
  • device_client.client_langmuir_hotprobe module
    • connect()
  • device_client.client_langmuir_motors module
    • connect()
  • device_client.client_langmuir_probe module
    • connect()
    • description
  • device_client.client_langmuir_ps module
    • connect()
  • device_client.client_langmuir_sourcemeter module
    • connect()
  • device_client.client_magnets_motors module
    • connect()
  • device_client.client_magnets_probes module
    • connect()
  • device_client.client_magnets_psbig module
    • connect()
  • device_client.client_magnets_pssmall module
    • connect()
  • device_client.client_magnets_psswitch module
    • connect()
  • device_client.client_oscope_ds1074z module
    • connect()
  • device_client.client_paschen_gauge module
    • connect()
  • device_client.client_paschen_motor module
    • connect()
  • device_client.client_paschen_powersupply module
    • connect()
  • device_client.client_resonance_controller module
    • connect()
  • device_client.client_resonance_spectanalyser module
    • connect()
  • device_client.client_test module
    • connect()
  • device_client.client_trap_cathode module
    • connect()
  • device_client.client_trap_diagnostics module
    • connect()
  • device_client.client_trap_hvsupply module
    • connect()
  • device_client.client_trap_probe module
    • connect()
  • device_client.client_trap_pscoils module
    • connect()
  • device_client.client_valveboard module
    • connect()
  • device_client.device_client module
    • DeviceClient
      • DeviceClient.connected
      • DeviceClient.disconnect_and_stop()
      • DeviceClient.emit()
      • DeviceClient.emit_command_state()
      • DeviceClient.emit_datafile()
      • DeviceClient.emit_log()
      • DeviceClient.keep_server_updated()
      • DeviceClient.on_connect()
      • DeviceClient.on_disconnect()
      • DeviceClient.register_background_task()
      • DeviceClient.register_command()
      • DeviceClient.registered
• server package
  • check_secrets()
  • create_app()
  • populate_database()
  • run_server()
  • Subpackages
    • server.events package
      • Submodules
      • server.events.client module
      • server.events.device module
      • server.events.update_frontend module
    • server.resources package
      • Submodules
      • server.resources.resources module
    • server.views_api package
      • Submodules
      • server.views_api.datafiles module
      • server.views_api.device module
      • server.views_api.experiment module
      • server.views_api.other module
      • server.views_api.session module
      • server.views_api.user module
      • server.views_api.usergroup module
      • server.views_api.validations module
    • server.views_main package
      • Submodules
      • server.views_main.auth module
      • server.views_main.root module
  • Submodules
  • server.blacklist_helpers module
    • add_token_to_database()
    • get_user_tokens()
    • prune_database()
    • revoke_all_tokens()
    • revoke_token()
    • token_is_revoked()
    • unrevoke_token()
  • server.config module
  • server.exceptions module
    • ItemMustHaveId
    • NonexistentDevice
    • NonexistentSid
    • PyplasError
    • TokenNotFound
    • UniqueIdConflict
  • server.functions module
    • submit_device()
    • submit_experiment()
    • submit_session()
    • submit_user()
    • submit_usergroup()
  • server.models module
    • Device
      • Device.by_id()
      • Device.by_name()
      • Device.check_password()
      • Device.id
      • Device.id_public
      • Device.ipv4
      • Device.modify()
      • Device.name
      • Device.password
      • Device.set_password()
      • Device.to_dict()
    • Experiment
      • Experiment.by_id()
      • Experiment.by_name()
      • Experiment.devices
      • Experiment.id
      • Experiment.id_public
      • Experiment.modify()
      • Experiment.name
      • Experiment.sessions
      • Experiment.to_dict()
    • Session
      • Session.all_active()
      • Session.begin
      • Session.by_id()
      • Session.end
      • Session.experiment
      • Session.experiment_id
      • Session.id
      • Session.id_public
      • Session.is_active()
      • Session.modify()
      • Session.name
      • Session.to_dict()
      • Session.users
    • Token
      • Token.expires
      • Token.id
      • Token.jti
      • Token.revoked
      • Token.to_dict()
      • Token.token_type
      • Token.user_identity
    • User
      • User.by_id()
      • User.by_username()
      • User.check_password()
      • User.email
      • User.get_active_sessions()
      • User.id
      • User.id_public
      • User.is_admin
      • User.modify()
      • User.password
      • User.role
      • User.sessions
      • User.set_password()
      • User.to_dict()
      • User.usergroups
      • User.username
    • Usergroup
      • Usergroup.by_id()
      • Usergroup.by_name()
      • Usergroup.description
      • Usergroup.id
      • Usergroup.id_public
      • Usergroup.modify()
      • Usergroup.name
      • Usergroup.style_json
      • Usergroup.to_dict()
      • Usergroup.users
  • server.protections module
    • add_claims_to_access_token()
    • admin_required()
    • admin_required_sio()
    • content_json()
    • device_required_sio()
    • user_authorized_for_device()
    • user_required()
    • user_required_sio()
  • server.proxy_helpers module
    • real_remote_addr()
  • server.serverlogging module
    • SlackHandler
      • SlackHandler.emit()
    • TimedSummaryFilter
      • TimedSummaryFilter.filter()
      • TimedSummaryFilter.log_summary()
    • configure()