6.1-roDeviceInformation

Owned by Anonymous
Sept 28, 2021
3 min read

ON THIS PAGE


This object provides information about the device hardware, firmware, and features.

ifDeviceInfo

GetModel() As String

Returns the model name for the BrightSign device running the script as a string (for example, "HD1020" or "XD230").

GetVersion() As String

Returns the version number of BrightSign firmware running on the device (for example, "4.0.13").

GetVersionNumber() As Integer

Returns the version number of the BrightSign firmware running on the device in comparable numeric form: major*65536 + minor*256 + build

GetBootVersion() As String

Returns the version number of the BrightSign boot firmware, also known as "safe mode", as a string (for example, "1.0.4").

GetBootVersionNumber() As Integer

Returns the version number of the BrightSign boot firmware, also known as "safe mode," in comparable numeric form: major*65536 + minor*256 + build

FirmwareIsAtLeast(version As String) As Boolean

Returns True if the BrightSign firmware version on the device is less than or equal to the version number represented by the passed string (e.g. "6.0.1").

BootFirmwareIsAtLeast(version As String) As Boolean

Returns True if the BrightSign boot firmware version on the device is less than or equal to the version number represented by the passed string (e.g. "4.4.22").

GetDeviceUptime() As Integer

Returns the number of seconds that the device has been running since the last power cycle or reboot.

GetLoadStatistics(parameters As roAssociativeArray) As String

Provides current performance information related to the Linux kernel. This method accepts an associative array with a single key/value pair formatted as {item: <parameter>}; it will then return a string containing information associated with that parameter. The following are recognized parameters:

  • "loadavg": Provides information about system performance. The first three columns measure CPU and I/O utilization over the past 1, 5, and 10 minutes, respectively. The fourth column displays the number of currently running processes and the total number of processes. The last column displays the ID of the most recently used process.
  • "meminfo": Displays physical and swap memory usage.
  • "slabinfo": Provides information about memory usage at the slab level.
  • "stat": Provides overall statistics about the system (e.g. the number of page faults since the system booted).
  • "vmstat": Displays detailed virtual memory statistics from the kernel.
  • "zoneinfo": Provides overall statistics about the system, broken down by system Node.
  • "interrupts": Displays which interrupts are in use and how many of each type there have been.
  • "version": Provides the kernel version.
GetDeviceUniqueId() As String

Returns an identifier that, if not an empty string, is unique to the unit running the script.

GetFamily() As String

Returns a single string that indicates the family to which the device belongs. A device family is a set of models that are all capable of running the same firmware.

GetDeviceLifetime() As Integer
 
HasFeature(feature As String) As Boolean

Returns True if the player feature, which is passed as a case-insensitive string parameter, is present on the current device and firmware. The possible features that can be queried from the script are listed below:

Important

 If you pass a parameter other than one of those listed below, it may return False even if the feature is available on the hardware and firmware.

  • "brightscript1": BrightScript Version 1
  • "brightscript2": BrightScript Version 2
  • "networking": Any form of networking capability; there may be no network currently available.
  • "hdmi"
  • "component video"
  • "vga"
  • "audio1": The first audio output
  • "audio2": A second audio output
  • "audio3": A third audio output
  • "ethernet"
  • "usb"
  • "serial port 0": The first RS-232 serial port
  • "serial port 1": A second RS-232 serial port
  • "serial port 2": A third RS-232 serial port
  • "5v serial"
  • "gpio connector"
  • "gpio12 button"
  • "reset button"
  • "rtc"
  • "registry"
  • "nand storage"
  • "sd": SD or SDHC
  • "sdhc": SDHC only

 

Example
di = CreateObject("roDeviceInfo")
print di.GetModel()
print di.GetVersion(), di.GetVersionNumber()
print di.GetBootVersion(), di.GetBootVersionNumber()
print di.GetDeviceUptime(), di.GetDeviceBootCount()

On a particular system, this will generate the following:

HD1010
3.2.41           197161
3.2.28           197148
 14353            3129