mirror/bbfdm
1
0
Fork 0
mirror of https://dev.iopsys.eu/bbf/bbfdm.git synced 2025-12-10 07:44:39 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1583 commits 56 branches 1 tag 18 MiB
Find a file
Vivek Kumar Dutta 3b0d56b301 Proposal for device/system mngr
2024-10-22 16:08:53 +05:30
bbfdmd Added -g flag for debugging 2024-10-15 14:22:32 +05:30
dm-service Added -g flag for debugging 2024-10-15 14:22:32 +05:30
docs Proposal for device/system mngr 2024-10-22 16:08:53 +05:30
gitlab-ci Fix pipeline 2024-10-18 12:21:57 +05:30
libbbfdm Improve event handling 2024-10-22 04:17:05 +00:00
libbbfdm-api Improve event handling 2024-10-22 04:17:05 +00:00
libbbfdm-ubus Improve event handling 2024-10-22 04:17:05 +00:00
test Add support for init and clean module 2024-10-14 17:58:04 +02:00
tools Tools: Use ParentalControl in place of URLFilter Object 2024-10-14 17:16:37 +02:00
utilities Fix pipeline 2024-10-16 12:06:49 +05:30
.gitignore Api to schedule a task 2024-10-15 04:17:32 +00:00
.gitlab-ci.yml Align with new code-analysis docker image 2024-09-20 06:18:52 +00:00
CMakeLists.txt Split 'bbfdmd' into two binaries: 'bbfdmd' (main tree) and 'dm-service' (micro-service tree) 2024-09-10 09:30:50 +00:00
LICENSE LICENSE: change license to BSD 3-Clause 2023-04-17 11:31:48 +02:00
mkdocs.yml Update documentation 2023-04-18 12:42:29 +05:30
README.md Update Documentation 2024-09-20 11:16:32 +02:00

README.md

BroadBand Forum Data Models (BBFDM)

bbfdm is a suite to provide TR181 datamodel backend for Higher layer management protocols like TR-069/CWMP or TR-369/USP. It is designed in a hardware agnostic way and provides the available datamodel parameters over ubus on the northbound interface and creates the datamodel mapping based on uci and ubus on southbound interface.

bbfdm has five main components:

Component Description
bbfdmd A daemon to expose data model objects over ubus
dm-service A daemon to expose data model objects as micro-service over ubus
libbbfdm-api API library to create and parse datamodel tree
libbbfdm-ubus API library to expose datamodel over ubus
libbbfdm A static library that contains the core data model of TR181

Directory Structure

bbfdm package is structured as follow:

├── bbfdmd            --  This directory contains daemon code to expose the datamodel tree on northbound
│   └── ubus              - Daemon to expose datamodel over ubus
├── dm-service        --  This directory contains daemon code to expose the datamodel tree as micro-service
├── docs              --  More detailed explanation of datamodel and user guide
├── gitlab-ci         --  Used for CI/CD pipeline test
├── libbbfdm          --  Minimal TR181 core datamodel implementation
├── libbbfdm-api      --  API library to create datamodel definition and parse the datamodel definition to form a datamodel tree
├── libbbfdm-ubus     --  API library to expose datamodel over ubus
├── tools             --  Tools to convert xml datamodel definition to json, generate c code and many more
└── utilities         --  Small helper utilities to complete/optimize the datamodel deployment

Important Topics

Datamodel related topics

Compilation helper utilities

Additional datamodel objects

This repository has bare minimal TR181 datamodel integrated, each service has their own datamodel additions, which they expose using plugins and micro-services. List of IOWRT provided service datamodel set available in tools_input.json

Dependencies

Build-Time Dependencies

To successfully build bbfdmd, 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
libbbfdm-api https://dev.iopsys.eu/bbf/bbfdm.git BSD-3
libbbfdm-ubus https://dev.iopsys.eu/bbf/bbfdm.git BSD-3
libbbfdm https://dev.iopsys.eu/bbf/bbfdm.git BSD-3

Run-Time Dependencies

In order to run the bbfdmd, following dependencies are needed to be running/available before bbfdmd.

Dependency Link License
ubusd https://git.openwrt.org/project/ubus.git LGPL 2.1
libbbfdm-api https://dev.iopsys.eu/bbf/bbfdm.git BSD-3
libbbfdm-ubus https://dev.iopsys.eu/bbf/bbfdm.git BSD-3
libbbfdm https://dev.iopsys.eu/bbf/bbfdm.git BSD-3

In order to run the dm-service, following dependencies are needed to be running/available before dm-service.

Dependency Link License
ubusd https://git.openwrt.org/project/ubus.git LGPL 2.1
libbbfdm-api https://dev.iopsys.eu/bbf/bbfdm.git BSD-3
libbbfdm-ubus https://dev.iopsys.eu/bbf/bbfdm.git BSD-3