mirror of https://dev.iopsys.eu/bbf/bbfdm.git synced 2025-12-10 07:44:39 +01:00

No description

Find a file

Amin Ben Romdhane fa69524868 Multiple updates - Transaction APIs removed - Use different save dirs per proto - In process instance update notifier - Use event based refresh timer - Commit changes from main daemon for default proto - For add request commit changes without reload for default proto - extend bbf.config to monitor based on input - extend bbf.config to reload/commit based on input - extend bb.config to provide list of service changes based on proto		2024-08-17 07:18:35 +00:00
bbfdmd	Multiple updates	2024-08-17 07:18:35 +00:00
docs	Multiple updates	2024-08-17 07:18:35 +00:00
gitlab-ci	Multiple updates	2024-08-17 07:18:35 +00:00
libbbfdm	Import tr181-2.18 xml	2024-08-01 11:11:57 +00:00
libbbfdm-api	Multiple updates	2024-08-17 07:18:35 +00:00
test	Multiple updates	2024-08-17 07:18:35 +00:00
tools	Multiple updates	2024-08-17 07:18:35 +00:00
utilities	Multiple updates	2024-08-17 07:18:35 +00:00
.gitignore	docs: cleanup and update	2024-07-09 17:48:18 +05:30
.gitlab-ci.yml	Remove redundant func	2024-05-29 17:30:42 +00:00
CMakeLists.txt	Introduce bbf.config with C code	2024-06-04 12:18:02 +02: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	docs: cleanup and update	2024-07-09 17:48:18 +05:30

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 three main components:

Component	Description
bbfdmd	A daemon to expose data model objects over ubus
libbbfdm-api	API library to create and parse datamodel tree
libbbfdm	Minimal TR181 datamodel definition

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
├── docs              --  More detailed explanation of datamodel and user guide
├── gitlab-ci         --  Used for CI/CD pipeline test
├── libbbfdm          --  Minimal TR181 datamodel implementation
├── libbbfdm-api      --  API library to create datamodel definition and parse the datamodel definition to form a datamodel tree
├── 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

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	https://dev.iopsys.eu/bbf/bbfdm.git	BSD-3
jq	https://github.com/stedolan/jq.git	BSD

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	https://dev.iopsys.eu/bbf/bbfdm.git	BSD-3
jq	https://github.com/stedolan/jq.git	BSD