amdgpu_fan 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f831dbba03b1f54f0ed55055eea94371b658b4e797dae7899f3954b55e755a28
-  data.tar.gz: 9fa6dd181fbcae74b6441fe9a62200fb2be98be59c88d470a434c2b2730ea691
+  metadata.gz: 822ba3e84cdd6cb64680ace91e696351c3ac8f61fe7344554304be517c1ee141
+  data.tar.gz: b74858f3916aec38afb02134694011f59f4c672d276dd4905e9da6accee69333
 SHA512:
-  metadata.gz: 92a2ab4778b838e1bbbe6607c8bb2ad4a5d9ec79f817f24fa03d5af460e73a857e2dd456b3fd0ca08ab58cc4a64924a981afd4a44c05be65dad449b65f56c1e9
-  data.tar.gz: 4b4d0cd42f4a0275e09230799c22c90eecf556a0adfa2918d579f43419878a2100f2230cb19491468b59dc1496badc71bfd9f6332c6fddb3d7cc7480f4c00b97
+  metadata.gz: 1798fa2cb6a578717c75d898501833e75e27fc8efd14881954c8a7cdf53e71a0dc1dfb0cba6b51b8b96572943761d6d9f23be33f26f8bc6ee3c42e38f017ab7c
+  data.tar.gz: 95df0c6e478a1cbe580695c9be8cf123e555ec76ef767eb5a91b24d174693667cf33b0dabcc6a3ddd45cdfd54a7efd070317e6a74fc63395f2b96d207b77e0eb

data/README.md

@@ -1,10 +1,16 @@
-# amdgpu-fan-rb
+# amdgpu_fan
 
 [![Build Status](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb.svg?branch=master)](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb) [![Maintainability](https://api.codeclimate.com/v1/badges/27233cee17ef6a2c14fd/maintainability)](https://codeclimate.com/github/HarlemSquirrel/amdgpu-fan-rb/maintainability)
 
-A Ruby CLI to read and set the fan speed for AMD Radeon graphics cards running on the AMDGPU Linux driver.
+A Ruby CLI to read and set fan speed, power profiles, and more for AMD Radeon graphics cards running on the AMDGPU Linux driver.
 
-See https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_control
+**amdgpu_fan** aims to provide a more user friendly interface on top of [sysfs](https://en.wikipedia.org/wiki/Sysfs) for displaying statistics and interacting with AMD Radeon graphics hardware running on the [AMDgpu](https://dri.freedesktop.org/docs/drm/gpu/amdgpu.html) driver.
+
+#### Further reading
+
+- https://wiki.archlinux.org/index.php/AMDGPU#Overclocking
+- https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_control
+- https://phoronix.com/scan.php?page=news_item&px=AMDGPU-Quick-WattMan-Cap-Test
 
 ## Installation
 
@@ -28,25 +34,28 @@ gem install amdgpu_fan
 ## Usage
 
 ```
-➤  bin/amdgpu_fan
+➤  bin/amdgpu_fan help
 Commands:
-  amdgpu_fan auto                         # Set fan mode to automatic (requires sudo)
-  amdgpu_fan connectors                   # View the status of the display connectors
-  amdgpu_fan help [COMMAND]               # Describe available commands or one specific command
-  amdgpu_fan profile                      # View power profile details.
-  amdgpu_fan profile_auto                 # Set the power profile to automatic mode.
-  amdgpu_fan profile_force [PROFILE_NUM]  # Manually set a power profile.
-  amdgpu_fan set PERCENTAGE               # Set fan speed to PERCENTAGE (requires sudo)
-  amdgpu_fan status [--logo]              # View device info, current fan speed, and temperature
-  amdgpu_fan watch [SECONDS]              # Watch fan speed, load, power, and temperature refreshed every n seconds
-  amdgpu_fan watch_csv [SECONDS]          # Watch stats in CSV format refreshed every n seconds defaulting to 1 second
-
-➤  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
+  amdgpu_fan connectors                 # View the status of the display connectors.
+  amdgpu_fan fan                        # View fan details.
+  amdgpu_fan fan_set PERCENTAGE/AUTO    # Set fan speed to percentage or automatic mode. (requires sudo)
+  amdgpu_fan help [COMMAND]             # Describe available commands or one specific command
+  amdgpu_fan profile                    # View power profile details.
+  amdgpu_fan profile_auto               # Set the power profile to automatic mode.
+  amdgpu_fan profile_force PROFILE_NUM  # Manually set a power profile. (requires sudo)
+  amdgpu_fan status [--logo]            # View device info, current fan speed, and temperature.
+  amdgpu_fan watch [SECONDS]            # Watch fan speed, load, power, and temperature refreshed every n seconds.
+  amdgpu_fan watch_csv [SECONDS]        # Watch stats in CSV format refreshed every n seconds defaulting to 1 second.
+
+➤  bin/amdgpu_fan status
+📺 GPU:    Advanced Micro Devices, Inc. [AMD/ATI] Radeon R9 FURY X / NANO
+📄 vBIOS:  113-C8800100-102
+⏰ Clocks: 724Mhz Core, 500Mhz Memory
+💾 Memory: 4096 MiB
+🌀 Fan:    auto mode running at 1809 rpm (48%)
+🌞 Temp:   21.0°C
+⚡ Power:  3D_FULL_SCREEN profile in performance mode using 16.2 / 300.0 Watts (5%)
+⚖  Load:   [                    ]0%
 
 ➤  bin/amdgpu_fan watch 3
 Watching Advanced Micro Devices, Inc. [AMD/ATI] Radeon R9 FURY X / NANO every 3 second(s)...

data/bin/amdgpu_fan

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/amdgpu_fan_cli'
+require_relative '../lib/amdgpu_fan'
 
-AmdgpuFanCli.start ARGV
+AmdgpuFan::Cli.start ARGV

data/config/environment.rb

@@ -2,4 +2,10 @@
 
 require 'thor'
 
-require_relative '../lib/amdgpu_service'
+require_relative '../lib/amdgpu_fan'
+
+require_relative '../lib/amdgpu_fan/mixin/cli_output_format'
+require_relative '../lib/amdgpu_fan/mixin/sys_write'
+
+require_relative '../lib/amdgpu_fan/service'
+require_relative '../lib/amdgpu_fan/cli'

data/lib/amdgpu_fan.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../config/environment'
+
+# The main module
+module AmdgpuFan
+end

data/lib/amdgpu_fan/cli.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # The command-line interface class
+  class Cli < Thor
+    include CliOutputFormat
+
+    WATCH_FIELD_SEPARATOR = ' | '
+
+    desc 'connectors', 'View the status of the display connectors.'
+    def connectors
+      amdgpu_service.connectors.each do |connector|
+        puts "#{connector.type} #{connector.index}:\t" +
+             (connector.connected? ? connector.display_name : connector.status)
+      end
+    end
+
+    desc 'profile', 'View power profile details.'
+    def profile
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'profile_auto', 'Set the power profile to automatic mode.'
+    def profile_auto
+      amdgpu_service.profile_auto
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'profile_force PROFILE_NUM', 'Manually set a power profile. (requires sudo)'
+    def profile_force(state)
+      amdgpu_service.profile_force = state
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'fan', 'View fan details.'
+    def fan
+      puts fan_status
+    end
+
+    desc 'fan_set PERCENTAGE/AUTO', 'Set fan speed to percentage or automatic mode. (requires sudo)'
+    def fan_set(value)
+      if value.strip.casecmp('auto').zero?
+        amdgpu_service.fan_mode = :auto
+      else
+        return puts 'Invalid percentage' unless (0..100).cover?(value.to_i)
+
+        amdgpu_service.fan_speed = value
+      end
+      puts fan_status
+    end
+
+    desc 'status [--logo]', 'View device info, current fan speed, and temperature.'
+    def status(option = nil)
+      puts radeon_logo if option == '--logo'
+      puts "👾 #{'GPU:'.ljust(9)} #{amdgpu_service.name}",
+           "📄 #{'vBIOS:'.ljust(9)} #{amdgpu_service.vbios_version}",
+           "📺 Displays: #{amdgpu_service.connectors.map(&:display_name).compact.join(',')}",
+           "⏰ #{'Clocks:'.ljust(9)} #{clock_status}",
+           "💾 #{'Memory:'.ljust(9)} #{mem_total_mibibyes}",
+           "🌀 #{'Fan:'.ljust(9)} #{fan_status}",
+           "🌞 #{'Temp:'.ljust(9)} #{amdgpu_service.temperature}°C",
+           "⚡ #{'Power:'.ljust(9)} #{amdgpu_service.profile_mode} profile in " \
+            "#{amdgpu_service.power_dpm_state} mode using " \
+            "#{amdgpu_service.power_draw} / #{amdgpu_service.power_max} Watts "\
+            "(#{amdgpu_service.power_draw_percent}%)",
+           "⚖  #{'Load:'.ljust(9)} #{percent_meter amdgpu_service.busy_percent, 20}"
+    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 "\nAnd now the watch is ended."
+        exit 0
+      end
+
+      loop do
+        time = Time.now
+        puts [time.strftime('%F %T'), summary_clock, summary_fan, summary_load, summary_power,
+              summary_temp].join(WATCH_FIELD_SEPARATOR)
+
+        # It can take a second or two to run the above so we remove them from the wait
+        # here to get a more consistant watch interval.
+        sec_left_to_wait = time.to_i + seconds.to_i - Time.now.to_i
+        sleep sec_left_to_wait if sec_left_to_wait.positive?
+      end
+    end
+
+    desc 'watch_csv [SECONDS]', 'Watch stats in CSV format ' \
+         'refreshed every n seconds defaulting to 1 second.'
+    def watch_csv(seconds = 1)
+      return puts 'Seconds must be from 1 to 600' unless (1..600).cover?(seconds.to_i)
+
+      puts 'Timestamp, Core Clock (Mhz),Memory Clock (Mhz),Fan speed (rpm), '\
+           'Load (%),Power (Watts),Temp (°C)'
+
+      trap 'SIGINT' do
+        exit 0
+      end
+
+      loop do
+        puts [Time.now.strftime('%F %T'),
+              amdgpu_service.core_clock,
+              amdgpu_service.memory_clock,
+              amdgpu_service.fan_speed_rpm,
+              amdgpu_service.busy_percent,
+              amdgpu_service.power_draw,
+              amdgpu_service.temperature].join(',')
+        sleep seconds.to_i
+      end
+    end
+
+    private
+
+    def amdgpu_service
+      @amdgpu_service ||= AmdgpuFan::Service.new
+    end
+
+    def clock_status
+      "#{amdgpu_service.core_clock} Core, #{amdgpu_service.memory_clock} Memory"
+    end
+
+    def fan_status
+      "#{amdgpu_service.fan_mode} mode running at " \
+       "#{amdgpu_service.fan_speed_rpm} rpm (#{amdgpu_service.fan_speed_percent}%)"
+    end
+
+    def mem_total_mibibyes
+      "#{amdgpu_service.memory_total / (2**20)} MiB"
+    end
+
+    def power_max
+      format('%<num>0.2f', num: amdgpu_service.power_max)
+    end
+
+    def summary_clock
+      "Core: #{amdgpu_service.core_clock.rjust(7)}#{WATCH_FIELD_SEPARATOR}"\
+        "Memory: #{amdgpu_service.memory_clock.rjust(7)}"
+    end
+
+    def summary_fan
+      fan_speed_string = "#{amdgpu_service.fan_speed_rpm} rpm".rjust(8)
+      "Fan: #{fan_speed_string} #{percent_meter(amdgpu_service.fan_speed_percent)}"
+    end
+
+    def summary_load
+      "Load: #{percent_meter amdgpu_service.busy_percent}"
+    end
+
+    def summary_power
+      "Power: #{format('%<num>0.02f', num: amdgpu_service.power_draw).rjust(power_max.length)} W" \
+        " #{percent_meter amdgpu_service.power_draw_percent}"
+    end
+
+    def summary_temp
+      temp_string = "#{amdgpu_service.temperature}°C".rjust(7)
+      "Temp: #{temp_string}"
+    end
+  end
+end

data/lib/amdgpu_fan/connector.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  ## Connector
+  #
+  # A model class for a GPU connector
+  class Connector
+    EDID_DESCRIPTORS_CONF = {
+      display_descriptor_leading_bytes: String.new('\x00\xFC\x00', encoding: 'ascii-8bit'),
+      index_range: (54..125)
+    }.freeze
+
+
+    attr_reader :card_num, :dir_path, :index, :type
+
+    class << self
+      ##
+      # Return an array of connector objects for the provided card number.
+      # The files are sorted to improve how they are displayed to the user.
+      def where(card_num:)
+        Dir["/sys/class/drm/card#{card_num}/card#{card_num}-*"].sort.map do |dir_path|
+          Connector.new card_num: card_num,
+                        dir_path: dir_path,
+                        index: dir_path[-1],
+                        type: dir_path.slice(/(?<=card#{card_num}-)[A-Z]+/)
+        end
+      end
+    end
+
+    def initialize(card_num:, dir_path:, index:, type:)
+      @card_num = card_num
+      @dir_path = dir_path
+      @index = index
+      @type = type
+    end
+
+    def connected?
+      status.casecmp('connected').zero?
+    end
+
+    def display_name
+      return if edid.to_s.empty?
+
+      edid.slice(EDID_DESCRIPTORS_CONF[:index_range])
+          .scan(/(?<=#{EDID_DESCRIPTORS_CONF[:display_descriptor_leading_bytes]}).{1,13}/)
+          .first
+          .strip
+    end
+
+    def status
+      File.read(File.join(dir_path, 'status')).strip
+    end
+
+    private
+
+    def edid
+      File.read("#{dir_path}/edid", encoding: 'ascii-8bit')
+    end
+  end
+end

data/lib/amdgpu_fan/mixin/cli_output_format.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # A mixin to help with CLI output formatting
+  module CliOutputFormat
+    METER_CHAR = '*'
+    TIME_FORMAT = '%F %T'
+
+    private
+
+    def current_time
+      Time.now.strftime(TIME_FORMAT)
+    end
+
+    def percent_meter(percent, length = 10)
+      progress_bar_count = (length * percent.to_f / 100).round
+      percent_string = "#{format '%<num>0.2i', num: percent}%".ljust(3)
+      "[#{METER_CHAR * progress_bar_count}#{' ' * (length - progress_bar_count)}]#{percent_string}"
+    end
+
+    def radeon_logo
+      File.read(File.join(__dir__, '../../../assets/radeon_r_black_red_100x100.ascii'))
+    end
+  end
+end

data/lib/amdgpu_fan/mixin/fan.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  ##
+  # A mixin to read fan details and validate input
+  module Fan
+
+    private
+
+    def fan_file(type)
+      @fan_file ||= {}
+      @fan_file[type] ||= "#{base_hwmon_dir}/fan1_#{type}"
+    end
+
+    def fan_mode_file
+      @fan_mode_file ||= "#{base_hwmon_dir}/pwm1_enable"
+    end
+
+    def fan_power_file
+      @fan_power_file ||= "#{base_hwmon_dir}/pwm1"
+    end
+
+    def fan_speed_raw
+      File.read(fan_power_file).strip
+    end
+
+    def fan_raw_speeds(type)
+      @fan_raw_speeds ||= {}
+      @fan_raw_speeds[type] ||= File.read(Dir.glob("#{base_card_dir}/**/pwm1_#{type}").first).to_i
+    end
+
+    ##
+    # Validate the raw fan speed is between the minimum and maximum values
+    # read from sysfs.
+    def valid_fan_raw_speed?(raw)
+      !raw.nil? && (fan_raw_speeds(:min)..fan_raw_speeds(:max)).cover?(raw.to_i)
+    end
+
+    def valid_fan_percent_speed?(percent)
+      (1..100.to_i).cover?(percent.to_i)
+    end
+  end
+end

data/lib/amdgpu_fan/mixin/sys_write.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # A mixin to help with writing to system files
+  module SysWrite
+
+    private
+
+    ##
+    # Write to a system file with elevated priviledges. 
+    def sudo_write(file_path, value)
+      `echo "#{value}" | sudo tee #{file_path}`
+    end
+  end
+end

data/lib/amdgpu_fan/service.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require_relative 'mixin/fan'
+require_relative 'mixin/sys_write'
+
+require_relative 'connector'
+
+module AmdgpuFan
+  ## AmdgpuService
+  #
+  # A service class for reading and interacting with AMD radeon graphics cards
+  # through the amdgpu Linux kernel driver.
+  class Service
+    include Fan
+    include SysWrite
+
+    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_dir}/gpu_busy_percent").strip
+    end
+
+    def connectors
+      @connectors ||= Connector.where card_num: card_num
+    end
+
+    def core_clock
+      clock_from_pp_file "#{base_card_dir}/pp_dpm_sclk"
+    end
+
+    def fan_mode
+      FAN_MODES[File.read(fan_mode_file).strip] || 'unknown'
+    end
+
+    def fan_mode=(mode)
+      sudo_write fan_mode_file, FAN_MODES.key(mode.to_s)
+    end
+
+    def fan_speed=(value)
+      if valid_fan_percent_speed?(value)
+        new_raw = (value.to_f / 100 * fan_raw_speeds(:max).to_i).round
+      elsif valid_fan_raw_speed?(value)
+        new_raw = value
+      end
+
+      raise(self.class::Error, 'Invalid fan speed provided') if new_raw.to_s.empty?
+
+      self.fan_mode = :manual unless fan_mode == 'manual'
+
+      sudo_write fan_power_file, new_raw
+    end
+
+    def fan_speed_percent
+      (fan_speed_raw.to_f / fan_raw_speeds(:max).to_i * 100).round
+    end
+
+    def fan_speed_rpm
+      File.read(fan_file(:input)).strip
+    end
+
+    def memory_clock
+      clock_from_pp_file "#{base_card_dir}/pp_dpm_mclk"
+    end
+
+    def memory_total
+      File.read("#{base_card_dir}/mem_info_vram_total").to_i
+    end
+
+    def name
+      lspci_subsystem.split(': ')[1].strip
+    end
+
+    def power_dpm_state
+      File.read("#{base_card_dir}/power_dpm_state").strip
+    end
+
+    def power_draw
+      power_raw_to_watts File.read(power_avg_file)
+    end
+
+    def power_draw_percent
+      (power_draw.to_f / power_max.to_i * 100).round
+    end
+
+    def power_max
+      @power_max ||= power_raw_to_watts File.read("#{base_hwmon_dir}/power1_cap")
+    end
+
+    def profile_auto
+      sudo_write "#{base_card_dir}/power_dpm_force_performance_level", 'auto'
+    end
+
+    def profile_force=(state)
+      sudo_write "#{base_card_dir}/power_dpm_force_performance_level", 'manual'
+      sudo_write "#{base_card_dir}/pp_power_profile_mode", state
+    end
+
+    def profile_mode
+      File.read("#{base_card_dir}/pp_power_profile_mode").slice(/\w+\s*+\*/).delete('*').strip
+    end
+
+    def profile_summary
+      File.read("#{base_card_dir}/pp_power_profile_mode")
+    end
+
+    def temperature
+      (File.read(temperature_file).to_f / 1000).round(1)
+    end
+
+    def vbios_version
+      @vbios_version ||= File.read("#{base_card_dir}/vbios_version").strip
+    end
+
+    private
+
+    def base_card_dir
+      @base_card_dir ||= "#{BASE_FOLDER}/card#{card_num}/device"
+    end
+
+    def base_hwmon_dir
+      @base_hwmon_dir ||= Dir.glob("#{base_card_dir}/hwmon/hwmon*").first
+    end
+
+    def clock_from_pp_file(file)
+      File.read(file).slice(/\w+(?= \*)/)
+    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_dir}/**/power1_average").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_dir}/**/temp1_input").first
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies: []
 description: A CLI for interacting with the amdgpu Linux driver
 email: harlemsquirrel@gmail.com
@@ -20,9 +20,13 @@ 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
+- lib/amdgpu_fan.rb
+- lib/amdgpu_fan/cli.rb
+- lib/amdgpu_fan/connector.rb
+- lib/amdgpu_fan/mixin/cli_output_format.rb
+- lib/amdgpu_fan/mixin/fan.rb
+- lib/amdgpu_fan/mixin/sys_write.rb
+- lib/amdgpu_fan/service.rb
 homepage: https://github.com/HarlemSquirrel/amdgpu-fan-rb
 licenses:
 - MIT
@@ -42,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A CLI to view and set fan speeds for AMD graphics cards running on the open

data/lib/amdgpu_fan_cli.rb

@@ -1,167 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../config/environment'
-
-# The main class
-class AmdgpuFanCli < Thor
-  METER_CHAR = '*'
-  WATCH_FIELD_SEPARATOR = ' | '
-
-  desc 'auto', 'Set fan mode to automatic (requires sudo)'
-  def auto
-    amdgpu_service.fan_mode = :auto
-    puts fan_status
-  end
-
-  desc 'connectors', 'View the status of the display connectors'
-  def connectors
-    amdgpu_service.connectors_status.each do |connector, status|
-      puts "#{connector}: #{status}"
-    end
-  end
-
-  desc 'profile', 'View power profile details.'
-  def profile
-    puts amdgpu_service.profile_summary
-  end
-
-  desc 'profile_auto', 'Set the power profile to automatic mode.'
-  def profile_auto
-    amdgpu_service.profile_auto
-    puts amdgpu_service.profile_summary
-  end
-
-  desc 'profile_force [PROFILE_NUM]', 'Manually set a power profile.'
-  def profile_force(state)
-    amdgpu_service.profile_force = state
-    puts amdgpu_service.profile_summary
-  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)
-
-    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 [--logo]', 'View device info, current fan speed, and temperature'
-  def status(option = nil)
-    puts radeon_logo if option == '--logo'
-    puts "📺 #{'GPU:'.ljust(7)} #{amdgpu_service.name}",
-         "📄 #{'vBIOS:'.ljust(7)} #{amdgpu_service.vbios_version}",
-         "⏰ #{'Clocks:'.ljust(7)} #{clock_status}",
-         "🌀 #{'Fan:'.ljust(7)} #{fan_status}",
-         "🌞 #{'Temp:'.ljust(7)} #{amdgpu_service.temperature}°C",
-         "⚡ #{'Power:'.ljust(7)} #{amdgpu_service.profile_mode} profile in " \
-          "#{amdgpu_service.power_dpm_state} mode using " \
-          "#{amdgpu_service.power_draw} / #{amdgpu_service.power_max} Watts "\
-          "(#{amdgpu_service.power_draw_percent}%)",
-         "⚖  #{'Load:'.ljust(7)} #{percent_meter amdgpu_service.busy_percent, 20}"
-  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 "\nAnd now the watch is ended."
-      exit 0
-    end
-
-    loop do
-      time = Time.now
-      puts [time.strftime('%F %T'), summary_clock, summary_fan, summary_load, summary_power,
-            summary_temp].join(WATCH_FIELD_SEPARATOR)
-
-      # It can take a second or two to run the above so we remove them from the wait
-      # here to get a more consistant watch interval.
-      sec_left_to_wait = time.to_i + seconds.to_i - Time.now.to_i
-      sleep sec_left_to_wait if sec_left_to_wait.positive?
-    end
-  end
-
-  desc 'watch_csv [SECONDS]', 'Watch stats in CSV format ' \
-       'refreshed every n seconds defaulting to 1 second'
-  def watch_csv(seconds = 1)
-    return puts 'Seconds must be from 1 to 600' unless (1..600).cover?(seconds.to_i)
-
-    puts 'Timestamp, Core Clock (Mhz),Memory Clock (Mhz),Fan speed (rpm), '\
-         'Load (%),Power (Watts),Temp (°C)'
-
-    trap 'SIGINT' do
-      exit 0
-    end
-
-    loop do
-      puts [Time.now.strftime('%F %T'),
-            amdgpu_service.core_clock,
-            amdgpu_service.memory_clock,
-            amdgpu_service.fan_speed_rpm,
-            amdgpu_service.busy_percent,
-            amdgpu_service.power_draw,
-            amdgpu_service.temperature].join(',')
-      sleep seconds.to_i
-    end
-  end
-
-  private
-
-  def amdgpu_service
-    @amdgpu_service ||= AmdgpuService.new
-  end
-
-  def clock_status
-    "#{amdgpu_service.core_clock} Core, #{amdgpu_service.memory_clock} Memory"
-  end
-
-  def current_time
-    Time.now.strftime('%F %T')
-  end
-
-  def fan_status
-    "#{amdgpu_service.fan_mode} mode running at " \
-     "#{amdgpu_service.fan_speed_rpm} rpm (#{amdgpu_service.fan_speed_percent}%)"
-  end
-
-  def percent_meter(percent, length = 10)
-    progress_bar_count = (length * percent.to_f / 100).round
-    percent_string = "#{percent}%".ljust(4)
-    "[#{METER_CHAR * progress_bar_count}#{' ' * (length - progress_bar_count)}]#{percent_string}"
-  end
-
-  def radeon_logo
-    File.read(File.join(__dir__, '../lib/radeon_r_black_red_100x100.ascii'))
-  end
-
-  def summary_clock
-    "Core: #{amdgpu_service.core_clock.ljust(7)} #{WATCH_FIELD_SEPARATOR}"\
-      "Memory: #{amdgpu_service.memory_clock.ljust(7)}"
-  end
-
-  def summary_fan
-    fan_speed_string = "#{amdgpu_service.fan_speed_rpm} rpm".ljust(8)
-    "Fan: #{fan_speed_string} #{percent_meter(amdgpu_service.fan_speed_percent)}"
-  end
-
-  def summary_load
-    "Load: #{percent_meter amdgpu_service.busy_percent}"
-  end
-
-  def summary_power
-    power_string = "#{amdgpu_service.power_draw} W".ljust(amdgpu_service.power_max.to_s.length + 3)
-    "Power: #{power_string} #{percent_meter amdgpu_service.power_draw_percent}"
-  end
-
-  def summary_temp
-    temp_string = "#{amdgpu_service.temperature}°C".ljust(7)
-    "Temp: #{temp_string}"
-  end
-end

data/lib/amdgpu_service.rb

@@ -1,177 +0,0 @@
-# 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 connectors_status
-    connectors_files.each_with_object({}) do |f, connectors|
-      connectors[f.slice(/(?<=card0-)(\w|-)+/)] = File.read(f).strip
-    end
-  end
-
-  def core_clock
-    clock_from_pp_file "#{base_card_folder}/pp_dpm_sclk"
-  end
-
-  def fan_mode
-    FAN_MODES[File.read(fan_mode_file).strip] || 'unknown'
-  end
-
-  def 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 memory_clock
-    clock_from_pp_file "#{base_card_folder}/pp_dpm_mclk"
-  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_draw_percent
-    (power_draw.to_f / power_max.to_i * 100).round
-  end
-
-  def power_max
-    @power_max ||= power_raw_to_watts File.read(power_max_file)
-  end
-
-  def profile_auto
-    `echo "auto" | sudo tee "#{base_card_folder}/power_dpm_force_performance_level"`
-  end
-
-  def profile_force=(state)
-    `echo "manual" | sudo tee "#{base_card_folder}/power_dpm_force_performance_level"`
-    `echo "#{state}" | sudo tee "#{base_card_folder}/pp_power_profile_mode"`
-  end
-
-  def profile_mode
-    File.read("#{base_card_folder}/pp_power_profile_mode").slice(/\w+ \*/).delete('*').strip
-  end
-
-  def profile_summary
-    File.read("#{base_card_folder}/pp_power_profile_mode")
-  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?
-
-    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 clock_from_pp_file(file)
-    File.read(file).slice(/\w+(?= \*)/)
-  end
-
-  def connectors_files
-    @connectors_files ||= Dir["/sys/class/drm/card#{card_num}*/status"].sort
-  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_max_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).cover?(raw.to_i)
-  end
-
-  def valid_fan_percent_speed?(percent)
-    (1..100.to_i).cover?(percent.to_i)
-  end
-end

data/lib/radeon_r_black_red_100x100.ascii

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