Change to light theme (or icon here)

Sysinfo

SysInfo Extension

Contents

Outgoing channel : "SYSINFO_CHANNEL"

Description

The sysinfo extension is designed to provide system information for other extensions to use. For some values to be read you may need to run streamroller in admin or sudo mode. For example on windows a lot of the data cannot be read by a user (only an admin). This protects things like uuid's from being read but there are also some other things like temperatures that might not show up unless run as admin. On windows you can do this by selecting the StreamRoller icon on the desktop and right clicking to set it to run as administrator. Alternativly you can start a command prompt as administrator (right click and select run as administrator) and then run StreamRoller from that prompt

Triggers/Actions

Triggers and actions below are updated when the automatic document generation system is run and only contain triggers actions relating to this specific extension.

Table last updated: Wed, 12 Mar 2025 05:38:02 GMT

Triggers

name trigger description
sysInfoCPUData trigger_sysinfoCPUData Data about the CPU
sysInfoCPUTemperatures trigger_sysinfoCPUTemperatures CPU Temperatures if available (you may need to run StreamRoller as admin to allow windows to read this)
sysInfoGPUData trigger_sysInfoGPUData GPU Data

Actions

name trigger description
sysInfoGetCPUData action_sysInfoGetCPUData Sends out a trigger with the CPU Data
sysInfoGetCPUTemperatures action_sysInfoGetCPUTemperatures Sends out a trigger with the CPU Temperatures
sysInfoGetGPUData action_sysInfoGetGPUData Sends out a trigger with the GPU Data

"Sysinfo" Extension Details...

Provides information about the system(computer) that the extension is running on
Source:

Methods

SaveConfigToServer()

Sends our config to the server to be saved for next time we run
Source:

SendSettingsWidgetSmall(toextension)

sends some modal code to be displayed on the admin page or somewhere else this is done as part of the webpage request for modal message we get from extension. It is a way of getting some user feedback via submitted forms from a page that supports the modal system
Parameters:
Name Type Description
toextension String
Source:

UpdateMonitoring()

Sends our config to the server to be saved for next time we run
Source:

findTriggerByMessageType(messagetype)

Finds a trigger by name
Parameters:
Name Type Description
messagetype string
Source:
Returns:
trigger

flatten(data)

Flattens an array to move nested objects to the top level
Parameters:
Name Type Description
data array
Source:
Returns:
1D array

flattenObject(data)

Flattens an object to move nested objects to the top level
Parameters:
Name Type Description
data object
Source:
Returns:
1D object

getCPUData(referenceopt)

Requests CPU data and sends out a trigger message to the system
Parameters:
Name Type Attributes Default Description
reference string <optional>
 "poll"
Source:

getCPUTemperature(referenceopt)

Requests CPU Temperature data and sends out a trigger message to the system
Parameters:
Name Type Attributes Default Description
reference string <optional>
 "poll"
Source:

getCPUTemperatureScheduler()

start the poll timer for the CPU temperature
Source:

getGPUData(referenceopt)

Requests GPU data and sends out a trigger message to the system
Parameters:
Name Type Attributes Default Description
reference string <optional>
 "poll"
Source:

getGPUDataScheduler()

start the poll timer for the GPU Data
Source:

initialise(app, host, port, heartbeat)

Starts the extension using the given data.
Parameters:
Name Type Description
app object:Express
host string
port number
heartbeat number
Source:

onDataCenterConnect(socket)

Connection message handler
Parameters:
Name Type Description
socket *
Source:

onDataCenterDisconnect(reason)

Disconnection message sent from the server
Parameters:
Name Type Description
reason String
Source:

onDataCenterMessage(server_packet)

receives message from the socket
Parameters:
Name Type Description
server_packet data
Source:

sendTrigger(trigger_name, trigger_data)

Requests CPU Temperature data and sends out a trigger message to the system
Parameters:
Name Type Description
trigger_name string
trigger_data object
Source:

sendTriggersAndActions(extension)

Sends the triggers and actions to the extension or broadcast if extension name is ""
Parameters:
Name Type Description
extension string
Source:

updateTrigger(trigger, ob)

Updates the trigger parameter fields to what we get from the system (as these will be different on each PC)
Parameters:
Name Type Description
trigger string
ob data
Source: