From d2c994277fcacc1e890109f7c05f5dd8b2b81a42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mark=20H=C3=A4hnel?= <1516205+markhaehnel@users.noreply.github.com> Date: Tue, 28 Nov 2023 08:31:00 +0100 Subject: [PATCH] feat: add channel based api (#5) * feat: add channel based api * test: fix parse_message test * chore: fix clippy lints --- Cargo.toml | 6 +- LICENSE-APACHE | 201 ++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 19 +++++ README.md | 54 ++++++++----- examples/basic.rs | 23 ++++-- src/client.rs | 85 ++++++++++++-------- src/message.rs | 8 +- src/parser.rs | 21 ++--- 8 files changed, 334 insertions(+), 83 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 78cae59..245bd27 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,10 +12,10 @@ categories = ["iot", "hardware"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -anyhow = "1.0.75" +anyhow = { version = "1.0.75" } futures = { version = "0.3.29", default-features = false } -paho-mqtt = "0.12.3" -rand = "0.8.5" +paho-mqtt = { version = "0.12.3" } +rand = { version = "0.8.5" } tokio = { version = "1.34.0", features = ["full"] } [profile.release] diff --git a/LICENSE-APACHE b/LICENSE-APACHE index e69de29..8dada3e 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT index e69de29..241262d 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) Mark Hähnel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 5c6a0d7..8cb50ec 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,12 @@ [![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** 🚧 +> 🚧 **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 asnyc Rust crate that provides an client for interacting with Bambu Lab devices. +bambulab is a async Rust crate that provides a channel based client for interacting with Bambu Lab devices over their MQTT broker. ## Features @@ -30,47 +33,54 @@ use bambulab::{client::Client, command::Command}; #[tokio::main] async fn main() -> Result<(), Box> { - let host = "printer-ip-or-hostname"; - let access_code = "printer-access-code"; - let serial = "printer-serial-number"; - - let mut client = Client::new(host, access_code, serial); - - client.connect().await?; - - client.publish(Command::PushAll).await?; - - loop { - let message = client.poll().await?; - println!("{message:?}"); - } + 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::(25); + + let mut client = Client::new(host, access_code, serial, tx); + + 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:?}"); + } + }) + )?; + + 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. +More examples available in the [examples](./examples) directory. ## FAQ ### How do I find the access code? -The access code is a 6 digit code that is printed on the back of your printer. It is also available in the Bambu Lab app. +You can find the access code in the printer settings under "WLAN" -> "Access Code". ### How do I find the serial number? -The serial number is a 6 digit code that is printed on the back of your printer. It is also available in the Bambu Lab app. +The serial can be found in the printer settings under "SN". ## Contributing -See the [contributing guidelines](./../CONTRIBUTING.md) for more information. +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) +- [MIT License](./LICENSE-MIT) +- [Apache-2.0 License](./LICENSE-APACHE) at your option. diff --git a/examples/basic.rs b/examples/basic.rs index b476732..977455d 100644 --- a/examples/basic.rs +++ b/examples/basic.rs @@ -1,6 +1,6 @@ use anyhow::Result; -use bambulab::{client::Client, command::Command}; +use bambulab::{client::Client, message::Message}; #[tokio::main] async fn main() -> Result<()> { @@ -8,14 +8,21 @@ async fn main() -> Result<()> { let access_code = "printer-access-code"; let serial = "printer-serial-number"; - let mut client = Client::new(host, access_code, serial); + let (tx, mut rx) = tokio::sync::broadcast::channel::(25); - client.connect().await?; + let mut client = Client::new(host, access_code, serial, tx); - client.publish(Command::PushAll).await?; + 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:?}"); + } + }) + )?; - loop { - let message = client.poll().await?; - println!("{message:?}"); - } + Ok(()) } diff --git a/src/client.rs b/src/client.rs index 5a1a6cc..bae119f 100644 --- a/src/client.rs +++ b/src/client.rs @@ -3,6 +3,7 @@ use std::time::Duration; use anyhow::Result; use futures::stream::StreamExt; use rand::Rng; +use tokio::sync::broadcast::Sender; use crate::{command::Command, message::Message, parser::parse_message}; @@ -14,6 +15,8 @@ pub struct Client { client: paho_mqtt::AsyncClient, stream: paho_mqtt::AsyncReceiver>, + tx: Sender, + topic_device_request: String, topic_device_report: String, } @@ -24,7 +27,7 @@ impl Client { /// # Panics /// /// Panics if the MQTT client cannot be created. - pub fn new>(ip: S, access_code: S, serial: S) -> Self { + pub fn new>(ip: S, access_code: S, serial: S, tx: Sender) -> Self { let host: String = format!("mqtts://{}:8883", ip.into()); let access_code: String = access_code.into(); let serial: String = serial.into(); @@ -46,18 +49,43 @@ impl Client { serial: serial.clone(), client, stream, + tx, topic_device_request: format!("device/{}/request", &serial), topic_device_report: format!("device/{}/report", &serial), } } - /// Connects to the Bambu MQTT broker and subscribes to the device report topic. + /// Polls for a message from the MQTT event loop. + /// You need to poll periodically to receive messages + /// and to keep the connection alive. + /// This function also handles reconnects. + /// + /// **NOTE** Don't block this while iterating /// /// # Errors /// - /// Returns an error if there was a problem connecting to the MQTT broker - /// or subscribing to the device report topic. - pub async fn connect(&mut self) -> Result<()> { + /// Returns an error if there was a problem polling for a message or parsing the event. + async fn poll(&mut self) -> Result<()> { + let msg_opt = self.stream.next().await; + + if let Some(Some(msg)) = msg_opt { + self.tx.send(parse_message(&msg)?)?; + } else { + // A "None" means we were disconnected. Try to reconnect... + self.tx.send(Message::Disconnected)?; + + while (self.client.reconnect().await).is_err() { + tokio::time::sleep(Duration::from_secs(1)).await; + self.tx.send(Message::Reconnecting)?; + } + + self.tx.send(Message::Connected)?; + } + + Ok(()) + } + + async fn connect(&mut self) -> Result<()> { let ssl_opts = paho_mqtt::SslOptionsBuilder::new() .disable_default_trust_store(true) .enable_server_cert_auth(false) @@ -66,51 +94,44 @@ impl Client { let conn_opts = paho_mqtt::ConnectOptionsBuilder::new() .ssl_options(ssl_opts) - .keep_alive_interval(Duration::from_secs(10)) + .keep_alive_interval(Duration::from_secs(5)) + .connect_timeout(Duration::from_secs(3)) .user_name("bblp") .password(&self.access_code) .finalize(); + self.tx.send(Message::Connecting)?; + self.client.connect(conn_opts).await?; - self.client - .subscribe(&self.topic_device_report, paho_mqtt::QOS_0); + self.tx.send(Message::Connected)?; Ok(()) } - /// Polls for a message from the MQTT event loop. - /// You need to poll periodically to receive messages - /// and to keep the connection alive. - /// This function also handles reconnects. - /// - /// **NOTE** Don't block this while iterating + fn subscibe_to_device_report(&mut self) { + self.client + .subscribe(&self.topic_device_report, paho_mqtt::QOS_0); + } + + /// Runs the Bambu MQTT client. + /// You should run this in a tokio task. /// /// # Errors /// - /// Returns an error if there was a problem polling for a message or parsing the event. - pub async fn poll(&mut self) -> Result { - let msg_opt = self.stream.next().await; - - let mut rconn_attempt: usize = 0; + /// Returns an error if there was a problem connecting to the MQTT broker + /// or subscribing to the device report topic. + pub async fn run(&mut self) -> Result<()> { + self.connect().await?; - if let Some(msg) = msg_opt { - parse_message(msg) - } else { - // A "None" means we were disconnected. Try to reconnect... - println!("Lost connection. Attempting reconnect..."); - while let Err(err) = self.client.reconnect().await { - rconn_attempt += 1; - println!("Error reconnecting #{rconn_attempt}: {err}"); - tokio::time::sleep(Duration::from_secs(1)).await; - } - println!("Reconnected."); + self.subscibe_to_device_report(); - Ok(Message::Reconnected) + loop { + Self::poll(self).await?; } } - /// Publishes a command to the MQTT broker. + /// Publishes a command to the Bambu MQTT broker. /// /// # Errors /// diff --git a/src/message.rs b/src/message.rs index db7b9e3..deda9c3 100644 --- a/src/message.rs +++ b/src/message.rs @@ -1,7 +1,11 @@ -#[derive(Debug, PartialEq, Eq, PartialOrd, Ord)] +#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone)] pub enum Message { Info(String), - Reconnected, Outgoing(String), Unknown(String), + + Connecting, + Connected, + Reconnecting, + Disconnected, } diff --git a/src/parser.rs b/src/parser.rs index e623841..f3678d8 100644 --- a/src/parser.rs +++ b/src/parser.rs @@ -2,13 +2,9 @@ use anyhow::Result; use crate::message::Message; -pub(crate) fn parse_message(message: Option) -> Result { - if let Some(message) = message { - let payload_str = String::from_utf8(message.payload().to_vec())?; - Ok(Message::Info(payload_str)) - } else { - Ok(Message::Unknown("Unknown message".into())) - } +pub(crate) fn parse_message(message: &paho_mqtt::Message) -> Result { + let payload_str = String::from_utf8(message.payload().to_vec())?; + Ok(Message::Info(payload_str)) } #[cfg(test)] @@ -16,22 +12,15 @@ mod tests { use super::*; #[test] - fn test_parse_message_some() { + fn test_parse_message() { let message = paho_mqtt::Message::new( "device/123456789/report", r#"{ "hello": "world" }"#, paho_mqtt::QOS_2, ); - let result = parse_message(Some(message)).unwrap(); + let result = parse_message(&message).unwrap(); assert_eq!(result, Message::Info(r#"{ "hello": "world" }"#.into())); } - - #[test] - fn test_parse_message_none() { - let result = parse_message(None).unwrap(); - - assert_eq!(result, Message::Unknown("Unknown message".into())); - } }