= OB-USP-AGENT

Open Broadband-User Services Platform-Agent (OB-USP-Agent) is an open source project that is focused on creating a reference implementation of the User Services Platform (USP) https://usp.technology[specification] from an "Agent" perspective. USP is a remote management and control protocol where management entities are separated between the Agent and the Controller.  A USP Agent is responsible for exposing a set of "Service Elements" (essentially, a data model composed of objects and parameters that represent a specific set of functionality) for consumption by a Controller.  While USP is capable of being used in many different environments, the home network is expected to be the most common environment, and in this environment a USP Agent would reside in a piece of Customer Premise Equipment (CPE), e.g. broadband home router, Wi-Fi access point, IoT gateway.

== Code Management

This repository is a fork of https://github.com/BroadbandForum/obuspa.git[Broadband Forum's OB-USP-A] project, which follows the Vendor Integration guideline to use datamodel exposed over ubus using https://dev.iopsys.eu/bbf/bbfdm.git[BBFDM].

In this repository, except vendor and test directories rest of the code is from upstream OB-USP-A project and referred as core code, any update in the core code maintained as a patch in https://dev.iopsys.eu/feed/iopsys/-/tree/devel/obuspa/[IOPSYS Feeds]

vendor directory code is mostly for integration with bbfdm over ubus.

== Important links

* link:./docs/guide[How to Guides]
* link:./docs/api/uci/obuspa.md[UCI Spec]
