lmsensors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e1c703203fcebc6433c02baeb8e27d25cdc94acd25937c1a22291fec0b7031
+  data.tar.gz: 8cb6984cff4359a059566c16f4c7674cf170a9a4564ccc848922da6825b64692
+SHA512:
+  metadata.gz: c90e178a106a429a89f887c960568424af6860a834b441dc3292ca5225fa775a42d25d78a8cf7c5f9b4bbe18fe02af35843bfaa636d4326a22631660bd77eb84
+  data.tar.gz: 63a5335b4c7c4814162591921771935b6c17f4bdb5dbb699375f693cff88a622734b5f71084380432d0c95db1fd563878b3513fa56c921e7d8582638295c2b14

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### CHANGELOG -- (Ruby LmSensors) ###
+1) 0.1.0, unreleased: 2021-May-26 -- Several major changes to the API access functionality. Massive levels of abstraction, per use cases noted from the Ruby programming server. [t. Edelweiss]

data/FMAPPER.md

@@ -0,0 +1,20 @@
+### FMAPPER INFORMATION ###
+
+For the default implementation, you should view ``lib/lmsensors/lm_constants.rb``.
+
+I have included a default feature mapper for most common sensor types, largely to mimic what is included in the ``sensors`` CLI program's formatter. If it is insufficient, however, then you can feel free to use your own.
+
+Unless heavily overriding the classes, the mapper should have an arity of 2 (name of the object, object data). I will not go into details about how to create complex format maps or heavily override the classes. However, the ``AbsFeature`` and all subclasses take the name of the feature (a symbol, such as ``:temp1``) and the feature's data, which includes all of its subfeatures.
+
+The default mapper, however, simply generates a ``Feature::GenFeature.new(name, f_obj)`` for a case statement, based on the feature's type (``SF_FAN``, ``SF_TEMP``, ``SF_VOLTAGE``, etc.). If you create an alternative, it should do similar.
+```ruby
+case f_obj[:type]
+when []
+  ...
+when []
+  ...
+else
+  ...
+end
+```
+For all intents and purposes, your own format-mapper can have a single clause, if you don't care about anything else. All of the ``AbsFeature`` subclasses were purely for convenience, and they should provide for the vast majority of use cases.

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,156 @@
+### OVERVIEW ###
+LmSensors is a C-Ruby API wrapper for ``lmsensors`` (which runs the ``sensors`` and ``sensors-detect`` commands) on Linux systems. This will allow users to access temperature, fan, and bus data for various system hardware devices.
+
+### USAGE ###
+```ruby
+# Global value only relevant to overriding format-mapping
+# functions. This is 'false', by default, but when set to
+# 'true', it disables a warning about the arity passed to
+# the format-mapping method of the abstract GenSensor, as
+# this class cannot guarantee knowing subclasses.
+$LmSensorsIgnArity
+
+LmSensors.init # Initialize the Sensors system data
+LmSensors.cleanup # Cleanup the Sensors data, when done
+
+# Create a new sensor spawner/bag
+# ``.enum`` and ``.stat`` default to ALL sensors, unless
+# a name is set with ``.set_name``
+s = LmSensors::SensorSpawner.new
+# LmSensors::Sensors is now just an alias of SensorSpawner.
+# I left this for compatibility purposes.
+
+# Count the number of sensors detected by the spawner,
+# with the current settings. Also works with a concrete
+# Sensor object, but will return the number of features.
+s.count # or s.count_s
+
+# Locate a specific Sensor on a SensorSpawner. This is
+# a shorthand way to assign a specific sensor, quickly, if you
+# already know the path, such as what might have been returned
+# from another gem or script.
+s.locate :path # Where path is something like '/sys/class/hwmon/hwmon3'
+
+# Assign a list of all the selected sensors available
+# ``.enum`` will return a list of LmSensors::AbsSensor objects
+# or their subclasses.
+items = s.enum
+
+# Sets the fmap of the sensor. If this is set on a SensorSpawner,
+# it will automatically use the same format map for any sensors it
+# creates. If it is set on a single Sensor, it will only affect that
+# one. This method can be used to pass in a custom Proc/Lambda
+# object for the sensor in question to use as its feature-formatting
+# selector. By default, the format will be 'LmSensors::DEF_FMAP'.
+# 
+# For more details on this, please view 'FMAPPER.md'
+s.set_fmap :your_proc
+
+s.reset_fmap # Reset it back to the default
+
+# Where :idx is an int in range, assign new
+# Sensor object to sobj.
+sobj = items[:idx]
+sobj.name # Name of Sensor
+sobj.adapater # Adapter of Sensor
+sobj.path # Path of Sensor
+sobj.info # Return the name, adapter, and path of a Sensor
+sobj.read # Raw data from the :stat part of the Sensor
+sobj.stat # Stat the selected sensor, returning features
+sobj.features # Alias for :stat
+sobj.count # Count the number of features
+sobj.count_s # Alias for :count
+sobj.count_sf # Return the number of subfeatures on a Sensor object
+
+# Set the name of the desired sensors to collect
+# Can be set to either specific sensor or a wildcard.
+# 
+# This will return a list of AbsSensors of the type.
+# 
+# Example: "amdgpu-*", for ANY Radeon card using this driver
+# Example: "*-pci-*", for ANY device on the PCI bus
+# Example: "k10temp-pci-00c3", for a Ryzen or other k10temp CPU
+#             identified on the PCI bus, with the identifier, '00c3'
+#             (This is from my dev system, so yours might be different)
+s.set_name :name
+s.name # Return the current chip or collector's name
+s.unset_name # Unset the chip selection -- ``.enum`` will go back to ALL chips
+
+# Set the filters to return for a Sensor.
+# The selected features must be an array.
+# For convenience, the features may use the
+# constants from the class.
+# 
+# Example: [1,2], for ONLY fans and temps
+# Example: [LmSensors::SF_FAN, LmSensors::SF_POWER], for ONLY fans and power
+sobj.set_filters :arr_of_choices
+sobj.unset_filters # Unset the filters -- returns ALL
+
+# Toggle whether to receive the subfeatures or
+# only to receive the features with their type.
+# By default, this is false, and you will receive the
+# type only.
+sobj.toggle_subs
+
+# Toggle whether to format output. By default, this is false.
+# When false, it returns the raw state of the feature object.
+sobj.toggle_fmt
+
+# Assign the features from a Sensor.
+# This will return an array of Feature objects.
+fs = sobj.features # This is an alias for :stat
+
+# Format the feature data. Some types will have a pre-defined
+# format, but for others, you can derive LmSensors::Feature::GenFeature.
+# 
+# This method can also take a separate formatter. The default is
+# 'LmSensors::Feature::BASE_FMT', which returns it as a simple hash.
+fs[0].fmt # Will format the first feature returned.
+
+# This will return the feature type and name.
+# 
+# Example: { :name => :vddgfx, :type => 0 }, for the voltage on my GPU
+#   :vddgfx is the name
+#   :type => 0, refers to the fact that this feature is measured with
+#     the voltage type (LmSensors::SF_IN, Voltage, 0).
+fs[0].feature
+```
+
+### TO-DO ###
+~~1) DONE, FINALLY!~~
+
+### INSTALLATION ###
+_DEV LIBS: As this is an extension, you will require the Ruby development headers. On some systems, this will come packaged with your Ruby installation. On others, you may need to install additional packages, such as ``ruby-dev`` (Ubuntu and similar). Check your specific system's requirements, and make sure you have the headers, as well as RubyGems and Rdoc_
+
+This wrapper requires the header files for ``lmsensors`` to be installed. For some systems, it will come with the userspace package directly. For others, it is a separate package. The header required is ``sensors.h``.
+
+NOTE: Below is how you can install it on various distros. As I use Arch and Debian, I had to look up the others, so if there is an issue, please submit the correction, and I will fix it.
+
+Arch:
+```
+sudo pacman -S lm_sensors
+```
+Debian-like (Debian, Ubuntu, Mint):
+```
+sudo apt install lm-sensors libsensors-dev
+```
+Fedora-like:
+```
+sudo yum install lm_sensors lm_sensors-devel
+sudo dnf install lm_sensors lm_sensors-devel
+```
+Gentoo:
+```
+sudo emerge --ask sys-apps/lm_sensors
+```
+For OpenSUSE, you will need to find a package that provides ``sensors.h``
+https://www.mankier.com/8/zypper.
+However, it appears that the correct way to install it will be:
+```
+sudo zypper install libsensors4-devel
+```
+
+Then, you can install it for Ruby:
+```
+gem install lmsensors
+```

data/ext/lmsensors_base/extconf.rb

@@ -0,0 +1,9 @@
+# ext/lmsensors_base/extconf.rb
+require 'mkmf'
+
+# Build LmSensors
+$LFLAGS = '-lsensors'
+$FLAGS = 'clean'
+have_library("sensors")
+have_header("sensors/sensors.h")
+create_makefile("lmsensors_base/lmsensors_base")

data/lib/lmsensors.rb

@@ -0,0 +1,13 @@
+# lib/lmsensors.rb
+
+##
+# This global is set up, to handle ignoring of
+# arity of passed procs for feature mapping.
+$LmSensorsIgnArity = false
+
+##
+# This module is a C-Ruby wrapper for
+# the program ``sensors``, which uses the
+# library ``lmsensors``, on Linux.
+require_relative "./lmsensors/lmsensors"
+require_relative "./lmsensors/version"

data/lib/lmsensors/feature.rb

@@ -0,0 +1,11 @@
+# lib/lmsensors/feature.rb
+
+# Require the extra classes
+require_relative "./features/voltage"
+require_relative "./features/current"
+require_relative "./features/power"
+require_relative "./features/temp"
+require_relative "./features/fan"
+require_relative "./features/humidity"
+require_relative "./features/alarm"
+require_relative "./features/beep"

data/lib/lmsensors/features/abs_feature.rb

@@ -0,0 +1,85 @@
+# lib/lmsensors/features/abs_feature.rb
+
+# Make sure to include the constants
+require_relative "../lm_constants"
+
+# :nodoc: Append to the main module
+module LmSensors
+  ##
+  # Feature module is used to handle the formatting
+  # and inheritance of various feature types.
+  module Feature
+    ##
+    # Base formatting for anything else.
+    # This pretty much just converts a general
+    # feature object into a hash, so it can be
+    # indexed in post-processing.
+    BASE_FMT = lambda do |feature|
+      # Attach the main feature name and unit type
+      fstruct = { name: feature.name, type: feature.type, unit: feature.unit }
+      # Merge the subfeatures
+      fstruct.merge(feature.subfs)
+    end # End base formatter proc
+    
+    ##
+    # The generic GenFeature class is appended to the LmSensors
+    # to handle generic formatting on feature types that
+    # generally will not need additional post-processing.
+    class GenFeature
+      ##
+      # GenFeature :default_formatter is BASE_FMT, which returns a
+      # simple representation of the sensor subfeatures, if no
+      # clear formatting can be determined.
+      attr_reader :default_formatter
+      ##
+      # GenFeature :name is the name of the feature, such as ':temp1'
+      attr_reader :name
+      ##
+      # GenFeature :subfs is a list/array of the subfeatures for this feature
+      attr_reader :subfs
+      ##
+      # GenFeature :type is the type of the feature, such as SF_TEMP or SF_FAN
+      attr_reader :type
+      ##
+      # GenFeature :unit is the default unit that is likely desired to
+      # represent subfeatures in this feature.
+      #   Example: :temp1 may have :temp1_input and :temp1_crit, but both
+      #     would be formatted with °C, which is returned from
+      #     LmSensors::UNITS[SF_TEMP]
+      attr_reader :unit
+      
+      ##
+      # Constructor
+      def initialize(name, data)
+        # Attach the default formatter
+        def_fmt
+        # Attach the base data for this instance
+        @name, @type, @subfs = name, data[:type], data
+        @subfs.delete(:type) # Remove :type from the hash (for cleaner iteration)
+        @unit = LmSensors::UNITS[@type] # Units
+      end # End constructor
+      
+      ##
+      # Return just the feature keys
+      def feature() { name: @name, type: @type, unit: @unit } end
+      
+      ##
+      # Set the default formatter for the subclass.
+      # If not overridden, will be be the default for
+      # the abstract general class.
+      def def_fmt() @default_formatter = LmSensors::Feature::BASE_FMT end
+      
+      ##
+      # Format the output struct. This uses
+      # a default formatter, but any desired formatting
+      # function can be passed. The formatter should be
+      # a lambda or proc type.
+      def fmt(callback=@default_formatter)
+        #puts "Abstract formatter for #{self.class}"
+        # If the callback is the wrong type, sue the default
+        cb = Proc === callback ? callback : @default_formatter
+        cb.call(self)
+      end # End formatting of new struct type
+    end # End abstract Feature class
+  end # End Feature module
+end # End LmSensors inclusion