Description

Describe the details about RDK TR69 DeviceInfo APIs specifications.

Functions
int	hostIf_DeviceInfo::get_Device_DeviceInfo_SerialNumber (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_SerialNumber. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_SoftwareVersion (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_SoftwareVersion. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_Manufacturer (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_Manufacturer. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_ManufacturerOUI (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_Manufacturer. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_ModelName (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_ModelName. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_Description (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_Description. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_ProductClass (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_ProductClass. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_HardwareVersion (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_HardwareVersion. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_AdditionalHardwareVersion (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_AdditionalHardwareVersion. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_AdditionalSoftwareVersion (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_AdditionalSoftwareVersion. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_ProvisioningCode (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_ProvisioningCode. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_UpTime (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_UpTime. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_FirstUseDate (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_FirstUseDate. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_STB_IP (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_COMCAST_COM_STB_IP. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_VendorConfigFileNumberOfEntries (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_VendorConfigFileNumberOfEntries. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_SupportedDataModelNumberOfEntries (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_SupportedDataModelNumberOfEntries. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_VendorLogFileNumberOfEntries (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_VendorLogFileNumberOfEntries. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_MemoryStatus_Total (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the device total memory status. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_MemoryStatus_Free (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the device total free memory status. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus (HOSTIF_MsgData_t , bool pChanged=NULL)
	get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus. More...

int	hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_CPUTemp (HOSTIF_MsgData_t , bool pChanged=NULL)
	This method gets the CPU temperature for doing general health check up of the box. More...

int	hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset (HOSTIF_MsgData_t *)
	set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset. More...

int	hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload (HOSTIF_MsgData_t *)
	This method set the firmware download file path which is present in "/opt/fwdnldstatus.txt". More...

int	hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareDownloadStatus (HOSTIF_MsgData_t *)
	This method set the status of the firmware download which is present in "/opt/fwdnldstatus.txt". More...

int	hostIf_DeviceInfo::readFirmwareInfo (char , HOSTIF_MsgData_t )
	This method read the firmware information which is present in "/opt/fwdnldstatus.txt". More...

int	hostIf_DeviceInfo::writeFirmwareInfo (char , HOSTIF_MsgData_t )
	This method writes the firmware information which is present in "/opt/fwdnldstatus.txt". More...

int	hostIf_DeviceInfo::get_X_RDK_FirmwareName (HOSTIF_MsgData_t *)
	This function identifying the imagename of the running image This Value comes from "imagename" property in /version.txt file. More...

Function Documentation

◆ get_Device_DeviceInfo_SerialNumber()

int hostIf_DeviceInfo::get_Device_DeviceInfo_SerialNumber	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_SerialNumber.

This function provides the Identifier of the particular device that is unique for the indicated class of product and manufacturer. This is the Serial Number of the box. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require to inform BOOTSTRAP.

This function provides the Identifier of the particular device that is unique for the indicated class of product and manufacturer. This is the Serial Number of the box.

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 301 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_SoftwareVersion()

int hostIf_DeviceInfo::get_Device_DeviceInfo_SoftwareVersion	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_SoftwareVersion.

This function identifying the Software/Firmware version of the running image on the box (Vx.y.z). A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

This function identifying the Software/Firmware version of the running image on the box (Vx.y.z)

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 392 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_Manufacturer()

int hostIf_DeviceInfo::get_Device_DeviceInfo_Manufacturer	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_Manufacturer.

This function retrieves manufacturer specific data from the box using IARM Bus call. The IARM Manager gets the manufacture information from mfr library.

Description. This is the getter api for DeviceInfo for Device.DeviceInfo Profile.

Parameters

[in]	name	Complete path name of the parameter.
[in]	type	It is a user data type of ParameterType.
[out]	value	It is the value of the parameter.

Return values

OK	if successful.
XXX_ERR_BADPARAM	if a bad parameter was supplied.

Execution:\n Synchronous.

Side Effects:\n None.

Note: This function must not suspend and must not invoke any blocking system calls. It should probably just a device inventory message from the platform.

See also: XXX_SomeOtherFunction. This function provides the manufacture information. The manufacturer of the CPE (human readable string).

Returns: The status of the operation.

Return values

OK	if DeviceInfo_Manufacturer was successfully fetched. :1
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ManufacturerOUI.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 486 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_ManufacturerOUI()

int hostIf_DeviceInfo::get_Device_DeviceInfo_ManufacturerOUI	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_Manufacturer.

This function provides the manufactureOUT information. Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns: [0-9A-F]{6}. This value MUST remain fixed over the lifetime of the device and also across firmware updates. Any change would indicate that, it's a new device and would therefore require a BOOTSTRAP.

This function provides the manufactureOUT information.

Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

[0-9A-F]{6}

The value MUST be a valid OUI as defined in [OUI].

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

Returns: The status of the operation.

Return values

OK	if ManufacturerOUI was successfully fetched.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_Manufacturer.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if ManufacturerOUI was successfully fetched.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 565 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_ModelName()

int hostIf_DeviceInfo::get_Device_DeviceInfo_ModelName	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_ModelName.

This function provides the Model name of the device. This MUST be based on Comcast_X_HW* specification and of the format TUVVVWXY.

This function provides the Model name of the CPE (human readable string) Device. This MUST be based on Comcast_X_HW* specification and of the format TUVVVWXY.

Returns: The status of the operation.

Return values

OK	if ManufacturerOUI was successfully fetched.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_Manufacturer.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if ManufacturerOUI was successfully fetched.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 640 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_Description()

int hostIf_DeviceInfo::get_Device_DeviceInfo_Description	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_Description.

This function provides the A full description of the device. Currently not implemented.

This function provides the A full description of the CPE device (human readable string). Device. *

Returns: The status of the operation.

Return values

OK	if Description is successfully fetched.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_Description.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns enum integer '-1' on method completion.

Definition at line 724 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_ProductClass()

int hostIf_DeviceInfo::get_Device_DeviceInfo_ProductClass	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_ProductClass.

This function provides the Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device and also across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP. Currently not implemented.

This function provides the Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique.

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_Description.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns enum integer '-1' on method completion.

Definition at line 748 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_HardwareVersion()

int hostIf_DeviceInfo::get_Device_DeviceInfo_HardwareVersion	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_HardwareVersion.

This function identifying the particular CPE model and version. This MUST be based on Comcast_X_HW* specification and of the format VM.m.R.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from device.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 821 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_AdditionalHardwareVersion()

int hostIf_DeviceInfo::get_Device_DeviceInfo_AdditionalHardwareVersion	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_AdditionalHardwareVersion.

This function identifying any additional CPE model and version. Currently not implemented.

This function identifying any additional CPE model and version. This MUST be based on Comcast_X_HW* specification and of the format VM.m.R.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns enum integer '-1' on method completion.

Definition at line 878 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_AdditionalSoftwareVersion()

int hostIf_DeviceInfo::get_Device_DeviceInfo_AdditionalSoftwareVersion	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_AdditionalSoftwareVersion.

This function identifying any additional Software/Firmware version of the running image on the box (Vx.y.z). A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware). To allow version comparisons, the version number SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

This function identifying any additional Software/Firmware version of the running image on the box (Vx.y.z)

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from device.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 901 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_ProvisioningCode()

int hostIf_DeviceInfo::get_Device_DeviceInfo_ProvisioningCode	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_ProvisioningCode.

This is an identifier of the primary service provider and other provisioning information, which MAY be used to determine service provider-specific customization and provisioning parameters.

This is an Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

See also: get_Device_DeviceInfo_ProductClass.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 965 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_UpTime()

int hostIf_DeviceInfo::get_Device_DeviceInfo_UpTime	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_UpTime.

This is an identifier of time in seconds since the CPE was last restarted.

This is an Identifier of time in seconds since the CPE was last restarted.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1022 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_FirstUseDate()

int hostIf_DeviceInfo::get_Device_DeviceInfo_FirstUseDate	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_FirstUseDate.

This function use to get the 'Date' and 'Time' in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the unknown time value.

This is Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset.

If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1047 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC.

This function use to get the MAC Address of the eth1 interface currently.

This is the MAC Address of the interface. This is currently the mac address of the eth1 interface.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1083 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_COMCAST_COM_STB_IP()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_STB_IP	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_COMCAST_COM_STB_IP.

This function use to get the IPv4 Address of the eth1 interface currently.

This is the IPv4 address of the interface. This is currently the ip address of the eth1 interface.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1328 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus.

The X_COMCAST_COM_PowerStatus as get parameter results in the power status being performed on the device. Power status of the device based on the front panel power LED.

The X_COMCAST_COM_PowerStatus as get parameter results in the power status being performed on the device. Power status of the device based on the front panel power LED. Enumeration of: PowerOn Standby PowerOff

Returns: The status of the operation. When read, this parameter returns an enumeration string.

Return values

OK	if it is successful.
NOK	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation. When read, this parameter returns an enumeration string.

Return values

OK	if it is successful fetch data from the device.
NOK	if not able to fetch data from the device.

Definition at line 1369 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename.

Get the filename of the firmware currently running on the device.

Filename of the firmware currently running on the device.

Returns: The Filename of the firmware currently running on the device.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the Filename of the firmware currently running on the device.

Return values

OK	if it is successfully fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1425 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload.

Get the filename of the firmware that the device was requested to download most recently.

Filename of the firmware that the device was requested to download most recently..

Returns: The Filename of the firmware that was recently downloaded.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the filename of the firmware that was recently downloaded.

Return values

OK	if it is successfully fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1529 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_VendorConfigFileNumberOfEntries()

int hostIf_DeviceInfo::get_Device_DeviceInfo_VendorConfigFileNumberOfEntries	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_VendorConfigFileNumberOfEntries.

This function gets the number of entries in the VendorConfigFile table. Currently not implemented.

This is the number of entries in the VendorConfigFile table.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1634 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_SupportedDataModelNumberOfEntries()

int hostIf_DeviceInfo::get_Device_DeviceInfo_SupportedDataModelNumberOfEntries	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_SupportedDataModelNumberOfEntries.

This function gets the number of entries in the SupportedDataModel table. Currently not implemented.

This is the number of entries in the SupportedDataModel table.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1652 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_VendorLogFileNumberOfEntries()

int hostIf_DeviceInfo::get_Device_DeviceInfo_VendorLogFileNumberOfEntries	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_VendorLogFileNumberOfEntries.

The function gets the number of entries in the VendorLogFile table. Currently not implemented.

The number of entries in the VendorLogFile table.

Returns: The status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1702 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset.

This function get X_COMCAST-COM_Reset returns an empty string. Currently not implemented.

Returns an empty string.

Returns: The status of the operation.

Return values

OK	if it is successful.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns integer '-1' on method completion

Definition at line 1717 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_MemoryStatus_Total()

int hostIf_DeviceInfo::get_Device_DeviceInfo_MemoryStatus_Total	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the device total memory status.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1740 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_MemoryStatus_Free()

int hostIf_DeviceInfo::get_Device_DeviceInfo_MemoryStatus_Free	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the device total free memory status.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful fetch data from the device.
ERR_INTERNAL_ERROR	if not able to fetch data from the device.

Definition at line 1768 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus.

This method is updated with the boot status of the device at the time of query. If the device is currently starting up, this parameter will hold boot status as per the boot sequence of the device. BootStatus string - Boot status for an STB CPE via TR-069 ACS when powered On. Enumeration of : Coax connection confirmed, MoCA enabled Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx Joining MoCA Network Connection successful Acquiring IP Address from Gateway Contacting ACS Contacting XRE.

This method is updated with the boot status of the device at the time of query. If the device is currently starting up, this parameter will hold boot status as per the boot sequence of the device.

BootStatus string - Boot status for an STB CPE via TR-069 ACS when powered On. Enumeration of : Coax connection confirmed, MoCA enabled Discovering MoCA Network Coordinator: MoCA MAC: xx:xx:xx:xx:xx:xx Joining MoCA Network Connection successful Acquiring IP Address from Gateway Contacting ACS Contacting XRE

Returns: The status of the operation. When read, this parameter returns an enumeration string.

Return values

OK	if it is successful.
NOK	if not able to fetch from device.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from the device.
NOK	if not able to fetch data from the device.

Definition at line 1801 of file Device_DeviceInfo.cpp.

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_CPUTemp()

int hostIf_DeviceInfo::get_Device_DeviceInfo_X_RDKCENTRAL_COM_CPUTemp	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This method gets the CPU temperature for doing general health check up of the box.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch data from the device.
NOK	if not able to fetch data from the device.

Definition at line 1931 of file Device_DeviceInfo.cpp.

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset()

int hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset ( HOSTIF_MsgData_t * stMsgData )

set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset.

This is set X_COMCAST-COM_Reset as setting this parameter results in the reset being performed on the device. The level of reset performed is defined by the value that is written into this parameter. Enumeration of: Cold Factory Warehouse Customer.

Setting this parameter results in a reset being performed on the device. The level of reset performed is defined by the value written into this parameter. Enumeration of: Cold Factory Warehouse Customer

Returns: The status of the operation. When read, this parameter returns an empty string.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Side Effects:\n All necessary structures and buffers are deallocated.

Execution:\n Synchronous.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from device.
ERR_INTERNAL_ERROR	if not able to fetch the data from device.

Definition at line 2098 of file Device_DeviceInfo.cpp.

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload()

int hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload ( HOSTIF_MsgData_t * stMsgData )

This method set the firmware download file path which is present in "/opt/fwdnldstatus.txt".

Helper methods

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from device.
NOK	if not able to fetch the data from device.

Definition at line 2186 of file Device_DeviceInfo.cpp.

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareDownloadStatus()

int hostIf_DeviceInfo::set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareDownloadStatus ( HOSTIF_MsgData_t * stMsgData )

This method set the status of the firmware download which is present in "/opt/fwdnldstatus.txt".

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Return the status of the operation.

Return values

OK	if it is successfully fetch the data from device.
NOK	if not able to fetch the data from device.

Definition at line 2207 of file Device_DeviceInfo.cpp.

◆ readFirmwareInfo()

int hostIf_DeviceInfo::readFirmwareInfo	(	char *	param,
		HOSTIF_MsgData_t *	stMsgData
	)

This method read the firmware information which is present in "/opt/fwdnldstatus.txt".

Parameters

[in]	param	Firmware name string.
[out]	stMsgData	TR-069 Host interface message request.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from device.
NOK	if not able to fetch the data from device.

Definition at line 4000 of file Device_DeviceInfo.cpp.

◆ writeFirmwareInfo()

int hostIf_DeviceInfo::writeFirmwareInfo	(	char *	param,
		HOSTIF_MsgData_t *	stMsgData
	)

This method writes the firmware information which is present in "/opt/fwdnldstatus.txt".

Parameters

[in]	param	Firmware name string.
[out]	stMsgData	TR-069 Host interface message request.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from device.
NOK	if not able to fetch the data from device.

Definition at line 4070 of file Device_DeviceInfo.cpp.

◆ get_X_RDK_FirmwareName()

int hostIf_DeviceInfo::get_X_RDK_FirmwareName ( HOSTIF_MsgData_t * stMsgData )

This function identifying the imagename of the running image This Value comes from "imagename" property in /version.txt file.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to fetch from device.

Definition at line 4743 of file Device_DeviceInfo.cpp.

Description

Functions

Function Documentation

◆ get_Device_DeviceInfo_SerialNumber()

◆ get_Device_DeviceInfo_SoftwareVersion()

◆ get_Device_DeviceInfo_Manufacturer()

◆ get_Device_DeviceInfo_ManufacturerOUI()

◆ get_Device_DeviceInfo_ModelName()

◆ get_Device_DeviceInfo_Description()

◆ get_Device_DeviceInfo_ProductClass()

◆ get_Device_DeviceInfo_HardwareVersion()

◆ get_Device_DeviceInfo_AdditionalHardwareVersion()

◆ get_Device_DeviceInfo_AdditionalSoftwareVersion()

◆ get_Device_DeviceInfo_ProvisioningCode()

◆ get_Device_DeviceInfo_UpTime()

◆ get_Device_DeviceInfo_FirstUseDate()

◆ get_Device_DeviceInfo_X_COMCAST_COM_STB_MAC()

◆ get_Device_DeviceInfo_X_COMCAST_COM_STB_IP()

◆ get_Device_DeviceInfo_X_COMCAST_COM_PowerStatus()

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareFilename()

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload()

◆ get_Device_DeviceInfo_VendorConfigFileNumberOfEntries()

◆ get_Device_DeviceInfo_SupportedDataModelNumberOfEntries()

◆ get_Device_DeviceInfo_VendorLogFileNumberOfEntries()

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset()

◆ get_Device_DeviceInfo_MemoryStatus_Total()

◆ get_Device_DeviceInfo_MemoryStatus_Free()

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_BootStatus()

◆ get_Device_DeviceInfo_X_RDKCENTRAL_COM_CPUTemp()

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_Reset()

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareToDownload()

◆ set_Device_DeviceInfo_X_RDKCENTRAL_COM_FirmwareDownloadStatus()

◆ readFirmwareInfo()

◆ writeFirmwareInfo()

◆ get_X_RDK_FirmwareName()