https://github.com/sashko/go-uinput

Go interface to Linux uinput kernel module that makes it possible to emulate input devices from userspace
https://github.com/sashko/go-uinput

go golang uinput

Last synced: about 1 year ago
JSON representation

Go interface to Linux uinput kernel module that makes it possible to emulate input devices from userspace

• Host: GitHub
• URL: https://github.com/sashko/go-uinput
• Owner: sashko
• License: mit
• Created: 2018-04-16T12:36:27.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-18T18:55:03.000Z (almost 6 years ago)
• Last Synced: 2025-04-01T04:32:50.660Z (about 1 year ago)
• Topics: go, golang, uinput
• Language: Go
• Homepage:
• Size: 26.4 KB
• Stars: 6
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# go-uinput

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Build Status](https://travis-ci.org/sashko/go-uinput.svg?branch=master)](https://travis-ci.org/sashko/go-uinput)

[![Coverage Status](https://coveralls.io/repos/github/sashko/go-uinput/badge.svg?branch=master)](https://coveralls.io/github/sashko/go-uinput?branch=master)

[![Go Report Card](https://goreportcard.com/badge/github.com/sashko/go-uinput)](https://goreportcard.com/report/github.com/sashko/go-uinput)

go-uinput is Go interface to Linux uinput kernel module that makes it possible to emulate input devices from userspace.

The interface aims to make it dead simple to create virtual input devices, e.g. keyboard, joystick, or mice for generating arbitrary input events programmatically.

## System prerequisites

First, the system must have `uinput` kernel module loaded.

    sudo modprobe -i uinput

Second, `/dev/uinput` device is owned by root and therefore its default permissions must either be changed using chmod

    sudo chmod 666 /dev/uinput

or, which is a much more preferred option, add the udev rule to allow a user use the device

    echo KERNEL=="uinput", MODE="0666" | sudo tee /etc/udev/rules.d/90-$USER.rules

    sudo udevadm trigger

## Installation

To build the package from sources, clone the repository and run

    go build

    go install

Alternatively, use `go get` to obtain and install the package in your `$GOPATH`

    go get github.com/sashko/go-uinput

## Usage

The following example shows how to create a new virtual keyboard, and how to send a key press event.

All the default imports and error handlers were removed for the sake of simplicity.

```go

func main() {

	keyboard, err := uinput.CreateKeyboard()

	defer keyboard.Close()

	// Press left Shift key, press G, release Shift

	keyboard.KeyDown(uinput.KeyLeftShift)

	keyboard.KeyPress(uinput.KeyG)

	keyboard.KeyUp(uinput.KeyLeftShift)

	// Press O key

	keyboard.KeyPress(uinput.KeyO)

}

```