bambulab 0.4.5

API client for Bambu Lab printers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Bambulab API

[![Docs](https://img.shields.io/docsrs/bambulab)](https://docs.rs/bambulab)
[![GitHub workflow status](https://github.com/markhaehnel/bambulab/actions/workflows/ci.yaml/badge.svg)](https://github.com/markhaehnel/bambulab/actions/workflows/ci.yaml)
[![Crates.io Version](https://img.shields.io/crates/v/bambulab)](https://crates.io/crates/bambulab)
[![Crates.io Downloads](https://img.shields.io/crates/d/bambulab)](https://crates.io/crates/bambulab)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](#license)

> 🚧 **WORK IN PROGRESS** 🚧
>
> This crate is still in development and not ready for production use.
> Breaking changes may occur at any time.

bambulab is a async Rust crate that provides a channel based client for interacting with Bambu Lab devices over their MQTT broker.

## Features

- Subscribe to printer messages like print progress, temperatures, errors, etc.
- Publish commands to the printer
- Support for P1P, P1S and X1C printer

## Usage

First, add `bambulab` to your dependencies:
```bash
cargo add bambulab
```

Then, use the `Client` struct to create a new client and connect to a printer:

```rust
use bambulab::{client::Client, command::Command};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let host = "printer-ip-or-hostname";
    let access_code = "printer-access-code";
    let serial = "printer-serial-number";

    let (tx, mut rx) = tokio::sync::broadcast::channel::<Message>(25);

    let mut client = Client::new(host, access_code, serial, tx);
    let mut client_clone = client.clone();

    tokio::try_join!(
        tokio::spawn(async move {
            client.run().await.unwrap();
        }),
        tokio::spawn(async move {
            loop {
                let message = rx.recv().await.unwrap();
                println!("received: {message:?}");

                if message == Message::Connected {
                    client_clone.publish(Command::PushAll).await.unwrap();
                }
            }
        }),
    )?;

    Ok(())
}
```

Please note that you need to call subscribe() to allow the API to listen to messages.

More examples available in the [examples](./examples) directory.

## FAQ

### How do I find the access code?

You can find the access code in the printer settings under "WLAN" -> "Access Code".

### How do I find the serial number?

The serial can be found in the printer settings under "SN". 

## Contributing

See the [contributing guidelines](./CONTRIBUTING.md) for more information.

## License

This code is licensed under either of

- [MIT License](./LICENSE-MIT)
- [Apache-2.0 License](./LICENSE-APACHE)

at your option.

## Disclaimer

This project is not officially associated with Bambu Lab. It is a third-party implementation.