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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 6ee82e55be17278219bec364b3bab1adb34ce3944d07da053e9c2627551a3cd0
MD5 d14aafdd546b9f1b15885fee640ac287
BLAKE2b-256 49d7d2121fa4e25c2238c477a936ee2bb80b6f052ab0daf9a8e5b17e551bc750

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 acc011a3c886080ae615e9ee16ed259ed9ee73e011d789d4307386e5a786b300
MD5 cf89abb4ec0ad3b39e87863690d426f9
BLAKE2b-256 71db53948521eb128240edb97eb5b84200d1a5cbbf655bf5293f01e60a1f8fc5

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