RDK Documentation (Open Sourced RDK Components)

Description

The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint).

About TR-069 Object Device.WiFi.AccessPoint.{i}

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.
Note
The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with a given value for SSIDReference.
About TR-069 Object Device.WiFi.EndPoint.{i}

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint;

if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with a given value for SSIDReference.
About TR-069 Object Device.WiFi.Radio.{i}.

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information.
Note
A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.
About TR-069 Object Device.WiFi.SSID.{i}.

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object.
WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the CPE MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.
At most one enabled entry in this table can exist with a given value for SSID, or with a given value for BSSID.

Modules

 TR-069 Object (Device.WiFi.) Public APIs
 The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint).
 
 TR-069 Object (Device.WiFi.AccessPoint.{i}) API
 This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.
 
 TR-069 Object (Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.) Public APIs
 The module provide the interface specifications for TR-069 Object Access Point. A table of the devices currently associated with the access point. At most one entry in this table can exist with a given value for MACAddress.
 
 TR-069 Object (Device.WiFi.AccessPoint.{i}.Security.) Public APIs
 This module contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].
 
 TR-069 Object (Device.WiFi.AccessPoint.{i}.WPS.) Public APIs
 This module provides interface functions related to Wi-Fi Protected Setup [WPSv1.0] for this access point.
 
 TR-069 Object (Device.WiFi.EndPoint.{i}) Public APIs
 This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.
 
 TR-069 Object (Device.WiFi.EndPoint.{i}.Profile.{i}.) Public APIs
 This module provides the interface functions related to wireless end point profile table.
 
 TR-069 Object (Device.WiFi.EndPoint.{i}.Profile.{i}.Security.) Public APIs
 This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007].
 
 TR-069 Object (Device.WiFi.EndPoint.{i}.Security.) Public APIs
 This object contains security related parameters that apply to a WiFi end point [802.11-2007].
 
 TR-069 Object (Device.WiFi.EndPoint.{i}.WPS.) Public APIs
 This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this end point.
 
 TR-069 Object (Device.WiFi.Radio.{i}.Stat.) Public APIs
 Throughput statistics for this interface.
 
 TR-069 Object (Device.WiFi.SSID.{i}.) Public APIs
 WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object.
 
 TR-069 Object (Device.WiFi.SSID.{i}.Stats) Public APIs
 Throughput statistics for this interface.