1# parameter-framework 2 3[](https://travis-ci.org/01org/parameter-framework) 4[](https://coveralls.io/r/01org/parameter-framework) 5 6## Introduction 7 8The parameter-framework is a plugin-based and rule-based framework for handling 9parameters. This means that you can: 10 111. Describe your system's structure and its parameters (in XML) - aka. **What**; 122. Write (in C++) or reuse a backend (aka. plugin) for accessing the parameters 13that you just described - aka. **How**; 143. Define (in XML or in a domain-specific-language) conditions/rules upon which 15a given parameter must take a given value - aka. **When**. 16 17 18 19### Usage examples 20 21#### Alsa controls on embedded platforms 22 23The parameter-framework can be used to set the value of alsa controls 24(switches, volumes, etc.) on smartphones/tablets based on parameter-framework 25rules (in this example, they transcribe use-cases). For accessing parameters 26(i.e. alsa controls), you may use the 27[alsa plugin](https://github.com/01org/parameter-framework-plugins-alsa). 28 29#### Parameters in files 30 31The [filesystem plugin](https://github.com/01org/parameter-framework-plugins-filesystem) 32can be used to write parameters in files. This is particularly useful for 33files in `/sys` managing GPIOs. 34 35### More details 36 37The parameter-framework's core comes in the form of a shared library. Its 38client has to provide: 39 40- configuration files describing the structure of the system to be managed by 41 the parameter-framework and what plugins it must use to read/write into each 42 subsystem; 43- a list of criteria (representing the state of the client) and their possible 44 values; 45- configuration files describing the value that each part of the system (aka 46 parameter) must take - this is done by writing rules based on the criteria 47 described above. 48 49At runtime, the most usual communication between the client and the 50parameter-framework are: 51 521. The update of *criteria* (that are used in the rules introduced above) and 532. Update all relevant parameters according to the new criteria values. The 54 parameter-framework uses the appropriate backend for writing the values in 55 each underlying subsystem. 56 57The parameter-framework comes with several tools, including a command-line 58interface: `remote-process`. 59 60## Going further 61 62See [the wiki on github](https://github.com/01org/parameter-framework/wiki). 63 64## Compiling 65 66Run `cmake .` then `make`. You may then install libraries, headers and 67binaries with `make install`. By default, they are installed under 68`/usr/local` on unix OSes; if you want to install them under a custom 69directory, you may do so by passing it to the `cmake .` command; e.g. 70 71 cmake -DCMAKE_INSTALL_PREFIX=/path/to/custom/install . 72 73Also, CMake can build a project out-of-tree, which is the recommended method: 74 75 mkdir /path/to/build/directory 76 cd /path/to/build/directory 77 cmake /path/to/parameter-framework/sources 78 make 79 80After an install you may want to run the parameter-framework tests with 81`make test`. 82
){kind=link}
){kind=link}
){kind=link}