mirror of
https://dev.iopsys.eu/bbf/bbfdm.git
synced 2025-12-10 07:44:39 +01:00
docs: Reorganise the documents
This commit is contained in:
parent
f571d45304
commit
a2ac63ce39
23 changed files with 23 additions and 22 deletions
34
README.md
34
README.md
|
|
@ -31,7 +31,7 @@
|
||||||
```
|
```
|
||||||
|
|
||||||
- `bbfdmd` folder which contains the source code of bbfdm deamon.
|
- `bbfdmd` folder which contains the source code of bbfdm deamon.
|
||||||
More explanation on how this daemon works and all supported methods are presented in this file [BBFDMD](./docs/arch/bbfdmd.md)
|
More explanation on how this daemon works and all supported methods are presented in this file [BBFDMD](./docs/guide/bbfdmd.md)
|
||||||
|
|
||||||
- `libbbfdm` folder which contains the different data models supported by iopsys
|
- `libbbfdm` folder which contains the different data models supported by iopsys
|
||||||
|
|
||||||
|
|
@ -59,22 +59,22 @@ All supported tools are presented in this file[BBFDM Tools](./tools/README.md)
|
||||||
|
|
||||||
|
|
||||||
## Design
|
## Design
|
||||||
* [BBFDMD Design](./docs/arch/bbfdmd.md)
|
* [BBFDMD Design](./docs/guide/bbfdmd.md)
|
||||||
* [Datamodel extension using JSON plugin](./docs/guide/json_plugin_v1.md)
|
* [Datamodel extension using JSON plugin](./docs/guide/libbbfdm-api_json_plugin_v1.md)
|
||||||
* [Datamodel Plugins and Microservice](./docs/guide/datamodel_as_microservice.md)
|
* [Datamodel Plugins and Microservice](./docs/guide/libbbfdm-api_datamodel_as_microservice.md)
|
||||||
* [BBFDM Tools](./tools/README.md)
|
* [BBFDM Tools](./tools/README.md)
|
||||||
|
|
||||||
## Important Topics
|
## Important Topics
|
||||||
* [Add support of a new Object/Parameter](./docs/guide/obj_param_extension.md)
|
* [Add support of a new Object/Parameter](./docs/guide/libbbfdm-api_obj_param_extension.md)
|
||||||
* [How to add new vendor](./docs/guide/vendor.md)
|
* [How to add new vendor](./docs/guide/libbbfdm-api_vendor.md)
|
||||||
* [Dynamic Object/Parameter/Operate/Event](./docs/guide/dynamic_dm.md)
|
* [Dynamic Object/Parameter/Operate/Event](./docs/guide/libbbfdm-api_dynamic_dm.md)
|
||||||
* [Design for firmware activation](./docs/guide/FirmwareImage.md)
|
* [Design for firmware activation](./docs/guide/libbbfdm_DeviceInfo_FirmwareImage.md)
|
||||||
* [TR181 Firewall datamodel mappings](./docs/guide/firewall.md)
|
* [TR181 Firewall datamodel mappings](./docs/guide/libbbfdm_Firewall.md)
|
||||||
* [Wireless Configuration handling](./docs/guide/WiFi.DataElements.md)
|
* [Wireless Configuration handling](./docs/guide/libbbfdm_WiFi.md)
|
||||||
* [Explain the different Network Deployment Scenarios](./docs/guide/network_depoyment_scenarios.md)
|
* [Explain the different Network Deployment Scenarios](./docs/guide/network_depoyment_scenarios.md)
|
||||||
* [How to Configure MACVLAN](./docs/guide/macvlan_interface.md)
|
* [How to Configure MACVLAN](./docs/guide/libbbfdm_Ethernet_X_IOPSYS_EU_MACVLAN.md)
|
||||||
* [Explain Policy Based Routing Management](./docs/guide/policy_based_routing.md)
|
* [Explain Policy Based Routing Management](./docs/guide/libbbfdm_Routing.md)
|
||||||
* [TR181 DNS datamodel](./docs/guide/device_dns.md)
|
* [TR181 DNS datamodel](./docs/guide/libbbfdm_DNS.md)
|
||||||
|
|
||||||
## External dependencies for datamodel objects
|
## External dependencies for datamodel objects
|
||||||
|
|
||||||
|
|
@ -91,7 +91,9 @@ All supported tools are presented in this file[BBFDM Tools](./tools/README.md)
|
||||||
| STUN parameters | stunc | https://dev.iopsys.eu/bbf/stunc.git |
|
| STUN parameters | stunc | https://dev.iopsys.eu/bbf/stunc.git |
|
||||||
| Device.XPON. | ponmngr | https://dev.iopsys.eu/hal/ponmngr.git |
|
| Device.XPON. | ponmngr | https://dev.iopsys.eu/hal/ponmngr.git |
|
||||||
| Device.UPNP. | ssdpd | https://github.com/miniupnp/miniupnp.git |
|
| Device.UPNP. | ssdpd | https://github.com/miniupnp/miniupnp.git |
|
||||||
| Device.Users. | usermngr | https://dev.iopsys.eu/bbf/usermngr.git |
|
| Device.Users. | usermngr | https://dev.iopsys.eu/bbf/usermngr.git |
|
||||||
| Device.PeriodicStatistics. | periodicstats | https://dev.iopsys.eu/bbf/periodicstats.git |
|
| Device.PeriodicStatistics. | periodicstats | https://dev.iopsys.eu/bbf/periodicstats.git |
|
||||||
| Device.SoftwareModules. | swmodd | https://dev.iopsys.eu/lcm/swmodd.git |
|
| Device.SoftwareModules. | swmodd | https://dev.iopsys.eu/lcm/swmodd.git |
|
||||||
|
| Device.Time. | timemngr | https://dev.iopsys.eu/bbf/timemngr.git |
|
||||||
|
| Device.Hosts. | hostmngr | https://dev.iopsys.eu/iopsys/hostmngr.git |
|
||||||
| Device.Services.VoiceService. | tr104 | https://dev.iopsys.eu/voice/tr104.git |
|
| Device.Services.VoiceService. | tr104 | https://dev.iopsys.eu/voice/tr104.git |
|
||||||
|
|
|
||||||
|
|
@ -133,7 +133,7 @@ Below is another example of json input file:
|
||||||
|
|
||||||
> NOTE1: `bbfdmd` CLI mode is an experimentation feature and it can be updated later.
|
> 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](../../json/input.json) located in '/etc/bbfdm/input.json'.
|
> NOTE2: If `-m` option is not passed when starting `bbfdmd`, so configuration options will be loaded from the default [INPUT.JSON](../../test/files/tmp/bbfdm/input.json) located in '/tmp/bbfdm/input.json'.
|
||||||
|
|
||||||
* To see the currently implemented data model use:
|
* To see the currently implemented data model use:
|
||||||
|
|
||||||
|
|
@ -164,10 +164,10 @@ $ bbfdmd -c set "parameter" "value"
|
||||||
|
|
||||||
|
|
||||||
## Important topics
|
## Important topics
|
||||||
* [UBUS methods](../guide/bbfdm_ubus_methods.md)
|
* [UBUS methods](bbfdmd_ubus_methods.md)
|
||||||
* [UBUS Errors](../guide/bbfdm_ubus_errors.md)
|
* [UBUS Errors](bbfdmd_ubus_errors.md)
|
||||||
* [Parallel UBUS call](../guide/bbfdm_ubus_parallel_call.md)
|
* [Parallel UBUS call](bbfdmd_ubus_parallel_call.md)
|
||||||
* [Third party datamodel integration](../guide/bbfdm_dm_integration.md)
|
* [Third party datamodel integration](bbfdmd_dm_integration.md)
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../tools/README.md
|
|
||||||
Loading…
Add table
Reference in a new issue