amdgpu_fan 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bd1ed519a47f577ba017c94f03ac02101767434796821120aef3f9e12d9ba9
-  data.tar.gz: 6d55c0d1c45d076d1409318332fade5d9038c8f4e64b86d8af2cb2d5eeb016df
+  metadata.gz: f831dbba03b1f54f0ed55055eea94371b658b4e797dae7899f3954b55e755a28
+  data.tar.gz: 9fa6dd181fbcae74b6441fe9a62200fb2be98be59c88d470a434c2b2730ea691
 SHA512:
-  metadata.gz: dba9441882e19a730fe7863ac49ac196d6ac6b6ed4f55a1f086d2467c122cb58b7e57fb3dc27d0bfbddcaba9344a89992b59fce9c1f52edb44feb54e9a718b97
-  data.tar.gz: 75b810c93258bbb39b2973f97e029cd602d70a61314da9e08af1a13fcaea5ec2ea7067e424aa0a3358d5a9b1863937cefa3a095897214f6ca8f0453757fd5250
+  metadata.gz: 92a2ab4778b838e1bbbe6607c8bb2ad4a5d9ec79f817f24fa03d5af460e73a857e2dd456b3fd0ca08ab58cc4a64924a981afd4a44c05be65dad449b65f56c1e9
+  data.tar.gz: 4b4d0cd42f4a0275e09230799c22c90eecf556a0adfa2918d579f43419878a2100f2230cb19491468b59dc1496badc71bfd9f6332c6fddb3d7cc7480f4c00b97

data/README.md

@@ -1,6 +1,6 @@
 # amdgpu-fan-rb
 
-[![Build Status](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb.svg?branch=master)](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb)
+[![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.
 
@@ -28,13 +28,18 @@ gem install amdgpu_fan
 ## Usage
 
 ```
-➤  amdgpu_fan help
+➤  bin/amdgpu_fan
 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 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
@@ -46,9 +51,16 @@ Commands:
 ➤  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
+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.
 ```

data/config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 require_relative '../lib/amdgpu_service'

data/lib/amdgpu_fan_cli.rb

@@ -4,22 +4,42 @@ 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.set_fan_mode! :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|
+    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)
+    return puts 'Invalid percentage' unless (0..100).cover?(percentage.to_i)
 
     amdgpu_service.set_fan_manual_speed! percent: percentage
     puts fan_status
@@ -28,57 +48,60 @@ class AmdgpuFanCli < Thor
     exit 1
   end
 
-  desc 'status', 'View device info, current fan speed, and temperature'
-  def status
-    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: #{percent_meter amdgpu_service.busy_percent, 20}"
+  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)
+  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
+    trap 'SIGINT' do
       puts "\nAnd now the watch is ended."
       exit 0
     end
 
     loop do
-      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
+      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)
+  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
+    trap 'SIGINT' do
       exit 0
     end
 
     loop do
-      puts [Time.now.strftime("%F %T"),
+      puts [Time.now.strftime('%F %T'),
             amdgpu_service.core_clock,
             amdgpu_service.memory_clock,
             amdgpu_service.fan_speed_rpm,
@@ -96,25 +119,49 @@ class AmdgpuFanCli < Thor
   end
 
   def clock_status
-    "⏰\tClocks: #{amdgpu_service.core_clock} Core, " \
-    "#{amdgpu_service.memory_clock} Memory"
+    "#{amdgpu_service.core_clock} Core, #{amdgpu_service.memory_clock} Memory"
   end
 
   def current_time
-    Time.now.strftime("%F %T")
+    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"
+    "#{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
-    "[#{'|' * progress_bar_count}#{' ' * (length - progress_bar_count)}]#{percent}%"
+    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

@@ -27,14 +27,14 @@ class AmdgpuService
   end
 
   def core_clock
-    clock_from_pp_file "/sys/class/drm/card#{card_num}/device/pp_dpm_sclk"
+    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 set_fan_mode!(mode)
+  def fan_mode=(mode)
     `echo "#{FAN_MODES.key(mode.to_s)}" | sudo tee #{fan_mode_file}`
   end
 
@@ -51,7 +51,7 @@ class AmdgpuService
   end
 
   def memory_clock
-    clock_from_pp_file "/sys/class/drm/card#{card_num}/device/pp_dpm_mclk"
+    clock_from_pp_file "#{base_card_folder}/pp_dpm_mclk"
   end
 
   def name
@@ -66,10 +66,31 @@ class AmdgpuService
     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
@@ -79,7 +100,7 @@ class AmdgpuService
 
     raise(self.class::Error, 'Invalid fan speed provided') if new_raw.to_s.empty?
 
-    set_fan_mode!(:manual) unless fan_mode == 'manual'
+    fan_mode = :manual unless fan_mode == 'manual'
 
     `echo "#{new_raw}" | sudo tee #{fan_power_file}`
   end
@@ -99,7 +120,7 @@ class AmdgpuService
   end
 
   def clock_from_pp_file(file)
-    File.read(file).slice /\w+(?= \*)/
+    File.read(file).slice(/\w+(?= \*)/)
   end
 
   def connectors_files
@@ -147,10 +168,10 @@ class AmdgpuService
   end
 
   def valid_fan_raw_speed?(raw)
-    (1..fan_speed_raw_max.to_i).include?(raw.to_i)
+    (1..fan_speed_raw_max.to_i).cover?(raw.to_i)
   end
 
   def valid_fan_percent_speed?(percent)
-    (1..100.to_i).include?(percent.to_i)
+    (1..100.to_i).cover?(percent.to_i)
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-11-17 00:00:00.000000000 Z
 dependencies: []
-description: A CLI for amdgpu fans
+description: A CLI for interacting with the amdgpu Linux driver
 email: harlemsquirrel@gmail.com
 executables:
 - amdgpu_fan
@@ -42,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A CLI to view and set fan speeds for AMD graphics cards running on the open