amdgpu_fan 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474b8500f7505a2793cf2a3cc1345d39273c78b2749cde1a40bef0f8050910e0
-  data.tar.gz: ceb407543897bd36b851c1c1c42660e8f146878cd354ee0411a104b9358fb133
+  metadata.gz: 7f57ebc2011d08efe82baa67964bf75a17dfe7c85a518249a93c7b6eeadf207e
+  data.tar.gz: 1e1fa6d5af4f3cecc5346003949eb4a1edeb1c1ef943e60478f09cd8e3600099
 SHA512:
-  metadata.gz: 2808b9d2b5ce15880b9ee3937bac0f534c81b66c3824fe44439ebfc7449ba52d7ad44e930cc21f201bedd1bc6b34a3d17f3d469aed62a534fc8e6cc005064a09
-  data.tar.gz: 2ddc2aeedb9648308e7bf39f7421d5ae5397addd9df7ed35e6f15e903c78b8c36c946df1a48e529e2cdd2de7629696e0e7caa67d0923d65d9b2b72f56aad7bcd
+  metadata.gz: a185688066129ae01860f6dcf15fa75d84b5441f0cf3fbf23df812986c8da194eb6ed00557afe607299d6d3640beed3b5dc60483b1e6155d09d4e40180865793
+  data.tar.gz: 2ef75cd3c949fd579eaf855c63ca985a1ddff172e41fceb46dd10b5f1177e0ddaf7f74427e3ce64c26a86ac15da473806f400014abaf428fb7275f075cd79069

data/README.md

@@ -1,33 +1,104 @@
-# amdgpu-fan-rb
+# amdgpu_fan
 
-A Ruby CLI to read and set the fan speed for AMD Radeon graphics cards running on the AMDGPU Linux driver.
+[![Gem Version](https://badge.fury.io/rb/amdgpu_fan.svg)](https://badge.fury.io/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)
 
-See https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_control
+A Ruby CLI to read and set fan speed, power profiles, and more for AMD Radeon graphics cards running on the AMDGPU Linux driver.
 
-## Usage
+**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
+
+The `amdgpu_fan` CLI command can be installed from [RubyGems](https://rubygems.org/gems/amdgpu_fan) or easily run from the source code.
+
+### From RubyGems
 
 ```
-➤  bundle
+gem install amdgpu_fan
+```
+
+### From Source
+
+```
+➤  git clone https://github.com/HarlemSquirrel/amdgpu-fan-rb.git
+➤  cd amdgpu-fan-rb
+➤  bundle install
+➤  bin/amdgpu_fan
+```
 
+## Usage
+
+```
 ➤  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           # View device info, current fan speed, and temperature
-  amdgpu_fan watch [SECONDS]  # Watch current fan speed, and temperature refreshed every n seconds
+  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:   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
+📺 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)...
+  <Press Ctrl-C to exit>
+2019-05-28 20:57:41 | Core: 724Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [**        ]24%  | Power: 16.07 W  [*         ]6%   | Temp: 34.0°C
+2019-05-28 20:57:45 | Core: 512Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 16.13 W  [*         ]7%   | Temp: 34.0°C
+2019-05-28 20:57:49 | Core: 892Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 25.22 W  [*         ]5%   | Temp: 33.0°C
+2019-05-28 20:57:53 | Core: 300Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 19.1 W   [*         ]6%   | Temp: 33.0°C
+2019-05-28 20:57:57 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [********* ]94%  | Power: 103.04 W [***       ]31%  | Temp: 36.0°C
+2019-05-28 20:58:01 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 954 rpm  [**        ]15%  | Load: [********* ]91%  | Power: 158.07 W [*****     ]53%  | Temp: 38.0°C
+2019-05-28 20:58:05 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 977 rpm  [**        ]16%  | Load: [**********]100% | Power: 218.01 W [*******   ]73%  | Temp: 40.0°C
+2019-05-28 20:58:09 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 1005 rpm [**        ]16%  | Load: [**********]100% | Power: 216.24 W [*******   ]71%  | Temp: 40.0°C
+2019-05-28 20:58:13 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 1033 rpm [**        ]17%  | Load: [**********]97%  | Power: 109.25 W [****      ]39%  | Temp: 38.0°C
+2019-05-28 20:58:17 | Core: 724Mhz   | Memory: 500Mhz  | Fan: 1058 rpm [**        ]17%  | Load: [          ]0%   | Power: 17.17 W  [*         ]6%   | Temp: 35.0°C
+^C
+And now the watch is ended.
+```
+
+```
+➤  bin/amdgpu_fan watch_avg
+Watching Sapphire Technology Limited Vega 10 XL/XT [Radeon RX Vega 56/64] min, max and averges since
+2020-06-02 23:05:20 -0400...
+  <Press Ctrl-C to exit>
+⏰ Core clock  min:    852 MHz avg:  887.0 MHz max:   1200 MHz now:    852 MHz
+💾 Memory clk  min:    167 MHz avg:  227.1 MHz max:    945 MHz now:    167 MHz
+🌀 Fan speed   min:   1231 RPM avg: 1231.0 RPM max:   1231 RPM now:   1231 RPM
+⚡ Power usage min:    6.0 W   avg:   21.8 W   max:  141.0 W   now:    6.0 W
+🌡  Temperature min:     30 °C  avg:   31.3 °C  max:     35 °C  now:     32 °C
+^C
+And now the watch is ended.
 ```
 
 ## Dependencies
 
-- Ruby
-- bundler
-- thor (installed with bundler)
-- lspci (included with most Linux distributions)
+- [Ruby](https://www.ruby-lang.org) with [Bundler](https://bundler.io)
+- [Thor](http://whatisthor.com/) (installed with `bundle install`)
+- [`lspci`](https://linux.die.net/man/8/lspci) (included with most Linux distributions)
+
+## Building a binary
+
+[Ruby Packer](https://github.com/pmq20/ruby-packer) provides a convenient way to compile this into a single executable. For the best results, compile Ruby Packer from source from the lastest master branch.
+
+```sh
+rubyc amdgpu_fan --output amdgpu_fan
+```

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

@@ -1,3 +1,14 @@
+# frozen_string_literal: true
+
 require 'thor'
 
-require_relative '../lib/amdgpu_service'
+require_relative '../lib/amdgpu_fan'
+require_relative '../lib/amdgpu_fan/version'
+
+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'
+require_relative '../lib/amdgpu_fan/stat_set'
+require_relative '../lib/amdgpu_fan/watcher'

data/config/icons.yml

@@ -0,0 +1,10 @@
+---
+clock: ⏰
+display: 📺
+fan: 🌀
+gpu: 👾
+load: "⚖ "
+memory: 💾
+power: ⚡
+temp: "🌡 "
+vbios: 📄

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,203 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module AmdgpuFan
+  # The command-line interface class
+  class Cli < Thor
+    include CliOutputFormat
+
+    ICONS = YAML.load(File.read(File.join(__dir__, '../../config/icons.yml')))
+                .transform_keys(&:to_sym).freeze
+    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 ICONS[:gpu] + ' GPU:'.ljust(9) + amdgpu_service.name,
+           ICONS[:vbios]+ ' vBIOS:'.ljust(9) + amdgpu_service.vbios_version,
+           ICONS[:display]  + ' Displays:' + amdgpu_service.display_names.join(', '),
+           ICONS[:clock] + ' Clocks:'.ljust(9) + clock_status,
+           ICONS[:memory] + ' Memory:'.ljust(9) + mem_total_mibibyes,
+           ICONS[:fan] + ' Fan:'.ljust(9) + fan_status,
+           ICONS[:temp] + ' Temp:'.ljust(9) + "#{amdgpu_service.temperature}°C",
+           ICONS[:power] + ' 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}%)",
+           ICONS[:load] + ' Load:'.ljust(9) + percent_meter(amdgpu_service.busy_percent, 20)
+    end
+
+    desc 'version', 'Print the application version.'
+    def version
+      puts AmdgpuFan::VERSION
+    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_avg',
+         <<~DOC
+           Watch min, max, average, and current stats.
+         DOC
+    def watch_avg
+      puts "Watching #{amdgpu_service.name} min, max and averges since #{Time.now}...",
+           '  <Press Ctrl-C to exit>',
+           "\n\n\n\n\n"
+
+      trap 'SIGINT' do
+        puts "\nAnd now the watch is ended."
+        exit 0
+      end
+
+      watcher = Watcher.new amdgpu_service
+
+      loop do
+        watcher.measure
+        5.times { print "\033[K\033[A" } # move up a line and clear to end of line
+
+        puts ICONS[:clock] +  ' Core clock  ' + watcher.core_clock.to_s,
+             ICONS[:memory] + ' Memory clk  ' + watcher.mem_clock.to_s,
+             ICONS[:fan] +    ' Fan speed   ' + watcher.fan_speed.to_s,
+             ICONS[:power] +  ' Power usage ' + watcher.power.to_s,
+             ICONS[:temp] +   ' Temperature ' + watcher.temp.to_s
+        sleep 1
+      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,72 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  ## Connector
+  #
+  # A model class for a GPU connector
+  class Connector
+    EDID_DESCRIPTORS_CONF = {
+      display_name_leading_bytes: String.new('\x00\xFC\x00', encoding: 'ascii-8bit'),
+      unspecified_text_leading_bytes: String.new('\x00\xFE\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?
+
+      (display_name_text + unspecified_text).join(' ').strip
+    end
+
+    def status
+      File.read(File.join(dir_path, 'status')).strip
+    end
+
+    private
+
+    def display_descriptors_raw
+      edid.slice EDID_DESCRIPTORS_CONF[:index_range]
+    end
+
+    def display_name_text
+      display_descriptors_raw
+        .scan(/(?<=#{EDID_DESCRIPTORS_CONF[:display_name_leading_bytes]}).{1,13}/)
+    end
+
+    def edid
+      File.read("#{dir_path}/edid", encoding: 'ascii-8bit')
+    end
+
+    def unspecified_text
+      display_descriptors_raw
+        .scan(/(?<=#{EDID_DESCRIPTORS_CONF[:unspecified_text_leading_bytes]}).{1,13}/)
+    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,161 @@
+# 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 display_names
+      connectors.map(&:display_name).compact
+    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

data/lib/amdgpu_fan/stat_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # A set of stats
+  class StatSet < Hash
+    attr_accessor :avg, :max, :min, :now
+    attr_reader :unit
+
+    def initialize(unit)
+      @unit = unit
+    end
+
+    def stats
+      { min: min, avg: avg, max: max, now: now }
+    end
+
+    ##
+    # Return a string containing all the stats with units.
+    #
+    def to_s
+      stats.map { |k,v| "#{k}: #{v.to_s.rjust(6)} #{unit.ljust(3)} " }.join
+    end
+  end
+end

data/lib/amdgpu_fan/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # Current version of RSpec Core, in semantic versioning format.
+  VERSION = '0.6.0'
+end

data/lib/amdgpu_fan/watcher.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'stat_set'
+
+module AmdgpuFan
+  # Keep track of stats over time.
+  class Watcher
+    attr_reader :core_clock, :fan_speed, :num_measurements, :mem_clock, :power, :temp
+
+    def initialize(amdgpu_service)
+      @amdgpu_service = amdgpu_service
+      @num_measurements = 0
+
+      @core_clock = StatSet.new 'MHz'
+      @mem_clock = StatSet.new 'MHz'
+      @fan_speed = StatSet.new 'RPM'
+      @power = StatSet.new 'W'
+      @temp = StatSet.new '°C'
+    end
+
+    ##
+    # Take a new set of measurements and adjust the stats.
+    #
+    def measure
+      @num_measurements += 1
+
+      @core_clock.now = @amdgpu_service.core_clock.to_i
+      @mem_clock.now = @amdgpu_service.memory_clock.to_i
+      @fan_speed.now = @amdgpu_service.fan_speed_rpm.to_i
+      @power.now = @amdgpu_service.power_draw.to_f
+      @temp.now = @amdgpu_service.temperature.to_i
+
+      [@core_clock, @mem_clock, @fan_speed, @power, @temp].each do |stat_set|
+        calculate_stats(stat_set)
+      end
+    end
+
+    private
+
+    def calculate_stats(stat_set)
+      if num_measurements == 1
+        stat_set.min = stat_set.now
+        stat_set.avg = stat_set.now.to_f
+        stat_set.max = stat_set.now
+        return
+      end
+
+      stat_set.min = stat_set.now if stat_set.now < stat_set.min
+      stat_set.avg =
+       ((stat_set.now + stat_set.avg * (num_measurements - 1)) / num_measurements.to_f)
+         .round(1)
+      stat_set.max = stat_set.now if stat_set.now > stat_set.max
+    end
+  end
+end

metadata

@@ -1,16 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
-dependencies: []
-description: A CLI for amdgpu fans
+date: 2020-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A CLI for interacting with the amdgpu Linux driver
 email: harlemsquirrel@gmail.com
 executables:
 - amdgpu_fan
@@ -20,9 +62,17 @@ 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
+- config/icons.yml
+- 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
+- lib/amdgpu_fan/stat_set.rb
+- lib/amdgpu_fan/version.rb
+- lib/amdgpu_fan/watcher.rb
 homepage: https://github.com/HarlemSquirrel/amdgpu-fan-rb
 licenses:
 - MIT
@@ -42,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+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,77 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../config/environment'
-
-# The main class
-class AmdgpuFanCli < Thor
-  desc 'auto', 'Set mode to automatic (requires sudo)'
-  def 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)
-
-    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
-    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
-
-    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
-
-  private
-
-  def amdgpu_service
-    @amdgpu_service ||= AmdgpuService.new
-  end
-
-  def current_time
-    Time.now.strftime("%F %T")
-  end
-
-  def fan_status
-    "🌀\tFan:   #{amdgpu_service.fan_mode} mode running at " \
-     "#{amdgpu_service.fan_speed_percent}% ~ #{amdgpu_service.fan_speed_rpm} rpm"
-  end
-
-  def print_radeon_logo
-    puts File.read('lib/radeon_r_black_red_100x100.ascii')
-  end
-end

data/lib/amdgpu_service.rb

@@ -1,134 +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 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

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