mxcubecore.HardwareRepository#

Gives access to the Hardware Objects contained in the Hardware Repository database

The Hardware Repository database is a set of XML files describing devices, equipments and procedures on a beamline. Each XML file represent a Hardware Object. The Hardware Repository module provides access to these Hardware Objects, and manages connections to the Control Software (Spec or Taco Device Servers).

Functions

add_hardware_objects_dirs(ho_dirs)

Adds directories with xml/yaml config files

get_hardware_repository()

Get the HardwareRepository (singleton) instance,

init_hardware_repository(configuration_path)

Initialise hardware repository - must be run at program start

load_from_yaml(configuration_file, role[, ...])

param configuration_file:

set_user_file_directory(user_file_directory)

Sets user file directory.

uninit_hardware_repository()

mxcubecore.HardwareRepository.add_hardware_objects_dirs(ho_dirs)[source]#

Adds directories with xml/yaml config files

Parameters:

ho_dirs ([type]) – [description]

mxcubecore.HardwareRepository.get_hardware_repository()[source]#

Get the HardwareRepository (singleton) instance,

Returns:

The Singleton instance of HardwareRepository

(in reality __HardwareRepositoryClient)

Return type:

HardwareRepository

mxcubecore.HardwareRepository.init_hardware_repository(configuration_path)[source]#

Initialise hardware repository - must be run at program start

Parameters:

  • configuration_path (str) – PATHSEP-separated string of directories

  • path (giving configuration file lookup) –

Returns:

mxcubecore.HardwareRepository.load_from_yaml(configuration_file, role, _container=None, _table=None)[source]#
Parameters:

  • configuration_file (str) –

  • role (str) – Role name of configured object, used as its name

  • _container (ConfiguredObject) – Container object for recursive loading

  • Optional[List] (_table) – Internal, collecting summary output

Returns:

mxcubecore.HardwareRepository.set_user_file_directory(user_file_directory)[source]#

Sets user file directory.

Parameters:

user_file_directory (str) – absolute path to user file directory