arvicco-avalon 0.0.12 → 0.0.14

data/README.md

@@ -1,10 +1,12 @@
-# Avalon
+# arvicco-avalon
 
-Helper scripts for Bitcoin and Avalon miners management...
+Helper scripts for Bitcoin mining units management...
 
 ## Description
 
-Congrats, you've got a few Avalon miners. It's all nice and dandy, but now you need to keep an eye on them to make sure they are always online and their valuable hashes are not wasted. This set of scripts is written to do just that. You run a monitor scipt non-stop and it keeps an eye on your Avalons, your (private) pool and your Internet connection, and alerts you as soon as there are any problems. The scripts should work on OSX and Linux (Windows users, move on).
+Congrats, you've got a few Bitcoin miners. It's all nice and dandy, but now you need to keep an eye on them to make sure they are always online and their valuable hashes are not wasted. This set of scripts is written to do just that. You run a monitor scipt non-stop and it keeps an eye on your mining units, your (private) pool and your Internet connection, and alerts you in case of any problems. The scripts should work on OSX and Linux (Windows users, move on).
+
+Initially, the scripts were used to manage an installation of Avalon miners, but they work just as well with any cgminer (or bfgminer) based device with known IP address and cgminer API enabled. It's been proven to work on such exotic devices as Raspberry Pi attached to Block Eruptor Blades as well as normal computers with FPGA or GPU attached. So, you can easily monitor all your mining zoo from one central location.
 
 ## Usage
 
@@ -18,17 +20,17 @@ Scripts:
 
 - Transcodes raw transaction from base64 (mtgox) to hex (blockchain) format
 
-## Installation
+## Script Installation
 
 You need Ruby 1.9 to install the scripts. Once the Ruby is installed, it's just:
 
     $ gem install arvicco-avalon
 
-You need to be able to ssh with public keys (that is no password required) into any Pool or Bitcoind node for monitor to work. How to do it is beyound the scope of this Readme, just google it. You also need to create ~/.avalon/monitor.yml config file, see below.
+You also need to enable cgminer API in your miners and create ~/.avalon/monitor.yml config file, see below.
 
-## Configuration
+## Monitor Configuration
 
-Sample monitor config file for production environment below. Modify it, add your own nodes to be monitored (for Avalon miners, you have to indicate their IP address and min hashrate in Gh/s):
+Monitor script is periodically polling the mining units and other types of objects to be monitored (called Nodes). If any Node does not respond or returns an error, the monitor prints error message and sounds alert. You need to tell the monitor about your Miners and other Nodes to be polled via config file. Please note sample monitor config file for production environment below. Modify it, add your own Nodes to be monitored (for miners, you have to indicate their IP address and min hashrate in Gh/s):
 
     ------- ~/.avalon/monitor.yml --------
     # Prod configuration (default)
@@ -45,8 +47,17 @@ Sample monitor config file for production environment below. Modify it, add your
         :nodes:
           - [miner, 192.168.1.151, 70] # type, ip, gh/s
           - [miner, 192.168.1.152, 70]
-          - [eloipool, 192.168.1.13, 4] # frequency of old block updates (once per X polls)
           - [internet, www.google.com, www.speedtest.net]
+          - [eloipool, 192.168.1.13, 4] # frequency of old block updates (once per X polls)
+
+## Miner/Node Configuration
+
+The Mining units need to be configured so that monitor is able to poll them. Specifically you need to make cgminer API accessible from the IP address your Monitor script runs on. Normally, it is done by running cgminer with an option like: "--api-allow W:192.168.1.13" where 192.168.1.13 is IP address of your Monitor. For Avalon Miners, this can be configured via WebGui->CGminer Configuration->API Allow field.
+
+Detailed description of cgminer API and relevant startup options can be found here:
+https://github.com/ckolivas/cgminer/blob/master/API-README
+
+For any Pool or Bitcoind nodes you'd like to monitor, you need to be able to ssh with public keys (that is, no password required) into this Node, otherwise the Monitor won't be able to poll it. How to make it work is beyound the scope of this Readme, just google 'ssh without password'.
 
 ## License
 

data/lib/avalon/monitor.rb

@@ -20,6 +20,11 @@ module Avalon
         # Report node errors (if any)
         @nodes.each {|node| node.report}
 
+        if @verbose
+          total_hash = @nodes.reduce(0) {|hash, node| hash + (node[:mhs] || 0)}
+          puts "Total hash rate: #{total_hash}"
+        end
+
         sleep @timeout
 
       end

data/lib/avalon/version.rb

@@ -1,3 +1,3 @@
 module Avalon
-  VERSION = "0.0.12"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arvicco-avalon
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday