Initial import
[olsrd.git] / lib / powerinfo / README_POWER
1 POWER STATUS PLUGIN FOR UNIK OLSRD
2 by Andreas T√łnnesen(andreto@olsr.org)
3
4
5               ***  LICENCING ***
6
7 THIS SOFTWARE IS LICENCED UNDER THE BSD LICENCE
8 TO ENABLE DEVELOPERS TO USE THIS CODE IN PROJECTS
9 USING NON-GLP LICENCING SCHEMES.
10
11 IN OTHER WORDS - YOU ARE FREE TO USE THIS CODE AS
12 A FRAMEWORK FOR WHATEVER YOU WANT.
13
14
15 ABOUT
16
17 The uolsrd power status plugin is ment to be a easy
18 to understand example of how one can write custom
19 plugins for the UniK olsr daemon.
20
21 It gathers powerifno from the local node by polling
22 the /proc/apm pseudofile. So to diffuse powerinfo
23 about a node it needs to have APM enabled.
24 All powerinfo is gathered in a database en you
25 can wiev the output by telneting to 127.0.0.1
26 port 8888 on the local machine.
27
28
29 WHAT IS IT?
30
31 This code compiles as a dynamic loadable library -
32 known as so files in Linux and DLL in windows.
33 The code is loaded by olsrd at runtime and the
34 plugin can use certain functionality offered
35 by olsrd.
36 It is very usefull when adding custom packettypes
37 but it could be used for a variety of purposes.
38
39
40 Read the HOWTO at www.olsr.org for more info
41
42 - Andreas T