Welcome to nxsrecconfig’s documentation!¶
Authors: Jan Kotanski Introduction
Tango server with Sardana Recorder settings
Tango Server API: https://nexdatas.github.io/nxsrecselector/doc_html
Installation¶
Install the dependencies:
From sources¶
Download the latest version of NeXuS Configuration Server from
Extract the sources and run
$ python3 setup.py install
Debian packages¶
Debian bookworm, bullseye and buster or ubuntu oracular, noble, jammy packages can be found in the HDRI repository.
To install the debian packages, add the PGP repository key
$ sudo su
$ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -
and then download the corresponding source list
$ cd /etc/apt/sources.list.d
$ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list
Finally, install module
$ apt-get update
$ apt-get install python3-nxsrecselector
and the NXSRecSelector tango server
$ apt-get update
$ apt-get install nxsrecselector
To instal other NexDaTaS packages
$ apt-get install python3-nxswriter nxsconfigtool nxstools python3-nxsconfigserver nxsconfigserver-db
and
$ apt-get install nxselector python3-sardana-nxsrecorder
for Component Selector and Sardana related packages.
From pip¶
To install it from pip you can
$ python3 -m venv myvenv
$ . myvenv/bin/activate
$ pip install nxsrecselector
Moreover it is also good to install
$ pip install pytango
$ pip install taurus
$ pip install sardana
$ pip install nxswriter
$ pip install nxsconfigserver
$ pip install nxstools
$ pip install pymysqldb
Setting environment¶
Setting Saradna¶
If sardana is not yet set up run
$ Pool
enter a new instance name
create the new instance
Then wait a while until Pool is started and in a new terminal run
$ MacroServer
enter a new instance name
create the new instance
connect pool
Next, run Astor and change start-up levels: for Pool to 2, for MacroServer to 3 and restart servers.
Alternatively, terminate Pool and MacroServer in the terminals and run
$ nxsetup -s Pool -l2
wait until Pool is started and run
$ nxsetup -s MacroServer -l3
Additionally, one can create dummy devices by running sar_demo in
$ spock
Setting NeXus Servers¶
To set up NeXus Servers run
$ nxsetup -x
or
$ nxsetup -x NXSDataWriter
$ nxsetup -x NXSConfigServer
$ nxsetup -x NXSRecSelector
for specific servers.
If the RecoderPath property of MacroServer is not set one can do it by
$ nxsetup -a /usr/lib/python2.7/dist-packages/sardananxsrecorder
where the path should point the sardananxsrecorder package.
Contents:¶
- nxsrecconfig package
- Submodules
- nxsrecconfig.CheckerThread module
- nxsrecconfig.Converter module
- nxsrecconfig.Describer module
- nxsrecconfig.DynamicComponent module
- nxsrecconfig.MacroServerPools module
MacroServerPoolsMacroServerPools.checkChannels()MacroServerPools.getMacroServer()MacroServerPools.getPools()MacroServerPools.getScanEnv()MacroServerPools.getSelectorEnv()MacroServerPools.isDoorRunning()MacroServerPools.poolBlacklistMacroServerPools.setScanEnv()MacroServerPools.setSelectorEnv()MacroServerPools.tangoSourceErrorStatesMacroServerPools.tangoSourceWarningStatesMacroServerPools.updateMacroServer()
- nxsrecconfig.NXSConfig module
NXSRecSelectorNXSRecSelector.AddStepDataSources()NXSRecSelector.AdministratorDataNames()NXSRecSelector.AvailableComponents()NXSRecSelector.AvailableDataSources()NXSRecSelector.AvailableMntGrps()NXSRecSelector.AvailableProfiles()NXSRecSelector.AvailableTimers()NXSRecSelector.ChannelProperties()NXSRecSelector.ComponentClientSources()NXSRecSelector.ComponentDataSources()NXSRecSelector.ComponentDescription()NXSRecSelector.ComponentSources()NXSRecSelector.CreateDataSources()NXSRecSelector.CreateDynamicComponent()NXSRecSelector.CreateWriterConfiguration()NXSRecSelector.DataSourceDescription()NXSRecSelector.DeleteAllProfiles()NXSRecSelector.DeleteProfile()NXSRecSelector.ExportEnvProfile()NXSRecSelector.FetchProfile()NXSRecSelector.FullDeviceNames()NXSRecSelector.ImportEnvProfile()NXSRecSelector.ImportMntGrp()NXSRecSelector.IsMntGrpUpdated()NXSRecSelector.LoadProfile()NXSRecSelector.MandatoryComponents()NXSRecSelector.MntGrpConfiguration()NXSRecSelector.MutedChannels()NXSRecSelector.PoolElementNames()NXSRecSelector.PreselectComponents()NXSRecSelector.PreselectedComponents()NXSRecSelector.PreselectedDataSources()NXSRecSelector.RemoveDynamicComponent()NXSRecSelector.ResetPreselectedComponents()NXSRecSelector.SaveProfile()NXSRecSelector.ScanEnvVariables()NXSRecSelector.SelectedComponents()NXSRecSelector.SelectedDataSources()NXSRecSelector.SetChannelProperties()NXSRecSelector.SetScanEnvVariables()NXSRecSelector.StoreProfile()NXSRecSelector.SwitchProfile()NXSRecSelector.UpdateConfigVariables()NXSRecSelector.UpdateMntGrp()NXSRecSelector.UpdateProfile()NXSRecSelector.VariableComponents()NXSRecSelector.always_executed_hook()NXSRecSelector.delete_device()NXSRecSelector.init_device()NXSRecSelector.is_AdministratorDataNames_allowed()NXSRecSelector.is_AvailableComponents_allowed()NXSRecSelector.is_AvailableDataSources_allowed()NXSRecSelector.is_AvailableMntGrps_allowed()NXSRecSelector.is_AvailableProfiles_allowed()NXSRecSelector.is_AvailableTimers_allowed()NXSRecSelector.is_CanFailDataSources_write_allowed()NXSRecSelector.is_ChannelProperties_allowed()NXSRecSelector.is_ComponentClientSources_allowed()NXSRecSelector.is_ComponentDataSources_allowed()NXSRecSelector.is_ComponentDescription_allowed()NXSRecSelector.is_ComponentSources_allowed()NXSRecSelector.is_CreateDataSources_allowed()NXSRecSelector.is_CreateDynamicComponent_allowed()NXSRecSelector.is_CreateWriterConfiguration_allowed()NXSRecSelector.is_DataSourceDescription_allowed()NXSRecSelector.is_DeleteAllProfiles_allowed()NXSRecSelector.is_DeleteProfile_allowed()NXSRecSelector.is_ExportEnv_allowed()NXSRecSelector.is_ExtraLinkDataSources_write_allowed()NXSRecSelector.is_FetchProfile_allowed()NXSRecSelector.is_FullDeviceNames_allowed()NXSRecSelector.is_ImportEnv_allowed()NXSRecSelector.is_ImportMntGrp_allowed()NXSRecSelector.is_IsMntGrpUpdated_allowed()NXSRecSelector.is_LinkDataSources_write_allowed()NXSRecSelector.is_LoadProfile_allowed()NXSRecSelector.is_MandatoryComponents_allowed()NXSRecSelector.is_MntGrpConfiguration_allowed()NXSRecSelector.is_MutedChannels_allowed()NXSRecSelector.is_PoolElementNames_allowed()NXSRecSelector.is_PreselectComponents_allowed()NXSRecSelector.is_PreselectedComponents_allowed()NXSRecSelector.is_PreselectedDataSources_allowed()NXSRecSelector.is_RemoveDynamicComponent_allowed()NXSRecSelector.is_ResetPreselectedComponents_allowed()NXSRecSelector.is_SaveProfile_allowed()NXSRecSelector.is_ScanEnvVariables_allowed()NXSRecSelector.is_SelectedComponents_allowed()NXSRecSelector.is_SelectedDataSources_allowed()NXSRecSelector.is_SetChannelProperties_allowed()NXSRecSelector.is_SetScanEnvVariables_allowed()NXSRecSelector.is_StepDataSources_write_allowed()NXSRecSelector.is_StoreProfile_allowed()NXSRecSelector.is_SwitchProfile_allowed()NXSRecSelector.is_UpdateConfigVariables_allowed()NXSRecSelector.is_UpdateMntGrp_allowed()NXSRecSelector.is_UpdateProfile_allowed()NXSRecSelector.is_VariableComponents_allowed()NXSRecSelector.read_AppendEntry()NXSRecSelector.read_CanFailDataSources()NXSRecSelector.read_Components()NXSRecSelector.read_ConfigDevice()NXSRecSelector.read_ConfigVariables()NXSRecSelector.read_DataSources()NXSRecSelector.read_DescriptionErrors()NXSRecSelector.read_DeviceGroups()NXSRecSelector.read_Door()NXSRecSelector.read_ExtraLinkDataSources()NXSRecSelector.read_LinkDataSources()NXSRecSelector.read_MacroServer()NXSRecSelector.read_MntGrp()NXSRecSelector.read_ProfileConfiguration()NXSRecSelector.read_ProfileFile()NXSRecSelector.read_ScanDir()NXSRecSelector.read_ScanFile()NXSRecSelector.read_ScanID()NXSRecSelector.read_StepDataSources()NXSRecSelector.read_UserData()NXSRecSelector.read_Version()NXSRecSelector.read_WriterDevice()NXSRecSelector.read_attr_hardware()NXSRecSelector.write_AppendEntry()NXSRecSelector.write_CanFailDataSources()NXSRecSelector.write_ConfigDevice()NXSRecSelector.write_ConfigVariables()NXSRecSelector.write_DeviceGroups()NXSRecSelector.write_Door()NXSRecSelector.write_ExtraLinkDataSources()NXSRecSelector.write_LinkDataSources()NXSRecSelector.write_MntGrp()NXSRecSelector.write_ProfileConfiguration()NXSRecSelector.write_ProfileFile()NXSRecSelector.write_ScanDir()NXSRecSelector.write_ScanFile()NXSRecSelector.write_ScanID()NXSRecSelector.write_StepDataSources()NXSRecSelector.write_UserData()NXSRecSelector.write_WriterDevice()
NXSRecSelectorClass
- nxsrecconfig.ProfileManager module
DEFAULT_RECORD_KEYSNXSTOOLSProfileManagerProfileManager.availableMntGrps()ProfileManager.clientRecordKeysProfileManager.componentDataSources()ProfileManager.components()ProfileManager.cpdescription()ProfileManager.createDataSources()ProfileManager.dataSources()ProfileManager.defaultPreselectedComponentsProfileManager.deleteProfile()ProfileManager.fetchProfile()ProfileManager.getPoolMotors()ProfileManager.importMntGrp()ProfileManager.isMntGrpUpdated()ProfileManager.masterTimerProfileManager.masterTimerFirstProfileManager.mntGrpConfiguration()ProfileManager.mutedPreScanAttrFiltersProfileManager.preselectedComponents()ProfileManager.preselectedDataSources()ProfileManager.switchProfile()ProfileManager.timerFiltersProfileManager.updateProfile()ProfileManager.writeallmotorpositions
- nxsrecconfig.Release module
- nxsrecconfig.Selection module
SelectionSelection.deselect()Selection.reset()Selection.resetMntGrp()Selection.resetPreselectedComponents()Selection.resetTimeZone()Selection.updateChannelProperties()Selection.updateComponentSelection()Selection.updateDataSourceSelection()Selection.updateOrderedChannels()Selection.updatePreselectingDataSources()
- nxsrecconfig.Selector module
SelectorSelector.configCommand()Selector.descErrorsSelector.deselect()Selector.exportEnv()Selector.fetchSelection()Selector.get()Selector.getMacroServer()Selector.getPools()Selector.getScanEnvVariables()Selector.importEnv()Selector.isDoorValid()Selector.keys()Selector.moduleLabelSelector.poolElementNames()Selector.preselect()Selector.reset()Selector.resetPreselectedComponents()Selector.set()Selector.setConfigInstance()Selector.setScanEnvVariables()Selector.storeSelection()
- nxsrecconfig.Settings module
SettingsSettings.addStepDataSources()Settings.adminDataNamesSettings.administratorDataNames()Settings.appendEntrySettings.availableComponents()Settings.availableDataSources()Settings.availableMntGrps()Settings.availableProfiles()Settings.availableTimers()Settings.canfaildatasourcesSettings.channelProperties()Settings.clientRecordKeysSettings.componentClientSources()Settings.componentDataSources()Settings.componentDescription()Settings.componentSources()Settings.componentsSettings.configDeviceSettings.configVariablesSettings.createDataSources()Settings.createDynamicComponent()Settings.createWriterConfiguration()Settings.dataSourceDescription()Settings.dataSourcesSettings.defaultCanFailDataSourcesSettings.defaultMntGrpSettings.defaultNeXusPathSettings.defaultNeXusTypeSettings.defaultPreselectedComponentsSettings.defaultTimeZoneSettings.defaultUserDataPathSettings.deleteAllProfiles()Settings.deleteProfile()Settings.descriptionErrorsSettings.deviceGroupsSettings.doorSettings.exportEnvProfile()Settings.extralinkdatasourcesSettings.fetchProfile()Settings.fullDeviceNames()Settings.importEnvProfile()Settings.importMntGrp()Settings.isMntGrpUpdated()Settings.linkdatasourcesSettings.loadProfile()Settings.macroServerSettings.mandatoryComponents()Settings.masterTimerSettings.masterTimerFirstSettings.mergeProfilesToMntGrpsSettings.mntGrpSettings.mntGrpConfiguration()Settings.mutedChannelFiltersSettings.mutedChannels()Settings.mutedPreScanAttrFiltersSettings.names()Settings.numberOfThreadsSettings.poolBlacklistSettings.poolElementNames()Settings.preselectComponents()Settings.preselectedComponents()Settings.preselectedDataSources()Settings.profileConfigurationSettings.profileFileSettings.removeDynamicComponent()Settings.resetInvalidDoorSettings.resetPreselectedComponents()Settings.saveProfile()Settings.scanDirSettings.scanEnvVariables()Settings.scanFileSettings.scanIDSettings.selectedComponents()Settings.selectedDataSources()Settings.setChannelProperties()Settings.setScanEnvVariables()Settings.stepdatasourcesSettings.storeProfile()Settings.switchProfile()Settings.syncSnapshotSettings.tangoSourceErrorStatesSettings.tangoSourceWarningStatesSettings.timerFiltersSettings.updateConfigVariables()Settings.updateMntGrp()Settings.updateProfile()Settings.userDataSettings.value()Settings.variableComponents()Settings.versionSettings.writeallmotorpositionsSettings.writepoolmotorpositionsSettings.writerDevice
- nxsrecconfig.StreamSet module
- nxsrecconfig.Utils module
MSUtilsOldTangoErrorPYTG_BUG_213PoolUtilsPoolUtils.filterNames()PoolUtils.filterOutTango()PoolUtils.getAliases()PoolUtils.getChannelSources()PoolUtils.getDeviceControllers()PoolUtils.getElementNames()PoolUtils.getFullDeviceNames()PoolUtils.getMntGrpName()PoolUtils.getMotorPositionAttributes()PoolUtils.getSource()PoolUtils.getTimers()
TangoUtilsUtils
- Module contents