Skip to main content

API for BambuLabs 3D Printers over MQTT

Project description

Bambulabs API

This package provides a Python API for the Bambulabs 3D Printers.

Status

flake8

pytest-unit-tests

GitHub Pages

Documentation

The documentation for this package can be found here.

Usage

To use the package, run the following command in the terminal:

pip install bambulabs_api

Examples

import bambulabs_api as bl

IP = '192.168.1.200'
SERIAL = 'AC12309BH109'
ACCESS_CODE = '12347890'

if __name__ == '__main__':
    print('Starting bambulabs_api example')
    print('Connecting to Bambulabs 3D printer')
    print(f'IP: {IP}')
    print(f'Serial: {SERIAL}')
    print(f'Access Code: {ACCESS_CODE}')

    # Create a new instance of the API
    printer = bl.Printer(IP, SERIAL, ACCESS_CODE)

    # Connect to the Bambulabs 3D printer
    printer.connect()

    # Get the printer status
    status = printer.get_state()
    print(f'Printer status: {status}')

    # Disconnect from the Bambulabs 3D printer
    printer.disconnect()

Development

To install the package, make sure conda is installed and then run the following commands in the terminal:

# Clone the repository
git clone https://github.com/acse-ci223/bambulabs_api.git

# Change directory
cd bambulabs_api

# Create the 'parally' environment
conda env create -f environment.yml

# Activate the environment
conda activate blapi

# Install the package
pip install -e .

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

bambulabs_api-2.1.8.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

bambulabs_api-2.1.8-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file bambulabs_api-2.1.8.tar.gz.

File metadata

  • Download URL: bambulabs_api-2.1.8.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for bambulabs_api-2.1.8.tar.gz
Algorithm Hash digest
SHA256 5d5fb5f230ae3ec7c93962f581f8a4e36f135ac883adfc5ec0d550c4150f0a34
MD5 55a102ba38db0a5389783b40c960c60d
BLAKE2b-256 9d8f4cd369f5b136e7e278505616c59ba42ab578ec432ceefa819bf1d21f6814

See more details on using hashes here.

File details

Details for the file bambulabs_api-2.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for bambulabs_api-2.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6958d49982f9291ba9ce16d7d22878d042bf490ac7894d278a3ad1c942e2d8d8
MD5 fe8a2ff56eec1dfa4485dbc6cfad04b2
BLAKE2b-256 05afe989f7fce8f002ed075c172e55e5035c5ba3ddd979d4a0db00423fa8bbb0

See more details on using hashes here.

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