Dan DitomasoandGitHub
7f177f6b83
* feat: publish js libs to npm * changed license type * updated readme * added id * added exclusion for web and deno packages * update comment * updating env var
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# @meshtastic/transport-web-serial
|
|
|
|
[](https://jsr.io/@meshtastic/transport-web-serial)
|
|
[](https://github.com/meshtastic/js/actions/workflows/ci.yml)
|
|
[](https://cla-assistant.io/meshtastic/meshtastic.js)
|
|
[](https://opencollective.com/meshtastic/)
|
|
[](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
|
|
|
|
## Overview
|
|
|
|
`@meshtastic/transport-web-serial` Provides Web Serial transport for Meshtastic
|
|
devices. Installation instructions are avaliable at
|
|
[JSR](https://jsr.io/@meshtastic/transport-web-serial)
|
|
[NPM](https://www.npmjs.com/package/@meshtastic/transport-web-serial)
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { MeshDevice } from "@meshtastic/core";
|
|
import { TransportWebSerial } from "@meshtastic/transport-web-serial";
|
|
|
|
const transport = await TransportWebSerial.create();
|
|
const device = new MeshDevice(transport);
|
|
```
|
|
|
|
## Stats
|
|
|
|
|
|
|
|
### Compatibility
|
|
|
|
The Web Serial API's have limited support in browsers, compatibility is
|
|
represented in the matrix below.
|
|
|
|
|