amdgpu_fan 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474b8500f7505a2793cf2a3cc1345d39273c78b2749cde1a40bef0f8050910e0
-  data.tar.gz: ceb407543897bd36b851c1c1c42660e8f146878cd354ee0411a104b9358fb133
+  metadata.gz: d8bd1ed519a47f577ba017c94f03ac02101767434796821120aef3f9e12d9ba9
+  data.tar.gz: 6d55c0d1c45d076d1409318332fade5d9038c8f4e64b86d8af2cb2d5eeb016df
 SHA512:
-  metadata.gz: 2808b9d2b5ce15880b9ee3937bac0f534c81b66c3824fe44439ebfc7449ba52d7ad44e930cc21f201bedd1bc6b34a3d17f3d469aed62a534fc8e6cc005064a09
-  data.tar.gz: 2ddc2aeedb9648308e7bf39f7421d5ae5397addd9df7ed35e6f15e903c78b8c36c946df1a48e529e2cdd2de7629696e0e7caa67d0923d65d9b2b72f56aad7bcd
+  metadata.gz: dba9441882e19a730fe7863ac49ac196d6ac6b6ed4f55a1f086d2467c122cb58b7e57fb3dc27d0bfbddcaba9344a89992b59fce9c1f52edb44feb54e9a718b97
+  data.tar.gz: 75b810c93258bbb39b2973f97e029cd602d70a61314da9e08af1a13fcaea5ec2ea7067e424aa0a3358d5a9b1863937cefa3a095897214f6ca8f0453757fd5250

data/README.md

@@ -1,15 +1,34 @@
 # amdgpu-fan-rb
 
+[![Build Status](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb.svg?branch=master)](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb)
+
 A Ruby CLI to read and set the fan speed 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
 
-## Usage
+## 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
 
-➤  bin/amdgpu_fan help
+```
+➤  git clone https://github.com/HarlemSquirrel/amdgpu-fan-rb.git
+➤  cd amdgpu-fan-rb
+➤  bundle install
+➤  bin/amdgpu_fan
+```
+
+## Usage
+
+```
+➤  amdgpu_fan help
 Commands:
   amdgpu_fan auto             # Set mode to automatic (requires sudo)
   amdgpu_fan help [COMMAND]   # Describe available commands or one specific command
@@ -17,17 +36,25 @@ Commands:
   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
+➤  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
+
+➤  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-10 20:36:01 - Clock: 512Mhz Core, 500Mhz Memory,        Fan: 1838 rpm [|||       ]27%,  Load: [|||       ]28%,  Power: 15.12 W, Temp: 28.0°C
+2019-05-10 20:36:05 - Clock: 300Mhz Core, 500Mhz Memory,        Fan: 1837 rpm [|||||     ]49%,  Load: [          ]0%,   Power: 16.18 W, Temp: 29.0°C
+2019-05-10 20:36:09 - Clock: 512Mhz Core, 500Mhz Memory,        Fan: 1837 rpm [|||||     ]49%,  Load: [          ]0%,   Power: 15.11 W, Temp: 28.0°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)

data/lib/amdgpu_fan_cli.rb

@@ -4,12 +4,19 @@ require_relative '../config/environment'
 
 # The main class
 class AmdgpuFanCli < Thor
-  desc 'auto', 'Set mode to automatic (requires sudo)'
+  desc 'auto', 'Set fan mode to automatic (requires sudo)'
   def auto
     amdgpu_service.set_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 'set PERCENTAGE', 'Set fan speed to PERCENTAGE (requires sudo)'
   def set(percentage)
     return puts "Invalid percentage" unless (0..100).cover?(percentage.to_i)
@@ -23,14 +30,15 @@ class AmdgpuFanCli < Thor
 
   desc 'status', 'View device info, current fan speed, and temperature'
   def status
-    print_radeon_logo
-    puts "📺\tGPU:   #{amdgpu_service.name}",
+    puts radeon_logo,
+         "📺\tGPU:   #{amdgpu_service.name}",
          "📄\tvBIOS: #{amdgpu_service.vbios_version}",
+         clock_status,
          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}%"
+         "⚖\tLoad: #{percent_meter amdgpu_service.busy_percent, 20}"
   end
 
   desc 'watch [SECONDS]', 'Watch fan speed, load, power, and temperature ' \
@@ -42,26 +50,56 @@ class AmdgpuFanCli < Thor
          '  <Press Ctrl-C to exit>'
 
     trap "SIGINT" do
-      puts 'And now the watch is ended.'
+      puts "\nAnd 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, " \
+      puts "#{Time.now.strftime("%F %T")} - " \
+           "Clock: #{amdgpu_service.core_clock} Core, #{amdgpu_service.memory_clock} Memory,\t" \
+           "Fan: #{amdgpu_service.fan_speed_rpm} rpm #{percent_meter amdgpu_service.fan_speed_percent},\t" \
+           "Load: #{percent_meter amdgpu_service.busy_percent},\t" \
+           "Power: #{amdgpu_service.power_draw} W,\t" \
            "Temp: #{amdgpu_service.temperature}°C "
       sleep seconds.to_i
     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
+    "⏰\tClocks: #{amdgpu_service.core_clock} Core, " \
+    "#{amdgpu_service.memory_clock} Memory"
+  end
+
   def current_time
     Time.now.strftime("%F %T")
   end
@@ -71,7 +109,12 @@ class AmdgpuFanCli < Thor
      "#{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')
+  def percent_meter(percent, length = 10)
+    progress_bar_count = (length * percent.to_f / 100).round
+    "[#{'|' * progress_bar_count}#{' ' * (length - progress_bar_count)}]#{percent}%"
+  end
+
+  def radeon_logo
+    File.read(File.join(__dir__, '../lib/radeon_r_black_red_100x100.ascii'))
   end
 end

data/lib/amdgpu_service.rb

@@ -20,6 +20,16 @@ class AmdgpuService
     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 "/sys/class/drm/card#{card_num}/device/pp_dpm_sclk"
+  end
+
   def fan_mode
     FAN_MODES[File.read(fan_mode_file).strip] || 'unknown'
   end
@@ -40,6 +50,10 @@ class AmdgpuService
     File.read(fan_input_file).strip
   end
 
+  def memory_clock
+    clock_from_pp_file "/sys/class/drm/card#{card_num}/device/pp_dpm_mclk"
+  end
+
   def name
     lspci_subsystem.split(': ')[1].strip
   end
@@ -84,6 +98,14 @@ class AmdgpuService
     @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
@@ -113,7 +135,7 @@ class AmdgpuService
   end
 
   def power_max_file
-    @power_avg_file ||= Dir.glob("#{base_card_folder}/**/power1_cap").first
+    @power_max_file ||= Dir.glob("#{base_card_folder}/**/power1_cap").first
   end
 
   def power_raw_to_watts(raw_string)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin McCormack
@@ -42,8 +42,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.0.3
 signing_key: 
 specification_version: 4
 summary: A CLI to view and set fan speeds for AMD graphics cards running on the open