bbfdm/docs/guide/bbfdmd.md

BBFDM Daemon (bbfdmd)

bbfdmd is daemon which exposes data-model objects over ubus as required by TR-069/cwmp or TR-369/USP.

Note 1: The command outputs shown in this readme are examples only, actual output may differ based on device and configuration.

Note 2: Long command outputs are compressed for better readability

UCI Config

The configuration file is an uci file /etc/config/bbfdm. Sample configuration file is provided below.

config bbfdmd 'bbfdmd'
        option loglevel  '2'
        option sock '/tmp/bbfdm.sock'
        option transaction_timeout 10
        option subprocess_level '1'
        option refresh_time '10'

In the above uci, loglevel can have below value:

loglevel	Meaning
0	Disabled logging
1	Only errors will be logged
2	Only errors and warnings will be logged
3	Log everything except debug
4	Everything will be logged

For more info on the bbfdmd UCI configuration visit uci documentation OR raw uci schema

Concepts and Workflow

bbfdmd internally uses both libbbfdm-api and libbbfdm to get the data-model objects. On startup it parses the uci file to check the different configurations and then based on that it registers the bbfdm ubus namespace.

When a ubus method is called it first fills bbfdm_data_t structure with the necessary information, then proceeds the Get/Set/Operate/Add/Del operation based on that information.

bbfdmd uses bbf_entry_method API from libbbfdm-api and tEntryRoot, tVendorExtension, tVendorExtensionOverwrite and tVendorExtensionExclude global shared arrays from libbbfdm to get the device tree schema and its values.

In short, it covers/supports all methods introduced in TR-069 and TR-369 by using the bbf_entry_method API from libbbfdm-api with the different methods and the existing data-model available with libbbfdm.

Debugging tools

With the advancement in the datamodel tree, it is sometime required to do some debugging at the source, to simplify that bbfdmd offer a command line tool, which can

• Work directly on plugins, or
• Gets the data from an ubus object

and then show it on the CLI. This command line tool is part of bbfdmd binary itself and can be accessed with command line argument option '-c' along with binary.

# bbfdmd -h
Usage: bbfdmd [options]

options:
    -s <socket path>    ubus socket
    -m <json path>      json input configuration for micro services
    -c <command input>  Run cli command
    -h                 Displays this help

# 

If no command line option provided along with bbfdmd command then it starts in daemon mode and get the default configuration from /etc/bbfdm/input.json

# cat /etc/bbfdm/input.json 
{
  "daemon": {
    "config": {
      "loglevel": "1",
      "refresh_time": "10",
      "transaction_timeout": "10"
    },
    "input": {
      "type": "DotSo",
      "name": "/lib/libbbfdm.so"
    },
    "output": {
      "type": "UBUS",
      "name": "bbfdm"
    }
  },
  "cli": {
    "config": {
      "proto": "both",
      "instance_mode": 0
    },
    "input": {
      "type": "UBUS",
      "name": "bbfdm"
    },
    "output": {
      "type": "CLI"
    }
  }
}

In command (or CLI) mode, it supports interactively querying the data model and setting values in the configuration via the data model.

# bbfdmd -c help
Valid commands:
   help
   get [path-expr]
   set [path-expr] [value]
   add [object]
   del [path-expr]
   instances [path-expr]
   schema [path-expr]
#

Below is another example of json input file:

{
    "cli": {
        "config": {
            "proto": "usp", // usp, cwmp
            "instance_mode": 0 // 0:number, 1:alias
        },
        "input": {
            "type": "UBUS", // JSON, UBUS, DotSO, UNIX
            "name": "bbfdm"
        },
        "output": {
            "type": "CLI" // CLI, JSON
        }
    }
}

NOTE1: bbfdmd CLI mode is an experimentation feature and it can be updated later.

NOTE2: If -m option is not passed when starting bbfdmd, so configuration options will be loaded from the default INPUT.JSON located in '/tmp/bbfdm/input.json'.

• To see the currently implemented data model use:

$ bbfdmd -c schema Device.

• To query the value of a parameter use:

root@iopsys:~# bbfdmd -c get Device.Time.           
Device.Time.Enable => 0
root@iopsys:~#
root@iopsys:~# bbfdmd -c get Device.WiFi.SSID.1.SSID
Device.WiFi.SSID.1.SSID => test-5g

Note: Wildcard (*) is valid placeholder for multi-instance object instance and partial paths are also allowed.

• To set the value of a data model parameter use:

$ bbfdmd -c set "parameter" "value"

Note: The CLI mode also supports adding and deleting instances of data model objects and supported instances.

Important topics

• UBUS methods
• UBUS Errors
• Parallel UBUS call
• Third party datamodel integration

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

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

System daemon ubusd is used to expose the BBFDM functionality over ubus.