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.3.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

bambulabs_api-2.1.3-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 574ff3d362fe37dc7f92ceccc4e395e3ce53c74b2a63c98db7e9d0fa1d07a8f5
MD5 f2b2539d098d80a3d840b8758fd0c884
BLAKE2b-256 ab17baaf0148ea750be5f6901268ef8d5594f5e949bb98f3b0e7f8733f20ce80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7df75fb66cceda6cc1d7246c1cd8352a1facfd6959216a609444c5ff6ca1da0d
MD5 45541777f3e3cf530f68e425b36710ab
BLAKE2b-256 e2e6c0f6da4d60c6e1fbf71fdd4570575c923119bff3bd90610890e6f06d972b

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