linux_stat 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3270fb4ddf3dd436a63233d134f5fecd2ff13d7aa0d4f91b444ac65ed29b84
-  data.tar.gz: 8f4987b804b866eb6b0bea4a9de1a507e6529ca6188d54b0def59a7dbf74c73f
+  metadata.gz: 58652553450c8570d4e9d1137256e8b27155bf7f61f2bd89f423f3eb3e6fd907
+  data.tar.gz: d90289e14f856823d2370d7a0629769d874d8f630043c1cce0fd3c357ca12f1b
 SHA512:
-  metadata.gz: fd9393533d03fbfe16599d972762aaa6d84aa737de9ceccd7a4b333a3e049742e2a088f29364203dfd5e65199c95ccc790a68d31e8c8cf6c5f6fd718dc655818
-  data.tar.gz: b4fbe848f72fe1d51ed8c3d8bba37aba8a1da937c4f1639503dedbb894fc8eebe6516c7c8957e88569b73362d03dfd4a60787af1c4c585fe40b73725e2f5dabe
+  metadata.gz: 4ee5142e8a10b2f4171aac6901b9cb98d9ca9ef74738e39f7b4dfca15381ee6c4a40c0815bb957476250958d207d21e8759266c3c7229af510b189d4ec7d758f
+  data.tar.gz: 454c9d051de0a49156e421a1c866e4b690fd6d98bdcb714acabb18d6b5e13c1ae29b1bb1035b75962e1e47f9a7094b6a5bde46742e54212aac427103f56308d4

data/README.md

@@ -854,6 +854,30 @@ LinuxStat::Sysconf.tty_name_max()
 
 ```
 
+### LinuxStat::Thermal
+```
+# File:		thermal.rb | Line: 57
+# Definition:	def count_fans
+LinuxStat::Thermal.count_fans()
+=> 1
+
+# File:		thermal.rb | Line: 49
+# Definition:	def count_sensors
+LinuxStat::Thermal.count_sensors()
+=> 8
+
+# File:		thermal.rb | Line: 41
+# Definition:	def fans
+LinuxStat::Thermal.fans()
+=> [{:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"Processor Fan", :rpm=>0}]
+
+# File:		thermal.rb | Line: 23
+# Definition:	def temperatures
+LinuxStat::Thermal.temperatures()
+=> [{:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"SODIMM", :temperature=>36.0}, {:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"CPU", :temperature=>46.0}, {:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"Ambi...
+
+```
+
 ### LinuxStat::USB
 ```
 # File:		usb.rb | Line: 135

data/lib/linux_stat.rb

@@ -28,6 +28,7 @@ require "linux_stat/net"
 require "linux_stat/pci"
 require "linux_stat/process"
 require "linux_stat/swap"
+require "linux_stat/thermal"
 require "linux_stat/usb"
 
 # Dependent Modules

data/lib/linux_stat/battery.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various battery related information of the current system.
+
 	module Battery
 		PATH = "/sys/class/power_supply/BAT0".freeze
 

data/lib/linux_stat/bios.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various BIOS related information of the current system.
+
 	module BIOS
 		class << self
 			##

data/lib/linux_stat/cpu.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various CPU related information of the current system.
+
 	module CPU
 		class << self
 			##

data/lib/linux_stat/filesystem.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Filesystem related information of the current system.
+
 	module Filesystem
 		class << self
 			##

data/lib/linux_stat/kernel.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Kernel related information of the current system.
+
 	module Kernel
 		class << self
 			##

data/lib/linux_stat/memory.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Memory related information of the current system.
+
 	module Memory
 		class << self
 			##

data/lib/linux_stat/mounts.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Mounted device related information of the current system.
+
 	module Mounts
 		class << self
 			##

data/lib/linux_stat/net.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Net related information of the current system.
+
 	module Net
 		class << self
 			DEV = '/proc/net/dev'.freeze

data/lib/linux_stat/os.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various OS related information of the current system.
+
 	module OS
 		class << self
 			##

data/lib/linux_stat/pci.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various PCI device related information of the current system.
+
 	module PCI
 		class << self
 			##

data/lib/linux_stat/prettify_bytes.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Helps you convert bytes to a unit like:
+	#
+	# 1. kilobyte, megabyte, gigabyte, terabyte, petabyte, exabyte, zettabyte, yottabyte
+	# 2. kibibyte, mebibyte, gibibyte, tebibyte, pebibyte, exbibyte, zebibyte, yobibyte
+	# 3. kB, MB, GB, TB, PB, EB, ZB, YB
+	# 4. kiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB
+
 	module PrettifyBytes
 		class << self
 			##

data/lib/linux_stat/process.rb

@@ -1,4 +1,7 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+
 	module Process
 		class << self
 			##

data/lib/linux_stat/process_info.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+	# Most methods can take a PID, but some uses polling to calculate
+	# something, they can accept options instead of arguments.
+	# Consult the documentation on the specific methods
+	# for more details on that.
+
 	module ProcessInfo
 		class << self
 			##

data/lib/linux_stat/swap.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Swap devices related information of the current system.
+
 	module Swap
 		class << self
 			##

data/lib/linux_stat/thermal.rb

@@ -0,0 +1,122 @@
+module LinuxStat
+	# Sensors are available to /sys/class/hwmon
+	# This module just reads the files inside them to get the sensor information.
+	#
+	# https://www.kernel.org/doc/Documentation/thermal/sysfs-api.txt
+
+	module Thermal
+		class << self
+			##
+			# Get temperatures from all sensors.
+			#
+			# The return value is an Array of Hashes.
+			#
+			# It opens various files from /sys/, and it should be
+			# considered very slow.
+			#
+			# Each hash may contain information including:
+			#
+			# path, name, label
+			# temperature, temp_crit, temp_max
+			#
+			# But if the info isn't available, it will return an empty Array.
+			def temperatures
+				query_hwmon('temp'.freeze, :temperature, true)
+			end
+
+			##
+			# Get RPM from all fans.
+			#
+			# The return value is an Array of Hashes.
+			#
+			# It opens various files from /sys/, and it should be
+			# considered very slow.
+			#
+			# Each hash may contain information including:
+			#
+			# path, name, label
+			# rpm, temp_crit, temp_max
+			#
+			# But if the info isn't available, it will return an empty Array.
+			def fans
+				query_hwmon('fan'.freeze, :rpm)
+			end
+
+			##
+			# Counts the number of sensors (fans are not counted)
+			#
+			# The return type is an Integer.
+			def count_sensors
+				return 0 unless hwmon_readable?
+
+				Dir["/sys/class/hwmon/hwmon[0-9]*/temp[0-9]*_input".freeze].size
+			end
+
+			##
+			# Counts the number of fans (sensors are not counted)
+			#
+			# The return type is an Integer.
+			def count_fans
+				return 0 unless hwmon_readable?
+
+				Dir["/sys/class/hwmon/hwmon[0-9]*/fan[0-9]*_input".freeze].size
+			end
+
+			private
+			def hwmon_readable?
+				@@hwmon_readable ||= File.readable?("/sys/class/hwmon/")
+			end
+
+			def query_hwmon(mon, key, div = false)
+				return [] unless hwmon_readable?
+
+				name = dir = ''.freeze
+
+				files = Dir["/sys/class/hwmon/hwmon[0-9]*/#{mon}[0-9]*_input".freeze]
+				i = -1
+				ret = []
+
+				while x = files[i += 1]
+					splitted = File.split(x)
+					path = File.join(splitted[0..-2])
+
+					n = splitted[-1][/.*_/]
+
+					label_f = "#{path}/#{n}label"
+					label = File.readable?(label_f) ? IO.read(label_f, encoding: 'ASCII-8BIT'.freeze).strip : nil
+
+					temp_crit_f = "#{path}/#{n}crit"
+					temp_crit = File.readable?(temp_crit_f) ? IO.read(temp_crit_f, encoding: 'ASCII-8BIT'.freeze).to_i : nil
+
+					temp_max_f = "#{path}/#{n}max"
+					temp_max = File.readable?(temp_max_f) ? IO.read(temp_max_f, encoding: 'ASCII-8BIT'.freeze).to_i : nil
+
+					value = File.readable?(x) ? IO.read(x).to_i : nil
+
+					if dir != path
+						dir = path
+						name_f = "#{path}/name"
+						name = File.readable?(name_f) ? IO.read(name_f, encoding: 'ASCII-8BIT'.freeze).tap(&:strip!) : ''.freeze
+					end
+
+					if div
+						value /= 1000.0
+						temp_max /= 1000.0 if temp_max
+						temp_crit /= 1000.0 if temp_crit
+					end
+
+					h = {path: path, name: name}
+
+					h.merge!(label: label) if label
+					h.merge!(key => value)
+					h.merge!(temp_crit: temp_crit) if temp_crit
+					h.merge!(temp_crit: temp_max) if temp_max
+
+					ret.push(h)
+				end
+
+				ret
+			end
+		end
+	end
+end

data/lib/linux_stat/usb.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various USB device related information of the current system.
+
 	module USB
 		class << self
 			##

data/lib/linux_stat/user.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various User related information of the current system.
+
 	module User
 		class << self
 			##

data/lib/linux_stat/version.rb

@@ -1,3 +1,3 @@
 module LinuxStat
-	VERSION ||= "1.2.3"
+	VERSION ||= "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linux_stat
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: Linux only, efficient linux system utilization reporting and system monitoring
   gem
@@ -52,6 +52,7 @@ files:
 - lib/linux_stat/process.rb
 - lib/linux_stat/process_info.rb
 - lib/linux_stat/swap.rb
+- lib/linux_stat/thermal.rb
 - lib/linux_stat/usb.rb
 - lib/linux_stat/user.rb
 - lib/linux_stat/version.rb