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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.1.9.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.9.tar.gz
Algorithm Hash digest
SHA256 893b1be1329a4446459c36a88538d6e96e088605eae04191a8a7ff47fd2a8639
MD5 aa3f33fee3ed7ec84f6cabb64572ae8f
BLAKE2b-256 08a5e9e0c2651429d724085cc7a7ae29e0f3915452404e36ddff2aa749fd751d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f80fd01a50f3308be75b26f5fbc9321be1557b5dc2efd50ff59dbe7e76e9e6dc
MD5 dfca7cf0c5704c31c4ac6cff1c54176c
BLAKE2b-256 b82347d3fc15abff6e9e8e87644ce26b3734e994a7b5f2b43875978a89d958de

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