tauri-plugin-device-info 1.0.1

A Tauri plugin to access device information.
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
95
96
97
98
99
100
101
102

//! # Tauri Plugin: Device Info
//!
//! A comprehensive Tauri plugin for accessing device information across all platforms.
//!
//! ## Features
//!
//! - **Device Info**: UUID, manufacturer, model, serial number
//! - **Battery Info**: Charge level, charging status, health
//! - **Network Info**: IP address, network type, MAC address
//! - **Storage Info**: Total/free space, storage type
//! - **Display Info**: Resolution, scale factor, refresh rate
//!
//! ## Supported Platforms
//!
//! | Platform | Status |
//! |----------|--------|
//! | Windows  | ✅     |
//! | macOS    | ✅     |
//! | Linux    | ✅     |
//! | iOS      | ✅     |
//! | Android  | ✅     |
//!
//! ## Usage
//!
//! ```rust,ignore
//! // In your Tauri app's main.rs or lib.rs
//! fn main() {
//!     tauri::Builder::default()
//!         .plugin(tauri_plugin_device_info::init())
//!         .run(tauri::generate_context!())
//!         .expect("error while running tauri application");
//! }
//! ```
//!
//! ## JavaScript/TypeScript API
//!
//! ```typescript
//! import { getDeviceInfo, getBatteryInfo } from 'tauri-plugin-device-info-api';
//!
//! const device = await getDeviceInfo();
//! const battery = await getBatteryInfo();
//! ```

use tauri::{
    plugin::{Builder, TauriPlugin},
    Manager, Runtime,
};

// Re-export all model types for public API
pub use models::*;

// ============================================================================
// Platform modules
// ============================================================================

#[cfg(desktop)]
mod desktop;
#[cfg(mobile)]
mod mobile;

mod commands;
mod error;
mod models;

pub use error::{Error, Result};

#[cfg(desktop)]
use desktop::DeviceInfo;
#[cfg(mobile)]
use mobile::DeviceInfo;

/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the device-info APIs.
pub trait DeviceInfoExt<R: Runtime> {
    fn device_info(&self) -> &DeviceInfo<R>;
}

impl<R: Runtime, T: Manager<R>> crate::DeviceInfoExt<R> for T {
    fn device_info(&self) -> &DeviceInfo<R> {
        self.state::<DeviceInfo<R>>().inner()
    }
}

/// Initializes the plugin.
pub fn init<R: Runtime>() -> TauriPlugin<R> {
    Builder::new("device-info")
        .invoke_handler(tauri::generate_handler![
            commands::get_device_info,
            commands::get_battery_info,
            commands::get_network_info,
            commands::get_storage_info,
            commands::get_display_info
        ])
        .setup(|app, api| {
            #[cfg(mobile)]
            let device_info = mobile::init(app, api)?;
            #[cfg(desktop)]
            let device_info = desktop::init(app, api)?;
            app.manage(device_info);
            Ok(())
        })
        .build()
}