MCPcopy Index your code
hub / github.com/deid84/tauri-plugin-serialport

github.com/deid84/tauri-plugin-serialport @v1.0.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.0.0 ↗ · + Follow
146 symbols 306 edges 13 files 15 documented · 10%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Tauri Plugin SerialPort

A tauri plugin for managin serial port communication, created using serialport-rs crate.

Installation

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

RUST

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-serialport = { git = "https://github.com/deid84/tauri-plugin-serialport", tag = "v0.1.0" }

Use in src-tauri/src/main.rs:

use tauri_plugin_serialport;

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_serialport::init())
        .build()
        .run();
}

WEBVIEW

Install from a tagged release

npm install github:deid84/tauri-plugin-serialport#v0.1.0
# or
yarn add github:deid84/tauri-plugin-serialport#v0.1.0

Install from a branch (dev)

npm install https://github.com/deid84/tauri-plugin-serialport\#master
# or
yarn add https://github.com/deid84/tauri-plugin-serialport\#master

package.json

  "dependencies": {
    "tauri-plugin-serialport-api": "github:deid84/tauri-plugin-serialport#v0.1.0",
  }

Use within your JS/TS:

todo...

Extension points exported contracts — how you extend this code

InvokeResult (Interface)
(no doc)
webview-dist/index.d.ts
InvokeResult (Interface)
(no doc)
webview-src/index.ts
ReadDataResult (Interface)
(no doc)
webview-dist/index.d.ts
ReadDataResult (Interface)
(no doc)
webview-src/index.ts
SerialportOptions (Interface)
(no doc)
webview-dist/index.d.ts
SerialportOptions (Interface)
(no doc)
webview-src/index.ts
Options (Interface)
(no doc)
webview-dist/index.d.ts
Options (Interface)
(no doc)
webview-src/index.ts

Core symbols most depended-on inside this repo

o
called by 59
webview-dist/index.js
e
called by 24
webview-dist/index.js
t
called by 16
webview-dist/index.js
s
called by 12
webview-dist/index.js
listen
called by 12
webview-dist/index.js
a
called by 8
webview-dist/index.js
open
called by 7
webview-src/index.ts
l
called by 5
webview-dist/index.js

Shape

Method 83
Function 41
Class 11
Interface 10
Enum 1

Languages

TypeScript83%
Rust17%

Modules by API surface

webview-dist/index.js92 symbols
webview-src/index.ts22 symbols
src/api.rs14 symbols
webview-dist/index.d.ts7 symbols
src/state.rs4 symbols
src/err.rs3 symbols
examples/serialport-test/src-tauri/src/main.rs2 symbols
src/lib.rs1 symbols
examples/serialport-test/src-tauri/build.rs1 symbols

For agents

$ claude mcp add tauri-plugin-serialport \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact