bec_lib#

bec_lib.alarm_handler

This module provides the alarm handler class and its related functionality.

bec_lib.async_data

This module contains the AsyncDataHandler class which is used to receive and store async device data from the BEC.

bec_lib.bec_errors

This module contains the custom exceptions used in the BEC library.

bec_lib.bec_service

This module provides the BECService class, which is the base class for all BEC services.

bec_lib.bl_checks

This module provides the BeamlineChecks class, which is used to perform beamline checks.

bec_lib.bl_conditions

This module contains classes for beamline checks, used to check the beamline status.

bec_lib.callback_handler

This module contains the CallbackHandler class to handle callbacks.

bec_lib.channel_monitor

This module provides a command line interface to monitor a channel.

bec_lib.client

BECClient class.

bec_lib.config_helper

This module provides a helper class for updating and saving the BEC device configuration.

bec_lib.configs

bec_lib.connector

This module defines the interface for a connector

bec_lib.dap_plugin_objects

This module contains the base classes for DAP plugin objects.

bec_lib.dap_plugins

This module provides the DAPPlugins class, which is used to access all available DAP plugins.

bec_lib.device

This module provides the DeviceBase class as well as its derived classes Signal, ComputedSignal, Positioner, and Device.

bec_lib.devicemanager

This module contains the DeviceManager class which is used to manage devices and their configuration.

bec_lib.endpoints

Endpoints for communication within the BEC.

bec_lib.file_utils

Module for file utilities.

bec_lib.lmfit_serializer

This module contains functions for serializing and deserializing lmfit objects.

bec_lib.logbook_connector

This module provides a connector to the electronic logbook SciLog.

bec_lib.logger

This module contains the BECLogger class, which is a wrapper around the loguru logger.

bec_lib.messages

bec_lib.numpy_encoder

This module contains the numpy encoder and decoder functions for serializing and deserializing numpy objects.

bec_lib.observer

This module provides the Observer class and the ObserverManager class.

bec_lib.pdf_writer

This module contains a class for writing pdfs.

bec_lib.plugin_helper

bec_lib.queue_items

This module contains the QueueItem and QueueStorage classes.

bec_lib.redis_connector

This module provides a connector to a redis server.

bec_lib.request_items

This module contains the RequestItem class and RequestStorage class.

bec_lib.scan_data

This module contains the classes for storing scan data from scan_segments.

bec_lib.scan_items

This module contains the ScanItem and ScanStorage classes.

bec_lib.scan_manager

This module provides a class that provides a convenient way to interact with the scan queue as well as the requests and scans that are currently running or have been completed.

bec_lib.scan_report

Scan Report class that provides a convenient way to access the status of a scan request.

bec_lib.scans

This module contains the Scans class and related classes for defining and running scans in BEC from the client side.

bec_lib.scibec_validator

This module provides a class to validate the device configuration against the openapi schema of SciBec.

bec_lib.serialization

Serialization module for BEC messages

bec_lib.service_config

This module provides a class to handle the service configuration.

bec_lib.signature_serializer

This module contains functions to serialize and deserialize function signatures.

bec_lib.tests

bec_lib.user_scripts_mixin

This module provides a mixin class for the BEC class that allows the user to load and unload scripts from the scripts directory.

bec_lib.utils

Utility functions for the bec_lib package.