ARRIS Enterprises, Inc. Confidential Information

System configuration objects

System configuration items and variables are provided by the Information Service. Each configuration item or variable is represented by a specific information object. All objects managed by the Information Service are organized in the common Information Service storage structure. Objects named with prefixes "const." and "var." are read only.

CFG_POWER_APD_TIMEOUT (cfg.power.apd.timeout)

Number of seconds from last user interaction (remote or front panel button press) until Auto Power Down occurs. A value of 0 disables auto power down. The default is 14400 (4 hours).

The default value may vary, depending on which power management scheme is in use. See also CONST_POWER_APD_DEFAULT.

Type:
Integer

Example:
18000

Sources:

CONST_FW_VERSION (const._fw.version)

IP-STB boot loader version

Type:
String

Example:
1.21

Sources: Flash Production Data

CONST_ARCHITECTURE_DEVICE (const.architecture.device)

The device type of the IP-STB.

Type:
String

Example:
vip19x3

Sources: OS

CONST_ARCHITECTURE_TOOLCHAIN (const.architecture.toolchain)

The type of toolchain used to build the IP-STB software.

Type:
String

Example:
st40

Sources: OS

CONST_CAPABILITIES_ASSETSHARING (const.capabilities.assetsharing)

Indicates that the asset sharing feature is available in the boot image.

Type:
String

Value set:

TRUE
asset sharing is enabled
FALSE
asset sharing is not supported

Sources: Build configuration, Default

CONST_CAPABILITIES_MACROVISION (const.capabilities.macrovision)

Indicates if macrovision copy protection is supported by the hardware.

Type:
String

Value set:

TRUE
macrovision is supported
FALSE
macrovision is not supported

Sources: Flash Production Data

CONST_CAPABILITIES_PIP (const.capabilities.pip)

Indicates the Picture in Picture (PiP) capability of the device.

Type:
String

Value set:

none
PiP not available
cif
352x288
sd
720x576
hd
1920x1088

Sources: OS

CONST_DTCP_DEVICEID (const.dtcp.deviceid)

The own device's ID number (40 bits) assigned by the DTLA.

The value is stored in PFD (Protected Flash Data).

Type:
String

Value set:
The five bytes Device ID contains ten hexadecimal-digit upper-case characters including any leading zeros.

Sources: Flash Production Data

CONST_GOLDENIMAGE_VERSION (const.goldenimage.version)

For products using the concept of a golden image, this object provides the version of that image.

Type:
String

Default:
N/A

Example:
1.0.0

Sources: OS, Default

CONST_HW_BLUETOOTH (const.hw.bluetooth)

Indicates if the hardware supports Bluetooth or not. The value is read from the production parameters.

Type:
String

Value set:

TRUE
FALSE

Default:
FALSE

Sources: Flash Production Data, Default

CONST_HW_MANUFACTURER (const.hw.manufacturer)

Manufacturer of the IP-STB.

Type:
String

Example:
ARRIS

Sources: Flash Production Data

CONST_HW_OUI (const.hw.oui)

Organizationally Unique Identifier of the STB manufacturer.

Type:
String

Example:
00029B

Sources: Flash Production Data

CONST_HW_PRODUCTNAME (const.hw.productname)

Model name of the IP-STB.

Type:
String

Example:
VIP1903-C

Sources: Flash Production Data

CONST_HW_SERIALNUMBER (const.hw.serialnumber)

IP-STB serial number.	Type: String
Sources: Flash Production Data

CONST_HW_WIFI (const.hw.wifi)

Indicates if the hardware supports WiFi or not. The value is read from the production parameters.

Type:
String

Value set:

TRUE
FALSE

Default:
FALSE

Sources: Flash Production Data, Default

CONST_IP_ETH0_MAC (const.ip.eth0.mac)

MAC address of the device. The object is deprecated, use IToiNetIpDevice::GetMacAddress() instead.	Type: String
Sources: Flash Production Data

CONST_MEDIA_TIMESHIFTBUFFER_CONFIGSIZE (const.media.timeshiftbuffer.configsize)

The amount of disk space, in bytes, the time-shift buffer needs to allocate to be able to store maximum time-shifted contet at maximum configured bitrate.

Type:
String

Example:
Example for a 1hr and 10MBit/s buffer:
4718592000

Sources: OS

CONST_MEDIA_TIMESHIFTBUFFER_CONFIGTIME (const.media.timeshiftbuffer.configtime)

The time-shift buffer's configured capacity in seconds.

Type:
String

Example:
Example for a 1hr buffer:
3600

Sources: OS

CONST_NETFLIX_ESN (const.netflix.esn)

This object displays the Netflix Electronic Serial Number (ESN).	Type: String
Sources: KreaTV platform, Default

CONST_NETFLIX_MODEL (const.netflix.model)

This object displays the Netflix device model.	Type: String
Sources: KreaTV platform, Default

CONST_NETFLIX_PROVISIONINGSTATUS (const.netflix.provisioningstatus)

Indicates whether the IP-STB has successfully been in-field provisioned with Netflix keys. A reboot is needed for the provisioning process to complete. If the provisioning is not finished the portal can detect this and notify the user.

Type:
String

Value set:

pending
Netflix provisioning is pending. If provisioning has started, a reboot is necessary to finalize the procedure.
partial
Netflix provisioning has been partially done but is not finished. A reboot is necessary to finalize the procedure.
completed
Netflix in-field provisioning has been completed.

Example:
pending

Sources: KreaTV platform

CONST_NETFLIX_SW_VERSION (const.netflix.sw.version)

This object displays the Netflix SDK version.	Type: String
Sources: KreaTV platform, Default

CONST_POWER_APD_DEFAULT (const.power.apd.default)

The default timeout in seconds for automatic power down as specified by the current power management scheme.

Type:
Integer

Example:
14400

Sources: Build configuration

CONST_POWER_APD_MAX (const.power.apd.max)

The maximum allowed timeout in seconds for automatic power down as specified by the current power management scheme.

Type:
Integer

Example:
14400

Sources: Build configuration

CONST_POWER_LOWEST_PROFILE (const.power.lowest.profile)

The lowest allowed power profile.

Type:
String

Value set:

active
active_standby
passive_standby

Sources: Build configuration

CONST_SW_BRANCH (const.sw.branch)

The branch which the software was built from.

This is an object holding build information about the boot image. For similar objects, look for other const.sw.* objects. More items of information can be added by using the --info option with the build_boot_image script.

Type:
String

Sources: OS

CONST_SW_DATE (const.sw.date)

The date the software was built.

Type:
String

Sources: OS

CONST_SW_HOST (const.sw.host)

The host on which the software was built.

Type:
String

Sources: OS

CONST_SW_TIME (const.sw.time)

The time the software was built.

Type:
String

Sources: OS

CONST_SW_USER (const.sw.user)

The user name of the user that built the software.

Type:
String

Sources: OS

CONST_SW_VERSION (const.sw.version)

The software version.

Type:
String

Sources: OS

CONST_WIFI_WPS_ENABLED (const.wifi.wps.enabled)

Indicates whether Wireless Protected Setup (WPS) is enabled. The value is read from the production parameters.

Type:
String

Value set:

TRUE
FALSE

Default:
TRUE

Sources: Flash Production Data, Default

VAR_CAPABILITIES_DVR (var.capabilities.dvr)

Indicates whether DVR is supported or not. Both the software and the hardware needs to support it, otherwise the value is FALSE.

Type:
String

Value set:

TRUE
FALSE

Sources: KreaTV platform

VAR_CAPABILITIES_TIMESHIFT (var.capabilities.timeshift)

Indicates whether TIMESHIFT is supported or not. Both the software and the hardware needs to support it, otherwise the value is FALSE.

Type:
String

Value set:

TRUE
FALSE

Sources: KreaTV platform

VAR_GATEWAY_MANUFACTUREROUI (var.gateway.manufactureroui)

Manufacturer OUI of the gateway retrieved through DHCP.

Type:
String

Value set:
Six hexadecimal-digit value using all upper-case letters and including any leading zeros.

Sources: DHCP server

VAR_GATEWAY_PRODUCTCLASS (var.gateway.productclass)

Product class of the gateway retrieved through DHCP.	Type: String
Sources: DHCP server

VAR_GATEWAY_SERIALNUMBER (var.gateway.serialnumber)

Serial number of the gateway retrieved through DHCP.	Type: String
Sources: DHCP server

VAR_IO_STATE (var.io.state)

Indicates the general state of operation.

Type:
String

Value set:

normal
Applications are running. Audio and video enabled.
standby
Applications are running. Audio and video disabled. In new power management terminology this is active standby.
passive_standby
Applications and platform is suspended. In new power management terminology this is passive standby.

Sources: KreaTV platform

VAR_IP_DHCP_240 (var.ip._dhcp.240)

Contains the value of option-240, set in the DHCP server.	Type: String
Sources: DHCP server

VAR_IP_DHCP_241 (var.ip._dhcp.241)

Contains the value of option-241, set in the DHCP server.	Type: String
Sources: DHCP server

VAR_IP_DHCP_242 (var.ip._dhcp.242)

Contains the value of option-242, set in the DHCP server.	Type: String
Sources: DHCP server

VAR_IP_DHCP_243 (var.ip._dhcp.243)

Contains the value of option-243, set in the DHCP server.	Type: String
Sources: DHCP server

VAR_IP_ETH0_ADDR (var.ip.eth0.addr)

IP address retrieved through DHCP or static.

This object is deprecated, please use IToiNetIpDevice::GetInterfaceInfo() instead. The IP address change is notified via IToiNetObserver::OnDeviceInterfaceChanged().

Type:
String

Example:
192.168.10.10

Sources: OS

VAR_IP_METACHANNEL (var.ip.metachannel)

The IP address and port of the Infocast Meta data channel. A string on the format <IP address>:<port>.

Type:
String

Example:
224.2.2.2:22222

Sources: Flash User Configuration, Flash Production Data

VAR_MEDIA_TIMESHIFTBUFFER_AVAILABILITY (var.media.timeshiftbuffer.availability)

Indicates the availability of time-shift buffer. Recording is disabled while time-shift buffer or time-shift storage is not ready.

Note that this is now always set to TRUE and the time-shift buffer is available immediately.

The object is deprecated, please use object IToiInformationService::VAR_CAPABILITIES_TIMESHIFT instead.

Type:
String

Value set:

TRUE

Sources: Volatile, OS

VAR_NETFLIX_USER_REGISTERED (var.netflix.user.registered)

The value of this object indicates if the Netflix application has an active user account or not.

Type:
String

Value set:

TRUE
FALSE

Sources: Flash File System

VAR_RCU_LOWBATTERY (var.rcu.low_battery)

Indicates that the battery level in the Remote Control Unit is running low. Applications should subscribe to this object to receive a callback every time the RCU signals low battery level. They should not look at the object's value, since the value is always false.

Type:
String

Value set:

false

Sources: KreaTV platform

VAR_SW_UPDATE (var.sw.update)

Indicates that a new software version is available in the Infocast or HTTP Server. Applications should subscribe to this object to receive new software notification.

This object cannot be written by applications.

Type:
String

Value set:

TRUE
FALSE

Default:
FALSE

Sources: KreaTV platform

VAR_TIME_VALID (var.time.valid)

This is object is set to "TRUE" when the Time Service has set a valid time.

This object cannot be written by applications.

Type:
String

Value set:

TRUE
FALSE

Default:
FALSE

Sources: Time Service