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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: bambulabs_api-2.1.17.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.17.tar.gz
Algorithm Hash digest
SHA256 a8cbf5fa0b1d9ad1404ed556adbe080eb1ef57d8b59446b9daeeaef7968fe85e
MD5 fcca19aa10c5faa15227ce35d9135a55
BLAKE2b-256 f62ecc1d00e2e8c073d6ba6567f3329883d09092fd5eaf0c233144f1e9b2b4f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bambulabs_api-2.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 b0cee6a83fb24865228ed92703080a8887cc3495aab9a787972410d414e7e9f5
MD5 1bb0c3e1a48e7bf645d825fb9fee1e03
BLAKE2b-256 1650246011a9e59a31714047708da7e5fc8ed1656f06d3ee97d59660ff8b8a53

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