Skip to content

This repository contains a web-based interface for communicating with serial devices directly from the browser. Utilizing the modern Web Serial API, it enables real-time interaction with any serial device connected to the user's computer.

Notifications You must be signed in to change notification settings

kongdayan/Web-Serial-API-demo

Repository files navigation

SerialPort Tool

Project Description

This project is a Vue.js web application designed to interact with serial ports. It provides a user-friendly interface for connecting to serial ports, reading data, and sending commands. The tool is particularly useful for interfacing with various devices over serial communication, offering functionalities like setting and getting device attributes.

Features

  • Connect to and disconnect from serial ports.
  • Display and modify device attributes.
  • Send custom commands to the connected device.
  • Real-time display of received data from the serial port.

Installation

To set up the project on your local machine, follow these steps:

  1. Clone the Repository

    git clone https://github.com/kongdayan/Web-Serial-API-demo.git
    cd Web-Serial-API-demo
  2. Install Dependencies

    Make sure you have Node.js installed, then run:

    npm install
  3. Run the Application

    npm run serve

    The application will be available at http://localhost:8080.

Usage

After launching the application, follow these steps:

  1. Select the serial port from the dropdown menu.
  2. Set the desired baud rate and other connection settings.
  3. Click 'Connect' to establish a connection with the serial port.
  4. Use the interface to send commands and read data.
  5. Adjust device attributes as needed.

Contributing

Contributions to this project are welcome. To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature (git checkout -b feature/AmazingFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some AmazingFeature').
  5. Push to the branch (git push origin feature/AmazingFeature).
  6. Open a pull request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - [email protected]

Project Link: https://github.com/kongdayan/Web-Serial-API-demo

About

This repository contains a web-based interface for communicating with serial devices directly from the browser. Utilizing the modern Web Serial API, it enables real-time interaction with any serial device connected to the user's computer.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published