/+---------------------------------------------------------------------------
//
//  Copyright (C) Intel Corporation, 2003 - 2007.
//
//  File:       README 
//
//  Contents:   a short description for developers
//
//----------------------------------------------------------------------------

Intel(R) AMT MEStatus
=====================================


The Intel(R) AMT MEStatus is a graphical user interface application used to 
monitor Intel(R) AMT state. User is able to verify whether 
Intel(R) AMT is enabled and running on the system. 
MEStatus is displayed in the system icon tray. 
If configured the status window is launched every time 
user starts X session. 
To use MEStatus make sure that Intel(R) UNS (User Notification Service) 
is running.


Required libraries/tools:
-------------------------------------

- libGLADEmm: Version 2.4 or newer
- GTKmm: Version 2.4 or newer

GTKmm version 2.10 or newer is strongly recommended.
To build and run MEstatus with earlier GTKmm version < 2.10
- IGTKXMM library


Building and installing the MEStatus:
-------------------------------------
1. In order to build and install the MEStatus 
   with GTKmm versions < 2.10   (=  2.4, 2.6 or 2.8 )
   you must first build the IGTKXMM library.
   (Skip this point if have GTKmm version 2.10 or newer.)
   call:
        './configure --prefix=/usr'
        'make'
        'make install'
    note: on 64bit system add --libdir=/usr/lib64

2. To build MEStatus call
        './configure'
        'make'
3. Call 'make install' to install MEStatus.

By default MEStatus installs to '/usr/local/intel/MEStatus' directory. 
To start it manually run MEStatus from installation directory.

To configure MEStatus to start automatically with KDE session create starting 
script in user's '.kde/Autostart' directory.


MEStatus usage:
-----------------------------------
The status window appears when X session starts or when the status icon 
is clicked or when AMT state changes from disabled to enabled. When Intel(R) AMT
is enabled the red 'x' is not displayed. 
The status window displays the state of Intel(R) AMT. The state of Intel(R) AMT 
can be seen on the first line of the status window. 
There are three possible values: 

    -Disabled: Setup and Configuration process has not started, Intel(R) ME is 
               disabled, Intel(R) AMT is not selected as the Manageability 
               mode or one of MEI driver, LMS service, UNS service was not
               started.

    -Enabled: A state of enabled does not mean Intel(R) AMT is fully 
              functional yet. State changes to enabled as soon as Setup and 
              Configuration process is started. Naturally, it stays enabled 
              when Setup and Configuration process is complete.

    -Unknown: Initial state before Enabled/Disabled state is known.


If one of MEI driver, UNS service become not operational the MEStatus
shows the last known Intel(R) AMT state.


MEStatus customization:
-----------------------------------
MEStatus uses machine configuration file  /etc/IntelAMTCheck.config
and/or user configuration files ~/.IntelAMTCheck.user.config
Configuration options are stored in format:

option_name = option_value

Configuration files are used to set following options:
 - "CheckAMTStatusTimeout"      - Intel(R) AMT status check timeout in ms
                                   default: 10000
 - "OemUrl"                     - URL to OEM vendor web page
                                   default: "http://www.intel.com/vpro"
 - "AMTStatusInitMaxRetries"    - max. number of retries checking initial 
                                  Intel(R) AMT status
                                   default: 7
 - "MinimizePrivacyIconAtStart" - 1 (true) if run MEStatus initially iconized
                                   default: 0
 - "AMTLastEnabled"             - 1 (true) if Intel(R) AMT status
                                  was enabled in previous run
                                   default: 0
                                 ( updated by MEStatus in user config file )
 - "PopupForCurrentUser"        - 1 (true) if Intel(R) AMT status popup 
                                  is displayed for user
                                   default: 1
                                 ( updated by MEStatus in user config file )

Intallation directory (default '/usr/local/intel/MEStatus')
contains resource subdirectory 'res' with files:

- res/oemlogo.bmp    - vendor logo displayed in Status window

- res/ATChk-on.ico   - tray icon for Enabled state of Intel(R) AMT

- res/ATChk-off.ico  - tray icon for Disabled state of Intel(R) AMT

- res/ATChk-unk.ico  - tray icon for Unknown state of Intel(R) AMT

- res/ATChk32.ico    - icon of MEStatus Intel(R) AMT

- res/MEStatus.glade - glade GUI configuration of MEStatus
