{"id":26209973,"url":"https://github.com/steven-s-martins/bitaxe-notifier","last_synced_at":"2026-04-12T08:37:21.254Z","repository":{"id":281801623,"uuid":"946463856","full_name":"steven-s-martins/bitaxe-notifier","owner":"steven-s-martins","description":"A Python-based monitoring and notification system for Bitaxes. This tool periodically checks the status of your Bitaxes and sends email notifications for important events.","archived":false,"fork":false,"pushed_at":"2025-03-11T07:38:16.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-19T17:26:58.293Z","etag":null,"topics":["bitaxe","bitaxe-miner","bitcoin","mining"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steven-s-martins.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-11T07:18:03.000Z","updated_at":"2025-03-11T07:38:19.000Z","dependencies_parsed_at":"2025-03-11T08:29:52.961Z","dependency_job_id":"5239983d-42ca-4ae3-b34d-4f0eed8a176c","html_url":"https://github.com/steven-s-martins/bitaxe-notifier","commit_stats":null,"previous_names":["steven-s-martins/bitaxe-notifier"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/steven-s-martins/bitaxe-notifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-s-martins%2Fbitaxe-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-s-martins%2Fbitaxe-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-s-martins%2Fbitaxe-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-s-martins%2Fbitaxe-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steven-s-martins","download_url":"https://codeload.github.com/steven-s-martins/bitaxe-notifier/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-s-martins%2Fbitaxe-notifier/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31709294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-12T06:22:27.080Z","status":"ssl_error","status_checked_at":"2026-04-12T06:21:52.710Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitaxe","bitaxe-miner","bitcoin","mining"],"created_at":"2025-03-12T07:18:38.469Z","updated_at":"2026-04-12T08:37:21.232Z","avatar_url":"https://github.com/steven-s-martins.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitaxe Notifier\n\nA Python-based monitoring and notification system for Bitaxes. This tool periodically checks the status of your Bitaxes and sends email notifications for important events.\n\n## Features\n\n- **Multi-Bitaxe Support**: Monitor multiple Bitaxes simultaneously\n- **Email Notifications**: Get alerts for:\n  - Overheating\n  - New all-time best difficulty achievements\n  - New session best difficulty achievements\n- **Configurable Settings**: Customize polling interval and notification preferences\n- **Logging**: Comprehensive logging to both console and file\n\n## Requirements\n\n- Python 3.6+\n- A Gmail account (for sending notifications)\n- One or more Bitaxes on your network\n\n## Installation\n\n1. Clone this repository:\n   ```bash\n   git clone https://github.com/steven-s-martins/bitaxe-notifier.git\n   cd bitaxe-notifier\n   ```\n\n2. Install the required dependencies:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n3. Create your configuration file:\n   ```bash\n   cp .env.example .env\n   ```\n\n4. Edit the `.env` file with your specific settings:\n   - Add the IPs and names of your Bitaxes\n   - Configure your Gmail credentials\n   - Adjust notification preferences as needed\n\n## Gmail App Password Setup\n\nTo send email notifications, you'll need to create an App Password for your Gmail account:\n\n1. First, enable 2-Step Verification on your Google account:\n   - Go to your Google Account settings\n   - Navigate to Security \u003e [2-Step Verification](https://myaccount.google.com/signinoptions/twosv)\n   - Add and set up a 2-Step Verification method (like SMS, authenticator app, etc.)\n   - Click \"Turn on 2-Step Verification\"\n\n2. Once 2-Step Verification is enabled, create an App Password:\n   - Search for the [App passwords](https://myaccount.google.com/apppasswords) page\n   - Enter a name like \"Bitaxe Notifier\"\n   - Click \"Create\"\n   - Copy the 16-character password that appears\n\n3. Use this generated password in your `.env` file as the `GMAIL_APP_PASSWORD` value\n\nNote: App passwords are only available if you've enabled 2-Step Verification on your Google account.\n\n## Usage\n\nRun Bitaxe Notifier:\n\n```bash\npython bitaxe-notifier.py\n```\n\nThe program will:\n1. Check your configuration\n2. Connect to your Bitaxes\n3. Begin monitoring according to your settings\n4. Send email notifications when specified events occur\n\nTo run in the background or as a service, consider using tools like `systemd`, `supervisor`, or `screen`.\n\n## Configuration Options\n\n| Setting | Description | Default |\n|---------|-------------|---------|\n| `BITAXE_X_IP` | IP address of your Bitaxe | Required |\n| `BITAXE_X_NAME` | Custom name for your Bitaxe | \"Bitaxe X\" |\n| `GMAIL_USER` | Your Gmail address | Required |\n| `GMAIL_APP_PASSWORD` | Your Gmail app password | Required |\n| `RECIPIENT` | Email address to receive notifications | Required |\n| `POLLING_INTERVAL_SECONDS` | How often to check Bitaxes (in seconds) | 60 |\n| `NOTIFY_ON_OVERHEAT` | Send notifications when overheat mode is activated | true |\n| `NOTIFY_ON_NEW_BEST_DIFFICULTY` | Send notifications for all-time best difficulties | true |\n| `NOTIFY_ON_NEW_BEST_SESSION_DIFFICULTY` | Send notifications for session best difficulties | true |\n\n## Logging\n\nLogs are written to both the console and `bitaxe-notifier.log` in the application directory.\n\n## License\n\n[MIT License](LICENSE)\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteven-s-martins%2Fbitaxe-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteven-s-martins%2Fbitaxe-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteven-s-martins%2Fbitaxe-notifier/lists"}