rustuya 0.3.0-rc.3

A fast and concurrent Tuya Local API implementation in Rust
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

//! # Rustuya
//!
//! Asynchronous Tuya Local API implementation for local control and monitoring
//! of Tuya-compatible devices without cloud dependencies.
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use rustuya::sync::Device;
//!
//! let device = Device::new("DEVICE_ID", "DEVICE_KEY");
//! device.set_value(1, true);
//! ```
//!
//! ## Choosing sync vs async
//!
//! Rustuya ships two parallel facades over the same internal actor:
//!
//! | When you're calling from… | Use |
//! |---|---|
//! | A non-async program (CLI, sync binary, scripting helpers) | [`sync::Device`](sync::Device), [`sync::SubDevice`](sync::SubDevice), [`sync::Scanner`](sync::Scanner) |
//! | Inside a `tokio` runtime (`#[tokio::main]`, `tokio::spawn`, axum, etc.) | [`Device`], [`DeviceBuilder`], [`Scanner`] (async) |
//!
//! Both flavours share state and reach the same backing tokio runtime — the
//! sync wrappers are just bridges. Calling the sync API from inside a tokio
//! runtime is **not** a supported configuration: the wrappers use
//! `blocking_send`, which would otherwise panic. Since v0.3.0 a runtime guard
//! turns that into a clear error, but you should pick the right facade up
//! front rather than relying on the guard.
//!
//! See the [`sync`] module docs for the full caveat.
//!
//! ## Lifecycle
//!
//! [`Device::new`] (and its `sync` mirror) **spawn a background connection
//! task immediately** on the library's internal runtime. The task stays
//! alive until the last `Device` clone is dropped or [`Device::stop`] is
//! called. Constructing many thousands of devices upfront is therefore
//! avoidable — prefer lazy construction in those scenarios.
//!
pub mod crypto;
pub mod device;
pub mod error;
pub(crate) mod macros;
pub mod protocol;
pub(crate) mod runtime;
pub mod scanner;
pub mod sync;

pub use device::{Device, DeviceBuilder};
pub use error::TuyaError;
pub use protocol::{CommandType, Version};
pub use runtime::maximize_fd_limit;
pub use scanner::Scanner;

pub const VERSION: &str = env!("CARGO_PKG_VERSION");

#[must_use]
pub fn version() -> &'static str {
    VERSION
}