WIP


Scope

Reference USP controller for testing Remote management in RDK-B

Code base

Use cases tested

Installation steps

  1. setup MQTT in host machine & allow the ports
    1. ontroller# netstat -tlnp | grep mosquitto
tcp        0      0 127.0.0.1:1883          0.0.0.0:*               LISTEN      1596/mosquitto      
tcp6       0      0 ::1:1883                :::*                    LISTEN      1596/mosquitto  
pip3 install paho-mqtt
pip3 install protobuf==3.20.3
pip3 install flask
  2. goto https://github.com/rdkcentral/rdkb-usp-reference-controller and configure the ip address and start app using python3 app.py
    1.  self.config = {
            'broker': "10.26.60.86",

   self.repos = {
          ......
            "server": "http://10.26.60.86/"

repos = {
               ......
                "server": "http://10.26.60.86/"
  3. Factory reset file
    1. ##########################################################################################################

#

# This file contains a factory reset database in text format

#

# If no USP database exists when OB-USP-AGENT starts, then OB-USP-AGENT will create a database containing

# the parameters specified in a text file located by the '-r' option.

# Example:

#    obuspa -p -v 4 -r factory_reset_example.txt

#

# Each line of this file contains either a comment (denoted by '#' at the start of the line)

# or a USP data model parameter and its factory reset value.

# The parameter and value are separated by whitespace.

# The value may optionally be enclosed in speech marks "" (this is the only way to specify an empty string)

#

##########################################################################################################

Device.LocalAgent.EndpointID "proto::rx_usp_agent_mqtt"





## Adding boot params

Device.LocalAgent.Controller.1.BootParameter.1.Enable true

Device.LocalAgent.Controller.1.BootParameter.1.ParameterName "Device.LocalAgent.EndpointID"





Device.LocalAgent.Subscription.1.Alias cpe-1

Device.LocalAgent.Subscription.1.Enable true

Device.LocalAgent.Subscription.1.ID default-boot-event-ACS

Device.LocalAgent.Subscription.1.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.1.NotifType Event

Device.LocalAgent.Subscription.1.ReferenceList Device.Boot!

Device.LocalAgent.Subscription.1.Persistent true





Device.LocalAgent.Subscription.2.Alias cpe-2

Device.LocalAgent.Subscription.2.Enable true

Device.LocalAgent.Subscription.2.ID PeriodicInformInterval

Device.LocalAgent.Subscription.2.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.2.NotifType ValueChange

Device.LocalAgent.Subscription.2.ReferenceList Device.ManagementServer.PeriodicInformInterval

Device.LocalAgent.Subscription.2.Persistent true

Device.LocalAgent.Subscription.2.TimeToLive 0

Device.LocalAgent.Subscription.2.NotifRetry true

Device.LocalAgent.Subscription.2.NotifExpiration 10000





Device.LocalAgent.Subscription.3.Alias cpe-3

Device.LocalAgent.Subscription.3.Enable true

Device.LocalAgent.Subscription.3.ID object-creation

Device.LocalAgent.Subscription.3.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.3.NotifType ObjectCreation

Device.LocalAgent.Subscription.3.ReferenceList Device.Routing.Router.

Device.LocalAgent.Subscription.3.Persistent true

Device.LocalAgent.Subscription.3.TimeToLive 0

Device.LocalAgent.Subscription.3.NotifRetry true

Device.LocalAgent.Subscription.3.NotifExpiration 10000





Device.LocalAgent.Subscription.4.Alias cpe-4

Device.LocalAgent.Subscription.4.Enable true

Device.LocalAgent.Subscription.4.ID object-deletion

Device.LocalAgent.Subscription.4.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.4.NotifType ObjectDeletion

Device.LocalAgent.Subscription.4.ReferenceList Device.Routing.Router.

Device.LocalAgent.Subscription.4.Persistent true

Device.LocalAgent.Subscription.4.TimeToLive 0

Device.LocalAgent.Subscription.4.NotifRetry true

Device.LocalAgent.Subscription.4.NotifExpiration 10000





Device.LocalAgent.Subscription.5.Alias cpe-5

Device.LocalAgent.Subscription.5.Enable true

Device.LocalAgent.Subscription.5.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.5.ID operation-complete

Device.LocalAgent.Subscription.5.NotifType OperationComplete

Device.LocalAgent.Subscription.5.ReferenceList Device.SelfTestDiagnostics()

Device.LocalAgent.Subscription.5.Persistent true

Device.LocalAgent.Subscription.5.TimeToLive 0

Device.LocalAgent.Subscription.5.NotifRetry true

Device.LocalAgent.Subscription.5.NotifExpiration 10000





Device.LocalAgent.Subscription.6.Alias cpe-6

Device.LocalAgent.Subscription.6.Enable true

Device.LocalAgent.Subscription.6.Recipient Device.LocalAgent.Controller.1

Device.LocalAgent.Subscription.6.ID default-boot-event-ACS

Device.LocalAgent.Subscription.6.CreationDate 0001-01-01T00:00:00Z

Device.LocalAgent.Subscription.6.NotifType Event

Device.LocalAgent.Subscription.6.ReferenceList Device.Boot!

Device.LocalAgent.Subscription.6.Persistent true

Device.LocalAgent.Subscription.6.TimeToLive 0

Device.LocalAgent.Subscription.6.NotifRetry true

Device.LocalAgent.Subscription.6.NotifExpiration 10000







Device.LocalAgent.MTP.1.MQTT.ResponseTopicConfigured "/usp/agent"

Device.LocalAgent.MTP.1.MQTT.Reference "Device.MQTT.Client.1"



#Device.MQTT.Client.1.BrokerAddress "mqtt.eclipse.org"

#Device.MQTT.Client.1.BrokerAddress "localhost"

#Device.MQTT.Client.1.BrokerAddress "192.168.2.130"

Device.MQTT.Client.1.BrokerAddress "69.136.48.217"



Device.MQTT.Client.1.ProtocolVersion "5.0"

Device.MQTT.Client.1.BrokerPort "1883"

Device.MQTT.Client.1.TransportProtocol "TCP/IP"

Device.MQTT.Client.1.Username ""

Device.MQTT.Client.1.Password ""

Device.MQTT.Client.1.Alias "cpe-1"

Device.MQTT.Client.1.Enable true

Device.MQTT.Client.1.ClientID ""

Device.MQTT.Client.1.KeepAliveTime "60"

Device.MQTT.Client.1.ConnectRetryTime "5"

Device.MQTT.Client.1.ConnectRetryIntervalMultiplier "2000"

Device.MQTT.Client.1.ConnectRetryMaxInterval "60"





Device.LocalAgent.Controller.1.Alias "cpe-1"

Device.LocalAgent.Controller.1.EndpointID "self::usp-controller"

Device.LocalAgent.Controller.1.ControllerCode ""

Device.LocalAgent.Controller.1.Enable true

Device.LocalAgent.Controller.1.PeriodicNotifInterval "86400"

Device.LocalAgent.Controller.1.PeriodicNotifTime "0001-01-01T00:00:00Z"

Device.LocalAgent.Controller.1.MTP.1.Alias "cpe-1"

Device.LocalAgent.Controller.1.MTP.1.Enable true

Device.LocalAgent.Controller.1.MTP.1.Protocol "MQTT"

Device.LocalAgent.Controller.1.MTP.1.MQTT.Reference "Device.MQTT.Client.1"

Device.LocalAgent.Controller.1.MTP.1.MQTT.Topic "/usp/controller"



#

# The following parameters may be modified

#

Device.LocalAgent.MTP.1.Alias "cpe-1"

Device.LocalAgent.MTP.1.Enable true

Device.LocalAgent.MTP.1.Protocol "MQTT"



Internal.Reboot.Cause "LocalFactoryReset"