aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: ba10cb06a133022fc6b181098a71a3340fca3c79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Controller Utilities

* Object: Generic Controller Utilities to handle Policy,Small Business Logic, Glue in between components, ...
* Status: Release Candidate
* Author: Fulup Ar Foll fulup@iot.bzh
* Date  : October-2017

## Usage

1) Add ctl-utilities as a submodule to include in your project
```
git submodule add git@github.com:iotbzh/afb-utilities
```

2) Add ctl-utilities as a static library to your binding
```
    # Library dependencies (include updates automatically)
    TARGET_LINK_LIBRARIES(${TARGET_NAME}
        ctl-utilities
        ... other dependencies ....
    )
```

3) Declare your controller config section in your binding
```
// CtlSectionT syntax:
// key: "section name in config file" 
// loadCB: callback to process section
// handle: a void* pass to callback when processing section
static CtlSectionT ctlSections[]= {
    {.key="plugins" , .loadCB= PluginConfig, .handle= &halCallbacks},
    {.key="onload"  , .loadCB= OnloadConfig},
    {.key="halmap"  , .loadCB= MapConfigLoad},
    {.key=NULL}
};

```

3) Do controller config parsing at binding pre-init
```
   // check if config file exist
    const char *dirList= getenv("CTL_CONFIG_PATH");
    if (!dirList) dirList=CONTROL_CONFIG_PATH;

    ctlConfig = CtlConfigLoad(dirList, ctlSections);
    if (!ctlConfig) goto OnErrorExit;        
```

4) Exec controller config during binding init 
```
  int err = CtlConfigExec (ctlConfig);
```

For sample usage look at https://github.com/iotbzh/afb-controller