• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

kreatv-option-timeman_bcm15

This package installs and enables Time Service.

Time Service is responsible for system time synchronization and configuration of time sources.

There are other configuration set by information objects with kreatv-option-is-default, which are:

  • cfg.ntp.servers. This must be set either through kreatv-option-is-default or TOI interface if ntp_server_sources includes "configurable".
  • cfg.ntp.minpoll
  • cfg.ntp.maxpoll
  • cfg.ntp.retry.interval
  • cfg.ntp.retry.attempts
  • cfg.locale.timezone

For more information on these, see platform objects.

Parameters

Name Repeat Description Type Default Example
enable_ntpdate Once

It takes effect only when time_sources includes "ntp".

Specifies whether ntpdate is running or not.

Value descriptions:

  • true
    ntpdate is queried periodically, and local system time is set accordingly.
  • false
    Usually, ntpdate will not be queried, but if ntpd_mode is set to client/server, ntpdate will be queried at boot and on recovery from passive standby.
Boolean false enable_ntpdate=true
ntp_retry_strategy Once

It takes effect only when time_sources includes "ntp" and enable_ntpdate=true.

It specifies ntpdate retry strategy when ntpdate fails.

Possible values are:

  • normal
    Time service will try first ntp server for several times which is specified by parameter cfg.ntp.retry.attempts then try next ntp server for same times until it gets valid time. If it can't get valid time at the last ntp server in server list, time service will restart trying immediately. The retry interval between each ntp server is specified by cfg.ntp.retry.interval.
  • exponential

    Firstly, time service will try each ntp server once in one loop. This loop will continues several times which is specified by parameter cfg.ntp.retry.attempts until the valid time is received. The interval between each loop is specified by parameter cfg.ntp.retry.interval and the interval between each ntp server defaults to 5 seconds.

    If the valid time is still not received, then an exponential interval will be adopted between each loop and the interval between each ntp server is unchanged. The exponential interval will be start and continues with two times of the previous interval. The max exponential interval defaults to 640 seconds. If the exponential interval reach the max value, it will keep in max value.

    For example: set parameter cfg.ntp.retry.interval to 5 and cfg.ntp.retry.attempts to 9. Given that there are two ntp servers: NTP1 and NTP2. After the box bootup, the scenario is: (NTP1-5s-NTP2)-5s .......+8 times.......5s-(NTP1-5s-NTP2)-10s-(NTP1-5s-NTP2)-20s-(NTP1-5s-NTP2)......640s- (NTP1-5s-NTP2)-640s-(NTP1-5s-NTP2)........

 Enum normal ntp_retry_strategy=exponential
ntp_server_sources Once

It takes effect only when time_sources includes "ntp".

Semicolon-delimited list of the NTP server address sources, specified in descending priority order.

The possible values are:

  • configurable: application can specify NTP servers by set cfg.ntp.servers.
  • dhcp: NTP servers can be specified through DHCP option ntp-servers.
  • tr069: NTP servers can be specified through TR069 through configuring the predefined parameters such as Device.Time.NTPServer1, Device.Time.NTPServer2.
  • server_discovery: NTP servers can be specified through some discovery protocols such as UPnP or mDNS.
 String ntp_server_sources=configurable;tr069;dhcp
ntpd_config Once

It takes effect only when time_sources includes "ntp".

Specifies the standard configuration file for ntpd, which follows information here..

Note: Using this parameter gives customer more power to control ntpd. If it is set, ntpd is expected to run. Hence ntpd_mode must NOT be set to "disable". Furthermore, it may cause time service work improperly with conflicting configuration with ntpd_mode.

 File path ntpd_config=/extra/files/ntp.conf
ntpd_mode Once

It takes effect only when time_sources includes "ntp".

Specifies in which mode ntpd is running.

The first sync time of STB will always be got by other ways, such as ntpdate.

When time_sources includes "ntp", you have to pay attention to the following:

  • It is not allowed to set enable_ntpdate=true and ntpd_mode=client at the same time, which causes the system time to be adjusted by two subjects.
  • It is not allowed to set enable_ntpdate=false and ntpd_mode=disable at the same time (or leave out these two parameters which has the same meaning).
  • If STBs work as ntp client, set either enable_ntpdate=true or ntpd_mode=client. Also ntp_server_sources must be set.
  • If STBs work as ntp server, set ntpd_mode=server.

Possible values are:

  • disable
    ntpd is disabled.
  • server
    ntpd is running as server, which will not set local system time.
  • client
    ntpd is running as client, which will set local system time.
Enum client ntpd_mode=server
time_sources Once

Semicolon-delimited list of the time synchronization sources, specified in descending priority order.

The time source can be:

  • dvb: Time is synced from DVB's SI TOT/TDT.
  • timecast: Time is synced from timecast, which is a private way of distributing time through a multicast channel. It is based on the infocast server which sets up a special channel where STBs can listen for time messages.
  • ntp: Time is synced with configured NTP servers through ntpdate or ntpd. The default is ntpdate disabled and ntpd working as client. See enable_ntpdate and ntpd_mode for more information.
  • sntp: Time is synced with DHCP-specified NTP servers through sntp.

Time service will keep trying to get time from each time source, then set time according to priority and active/inactive state. If the time service can't receive time from a time source successfully within a certain time frame, the time source will become inactive. The time service will use the time from the lower priority time source to set STB's time only after all time sources with higher priority become inactive.

Especially, when STB is started up, to get a valid time as quick as possible, the time from the fastest responding time source is used.

Different time sources have different timeouts:

  • dvb: 5 minutes longer than time_sync_interval. Refer to time_sync_interval for more information.
  • timecast: Hardcoded 1 hour.
  • ntp's ntpdate: Random value within synchronization interval plus 5 minutes.

Limitation: Sntp and ntp's ntpd don't need active timeout as they never go inactive. Also priority order doesn't take effect for them.

 String timecast time_sources=ntp;timecast
time_sync_interval Once

Interval of time synchronization, unit in seconds, which only takes effect for dvb time source.

Note: Time sync interval for ntp is determined by cfg.ntp.minpoll and cfg.ntp.maxpoll. For ntpd, the sync interval is controlled by ntpd daemon itself; for ntpdate, time service will choose a random value between 2^cfg.ntp.minpoll and 2^cfg.ntp.maxpoll as sync interval each time after successful synchronization.

Valid range is {1, ...}.

 Integer 3600 time_sync_interval=300
timeman_start Once Put/remove timemanager into processlist.xml and start/not-start timeman process.

NOTE: This parameter is deprecated. This parameter does not take effect. Timeman always runs as platform service.

 String timeman_start=no

Details

Version5.1.1.p8
Content version-
Branchkreatv.5.1.1.p8
Date20180221
Time145211
Architecturebcm15
Rootdisk dependencieskreatv-platform, kreatv-option-timezone
Finalize dependencies-
Installation scriptsbuildtime, kit
Dependency onlyno
Explicitno
Allow any parametersno

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.