diff options
| author | Jeremiah C. Foster <jeremiah@jeremiahfoster.com> | 2016-11-01 15:31:26 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-01 15:31:26 -0400 |
| commit | c1401bd9279bfc82611739e13db5f2be2a3d8edf (patch) | |
| tree | 889d38dd5224422f3e39006e0f7ea823bf3ced54 | |
| parent | eae3646dc7f907e64877c862be6f7ea325c8e258 (diff) | |
| download | node-state-manager-c1401bd9279bfc82611739e13db5f2be2a3d8edf.tar.gz | |
Added content to markdown README file
Essentially a copy of the README with some editing.
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -1 +1,28 @@ +# GENIVI Node State Manager (NSM) README +This is the official source code repository of the GENIVI Node State Manager. +# About +The Node State Manager (NSM) is the central functional component that gathers information on the current running state of the embedded +system. The NSM component provides a common implementation framework for the main state machine of the system. +It collates information from multiple sources and uses this to determine the current state(s). The NSM notifies registered +consumers (applications or other platform components) of relevant changes in system state. Node state information can also be requested on-demand via provided D-Bus interfaces. +The node state management also provides shutdown management, so one part of the information which is provided is the shutdown request notification to the consumers. +The node state management is the last/highest level of escalation on the node and will therefore command the reset and supply control logic. It is notified of errors and other status signals from components that are responsible for monitoring system health in different ways. +Internally, node state management is made up of a common generic component, Node State Manager (NSM), and a system-specific state machine (NSMC) that is plugged into the Node State Manager. Through this architecture there can be a standardized solution with stable interfaces towards the applications, which still allows for product-specific behavior through the definition of the specific state machine. +More information on the software can be found here: + +## License +This software is licensed under the MPL 2.0 +For licensing information see the COPYING file, +distributed along with this project. + +## Build Dependencies and Instructions +The NodeStateManager needs glib >= 2.30.0 to be compiled. +In addition, the NodeStateManager(NSM) has dependencies +to the NodeStateMachine (NSMC) and NodeStateAccess (NSMA). + +The NSMC is delivered within this package as a stub. +To understand the task it performs, please see its interface header. + +Please note: Due to legal restrictions the NSMA currently +is being built as a shared library that is used by the NSM. |