System configuration items and variables

System configuration items and variables are provided by the Information Service. Each configuration item or variable is represented by a specific information object and all objects managed by the Information Service are organized in the common Information Service storage structure. The information objects representing system information are no exceptions to this rule.

IP-STB System information
Object Name Object Comment Values Sources
CFG_IP_DNS1 cfg.ip.dns1 Primary DNS server address to use for static IP. Type:
String

Example:
192.168.0.2

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CFG_IP_DNS2 cfg.ip.dns2 Secondary DNS server address to use for static IP. Type:
String

Example:
192.168.0.3

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CFG_IP_ETH0_MODE cfg.ip.eth0.mode
(deprecated alias: config.ipsetting)
The IP address retrieval method; Static IP or DHCP. Type:
String

Value set:
DHCP | Static

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CFG_IP_ETH0_ADDR cfg.ip.eth0.addr IP address to use for static IP. Type:
String

Example:
192.168.10.10

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CFG_IP_ETH0_MASK cfg.ip.eth0.mask Netmask to use for static IP. Type:
String

Example:
255.255.255.0

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CFG_IP_GATEWAY cfg.ip.gateway Default gateway to use for static IP. Type:
String

Example:
192.168.0.1

  1. Volatile
  2. Flash File System
  3. Flash User Configuration
  4. Flash Production Data
CONST_FW_VERSION const._fw.version IP-STB firmware version Type:
String

Example:
1.21

  1. Flash Production Data
CONST_CAPABILITIES_MACROVISION const.capabilities.macrovision Indicates if macrovision copy protection is supported by the hardware. TRUE = macrovision is supported, FALSE macrovision is not supported. Type:
String

Value set:
TRUE | FALSE

  1. Flash Production Data
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. It is variable rather than a constant for use cases with external drives that are plugged in at run-time. Type:
String

Value set:
TRUE | FALSE

  1. Flash Production Data
CONST_IP_ETH0_MAC const.ip.eth0.mac   Type:
String
  1. Flash Production Data
CONST_HW_MANUFACTURER const.hw.manufacturer Manufacturer of the IP-STB. Type:
String

Example:
Motorola

  1. Flash Production Data
CONST_HW_PRODUCTNAME const.hw.productname Model name of the IP-STB. Type:
String

Example:
VIP2262

Example:
VIP1903-C

  1. Flash Production Data
CONST_HW_SERIALNUMBER const.hw.serialnumber IP-STB serial number. Type:
String
  1. 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 for a 1hr and 10MBit/s buffer:
4718592000

  1. OS
CONST_MEDIA_TIMESHIFTBUFFER
_CONFIGTIME
const.media.timeshiftbuffer
.configtime
The time-shift buffer's configured capacity in seconds. Type:
String

Example for a 1hr buffer:
3600

  1. OS
CONST_SW_BRANCH

CONST_SW_DATE

CONST_SW_HOST

CONST_SW_TIME

CONST_SW_USER

CONST_SW_VERSION
const.sw.* A number of items giving build information about the boot image. At least the following items is available:
  • const.sw.branch
  • const.sw.date
  • const.sw.host
  • const.sw.time
  • const.sw.user
  • const.sw.version

More items can be added when building boot images using the --info option to build_boot_image.

Type:
String

  1. OS
CFG_ARCHITECTURE_TARGET

CFG_ARCHITECTURE
_BOOTIMAGECOMPATIBILITY

CFG_ARCHITECTURE_DBLCOMPATIBILITY
config.architecture.* A number of items describing the hardware architecture and the kind of operating system running of the IP-STB.

The following three items are defined:

  • config.architecture.target
  • config.architecture.bootimagecompatibility
  • config.architecture.dblcompatibility

Here are examples of values for the config.architecture.* items (target / bootimage / dbl):

  • vip1500 / 6 / 6

More combinations can be found in the compatibility section

Type:
String

  1. OS
VAR_IP_DNS1 var.ip.dns1 Primary DNS server address retrieved through DHCP. Type:
String

Example:
192.168.0.2

  1. OS
VAR_IP_DNS2 var.ip.dns2 Secondary DNS server address retrieved through DHCP Type:
String

Example:
192.168.0.3

  1. OS
VAR_IP_ETH0_ADDR var.ip.eth0.addr IP address retrieved through DHCP. Type:
String

Example:
192.168.10.10

  1. OS
VAR_IP_ETH0_MASK var.ip.eth0.mask Netmask retrieved through DHCP. Type:
String

Example:
255.255.255.0

  1. OS
VAR_IP_ETH0_STATUS var.ip.eth0.status Indicates if the network is ready Type:
String

Example:
Valid

  1. OS
VAR_IP_GATEWAY var.ip.gateway Default gateway retrieved through DHCP. Type:
String

Example:
192.168.0.1

  1. 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

  1. Flash User Configuration
  2. Flash Production Data
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. false
  1. KreaTV platform
VAR_IO_STATE var.io.state Indicates the general state of operation.
  • normal: Applications are running. Video enabled.
  • suspended: Applications are still running. Video disabled. This is an intermediate state before going to standby.
  • standby: Applications are stopped. Video disabled.
Type:
String

Value set:
normal | suspended | standby

  1. KreaTV platform
VAR_MEDIA_TIMESHIFTBUFFER
_SPACEREQUIRED
var.media.timeshiftbuffer
.spacerequired
Indicates the amount of disk space, in bytes, the time-shift buffer lacks to reach full capacity. This values should normally be "0". When this value is greater than "0", the storage disk partition is getting full and time-shift buffer can't allocate needed disk space to reach configured values. This can happen when migrating from a fully populated storage device containing legacy (ie KreaTV 3.8 and older) DVR and time-shift files. The ratio between this figure and const.media.timeshiftbuffer.configsize can be used by the application to get a value of the reduced time-shift capacity. Type:
String
  1. OS
VAR_MEDIA_TIMESHIFTBUFFER
_AVAILABILITY
var.media.timeshiftbuffer
.availability
Deprecated

Indicates the availability of time-shift buffer. Recording is disabled if time-shift buffer is not ready.

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

Type:
String

Value set:
TRUE

  1. Volatile

  2. OS