bobcat-miner 0.5.1

A python SDK for interacting with the bobcat miner.

bobcat-miner

A python SDK for interacting with the bobcat miner.

Install

pip install bobcat-miner

Autopilot Usage

Follow these instructions to find the bobcat miner's ip address.

BOBCAT_IP_ADDRESS="192.168.1.100" bobcat-autopilot

Bobcat Usage

import bobcat_miner

bobcat = bobcat_miner.Bobcat("192.168.1.100")

# refresh
bobcat.refresh_status()
bobcat.refresh_miner()
bobcat.refresh_speed()
bobcat.refresh_temp()
bobcat.refresh_dig()
bobcat.refresh()

# properties
bobcat.status
bobcat.gap
bobcat.miner_height
bobcat.blockchain_height
bobcat.epoch
bobcat.tip
bobcat.ota_version
bobcat.region
bobcat.frequency_plan
bobcat.animal
bobcat.name
bobcat.pubkey
bobcat.state
bobcat.miner_status
bobcat.names
bobcat.image
bobcat.created
bobcat.p2p_status
bobcat.ports_desc
bobcat.ports
bobcat.private_ip
bobcat.public_ip
bobcat.peerbook
bobcat.peerbook_miner
bobcat.peerbook_listen_address
bobcat.peerbook_peers
bobcat.timestamp
bobcat.error
bobcat.temp0
bobcat.temp1
bobcat.temp0_c
bobcat.temp1_c
bobcat.temp0_f
bobcat.temp1_f
bobcat.download_speed
bobcat.upload_speed
bobcat.latency
bobcat.dig_name
bobcat.dig_message
bobcat.dig_dns
bobcat.dig_records

# actions
bobcat.ping()
bobcat.reboot()
bobcat.reset()
bobcat.resync()
bobcat.fastsync()

Advanced Usage

import bobcat_miner

bobcat = bobcat_miner.Bobcat("192.168.1.100")
autopilot = bobcat_miner.Autopilot(bobcat)

# diagnostics
autopilot.diagnose_relay()
autopilot.diagnose_temp()
autopilot.diagnose_network_speed()
autopilot.diagnose_sync()

# actions
autopilot.ping()        # repeat ping attempts until bobcat is reached or exceeds max attempts
autopilot.reboot()      # reset and wait for bobcat to connect
autopilot.reset()       # reset and wait for health check
autopilot.resync()      # resync and wait for health check
autopilot.fastsync()    # repeat fastsync attempts until gap is less than 400 or exceeds max attempts
autopilot.autosync()    # check sync -> reboot -> check sync -> fastsync -> check sync
autopilot.is_syncing()  # Poll the Bobcat's gap to see if it is syncing over time

autopilot.run()         # reboot -> reset -> fastsync when bobcat is unhealthy and diagnostics

Troubleshooting

Please see No Witness's Troubleshooting Guide for more information troubleshooting your bobcat miner.

https://bobcatminer.zendesk.com/hc/en-us/articles/4408443160347-Troubleshooting-your-Bobcat-hotspot

Donations

Donations are welcome and appreciated! :gift: :tada:

HNT: 14HmckNU4WHDDtGH29FMqVENzZAYh5a9XRiLfY2AN6ghfHMvAuR