📟 Web Serial for Vue.js

Features

$3

- Easy-to-use event-based API
- States, signals and configuration variables are Vue.js reactive
- Can poll CTS, DCD, DSR, and RI signals
- Serial configuration is stored in the browser localStorage

Requirements

- Your website must be served with HTTPS
- The client browser must support Web Serial API
- The connect() function must be called from a DOM event

###### :speech_balloon: To setup HTTPS quickly for development with Vite.js, you can use @vitejs/plugin-basic-ssl

Installation

##### In your Vue.js project:

``npm install vue-serial`

###### :speech_balloon: If you prefer static files, import assets from the dist folder.

`Examples`


###### MyComponent.vue (using Composition API)

Vue


same example using static files loaded with a CDN (using Options API)

`HTML


    
      Web Serial is not available. Check that this browser supports Web Serial API and this page is served with HTTPS.

      
        vue-serial: {{ serial.isOpen ? "is open (device is " + (serial.isConnected ? "connected)" : "disconnected)") : "is closed" }}

`Docs`


:book: Read the API
Project development

-

npm run dev

 compiles and hot-reloads demo for development
-

npm run build:demo

 compiles and minifies demo
-

npm run build:lib

 compiles and minifies library
-

npm run typedoc` compiles API documentation

Licensing