Skip to main content

A python SDK for interacting with the bobcat miner.

Project description

PyPI Tests

bobcat-miner

A python SDK for interacting with the bobcat miner.

Install

pip install bobcat-miner

Autopilot Usage

:information_source: 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()

:warning: Both bobcat.refresh_speed() or bobcat.refresh() take about 30 seconds to complete and you should not call them repeatedly. Doing so will slow down your internet speed, which in turn will slow down your miner.

Advanced Usage

import bobcat_miner

autopilot = bobcat_miner.Autopilot(bobcat)

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

# actions
autopilot.run()
autopilot.reboot_reset_fastsync()
autopilot.wait()

:warning: Both autopilot.autopilot.is_local_network_slow take about 30 seconds to complete and you should not call them repeatedly. Doing so will slow down your internet speed, which in turn will slow down your miner.

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

HNT: 14HmckNU4WHDDtGH29FMqVENzZAYh5a9XRiLfY2AN6ghfHMvAuR

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bobcat-miner-0.4.0.tar.gz (13.3 kB view hashes)

Uploaded Source

Built Distribution

bobcat_miner-0.4.0-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page