amdgpu_fan 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab8784cb1b68ab424942a5c7f2b4c11d9b15ef664529d8029b3c1cc03d4c4ffe
-  data.tar.gz: c2be64896c2d981b6462e4df7ff4e060a78663d55b51ff270f0c6089ec26a855
+  metadata.gz: 7f57ebc2011d08efe82baa67964bf75a17dfe7c85a518249a93c7b6eeadf207e
+  data.tar.gz: 1e1fa6d5af4f3cecc5346003949eb4a1edeb1c1ef943e60478f09cd8e3600099
 SHA512:
-  metadata.gz: db7e5229ca97968edf84e563d0a626777e053922969e3f03a0e801b30ed5108971bc0679fdecc582c9d9920f52ac35e24af9800fd10cf9755a51f3ca222daa9e
-  data.tar.gz: 963a1876d6ef7b00f3693035bc181d245268c9d528344e4cb1eec1af45c8d85305a6c292d93cc3340b68facc2d85d30df452ee81df882e062c7adbfcdef4b5e0
+  metadata.gz: a185688066129ae01860f6dcf15fa75d84b5441f0cf3fbf23df812986c8da194eb6ed00557afe607299d6d3640beed3b5dc60483b1e6155d09d4e40180865793
+  data.tar.gz: 2ef75cd3c949fd579eaf855c63ca985a1ddff172e41fceb46dd10b5f1177e0ddaf7f74427e3ce64c26a86ac15da473806f400014abaf428fb7275f075cd79069

data/README.md

@@ -75,8 +75,30 @@ Watching Advanced Micro Devices, Inc. [AMD/ATI] Radeon R9 FURY X / NANO every 3
 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](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/config/environment.rb

@@ -3,9 +3,12 @@
 require 'thor'
 
 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/cli.rb

@@ -1,10 +1,14 @@
 # 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.'
@@ -52,18 +56,23 @@ module AmdgpuFan
     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 " \
+      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}%)",
-           "⚖  #{'Load:'.ljust(9)} #{percent_meter amdgpu_service.busy_percent, 20}"
+           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 ' \
@@ -91,6 +100,35 @@ module AmdgpuFan
       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)

data/lib/amdgpu_fan/service.rb

@@ -37,6 +37,10 @@ module AmdgpuFan
       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

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,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: amdgpu_fan
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
-dependencies: []
+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:
@@ -20,6 +62,7 @@ files:
 - README.md
 - bin/amdgpu_fan
 - config/environment.rb
+- config/icons.yml
 - lib/amdgpu_fan.rb
 - lib/amdgpu_fan/cli.rb
 - lib/amdgpu_fan/connector.rb
@@ -27,6 +70,9 @@ files:
 - 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