Overview

What it is?

serial2Keypress
Figure 1. serial2Keypress

Serial2Keypress is a Windows platform, ElectronJS-based application that interprets data received from serial port into keypresses. It is open source and relies on multiple third party node modules.

How does it work?

Core functionality and lifecycle:

  • Automatically find the correct port

    • Scanning using SerialPort.list(), finding port match according to predefined list of accepted port driver manufacturers.

  • Establish serial communication

  • Read data from serial port

  • Interpret simple signal code with prefix and delimiter to differentiate payload data

  • Interpreting payload data, send keypress event to Windows OS

  • Sleek UI

  • Configurable, has config.json file

    • Change accepted port driver manufacturers

    • Change baud rate

    • Change signal code prefix (default kb)

    • Change signal code delimiter (default :)

What can it be used for?

Intended use is for Arduino-like microcontrollers where it’s acceptable that simulated keystrokes are a bit slower, eg once every second. It will work with any device that is capable of sending serial port data to Windows PC.

Requirements

  • Windows 10

  • Communication-ready Com port with a driver manufacturer that you can whitelist in config.json

Why did you create it?

I had a project that needed communication between physical buttons and a third-party PC game. Some microcontrollers (like ATmega32U4) have built in USB modules capable of acting as HID devices, ie you can make a fully functional fast-speed keyboard. Other microcontrollers have virtual USB capability and need to be reprogrammed. Since my specification did not need high performance keystrokes, I decided easiest way is to just read serialport and simulate keys on OS. This works well when you need to press a button at most once every second.

Getting started

To get started, see the Getting Started page.