Rules

Awesome Miner uses rules to define actions to be performed when a certain condition (trigger) is met. There are two kind of rules:
  • Predefined rules: These rules are included in Awesome Miner and cannot be removed, only disabled. The actions of a predefined rule can be modified, but only limited changes to the triggers are allowed.
  • User defined rules: These rules are defined by the user of Awesome Miner and both triggers and actions can be fully configured.
The configuration of rules are performed in the Options dialog, Rules section, illustrated below. Awesome Miner rules

Configure a rule

This section describes the settings that can be configured for a specific rule.

A rule consists of one or more triggers and one or more actions. If the conditions of the triggers are met, all the defined actions will be performed.

The rule configuration dialog where triggers and actions can be configured are displayed below.

Awesome Miner rule configuration

Settings

Configuration of the name of the rule and selection of which miners the rule should apply to.

Triggers

Configuration of triggers for the rule. One or more triggers can be added.

These are the supported trigger types:
  • Check statistics: Trigger on miner statistics like accepted, rejected and HW errors
  • Offline detection: Trigger if a miner goes offline
  • Detect dead/sick devices: Trigger if a device (for example a GPU) is either sick or dead.
  • Detect found blocks: Trigger if a block is found during mining
  • Detect pool: Trigger if a pool is either present or missing
  • Device temperature: Trigger if the temperature of a device (for example a GPU) is either too high or too low
  • Time: Trigger on a specific time, day or on a regular interval
  • Ping: Trigger if a ping response was received or not
  • Detect miner API connection established: Trigger when the API connection to a miner is established
  • C# Script: Develop a custom C# script to define a trigger. For advanced users only

If Match all is selected, the conditions for all triggers must be met to trigger the actions. If Match at least one is selected, only the conditions for at least one trigger must be met.

Actions

These are the supported actions types:
  • Create notification: Creates an information or warning notification. If the notification configuration is set to display desktop notifications and/or send e-mail messages, these actions will also be performed
  • Send e-mail: Send an e-mail message
  • Run executable: Run an external application or command
  • Miner command: Send a command to the miner(s), for example to start, stop, restart, reboot computer or to change pool
  • Device command: Send a command to the miner(s) to change device settings, for example to enable or disable a GPU or ASIC device or to change GPU speed
  • SSH command: Send SSH commands to either the miner(s) or to any other computer with SSH enabled
  • Antminer command: Change Antminer frequency
  • Highlight miner: The miner will be highlighted with a color in the Miners tab in the Awesome Miner main window
  • Wait: Wait a specified number of seconds before the next action is executed
  • Run profit switching: Manually trigger the profit switcher to run
  • C# Script: Develop a custom C# script that will be executed

Support manual activation: Instead of, or in addition to, the defined triggers, this features allows a rule to be triggered manually. When enabled, a button with all the rules supporting manual activation will be displayed in the toolbar of the Awesome Miner main window. The toolbar button name is Actions and will expand a sub menu with all available rules.

Example configuration

The screenshot below shows an example of a Check statistics trigger that is configured to check if the current hash rate is less than (or equal) to 4 MH/s.

Awesome Miner cgminer statistics

The screenshot below shows an example of a Create notification action that is configured to display an information message.

Awesome Miner action
Back to help section