This Rust library provides an asynchronous interface to interact with the Mikrotik API.

• No Unsafe Code 💥: Built entirely in safe Rust 🦀
• Zero-copy Parsing: Avoid unnecessary memory allocations by parsing the API responses in-place.
• Concurrent Commands 🚦: Supports running multiple Mikrotik commands concurrently, with each command and its response managed via dedicated channels.
• Error Handling ⚠️: Designed with error handling in mind, ensuring that network or parsing errors are gracefully handled and reported back to the caller.

To use this library in your project, run the following command in your project's directory:

cargo add mikrotik-rs

Alternatively, you can add the library to your Cargo.toml file manually:

[dependencies]
mikrotik-rs = "0.3.1"
tokio = { version = "1", features = ["full"] }

Ensure you have Tokio set up in your project as the library relies on the Tokio runtime.

use mikrotik_rs::{command::CommandBuilder, MikrotikDevice};
use tokio;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize the MikrotikClient 🤖 with the router's address and access credentials
    let device = MikrotikDevice::connect("192.168.122.144:8728", "admin", Some("admin")).await?;

    // Execute a command 📝
    let system_resource_cmd = CommandBuilder::new()
        .command("/system/resource/print")
        // Send the update response every 1 second
        .attribute("interval", Some("1"))
        .build();

    // Send the command to the device 📡
    // Returns a channel to listen for the command's response(s)
    let response_channel = device.send_command(system_resource_cmd).await;

    // Listen for the command's response 🔊
    while let Some(res) = response_channel.recv().await {
        println!(">> Get System Res Response {:?}", res);
    }

    Ok(())
}

For more detailed information on the library's API, please refer to the documentation.

Contributions are welcome! Whether it's submitting a bug report 🐛, a feature request 💡, or a pull request 🔄, all contributions help improve this library. Before contributing, please read through the CONTRIBUTING.md file for guidelines.

This project is licensed under the MIT License - see the LICENSE file for details.

This library is not officially associated with Mikrotik. It is developed as an open-source project to facilitate Rust-based applications interacting with Mikrotik devices.