SPELL - Server Manual
Contents
1. SPELL Server Manual SPELL version 2 4 4 Distribution list Full Report SES SSO SOE For Information Purposes Open Source Reference SES SSO SOE SPELL 2015 05 Date issued February 2015 SPELL version 2 4 4 Acronyms CV GCS GDB GUI HMI IDE MMD OOL PDF PROC RCP S C SCDB SDE SEE SES SPELL TC TM URI USL UTC SES Command Verification Ground Control System Ground Database Graphical User Interface Human Machine Interface equivalent to GUI Integrated Development Environment Manoeuvre Message Database Out of limits Portable Document Format Automated SPELL procedure Rich Client Platform Spacecraft Spacecraft Database SPELL Development Environment SPELL Execution Environment Soci t Europ enne des Satellites Satellite Procedure Execution Language Telecommand Telemetry Uniform Resource Identifier Unified Scripting Language Coordinated Universal Time SES SPELL version 2 4 4 Table of Contents 1 1 1 2 1 3 2 1 2 2 2 3 2 4 2 5 2 6 3 1 3 2 3 3 3 4 3 5 3 6 Introduction picccinccnnicinicieceiessuacniaisiniiieisuansunasuantneiss Error Bookmark not defined Purpose of this document Error Bookmark not defined Software Requirements cccccceeeeeeeeeeeeeeeeeeeeeees Error Bookmark not defined The Build SYSTEM nee aies Error Bookmark not defined Building SPELL sn ones Error Bookmark not defined D2. lt family name FAM gt SATI SAT2 SAT3 lt family gt lt families gt 2 2 The spell subfolder The first mandatory file it includes is the language xml file It is used to redefine the defaults modifiers for each of the wrappers named function and core adapter objects named interface For instance the defaults modifiers definition for the TM object may look like the following lt defaults interface TM gt lt modifier name OnFailure gt ABORT SKIP RECHECK CANCEL lt modifier gt lt modifier name PromptFailure gt True lt modifier gt lt modifier name ValueFormat gt ENG lt modifier gt lt modifier name Timeout gt 30 lt modifier gt lt modifier name Retries gt 3 lt modifier gt lt modifier name Tolerance gt 0 lt modifier gt lt modifier name Wait gt False lt modifier gt lt modifier name Delay gt None lt modifier gt lt modifier name PromptUser gt True lt modifier gt lt modifier name OnFalse gt NOACTION lt modifier gt lt modifier name OnTrue gt NOACTION lt modifier gt lt modifier name IgnoreCase gt False lt modifier gt lt modifier name AdjLimits gt False lt modifier gt lt defaults gt The list of modifiers depends on the interface or function that is being defined Please refer to the SPELL language reference manual for the complete list of modifiers Other XML files available in this folder are
3. February 2015 SPELL Build Manual Page 6 of 11 A SPELL Server Manual 2 4 4 docx lt context gt lt property name ExecutorProgram gt SPELL HOME bin SPELL Executor lt property gt lt context gt The executor section the executor is the component that creates and manages the procedure instance at runtime It supports the following parameters e ExecDelay in milliseconds the time to wait between the execution of two procedure lines of code e PromptWarningDelay in seconds the time to wait between a prompt appears and the injection of a warning event in the GCS if the prompt does not get an answer e Runinto True False Enables or disables the Run Into feature by default This makes visible the execution of code within the functions or subprocedures themselves e ByStep True False Enables or disables the By Step feature by default This makes the execu tion pause at each line executing a Step statement e BrowsableLib True False Allows or not to run into the UserLib source code at execution time e MaxVerbosity integer Defines the upper limit of verbosity to show at runtime For more infor mation please refer to the Verbosity feature in the SPELL language manual e WatchVariables ENABLED DISABLED Enables or disables the Watch Variables feature in SPEL GUI Mainly used for performance reasons SexGeuLror lt property name ExecDelay gt 4
4. gt lt property name MaxVerbosity gt 5 lt property gt lt property name WatchVariables gt ENABLED lt property gt lt executor gt The databases section defines the parameters of the different URL prefixes as well as the preloaded databases In the example below the SCDB and GDB global variables will exist and respectively contain the spacecraft database and the ground database February 2015 SPELL Build Manual Page 10 of 11 A SPELL Server Manual 2 4 4 docx The location element defines the path to the database folder in case of a filesystem database relative to the SPELL_DATA environment variable supports the following attributes e name the unique identifier for the location e type may be file for regular file asrun for the As Run files and svn for the revision controlled files e ext the file name extension in case of a filesystem regular file The database element provides the database name file name in case of filesystem based database and supports the following tags e name the name of the global variable that will contain the database and that will be provided to the running procedure e location the location identifier see above lt databases gt lt location name SCDB type file ext DB gt InputFiles SAT SIM SpacecraftDB lt location gt lt location name GDB type file ext DB gt InputFiles SAT SIM GroundDB lt location gt lt l
5. in idle mode The SPELL listener process is then ready to accept client connections
6. server configuration file is composed of the following elements listed hereafter The common section allows to enable or disable the server logging Log and the level of verbosity LogDetail The values accepted by the LogDetail tag are PROC MAIN CNFG and COMM lt common gt lt property name Log gt ENABLED lt property gt lt property name LogDetail gt PROC lt property gt lt common gt The language section it has one only element named language that provides the path to the language xml file see the spell subfolder section above lt language gt lt file gt language xml lt file gt lt language gt The listener section the listener is the component to which all SPELL client applications e g SPEL GUI initially connect to This section provides configuration parameters for the listener process It accepts two property elements e the ListenerPort element to define the port to listen to e the ContextListenerPort is the internal port used between the listener process and the context process lt listener gt lt property name ListenerPort gt 9980 lt property gt lt property name ContextListenerPort gt 9981 lt property gt lt listener gt The context section the context process is configured with the parameters provided in this section e the ExecutorProgram element defines the location of the SPELL executor process binary
7. 0 lt property gt property name PromptWarningDelay gt 60 lt property gt property name RunInto gt False lt property gt lt lt lt property name ByStep gt False lt property gt lt property name BrowsableLib gt True lt property gt lt property name MaxVerbosity gt 5 lt property gt lt property name WatchVariables gt ENABLED lt property gt lt executor gt The drivers section lists the available drivers in the system The driver elements provide the configuration file name lt drivers gt lt driver gt driver std xml lt driver gt lt driver gt driver xxx xml lt driver gt lt drivers gt The available contexts section provides the list of available contexts available for the server The context element provides the configuration file name lt contexts gt lt context gt context_SAT1 xml lt context gt lt context gt context SAT2 xml lt context gt lt context gt context SAT3 xml lt context gt lt contexts gt February 2015 SPELL Build Manual Page 7 of 11 A SPELL Server Manual 2 4 4 docx The families section maps the spacecraft name to the different GCS instances names This allows identifying simulated instances to the real spacecraft in order not to filter out the matching procedures referring to the SPELL coding guidelines for more information on the procedures headers lt families gt
8. X threads libpthread 2 4 POSIX 1 b realtime extensions librt 2 4 BSD utility functions libutil 2 4 Xerces C libxerces c 27 Dynamic linking interface libdl 2 4 C C standard libraries libstd 6 0 Python library and headers libpython 2 5 2 6 Not compatible with 2 7 NCurses development libraries libncurses only Executor Cmd Line 5 5 Log4CPlus 1 2 log4cplus sourceforge net Subversion for svn databases only lt 1 7 0 1 3 Installation basics A SPELL execution environment is typically installed on the home directory of the user spell i e home spell In the following it is assumed that all the SPELL software is installed in home spell SPELL The environment variable SPELL_HOME shall be defined and it shall point to the aforementioned folder February 2015 SPELL Build Manual Page 5 of 11 A SPELL Server Manual 2 4 4 docx 2 Configuration The configuration files consist in a set of XML files located in dedicated subfolders in SPELL HOME config Within this folder several subdirectories can be found server contexts spell gui and or dev depending on the SPELL software packages installed 2 1 The server subfolder This folder includes the XML configuration file that is used by the server at startup This file is the main one and links to other configuration files The name of the file is typically server xml although the name can be freely chosen A
9. contents of this file follows log4cplus rootLogger DEBUG STDOUT log4cplus appender STDOUT log4cplus ConsoleAppender log4cplus appender STDOUT layout log4cplus PatternLayout log4cplus appender STDOUT layout ConversionPattern 5p Sh 30 301 Sm n 2 3 The contexts subfolder This folder includes the configuration files that can be read at SPEL Server startup Refer to the This one links to the other XML configuration files A server configuration file is composed of the following elements listed hereafter Note that the context id tag is a unique identifier for the context definition First appears a set of single elements name a label describing the context in short driver provides the driver to use for this context See the spell subfolder description above for more information spacecraft gives the spacecraft family identifier for the context satname provides the identifier for the satellite instance gcs provides the hostname of the GCS to bind to procpath provides the path to the procedures base folder February 2015 SPELL Build Manual Page 9 of 11 A SPELL Server Manual 2 4 4 docx e _libpath provides the path to the User Library folder e output_dir provides the base path for the files generated by procedures e input_dir provides the base path for the files read by procedures lt name gt Standalone instance lt name gt lt description g
10. irectory Structure sssssssncscnnessnssesennunnennesesase Error Bookmark not defined Pr paration ssssssssssis sccrseisstetssccv cngeasnnses venenses Error Bookmark not defined Configuration aiiicds ccsicasaiscsasanccacnnseiseansiandanaaedsncainn Error Bookmark not defined COMP MANION sisstssiacciscassticionssanctensetucvensstectoasstucsonsedns Error Bookmark not defined DS TAN AGI GIN SN Error Bookmark not define CIO ANID PR Error Bookmark not de Building SPELL DEV issus Error Bookmark Directory Structure seusbeEENSEKEENSEERASKRERENEEKREERSEAaeg Error Bookma PreparatiO eene Error Boo not defined Configuration E Error Bookmark not defir COMPINAUON EE Error Bookmark no MS TE ET Error Bookma Cleanup cc Error Book February 2015 Page 4 of 11 SPELL Build Manual SPELL Server Manual 2 4 4 docx S E S 1 Introduction 1 1 Purpose of this document This document is the SPELL server user manual for the SPELL framework It is intended to be used by software teams in order to install and configure the SPELL Server component part of the execution environment of the SPELL framework on a Linux platform 1 2 Software Requirements The following packages and libraries are needed to run the SPEL Server component Package Version Remarks GNU autotools 1 9 GNU GCC buildchain 4 1 2 GNU Bash 3 1 GNU Binutils 2 16 GNU Make 3 8 POSI
11. named driver_ lt drivername gt xml These files provide the configurations for each SPELL driver installed The typical example is the driver_std xml file corresponding to the standalone driver February 2015 SPELL Build Manual Page 8 of 11 A SPELL Server Manual 2 4 4 docx A typical content for this driver is lt driver id standalone gt lt name gt Standalone SPELL driver lt name gt lt interfaces gt TM TC EV TIME TASK RSC lt interfaces gt lt maxproc gt 5 lt maxproc gt lt path gt SSPELL HOME drivers lt path gt lt properties gt lt property name SimPath gt Simulator lt property gt lt properties gt lt driver gt The tags have the following meaning driver id a unique identifier that will be used to reference the driver in the server configuration file refer to next section name a meaningful name for the driver interfaces allows to enable or disable the different interfaces maxproc indicates the maximum number of procedures that can run in parallel per context path the path to the folder that contains the driver s specific binaries properties a free list of properties relevant to the driver In the case of the standalone driver the SimPath property indicates the subfolder name that contains the simulator data definition Finally a configuration file for Log4CPLUS is included log properties An example of the
12. ocation name mmd type file ext IMP gt InputFiles SAT SIM ManeuvreMessage lt location gt lt location name usr type file ext IMP gt InputFiles SAT SIM User lt location gt lt location name ar type asrun ext ASRUN gt OutputFiles SAT SIM AsRun lt location gt lt location name ws type file ext WS gt OutputFiles SAT SIM Warmstart lt location gt lt location name svn type svn ext SVN gt InputFiles SAT SIM User lt location gt lt database name SCDB location SCDB gt SCDB lt database gt lt database name GDB location GDB gt GDB lt database gt lt databases gt The language section allows to override the defaults of the functions and core adapter objects modifiers refer to the spell subfolder section above lt language gt lt language gt Page 11 of 11 February 2015 SPELL Build Manual SPELL Server Manual 2 4 4 docx S E S 3 Starting Up The SPEL Server The startup scripts for the SPELL applications are located in the SPELL_HOME bin directory The server launcher script has the following syntax 2 SPELL Server lt Context Id gt It will start a SPELL Server using the the default server configuration file named server_ lt Context Id gt xml that is SPELL_HOME config server server_SAT xml if the context identifier is SAT When started the server standard output displays some general information and log messages and goes
13. t Context for the Standalone simulator lt description gt lt driver gt std lt driver gt lt spacecraft gt STD lt spacecraft gt lt satname gt STD1 lt satname gt lt gcs gt gcsserver lt gcs gt lt procpath gt S SSPELL DATA Procedures lt procpath gt lt libpath gt SSPELL DATA UserLib lt libpath gt lt output dir gt SPELL DATA OutputFiles lt output dir gt lt input dir gt SPELL DATA InputFiles lt input dir gt x TJ The driverconfig section provides driver configuration parameters that apply to all procedures running for the spacecraft associated to the context The example below sets up the parameters for a connection to a CORBA naming service assuming the SPELL driver needs this kind of information lt driverconfig gt lt property name NameID gt NameServiceld lt property gt lt property name NameServer gt gcsserver lt property gt lt property name NamePort gt 29999 lt property gt lt driverconfig gt The executor section overrides the server configuration default parameters for the executor component giving specific parameters for the associated spacecraft See the server subfolder above for more information lt exeCucor gt lt property name ExecDelay gt 100 lt property gt lt property name RunInto gt True lt property gt lt property name ByStep gt False lt property gt lt property name BrowsableLib gt False lt property
Download Pdf Manuals
Related Search