Development status:
Released,
Release: v3.9.1
Information status: New
Repository:
https://github.com/nexdatas/recselector
Contact:
Class Description
Tango server with Sardana Recorder settings
Source code: https://github.com/nexdatas/recselector Web page: https://nexdatas.github.io/recselector NexDaTaS Web page: https://nexdatas.github.io
Families: Acquisition
Key words:
Platform: All Platforms
Language: Python
License: GPL
Contact:
Hardware
Manufacturer: DESY
Bus: Not Applicable
Class interface
Attributes:
| Name | Description |
|---|---|
| StepDataSourcesScalar: DevString | list of datasources to be switched into step mode |
| VersionScalar: DevString | server version |
| MacroServerScalar: DevString | Macro Server device name |
| MntGrpScalar: DevString | Measurement Group name |
| ScanDirScalar: DevString | Scan Directory |
| ScanIDScalar: DevLong | Scan ID |
| ScanFileScalar: DevString | Scan File(s) |
| ConfigDeviceScalar: DevString | Configuration Device name |
| DoorScalar: DevString | Door device name |
| WriterDeviceScalar: DevString | Writer device device name |
| UserDataScalar: DevString | JSON dictionary with User Data |
| DeviceGroupsScalar: DevString | JSON dictionary with device groups |
| ProfileConfigurationScalar: DevString | JSON dict of server configuration |
| AppendEntryScalar: DevDouble | flag for entry appending |
| ConfigVariablesScalar: DevString | JSON dictionary with configuration variables for templated components |
| ProfileFileScalar: DevString | config file with its full path |
| LinkDataSourcesScalar: DevString | list of datasources to which a link will be added |
| ComponentsSpectrum: DevString | list of Selected Components |
| DescriptionErrorsSpectrum: DevString | list of Descriptive Component Errors |
| DataSourcesSpectrum: DevString | list of Selected Datasources |
Commands:
| Name | Description |
|---|---|
| AvailableComponentsInput: DevVoid Output: DevVarStringArray list of available component names |
Return a list of available component names |
| AvailableDataSourcesInput: DevVoid Output: DevVarStringArray list of available DataSource names |
Return a list of available DataSource names |
| AvailableMntGrpsInput: DevVoid Output: DevVarStringArray list of available mntgrp names |
Return a list of available mntgrp names |
| AvailableProfilesInput: DevVoid Output: DevVarStringArray list of available selection names |
Return a list of available selection names |
| AvailableTimersInput: DevVoid Output: DevVarStringArray list of available timers |
Return a list of available component names |
| ChannelPropertiesInput: DevString property type Output: DevString JSON dictionary with channel properties {channel:property} |
Provide JSON dictionary with channel properties {channel:property} |
| ComponentClientSourcesInput: DevVarStringArray list of required components Output: DevString JSON with description of CLIENT Datasources |
Describe client datasources from components |
| ComponentDataSourcesInput: DevVoid Output: DevVarStringArray profile component datasources |
Provide the component datasources |
| ComponentDescriptionInput: DevVoid Output: DevString JSON component description |
Return a list of available component names |
| CreateDynamicComponentInput: DevVarStringArray list of JSON strings with datasource parameters Output: DevString name of dynamic Component |
Create dynamic component |
| CreateWriterConfigurationInput: DevVarStringArray list of required components Output: DevVoid |
Create configuration from the given components |
| DataSourceDescriptionInput: DevVarStringArray list of required datasources Output: DevVarStringArray list of JSON with description of CLIENT Datasources |
Provide datasource description |
| DeleteAllProfilesInput: DevVoid Output: DevVoid |
Delete all profiles from Configuration Server |
| DeleteProfileInput: DevString mntgrp name Output: DevVoid |
Delete the given mntgrp |
| ExportEnvProfileInput: DevVoid Output: DevVoid |
Export all environment variables |
| FetchProfileInput: DevVoid Output: DevVoid |
Fetch server configuration |
| FullDeviceNamesInput: DevVoid Output: DevString JSON Dictionary with full device names for all aliases |
Return a JSON with full device names for all aliases |
| ImportEnvProfileInput: DevVoid Output: DevVoid |
Import all environment variables |
| ImportMntGrpInput: DevVoid Output: DevVoid |
Import active mntgrp configuration |
| IsMntGrpUpdatedInput: DevVoid Output: DevBoolean true if mntgrp changed |
True if mntgrp was changed |
| StatusInput: DevVoid Output: ConstDevString Device status |
This command gets the device status (stored in its device_status data member) and returns it to the caller. |
| StateInput: DevVoid Output: State Device state |
This command gets the device state (stored in its device_state data member) and returns it to the caller. |
| AdministratorDataNamesInput: DevVoid Output: DevVarStringArray administrator data names |
Provide Administrator Data Names |
| LoadProfileInput: DevVoid Output: DevVoid |
Load server configuration |
| MandatoryComponentsInput: DevVoid Output: DevVarStringArray component names |
Set the mandatory components |
| MntGrpConfigurationInput: DevVoid Output: DevString mntgrp configuration string |
Provide mntgrp configuration in json string |
| MutedChannelsInput: DevVoid Output: DevVarStringArray list of muted channels |
Return a list of muted channel names |
| PoolElementNamesInput: DevString pool list attribute name Output: DevVarStringArray list of available pool elements |
Return a list of available pool channels |
| PreselectComponentsInput: DevVoid Output: DevVoid |
Check existing devices of pools |
| PreselectedComponentsInput: DevVoid Output: DevVarStringArray component names |
Provide the preselected components |
| PreselectedDataSourcesInput: DevVoid Output: DevVarStringArray datasources names |
Provide the preselected components |
| RemoveDynamicComponentInput: DevString name of dynamic Component Output: DevVoid |
Delete the given dynamic component |
| ResetPreselectedComponentsInput: DevVoid Output: DevVoid |
Reset PreselectedComponents to DefaultPreselectedComponents |
| SaveProfileInput: DevVoid Output: DevVoid |
Save server configuration |
| ScanEnvVariablesInput: DevVoid Output: DevString environment data |
Fetch ScanDir, ScanFile, ScanID and NeXusSelectorDevice in environment variables |
| SelectedComponentsInput: DevVoid Output: DevVarStringArray component names |
Provide the selected components |
| SelectedDataSourcesInput: DevVoid Output: DevVarStringArray profile datasources |
Provide the selected datasources |
| SetChannelPropertiesInput: DevVarStringArray a two element list with a property type and JSON value dictionary {channel:property} Output: DevVoid |
Set Channel Properties of the given type |
| SetScanEnvVariablesInput: DevString environment data Output: DevLong scanID |
Store ScanDir, ScanFile and NeXusSelectorDevice in environment variables |
| StoreProfileInput: DevVoid Output: DevVoid |
Store server configuration |
| SwitchProfileInput: DevVoid Output: DevVoid |
Switch mntgrp configuration |
| UpdateConfigVariablesInput: DevVoid Output: DevVoid |
Send ConfigVariables into ConfigServer and update serialno if appendEntry selected |
| UpdateMntGrpInput: DevVoid Output: DevString configuration |
Update mntgrp configuration |
| UpdateProfileInput: DevVoid Output: DevString mntgrp configuration string |
Update mntgrp configuration |
| VariableComponentsInput: DevVoid Output: DevString JSON Dictionary with all Components for configuration variable |
Return a list of available component names |
| ComponentSourcesInput: DevVarStringArray list of required components Output: DevString JSON with description of Datasources |
Describe datasources from components |
Pipes:
Properties:
| Name | Description |
|---|---|
| NumberOfThreadsDevLong | maximal number of threads |
| PoolBlacklistArray of DevString | blacklist of pools |
| TimerFiltersArray of DevString | list of timer filters |
| MutedChannelFiltersArray of DevString | list of muted channel filters |
| AdminDataNamesArray of DevString | list of administrator data names |
| DefaultPreselectedComponentsArray of DevString | list of default preselected components |
| DefaultNeXusPathDevString | default NeXus path |
| DefaultTimeZoneDevString | default time zone |
| DefaultMntGrpDevString | defaultmeasurement group name |
Please log in to comment.
README
b"========================================\nWelcome to nxsrecconfig's documentation!\n========================================\n\nAuthors: Jan Kotanski\nIntroduction\n\nTango server with Sardana Recorder settings\n\nTango Server API: https://nexdatas.github.io/recselector/doc_html\n\n| Source code: https://github.com/nexdatas/recselector\n| Web page: https://nexdatas.github.io/recselector\n| NexDaTaS Web page: https://nexdatas.github.io\n\n------------\nInstallation\n------------\n\nInstall the dependencies:\n\n| Sardana, PyTango, sphinx\n\nFrom sources\n^^^^^^^^^^^^\n\nDownload the latest version of NeXuS Configuration Server from\n\n| https://github.com/nexdatas/recselector\n\nExtract the sources and run\n\n.. code-block:: console\n\n\t $ python setup.py install\n\nDebian packages\n^^^^^^^^^^^^^^^\n\nDebian Jessie (and Wheezy) packages can be found in the HDRI repository.\n\nTo install the debian packages, add the PGP repository key\n\n.. code-block:: console\n\n\t $ sudo su\n\t $ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -\n\nand then download the corresponding source list\n\n.. code-block:: console\n\n\t $ cd /etc/apt/sources.list.d\n\t $ wget http://repos.pni-hdri.de/jessie-pni-hdri.list\n\nFinally,\n\n.. code-block:: console\n\n\t $ apt-get update\n\t $ apt-get install python-nxsrecselector\n\nTo instal other NexDaTaS packages\n\n.. code-block:: console\n\n\t $ apt-get install python-nxswriter nxsconfigtool nxstools python-nxsconfigserver nxsconfigserver-db\n\nand\n\n.. code-block:: console\n\n\t $ apt-get install nxselector python-sardana-nxsrecorder\n\nfor Component Selector and Sardana related packages.\n\n-------------------\nSetting environment\n-------------------\n\n\nSetting Saradna\n^^^^^^^^^^^^^^^\nIf sardana is not yet set up run\n\n\n.. code-block:: console\n\n\t $ Pool\n\n- enter a new instance name\n- create the new instance\n\nThen wait a while until Pool is started and in a new terminal run\n\n.. code-block:: console\n\n\t $ MacroServer\n\n- enter a new instance name\n- create the new instance\n- connect pool\n\nNext, run Astor and change start-up levels: for Pool to 2,\nfor MacroServer to 3 and restart servers.\n\nAlternatively, terminate Pool and MacroServer in the terminals and run\n\n.. code-block:: console\n\n $ nxsetup -s Pool -l2\n\nwait until Pool is started and run\n\n.. code-block:: console\n\n $ nxsetup -s MacroServer -l3\n\n\nAdditionally, one can create dummy devices by running sar_demo in\n\n.. code-block:: console\n\n\t $ spock\n\n\n\nSetting NeXus Servers\n^^^^^^^^^^^^^^^^^^^^^\n\nTo set up NeXus Servers run\n\n.. code-block:: console\n\n\t $ nxsetup -x\n\nor\n\n.. code-block:: console\n\n $ nxsetup -x NXSDataWriter\n $ nxsetup -x NXSConfigServer\n\t $ nxsetup -x NXSRecSelector\n\nfor specific servers.\n\nIf the RecoderPath property of MacroServer is not set one can do it by\n\n.. code-block:: console\n\n\t $ nxsetup -a /usr/lib/python2.7/dist-packages/sardananxsrecorder\n\nwhere the path should point the sardananxsrecorder package.\n"
Created:
The device class has been added to catalogue.