OSHI - Operating System + Hardware

This module allows you to interact with hardware and the operating system.

Welcome to BoxLang OSHI

This module is based on the great work of the . You can use this module to get information about the operating system and hardware of your machine. This is a great way to get sensor or embedded system information like batteries, Raspberry Pi, etc.

OSHI is a free JNA-based (native) Operating System and Hardware Information library for Java. It does not require the installation of any additional native libraries and aims to provide a cross-platform implementation to retrieve system information, such as OS version, processes, memory and CPU usage, disks and partitions, devices, sensors, etc.

# For Operating Systems using our Quick Installer.
install-bx-module bx-oshi

# Using CommandBox to install for web servers.
box install bx-oshi

Supported Features

Computer System and firmware, baseboard
Operating System and Version/Build
Physical (core) and Logical (hyperthreaded) CPUs, processor groups, NUMA nodes
System and per-processor load, usage tick counters, interrupts, uptime
Process uptime, CPU, memory usage, user/group, command line args, thread details
Physical and virtual memory used/available
Mounted filesystems (type, usable and total space, options, reads and writes)
Disk drives (model, serial, size, reads and writes) and partitions
Network interfaces (IPs, bandwidth in/out), network parameters, TCP/UDP statistics
Battery state (% capacity, time remaining, power usage stats)
USB Devices
Connected displays (with EDID info), graphics and audio cards
Sensors (temperature, fan speeds, voltage) on some hardware

Contributed Functions

Here are the contributed functions in this module:

getSystemInfo() : Get the main entry point for the OSHI system: https://www.oshi.ooo/oshi-core-java11/apidocs/com.github.oshi/oshi/SystemInfo.html
getOperatingSystem() : Get the Operating System information: https://www.oshi.ooo/oshi-core-java11/apidocs/com.github.oshi/oshi/software/os/OperatingSystem.html
getHardware() : Get the Hardware information: https://www.oshi.ooo/oshi-core-java11/apidocs/com.github.oshi/oshi/hardware/HardwareAbstractionLayer.html

The following are also contributed functions provided by convenience:

getCpuUsage( [interval] ) : Gets the CPU usage of the system with a custom interval
getFreeSpace( path ) : Gets the free space of a drive
getTotalSpace( path ) : Gets the total space of a drive
getSystemFreeMemory() : Gets the free memory of the operating system
getSystemTotalMemory() : Gets the total memory of the operating system
getJVMFreeMemory() : Gets the free memory of the JVM
getJVMTotalMemory() : Gets the total memory of the JVM

Ini Files Support

This module also provides a way to read and write initialization files.

[General]
appName=MyApplication
version=1.2.3
author=John Doe
boxlang=rocks

[Database]
host=localhost
port=5432
username=dbuser
password=dbpass
dbname=mydatabase

[Logging]
logLevel=DEBUG
logFile=/var/log/myapp.log
maxFileSize=10MB

[Features]
enableFeatureX=true
enableFeatureY=false
maxConnections=100

You can use the following functions to read and write ini files:

getIniFile( file ) : Reads an ini file and returns the IniFile object. If the file does not exist, it will create it.
getProfileSection( iniFile, section ) : Gets a section from the ini file as a struct
getProfileSections( iniFile ) : Gets all the sections from the ini file as a struct of structs
getProfileString( iniFile, section, entry ) : Gets an entry from a section in the ini file, if it does not exist, it will return an empty string
setProfileString( iniFile, section, entry, value ) : Sets an entry in a section in the ini file, if the section does not exist, it will create it
removeProfileSection( iniFile, section ) : Removes a section from the ini file
removeProfileString( iniFile, section, entry ) : Removes an entry from a section in the ini file

The IniFile object is a fluent object that allows you to work with ini files in a very easy way. Here is an example of how to use it:


// Get the ini file
var iniFile = getIniFile( "test.ini" );
iniFile.createSection( "mySettings" );
// Set a string
iniFile.setEntry( "section1", "entry1", "value1" );
// Get a string
var value = iniFile.getEntry( "section1", "entry1" );
// Remove a string
iniFile.removeEntry( "section1", "entry1" );
// Remove a section
iniFile.removeSection( "section1" );

PreviousFTP NextImage Manipulation

Last updated 28 days ago

Was this helpful?

[General] appName=MyApplication version=1.2.3 author=John Doe boxlang=rocks [Database] host=localhost port=5432 username=dbuser password=dbpass dbname=mydatabase [Logging] logLevel=DEBUG logFile=/var/log/myapp.log maxFileSize=10MB [Features] enableFeatureX=true enableFeatureY=false maxConnections=100

// Get the ini file var iniFile = getIniFile( "test.ini" ); iniFile.createSection( "mySettings" ); // Set a string iniFile.setEntry( "section1", "entry1", "value1" ); // Get a string var value = iniFile.getEntry( "section1", "entry1" ); // Remove a string iniFile.removeEntry( "section1", "entry1" ); // Remove a section iniFile.removeSection( "section1" );