bobcat-miner 0.14.11

A command line tool used to automate the Bobcat miner. This project also offers a robust python SDK's for interacting with the Bobcat miner.

bobcat miner python

A command line tool used to automate the Bobcat miner. This project also offers a robust python SDK's for interacting with the Bobcat miner.

Install

pipx install bobcat-miner

Please see this guide for more information about installing stand alone command line tools with pipx.

Quick Start

Automatically diagnose and repair the Bobcat miner!

bobcat autopilot
✅ Online Status: Online ⭐
✅ Sync Status: Synced (gap:-1) 💫
✅ Relay Status: Not Relayed ✨
✅ Network Status: Good 📶
✅ Temperature Status: Good (38°C) ☀️

or run with the official Docker image

docker run --rm -it aidanmelen/bobcat autopilot

Run bobcat --help to learn about the available sub-commands and options.

Finding your Bobcat

By default, the Bobcat Autopilot will search the common 192.168.0.0/24 and 10.0.0.0/24 local networks to find the Bobcat miner.

Find Bobcat by Animal Name

This will connect to the Bobcat on your network that matches the animal name.

bobcat --animal "Fancy Awesome Bobcat" -C DEBUG autopilot
🐛 Connected to Bobcat: 192.168.0.10
🐛 Refresh: Miner Data
🐛 Verified Bobcat Animal: fancy-awesome-bobcat
🐛 The Bobcat Autopilot is starting 🚀 🚀 🚀

Specify the Hostname / IP Address

Otherwise, follow these instructions to find your Bobcats's ip address and specify it with:

bobcat --ip-address 192.168.0.10 -C DEBUG autopilot
🐛 Connected to Bobcat: 192.168.0.10
🐛 The Bobcat Autopilot is starting 🚀 🚀 🚀

Monitoring with Discord

Monitor your Bobcat remotely by sending events to a Discord channel by specifying a webhook URL. No need for VPN or SSH agent setup!

bobcat --discord-webhook-url https://discord.com/api/webhooks/xxx autopilot
✅ Online Status: Online ⭐
✅ Sync Status: Synced (gap:0) 💫
⚠️ Relay Status: Relayed
✅ Network Status: Good 📶
❌ Temperature Status: Hot (78°C) 🌋

By default, all events WARNING or higher (i.e. ERROR and CRITICAL) will be sent to the Discord channel. This can be configured to include DEBUG and INFO events as well.

Dry Run

This example is admittedly contrived, but it demonstrates how the --dry-run option can be used show what actions would normally be performed against the bobcat without actually running them.

bobcat --dry-run reboot
Are you sure you want to restart your hotspot? [y/N]: y
⚠️ Dry run is enabled: Reboot Skipped

Bobcat SDK

Please see the Bobcat SDK Docs for more information.

Contributions

Please see the Contributions Docs for more information. This document includes sections for Development, Test and Release.

DIY Troubleshooting

Please see No Witness's Troubleshooting Guide for more information.

Donations

Donations are welcome and appreciated! :gift:

HNT: 14HmckNU4WHDDtGH29FMqVENzZAYh5a9XRiLfY2AN6ghfHMvAuR