MARIE Trunk aastatgrab

From MARIEWiki

Contents 1 Version 2 Description 3 Requirements 4 Inputs/Outputs 5 Configuration 6 Usage 7 Executing aastatgrab in project 8 Executing aastagrab with appman [deprecated] 8.1 Start component 8.2 Stop component 8.3 Quit component 9 Authors 10 Thanks to 11 License

Version

0.1

Description

Prints system statistics such as CPU used, memory used, etc.

See the project website for more information.

Requirements

• You must have libstatgrab 0.12 installed before compiling the statgrab Application Adapter.

See Install instructions.

Inputs/Outputs

None

Configuration

Note : see Configuration Description Language for syntax details.

# C StatGrab
   o KV frequency
      

• frequency : Print frequency (ms) (default = 2000 ms)

Usage

usage :  statgrab -n component_name [-t component_type] [-d director_port_number] [-c configurator_port_number]

      -n     #Specify component's name
              
      -t     #Specify component's control type :
             #  DEFAULT - use when controlled by appman Application Manager (default)
             #  MPI     - use when controlled by ammpi Application Manager
               
      -d     #Specify director server socket port number (mandatory in DEFAULT component's control type)
      -c     #Specify configurator server socket port number (mandatory in DEFAULT component's control type)

Executing aastatgrab in project

This section shows how to use aastatgrab in a Project..

In .setup file, add the following process :

aastatgrab

# T process
   # KV name
   # KV type = MARIE:MPI
   # KV executableName = aastatgrab
  
   # KV configFile

• name : Specify a reference name for the process
• type : Specify component's control type
• executableName : Specify the executable name
• configFile : Specify path to aastatgrab configuration file (see Configuration)

Executing aastagrab with appman [deprecated]

This section shows how to use aastagrab with appman Application Manager from a terminal script.

Start component

aastagrab -n component_name -t MARIE -d director_port_number -c configurator_port_number
sleep 4    # Sleep time (plateform specific)

appman -p configurator_port_number -c sxml:PathToConfigFile
sleep 1    # Sleep time (plateform specific)

appman -p director_port_number -c init
sleep 1    # Sleep time (plateform specific)

appman -p director_port_number -c start

Component can take couple of seconds to boot, configure and initialize before being ready to receive requests on director and configurator ports. Delays are required and must be adjusted depending on the running platform.

Stop component

appman -p director_port_number -c stop
sleep 1    # Sleep time (plateform specific)

Component can take couple of seconds to stop before being ready to receive requests on director and configurator ports. Delay is required and must be adjusted depending on the running platform.

Quit component

appman -p director_port_number -c quit

Authors

• Carle Cote
• Patrick Frenette

Thanks to

• Dominic Letourneau

License

MARIE - Mobile and Autonomous Robotics Integration Environment Copyright (C) 2004-2007 Carle Cote, Patrick Frenette,

This library and its documentation are free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library and documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You can contact MARIE development team at http://marie.sourceforge.net.