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

Uploaded Source

Built Distribution

bambulabs_api-2.3.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.3.0.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.3.0.tar.gz
Algorithm Hash digest
SHA256 0b2a60ef249246e56341c1b83242f271ee8e306a8aad80ed508e0a83b9e589da
MD5 3b64fcf538904092386449541e1d5fb3
BLAKE2b-256 14876e10c301075730606e64f4bc0c596adc48fa7549fca0f709e962b0bc81ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e02c3d0ff20433a3527962b6a7b6e5575114602434772b4f498315261a16f359
MD5 ce2808fc151749007e9c9b4832a3cced
BLAKE2b-256 5fa63d34115c7074c175c9a1b485c1c2936a73cee8539bccddee5a3e19f874a4

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