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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.1.13.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.13.tar.gz
Algorithm Hash digest
SHA256 a84cafc445291bef1f3c657ef19d3926805900ec9c5eb7f6fb07cbcbdee40a2f
MD5 e67de3be48053ccbebf7c93eaf2f7208
BLAKE2b-256 7308f89dcc1f03db8e2d27b1310f7e4971ee6d658bd8a9b88026c77395200d83

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 9e202c1340b14683a12e99b2f876fbd3e5441a034a162fe67e2e93004a57d01a
MD5 d9730ed62e5e1ea9bb234e3c054cf63d
BLAKE2b-256 02018b86736381663f91a3b7677a4bbeb1d1dbf1c6f077a7fdffd7b10f18a056

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