Everyware™ Software Framework

PART 4. SUPPLEMENTARY DOCUMENTATION
System Manager Service

System Manager Service

Overview

System Management has two definitions in ESF. First, there is a system manager service in ESF. This is really a service to distribute information about the state of the system. A properties file contains information such as Wind River Linux (WRL) version information, JVM version, JVM profile, number of Ethernet devices, etc. This information is provided via a service API to other bundles within the system. System Management also refers to overall management of the software, updates, and configuration. All of the software in the system needs to be maintained in the sense that it can be upgraded and modified over time.

The System Manager Service is purely a tool for providing information about the state of the system. System Management is a concept about how to control the software and the metadata in the System Manager Service over time. There are many tools in ESF to aid in overall System Management. These include two basic components – the Software Updater and the Configuration Manager. These two items will not be covered in this section. For more information on these you can visit the Code Update Deployment section or the Configuration Deployment sections. There are also code examples for these two sections here and here respectively.

System Manager Service API

The System Manager Service is quite simple in how it works. There is a basic properties file called /opt/jvm/esf/configuration/.esf/com.esf.core.system.manager/esf.props that contains the basic nondynamic properties of the system. This is an example esf.props file for the system manager.

########################################################################

platform=helios

osArch=x86

osName=Linux

osVersion=2.6.27.39-WR3.0.2ax_standard

osDistro=wrl

osDistroVersion=3.0.2

javaVmName=J9

javaVmVersion=2.4

javaProfile=harmony

company=eurotech

project=denali

entity=eurotech

########################################################################

These are all fairly self explanatory properties. These are the definitions.

platform – The hardware platform this instance of ESF is running on

osArch – The processor architecture

osName – The OS name ESF is running on

osVersion – The OS version (the kernel version in the case or WRL)

osDistro – The OS distribution name if applicable

osDistroVersion – The OS distribution version if applicable

javaVmName – The JVM name

javaVmVersion – The JVM version

javaProfile – The JVM profile

company – The company who owns this ESF application

project – The project name for this product

entity – The base MQTT topic to use if applicable

Each of these properties must be updated as the components are updated so they are properly reflected via the service API.

There are additional services provided for more dynamic features of the system. These include:

Getting the primary MAC address

This is the MAC address of the first (if more than one) Ethernet controller. This can and frequently is used as a unique identifier for the system.

Getting the product version

The product version is held in the /etc/esf/release.xml file. The System Manager Service fetches this and can provide it to calling methods.

Getting ESF_HOME

ESF_HOME is defined as the directory root of ESF. This is commonly /etc/jvm/esf on WRL.

Getting the ESF base bundle directory

This is commonly the $ESF_HOME/bundlefiles on WRL.

Getting the ESF configuration directory

This is commonly the $ESF_HOME/configuration/.esf directory on WRL.

Getting the ESF temporary directory

This is commonly /tmp/.esf/ on WRL.

Getting the Ethernet interfaces

This returns an ArrayList of Strings representing the Ethernet interfaces on the board

Getting the COM ports

This returns an ArrayList of com.esf.core.system.manager.service.EsfSerialPort definitions. This is dynamic in that USB to Serial devices are also returned in this list.

As part of updating a system it is also important to keep these system properties up to date in /opt/jvm/esf/configuration/.esf/com.esf.core.system.manager/esf.props. Any time one of these is updated the file showing this should also be updated. This will help components that are dependent on specific versions up to date with the current state of the system.

<<Previous Quickstart Next>>

PART 4. SUPPLEMENTARY DOCUMENTATION System Manager Service

System Manager Service

Overview

System Manager Service API

PART 4. SUPPLEMENTARY DOCUMENTATION
System Manager Service