RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.) Public APIs

Description

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.

Functions

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_MACAddress (HOSTIF_MsgData_t *stMsgData)
 Get the MAC Address of an Associated Device of a WiFi Interface. More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_AuthenticationState (HOSTIF_MsgData_t *stMsgData)
 Check Whether an associated device has authenticated (true) or not (false). More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataDownlinkRate (HOSTIF_MsgData_t *stMsgData)
 Get the data transmit rate in kbps that was most recently used for transmission from the access point to the associated device. More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataUplinkRate (HOSTIF_MsgData_t *stMsgData)
 Get the data transmit rate in kbps that was most recently used for transmission from the associated device to the access point. More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_SignalStrength (HOSTIF_MsgData_t *stMsgData)
 Get the radio signal strength of the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device. More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_Retransmissions (HOSTIF_MsgData_t *stMsgData)
 Get the number of packets that had to be re-transmitted, from the last 100 packets sent to the associated device. Multiple re-transmissions of the same packet count as one. More...
 
int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_Active (HOSTIF_MsgData_t *stMsgData)
 Check whether or not this node is currently present in the WiFi AccessPoint network. More...
 

Function Documentation

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_MACAddress()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_MACAddress ( HOSTIF_MsgData_t stMsgData)

Get the MAC Address of an Associated Device of a WiFi Interface.

This function provides the MAC address of the WiFi interface of the device associated with this WiFi interface.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_AuthenticationState()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_AuthenticationState ( HOSTIF_MsgData_t stMsgData)

Check Whether an associated device has authenticated (true) or not (false).

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataDownlinkRate()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataDownlinkRate ( HOSTIF_MsgData_t stMsgData)

Get the data transmit rate in kbps that was most recently used for transmission from the access point to the associated device.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataUplinkRate()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_LastDataUplinkRate ( HOSTIF_MsgData_t stMsgData)

Get the data transmit rate in kbps that was most recently used for transmission from the associated device to the access point.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_SignalStrength()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_SignalStrength ( HOSTIF_MsgData_t stMsgData)

Get the radio signal strength of the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_Retransmissions()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_Retransmissions ( HOSTIF_MsgData_t stMsgData)

Get the number of packets that had to be re-transmitted, from the last 100 packets sent to the associated device. Multiple re-transmissions of the same packet count as one.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDevice_Active()

int hostIf_WiFi_AccessPoint_AssociatedDevice::get_hostIf_WiFi_AccessPoint_AssociatedDevice_Active ( HOSTIF_MsgData_t stMsgData)

Check whether or not this node is currently present in the WiFi AccessPoint network.

The ability to list inactive nodes is optional. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.