项目作者: vshymanskyy

项目描述 :
Simple serial port server
高级语言: JavaScript
项目地址: git://github.com/vshymanskyy/serial-server.git
创建时间: 2019-02-05T01:22:50Z
项目社区:https://github.com/vshymanskyy/serial-server

开源协议:MIT License

下载


This tool allows you to share/access your serial terminal over the internet.
Based on xterm.js, localtunnel.

Works on:
Linux,
Windows,
MacOS

Features:

  • Automatic tunneling from local machine to a public-accessible link
  • Multi-user access
  • Simple password-based authentication (with multiple credentials)
  • Read-only access for specific users
  • ANSI escape codes support: colors, mouse, window resize, window title
  • Bonus: share your OS shell. Just specify shell instead of serial port

Example

  1. $ serial-server /dev/ttyACM0 --baud=115200 --auth=vova:MyPaSS --tunnel=vsh-device01
  2. Server listening on 0.0.0.0:5123
  3. Preparing your tunnel...
  4. Opened port /dev/ttyACM0,115200
  5. Tunnel link: https://vsh-device01.localtunnel.me

Visit the provided tunnel link. It will ask for the password, then present you with a remote terminal:

examples

Installation

  1. npm i -g https://github.com/vshymanskyy/serial-server.git

Usage

  1. serial-server <port> [options]
  2. Options:
  3. --version Show version number [boolean]
  4. --bind, --addr Server endpoint address [default: "0.0.0.0:5123"]
  5. --baudRate, -b, --baud [number] [default: 115200]
  6. --dataBits [choices: 8, 7, 6, 5] [default: 8]
  7. --stopBits [choices: 1, 2] [default: 1]
  8. --parity [choices: "none", "even", "mark", "odd", "space"] [default: "none"]
  9. --auth Password protection. Can add multiple users (user:pass) [array]
  10. --readonly, --ro List of users with readonly access (comma-separated)
  11. --tunnel Create tunnel link automatically [string]
  12. --config Path to JSON config file
  13. -h, --help Show help [boolean]
  14. Copyright 2019 Volodymyr Shymanskyy

More examples

Start OS shell server, allow multiple guests to connect with read-only access:

  1. $ serial-server shell --auth=vova:MyPaSS --auth=guest --readonly=guest --tunnel=vsh-shell

Non-authenticated access is always provided in read-only mode:

  1. $ serial-server /dev/ttyACM0 --tunnel=vsh-device01