amdgpu_fan 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5628dc7eec5a2fb4737be7e3f79cad3d51d1359457162568303a12f7f9886ee
-  data.tar.gz: 98ed0f072b9b8174b1160a4460bb80631c3e5c7263c244cf148dbb738a26fd16
+  metadata.gz: 474b8500f7505a2793cf2a3cc1345d39273c78b2749cde1a40bef0f8050910e0
+  data.tar.gz: ceb407543897bd36b851c1c1c42660e8f146878cd354ee0411a104b9358fb133
 SHA512:
-  metadata.gz: ceed05049dd35db984ba670ad0bee7336c6693fb16a83c77bedebd8fa327ccff0b63bc84dde4436f9a2a9654f00f5284086a66aff8d6cd6f358760160865bbe9
-  data.tar.gz: ae319ad4e4acc088930b435f886527b0c226203ab3743e2794ae03f0f969178f51f9315cf4f28212f17a31c20daa1a52e2aa717495a1b23aed88d1d3809acb39
+  metadata.gz: 2808b9d2b5ce15880b9ee3937bac0f534c81b66c3824fe44439ebfc7449ba52d7ad44e930cc21f201bedd1bc6b34a3d17f3d469aed62a534fc8e6cc005064a09
+  data.tar.gz: 2ddc2aeedb9648308e7bf39f7421d5ae5397addd9df7ed35e6f15e903c78b8c36c946df1a48e529e2cdd2de7629696e0e7caa67d0923d65d9b2b72f56aad7bcd

data/README.md

@@ -7,10 +7,27 @@ See https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_cont
 ## Usage
 
 ```
-➤  bin/amdgpu_fan
+➤  bundle
+
+➤  bin/amdgpu_fan help
 Commands:
-  amdgpu_fan auto            # set mode to automatic (requires sudo)
-  amdgpu_fan help [COMMAND]  # Describe available commands or one specific command
-  amdgpu_fan set PERCENTAGE  # set fan speed to PERCENTAGE (requires sudo)
-  amdgpu_fan status          # report the current status
+  amdgpu_fan auto             # Set mode to automatic (requires sudo)
+  amdgpu_fan help [COMMAND]   # Describe available commands or one specific command
+  amdgpu_fan set PERCENTAGE   # Set fan speed to PERCENTAGE (requires sudo)
+  amdgpu_fan status           # View device info, current fan speed, and temperature
+  amdgpu_fan watch [SECONDS]  # Watch current fan speed, and temperature refreshed every n seconds
+
+➤  bin/amdgpu_fan status
+📺	GPU:   AMD Radeon (TM) R9 Fury Series
+📄	vBIOS: 113-C8800100-102
+🌀	Fan:   auto mode running at 48% ~ 1828 rpm
+🌡	Temp:  28.0°C
+⚡	Power: 19.26 / 300.0 Watts
 ```
+
+## Dependencies
+
+- Ruby
+- bundler
+- thor (installed with bundler)
+- lspci (included with most Linux distributions)

data/config/environment.rb

@@ -0,0 +1,3 @@
+require 'thor'
+
+require_relative '../lib/amdgpu_service'

data/lib/amdgpu_fan_cli.rb

@@ -1,104 +1,77 @@
 # frozen_string_literal: true
 
-require 'thor'
+require_relative '../config/environment'
 
 # The main class
 class AmdgpuFanCli < Thor
-  FAN_POWER_FILE = Dir.glob("/sys/class/drm/card0/device/**/pwm1").first
-  FAN_MAX_POWER_FILE = Dir.glob("/sys/class/drm/card0/device/**/pwm1_max").first
-  FAN_INPUT_FILE = Dir.glob("/sys/class/drm/card0/device/**/fan1_input").first
-  FAN_MODE_FILE = Dir.glob("/sys/class/drm/card0/device/**/pwm1_enable").first
-  FAN_MODES = { auto: '2', manual: '1' }.freeze
-  POWER_MAX_FILE = '/sys/class/drm/card0/device/hwmon/hwmon2/power1_cap'
-  POWER_AVG_FILE = '/sys/class/drm/card0/device/hwmon/hwmon2/power1_average'
-  TEMPERATURE_FILE = Dir.glob("/sys/class/drm/card0/device/**/temp1_input").first
-  VBIOS_VERSION = File.read('/sys/class/drm/card0/device/vbios_version').strip
-
   desc 'auto', 'Set mode to automatic (requires sudo)'
   def auto
-    set_mode(:auto)
+    amdgpu_service.set_fan_mode! :auto
+    puts fan_status
   end
 
   desc 'set PERCENTAGE', 'Set fan speed to PERCENTAGE (requires sudo)'
   def set(percentage)
     return puts "Invalid percentage" unless (0..100).cover?(percentage.to_i)
-    set_mode(:manual) unless in_manual_mode?
-    puts "Setting fan to #{setting_from_percent percentage}/#{max}..."
-    set_manual_speed setting_from_percent(percentage)
+
+    amdgpu_service.set_fan_manual_speed! percent: percentage
+    puts fan_status
+  rescue AmdgpuService::Error
+    puts 'Invalid fan speed provided. The percentage should be between 1 and 100'
+    exit 1
   end
 
   desc 'status', 'View device info, current fan speed, and temperature'
   def status
-    puts device_info,
-         "Video BIOS version: #{VBIOS_VERSION}",
-         "🌀\tFan:   #{current_mode} mode running at #{current_percentage.round}% ~ #{rpm} rpm",
-         "🌡\tTemp:  #{current_temperature}°C",
-         "⚡\tPower: #{current_power} / #{power_max} Watts"
-  end
-
-  private
-
-  def device_info
-    @device_info ||= `glxinfo | grep -m 1 -o "AMD Radeon .* Series"`.strip
-  end
-
-  def current
-    File.read FAN_POWER_FILE
-  end
-
-  def current_mode
-    case File.read(FAN_MODE_FILE).strip
-    when '1'
-      'manual'
-    when '2'
-      'auto'
-    else
-      'unknown'
+    print_radeon_logo
+    puts "📺\tGPU:   #{amdgpu_service.name}",
+         "📄\tvBIOS: #{amdgpu_service.vbios_version}",
+         fan_status,
+         "🌡\tTemp:  #{amdgpu_service.temperature}°C",
+         "⚡\tPower: #{amdgpu_service.power_dpm_state} mode using " \
+          "#{amdgpu_service.power_draw} / #{amdgpu_service.power_max} Watts",
+         "⚖\tLoad: #{amdgpu_service.busy_percent}%"
+  end
+
+  desc 'watch [SECONDS]', 'Watch fan speed, load, power, and temperature ' \
+       'refreshed every n seconds'
+  def watch(seconds=1)
+    return puts "Seconds must be from 1 to 600" unless (1..600).cover?(seconds.to_i)
+
+    puts "Watching #{amdgpu_service.name} every #{seconds} second(s)...",
+         '  <Press Ctrl-C to exit>'
+
+    trap "SIGINT" do
+      puts 'And now the watch is ended.'
+      exit 0
     end
-  end
-
-  def current_percentage
-    current.to_f / max.to_i * 100
-  end
-
-  def current_power
-    (File.read(POWER_AVG_FILE).strip.to_f / 1000000).round(2)
-  end
-
-  def current_temperature
-    (File.read(TEMPERATURE_FILE).to_f / 1000).round(1)
-  end
-
-  def max
-    @max ||= File.read(FAN_MAX_POWER_FILE).to_i
-  end
-
-  def in_auto_mode?
-    File.read(FAN_MODE_FILE).strip == '2'
-  end
 
-  def in_manual_mode?
-    File.read(FAN_MODE_FILE).strip == '1'
+    loop do
+      puts "#{Time.now.strftime("%F %T")} " \
+           "Fan: #{amdgpu_service.fan_speed_rpm} rpm (#{amdgpu_service.fan_speed_percent}%), " \
+           "Load: #{amdgpu_service.busy_percent}%, " \
+           "Power: #{amdgpu_service.power_draw} W, " \
+           "Temp: #{amdgpu_service.temperature}°C "
+      sleep seconds.to_i
+    end
   end
 
-  def power_max
-    @power_max ||= (File.read(POWER_MAX_FILE).strip.to_f / 1000000).round(2)
-  end
+  private
 
-  def rpm
-    File.read(FAN_INPUT_FILE).strip
+  def amdgpu_service
+    @amdgpu_service ||= AmdgpuService.new
   end
 
-  def set_mode(mode)
-    puts "Setting mode to #{mode}"
-    `echo "#{FAN_MODES[mode]}" | sudo tee #{FAN_MODE_FILE}`
+  def current_time
+    Time.now.strftime("%F %T")
   end
 
-  def set_manual_speed(speed)
-    `echo "#{speed}" | sudo tee #{FAN_POWER_FILE}`
+  def fan_status
+    "🌀\tFan:   #{amdgpu_service.fan_mode} mode running at " \
+     "#{amdgpu_service.fan_speed_percent}% ~ #{amdgpu_service.fan_speed_rpm} rpm"
   end
 
-  def setting_from_percent(percent)
-    (percent.to_f / 100 * max.to_i).round
+  def print_radeon_logo
+    puts File.read('lib/radeon_r_black_red_100x100.ascii')
   end
 end

data/lib/amdgpu_service.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+## AmdgpuService
+#
+# A service class for reading and interacting with AMD radeon graphics cards
+# through the amdgpu Linux kernel driver.
+class AmdgpuService
+  BASE_FOLDER = '/sys/class/drm'
+  FAN_MODES = { '1' => 'manual', '2' => 'auto' }.freeze
+
+  attr_reader :card_num
+
+  class Error < StandardError; end
+
+  def initialize(card_num: 0)
+    @card_num = card_num
+  end
+
+  def busy_percent
+    File.read("#{base_card_folder}/gpu_busy_percent").strip
+  end
+
+  def fan_mode
+    FAN_MODES[File.read(fan_mode_file).strip] || 'unknown'
+  end
+
+  def set_fan_mode!(mode)
+    `echo "#{FAN_MODES.key(mode.to_s)}" | sudo tee #{fan_mode_file}`
+  end
+
+  def fan_speed_percent
+    (fan_speed_raw.to_f / fan_speed_raw_max.to_i * 100).round
+  end
+
+  def fan_speed_raw_max
+    @fan_speed_raw_max ||= File.read(Dir.glob("#{base_card_folder}/**/pwm1_max").first).strip
+  end
+
+  def fan_speed_rpm
+    File.read(fan_input_file).strip
+  end
+
+  def name
+    lspci_subsystem.split(': ')[1].strip
+  end
+
+  def power_dpm_state
+    File.read("#{base_card_folder}/power_dpm_state").strip
+  end
+
+  def power_draw
+    power_raw_to_watts File.read(power_avg_file)
+  end
+
+  def power_max
+    @power_max ||= power_raw_to_watts File.read(power_max_file)
+  end
+
+  def set_fan_manual_speed!(percent: nil, raw: nil)
+    if valid_fan_percent_speed?(percent)
+      new_raw = (percent.to_f / 100 * fan_speed_raw_max.to_i).round
+    elsif valid_fan_raw_speed?(raw)
+      new_raw = raw
+    end
+
+    raise(self.class::Error, 'Invalid fan speed provided') if new_raw.to_s.empty?
+
+    set_fan_mode!(:manual) unless fan_mode == 'manual'
+
+    `echo "#{new_raw}" | sudo tee #{fan_power_file}`
+  end
+
+  def temperature
+    (File.read(temperature_file).to_f / 1000).round(1)
+  end
+
+  def vbios_version
+    @vbios_version ||= File.read("#{base_card_folder}/vbios_version").strip
+  end
+
+  private
+
+  def base_card_folder
+    @base_card_folder ||= "#{BASE_FOLDER}/card#{card_num}/device"
+  end
+
+  def fan_input_file
+    @fan_input_file ||= Dir.glob("#{base_card_folder}/**/fan1_input").first
+  end
+
+  def fan_mode_file
+    @fan_mode_file ||= Dir.glob("#{base_card_folder}/**/pwm1_enable").first
+  end
+
+  def fan_power_file
+    @fan_power_file ||= Dir.glob("#{base_card_folder}/**/pwm1").first
+  end
+
+  def fan_speed_raw
+    File.read(fan_power_file).strip
+  end
+
+  def gpu_pci_id
+    @gpu_pci_id ||= `lspci -v | grep VGA`.split(' ').first
+  end
+
+  def lspci_subsystem
+    @lspci_subsystem ||= `lspci -v -s #{gpu_pci_id} | grep "Subsystem:"`
+  end
+
+  def power_avg_file
+    @power_avg_file ||= Dir.glob("#{base_card_folder}/**/power1_average").first
+  end
+
+  def power_max_file
+    @power_avg_file ||= Dir.glob("#{base_card_folder}/**/power1_cap").first
+  end
+
+  def power_raw_to_watts(raw_string)
+    (raw_string.strip.to_f / 1_000_000).round(2)
+  end
+
+  def temperature_file
+    @temperature_file ||= Dir.glob("#{base_card_folder}/**/temp1_input").first
+  end
+
+  def valid_fan_raw_speed?(raw)
+    (1..fan_speed_raw_max.to_i).include?(raw.to_i)
+  end
+
+  def valid_fan_percent_speed?(percent)
+    (1..100.to_i).include?(percent.to_i)
+  end
+end

data/lib/radeon_r_black_red_100x100.ascii

@@ -0,0 +1,40 @@
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''.                                        .''''''''''''''''''''''''
+''''''''''''''.                                          .''''''''''''''''''''''
+''''''''''''''.                                            ..'''''''''''''''''''
+''''''''''''''.                                              .''''''''''''''''''
+''''''''''''''.                             ..                ..''''''''''''''''
+''''''''''''''.          .'''''''''''''''''''''''..            .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.          .''''''''''''''''
+''''''''''''''.           '''''''''''''''''''''''..            .''''''''''''''''
+''''''''''''''.                                                .''''''''''''''''
+''''''''''''''.                                              .''''''''''''''''''
+''''''''''''''.                                            ..'''''''''''''''''''
+''''''''''''''.                                          .''''''''''''''''''''''
+''''''''''''''.                                         .'''''''''''''''''''''''
+''''''''''''''.           ''''''''''''''''..            .'''''''''''''''''''''''
+''''''''''''''.           ''''''''''''''''''.            .''''''''''''''''''''''
+''''''''''''''.           '''''''''''''''''''.             .''''''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''..            ..''''''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''.             .'''''''''''''''''
+''''''''''''''.           '''''''''''''''''''''''..            ..'''''''''''''''
+''''''''''''''.           '''''''''''''''''''''''''.             .''''''''''''''
+''''''''''''''.           ''''''''''''''''''''''''''.             .'''''''''''''
+''''''''''''''............''''''''''''''''''''''''''''..............''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies: []
 description: A CLI for amdgpu fans
 email: harlemsquirrel@gmail.com
@@ -19,7 +19,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/amdgpu_fan
+- config/environment.rb
 - lib/amdgpu_fan_cli.rb
+- lib/amdgpu_service.rb
+- lib/radeon_r_black_red_100x100.ascii
 homepage: https://github.com/HarlemSquirrel/amdgpu-fan-rb
 licenses:
 - MIT