You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

In Progress


What is Harvester ?

  • Harvester is a CCSP component, which runs on an RDKB gateway to collect data from the Wi-Fi driver in three areas: Associated Devices, Radio Traffic, and Neighboring Wireless Networks.

Repository 

Architecture

  • The Harvester Agent is a  CCSP component to handle configuration parameters to control data extraction from the device.
  • The harvester operates by polling the WiFi HAL (Hardware Access Layer) for information for each of the three reports and may store multiple polls for bulk transmission to WebPA and subsequent components.

TR-181

TR-181 Object is X_RDKCENTRAL-COM_Report. A Device Report is an Encoded Avro Schema Payload

  1. InterfaceDevicesWifi

    • The InterfaceDevicesWifi Report sends WiFi Metrics Data for the devices connected to the Gateway harvested from the WiFi HAL.

    • This report is generated by the Harvester Component
    • It supports various parameters to control the Harvesting Periodicity, Schema Identification and Default Values for the various intervals.

TR-181

Type

Default value

Range

Description

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.Enabled

Boolean

False

 

  • Enables or disables InterfaceDevicesWifi data collection.
  • A value of true means that the harvester will collect data about devices connected to all the SSID's which are Enabled on the system and send them to the Cloud

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.PollingPeriod

unsigned integer

900

1, 5, 10, 15, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400

  • Stores the InterfaceDevicesWifi polling time period in seconds
  • An unsigned integer in seconds  denotes the time the harvester will wait between querying associated device data on all SSID's which are enabled in the System. Must be less than or equal to Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.ReportingPeriod

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.ReportingPeriod

unsigned integer

900

1, 5, 10, 15, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400
Must be greater than or equal to the PollingPeriod

  • Stores the InterfaceDevicesWifi reporting time period in seconds
  • An unsigned integer in seconds  denotes the time the harvester will wait between uploading associated device data on all SSID's which are enabled in the System to the cloud. Must be greater than or equal to Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.PollingPeriod

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.Schema

string

 

 

  • Stores the Schema used to encode the Associated Devices Scan Data
  • A String consisting of the Avro Schema used to Encode the InterfaceDevicesWifi data from the HAL

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.SchemaID

string

 

 

  • Stores the UUID/HASH of the Schema used to encode the Scan data
  • UUID/HASH as a string of the Schema used to Encode the data from HAL

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.Default.PollingPeriod

unsigned integer

900

1, 5, 10, 15, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400

  • Stores the InterfaceDevicesWifi default polling time period in seconds
  • An unsigned integer in seconds denotes the default time the harvester will wait between querying associated device data on all SSID's which are enabled in the System.

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.Default.ReportingPeriod

unsigned integer

900

1, 5, 10, 15, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400
Must be greater than Polling Period

  • Stores the InterfaceDevicesWifi default reporting time period in seconds
  • An unsigned interger in seconds denotes the default time the harvester will wait between uploading associated device data on all SSID's which are enabled in the System to the cloud.

Device.X_RDKCENTRAL-COM_Report.InterfaceDevicesWifi.Default.OverrideTTL

unsigned integer

300

 

  • Stores the time which an accelerated Polling or Reporting period will remain active
  • An unsigned integer in seconds denotes the time that a request to accelerate a polling interval or reporting interval will remain active.
  • Defaults to 300 seconds if a value is not specified


  1.  RadioInterfaceStatistics
  2. NeighboringAP
  • No labels

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.