pifan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68ad632c8933be7ae9aee5b0d04ed6fa916ebabf81001f37863afba54c40cb5d
+  data.tar.gz: 84363ab0a93c667e16895e38d094f3509fd1de532f22b2ef107c3e7dffbff228
+SHA512:
+  metadata.gz: a1e3cd11d5dd543b1710d81068945d23afd0c8142d97da39980cbf26ad69f4272728171adc17519e5930b4b6291ef159c521a223ec3ea8a057a094b00118edf5
+  data.tar.gz: 34fde7d79f1821ed8561f355a2e17bd3e6a8c7b8f4ba03bc5498d481c1de1476264d45d487f9ad8f02020d1b86347c2fb984cc19cf1b221eaa0818fc450e27f2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - '*.gemspec'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pifan.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Pifan - Control your Raspberry Pi fan
+Copyright (C) 2021  Michal Kimle
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,67 @@
+# Pifan
+**Control your Raspberry Pi fan**
+
+Pifan is a daemon adjusting your fan's strength based on your Raspberry Pi's temperature.
+
+The whole project was inspired and based on this [instructable](https://www.instructables.com/PWM-Regulated-Fan-Based-on-CPU-Temperature-for-Ras/). Many thanks to the author [Aerandir14](https://www.instructables.com/member/Aerandir14/)!
+## Hardware configuration
+The most basic configuration is depicted on the following schematics:
+
+<img src="schematics/pifan-breadboard.png" width="800"/>
+<br/>
+<img src="schematics/pifan-schematic.png" width="800"/>
+
+This is the most common setup with **5V** fan rated for **200mA**. If you have different components, read through the [instructable](https://www.instructables.com/PWM-Regulated-Fan-Based-on-CPU-Temperature-for-Ras/), you can find instructions on how to calculate the correct values for your setup.
+
+## Installation
+### Arch Linux
+You can install the [`pifan`](https://aur.archlinux.org/packages/pifan) package from AUR.
+```bash
+yay -S pifan
+```
+
+### RubyGems.org
+To install the most recent stable version:
+```bash
+gem install pifan
+```
+
+### Source (development)
+**Installation from source should never be your first choice! Especially, if you are not familiar with RVM, Bundler, Rake and other dev tools for Ruby!**
+
+**However, if you wish to contribute to my project, this is the right way to start.**
+
+To build and install the bleeding edge version from master:
+```bash
+git clone git://gitlab.com/amarthadan/pifan.git
+cd pifan
+gem install bundler
+bundle install
+```
+
+## Configuration
+Configuration is read from `/etc/pifan/pifan.yml` (file is automatically created when installed [via package method](#arch-linux)). Sample (and also the default) configuration file can be found at [`config/pifan.yml`](config/pifan.yml).
+
+Pifan can be also controlled via CLI options. Run
+```bash
+pifan -h
+```
+to list all the available options.
+
+## Usage
+You can run Pifan manually via `pifan` command. This is particularly useful in order to figure out the correct configuration for your setup. Once you know the correct values, you can use [`systemd/pifan.service`](systemd/pifan.service) systemd unit to control Pifan as a daemon (service unit is automatically available when installed [via package method](#arch-linux)).
+
+```bash
+sudo systemctl enable pifan
+sudo systemctl start pifan
+```
+
+## Development & contribution
+Contributions are very welcome! To setup the project for development follow the [installation from source](#source-development) instructions.
+
+Contribution flow:
+1. Fork it (https://gitlab.com/amarthadan/pifan/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Merge Request

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/pifan

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pifan'
+
+SIGINT = 2
+SIGTERM = 15
+SIGNALS = [SIGTERM, SIGINT].freeze
+
+cli = Pifan::CLI.new
+config = Pifan::Config.new
+
+cli.parse
+options = cli.run
+config = config.read
+
+parameters = config.merge(options)
+
+Pifan::Logging.level = :debug if parameters[:debug]
+
+Pifan::Logging.logger.debug "Starting pifan #{Pifan::VERSION}"
+Pifan::Logging.logger.debug "Configuration: #{parameters}"
+
+abort 'Refresh time has to be at least 1 second' if parameters[:refresh_time] < 1
+if parameters[:temperature_steps].length != parameters[:speed_steps].length
+  abort 'Temperature and speed steps arrays have to be of the same length'
+end
+
+begin
+  process = Pifan::Process.new parameters
+  process.start
+rescue SignalException => e
+  raise e unless SIGNALS.include? e.signo
+
+  Pifan::Logging.logger.debug 'Running cleanup'
+  process.cleanup
+  Pifan::Logging.logger.debug 'Terminating'
+end

data/config/pifan.yml

@@ -0,0 +1,9 @@
+control-pin: 15       # Controll PIN
+refresh-time: 1       # [s] Time to wait between each refresh
+pwm-frequency: 25     # [Hz]
+temperature-steps:    # [°C]
+  - 50
+  - 70
+speed-steps:          # [%]
+  - 0
+  - 100

data/lib/pifan.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+module Pifan
+  autoload :Logging, 'pifan/logging'
+  autoload :CLI, 'pifan/cli'
+  autoload :Config, 'pifan/config'
+  autoload :Process, 'pifan/process'
+end
+
+require 'pifan/version'

data/lib/pifan/cli.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'tty-option'
+
+module Pifan
+  class CLI
+    include TTY::Option
+
+    usage do
+      no_command
+
+      desc 'Control your Raspberry Pi fan'
+    end
+
+    flag :help do
+      short '-h'
+      long '--help'
+      desc 'Print usage'
+    end
+
+    flag :version do
+      short '-v'
+      long '--version'
+      desc 'Print version'
+    end
+
+    flag :debug do
+      short '-d'
+      long '--debug'
+      desc 'Run in debug mode'
+      default false
+    end
+
+    option :control_pin do
+      short '-p'
+      long '--control-pin pin'
+      desc 'Pin to control Raspberry Pi fan with'
+      optional
+      convert :int
+    end
+
+    option :refresh_time do
+      short '-t'
+      long '--refresh-time time'
+      desc 'Time to wait between each refresh in seconds'
+      optional
+      convert :int
+    end
+
+    option :pwm_frequency do
+      short '-f'
+      long '--pwm-frequency frequency'
+      desc 'PWM frequency in Hz'
+      optional
+      convert :int
+    end
+
+    option :temperature_steps do
+      long '--temperature-steps steps'
+      desc 'Temperature steps in °C'
+      optional
+      convert :ints
+    end
+
+    option :speed_steps do
+      long '--speed-steps steps'
+      desc 'Speed steps in percents'
+      optional
+      convert :ints
+    end
+
+    def run
+      if params[:help]
+        print help
+        exit
+      elsif params[:version]
+        $stdout.puts Pifan::VERSION
+        exit
+      else
+        params.to_h
+      end
+    end
+  end
+end

data/lib/pifan/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'tty-config'
+
+module Pifan
+  class Config
+    def initialize
+      @config = TTY::Config.new
+      @config.filename = 'pifan'
+      @config.extname = '.yml'
+      @config.append_path('/etc/pifan')
+      @config.append_path("#{File.dirname(__FILE__)}/../../config")
+    end
+
+    def read
+      @config.read.deep_transform_keys { |key| key.underscore.to_sym }
+    end
+  end
+end

data/lib/pifan/logging.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'tty-logger'
+
+module Pifan
+  module Logging
+    class << self
+      def level
+        @level ||= :error
+      end
+
+      def logger
+        @logger ||= TTY::Logger.new do |config|
+          config.level = level
+        end
+      end
+
+      attr_writer :logger, :level
+    end
+
+    def self.included(base)
+      class << base
+        def logger
+          Logging.logger
+        end
+      end
+    end
+
+    def logger
+      Logging.logger
+    end
+  end
+end

data/lib/pifan/process.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'rpi_gpio'
+
+CPU_TEMP_FILENAME = '/sys/class/thermal/thermal_zone0/temp'
+
+module Pifan
+  class Process
+    include Pifan::Logging
+
+    def initialize(parameters)
+      @control_pin = parameters[:control_pin]
+      @refresh_time = parameters[:refresh_time]
+      @pwm_frequency = parameters[:pwm_frequency]
+      @temp_steps = parameters[:temperature_steps]
+      @speed_steps = parameters[:speed_steps]
+
+      RPi::GPIO.set_numbering :bcm
+      RPi::GPIO.setup @control_pin, as: :output, initialize: :low
+      @fan = RPi::GPIO::PWM.new(@control_pin, @pwm_frequency)
+      @fan.start(0)
+    end
+
+    def start
+      hyst = 1
+      cpu_temp_old = 0
+      fan_speed_old = 0
+
+      # Run at full speed for 2 secs to avoid not starting at small speed
+      @fan.duty_cycle = 100
+      sleep 2
+
+      loop do
+        cpu_temp_current = cpu_temp
+        logger.debug("New temperature: #{cpu_temp_current}")
+
+        if (cpu_temp_current - cpu_temp_old).abs > hyst
+          fan_speed_current = fan_speed
+          if fan_speed_current != fan_speed_old
+            logger.debug("New fan speed: #{fan_speed_current}")
+            @fan.duty_cycle = fan_speed_current
+            fan_speed_old = fan_speed_current
+          end
+
+          cpu_temp_old = cpu_temp_current
+        end
+
+        sleep @refresh_time
+      end
+    end
+
+    def cleanup
+      RPi::GPIO.clean_up
+    end
+
+    private
+
+    def cpu_temp
+      File.read(CPU_TEMP_FILENAME).to_f / 1000
+    end
+
+    def fan_speed
+      if cpu_temp <= @temp_steps.first
+        @speed_steps.first
+      elsif cpu_temp >= @temp_steps.last
+        @speed_steps.last
+      else
+        more_index = @temp_steps.find_index { |n| cpu_temp < n }
+        less_index = more_index - 1
+
+        speed_interpolation less_index, more_index
+      end
+    end
+
+    def speed_interpolation(less_index, more_index)
+      ((@speed_steps[more_index] - @speed_steps[less_index]) / \
+        (@temp_steps[more_index] - @temp_steps[less_index]) * \
+        (cpu_temp - @temp_steps[less_index]) + \
+        @speed_steps[less_index]).round 1
+    end
+  end
+end

data/lib/pifan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pifan
+  VERSION = '1.0.0'
+end

data/pifan.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pifan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pifan'
+  spec.version       = Pifan::VERSION
+  spec.authors       = ['Michal Kimle']
+  spec.email         = ['kimle.michal@gmail.com']
+
+  spec.summary       = 'Control your Raspberry Pi fan'
+  spec.description   = "Pifan is a daemon adjusting your fan's strength based on your Raspberry Pi's temperature."
+  spec.homepage      = 'https://gitlab.com/amarthadan/pifan'
+  spec.license       = 'GPL-3.0-only'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.92'
+
+  spec.add_runtime_dependency 'activesupport', '~> 6.0'
+  spec.add_runtime_dependency 'rpi_gpio', '~> 0.5'
+  spec.add_runtime_dependency 'tty-config', '~> 0.4'
+  spec.add_runtime_dependency 'tty-logger', '~> 0.5'
+  spec.add_runtime_dependency 'tty-option', '~> 0.1'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+end

data/systemd/pifan.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=Pifan Daemon
+
+[Service]
+ExecStart=/usr/bin/pifan
+RestartSec=1
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: pifan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michal Kimle
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.92'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.92'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rpi_gpio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tty-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Pifan is a daemon adjusting your fan's strength based on your Raspberry
+  Pi's temperature.
+email:
+- kimle.michal@gmail.com
+executables:
+- pifan
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/pifan
+- config/pifan.yml
+- lib/pifan.rb
+- lib/pifan/cli.rb
+- lib/pifan/config.rb
+- lib/pifan/logging.rb
+- lib/pifan/process.rb
+- lib/pifan/version.rb
+- pifan.gemspec
+- schematics/pifan-breadboard.png
+- schematics/pifan-schematic.png
+- systemd/pifan.service
+homepage: https://gitlab.com/amarthadan/pifan
+licenses:
+- GPL-3.0-only
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Control your Raspberry Pi fan
+test_files: []