From 4f8a100d7a582b0ce1f8b1c9dbd8d2da24094d1b Mon Sep 17 00:00:00 2001 From: Amin Ben Ramdhane Date: Sun, 16 Feb 2020 23:00:48 +0100 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2024f507..9868038d 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ End of BBF Data Models Generation ``` #### JSON generator: #### -It is a generator of json file from C source code. +It is a generator of json file from xml data model and C source code. ```plain $ python generator_json_with_backend.py Usage: generator_json_with_backend.py [Object path] @@ -218,6 +218,18 @@ Examples: Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-12-0-cwmp-full.xml ``` +#### Excel generator: #### +It is a generator of excel sheet with supported and unsupported data model parameters. +```plain +$ python generate_excel.py +Usage: generate_excel.py +Examples: + - generate_excel.py tr181.json + ==> Generate excel file in tr181.xls + - generate_excel.py tr104.json + ==> Generate excel file in tr104.xls +``` + #### Load additional parameters at run time #### The bbfdm library allows all applications installed on the box to import its own tr-181 data model parameters at run time in two formats: **JSON files** and **Plugin(library) files**. @@ -454,3 +466,17 @@ Examples: **3. Fill the functions of object/parameter:** After building the templates of source code, a **test.c, test.h and Makefile** files will be generated under **test** folder that contains the functions related to each object, parameter and operate. Then, you have to fill each function with the necessary [bbfdm API](#bbfdm-api) defined above. You can find an example of source code **(example folder)** under **library** folder. + +## Dependencies ## + +To successfully build libbbfdm, the following libraries are needed: + +| Dependency | Link | License | +| ----------- | ------------------------------------------- | -------------- | +| libuci | https://git.openwrt.org/project/uci.git | LGPL 2.1 | +| libubox | https://git.openwrt.org/project/libubox.git | BSD | +| libubus | https://git.openwrt.org/project/ubus.git | LGPL 2.1 | +| libjson-c | https://s3.amazonaws.com/json-c_releases | MIT | +| libtrace | https://github.com/apietila/libtrace.git | GPLv2 | +| libbbf_api | https://dev.iopsys.eu/iopsys/bbf.git | LGPL 2.1 | +