keyboard

README

Keyboard

This module implements support for keyboard events, wrapping the stty utility.

How to Install

go get -d -u gobot.io/x/gobot/...

How to Use

Example parsing key events

package main

import (
	"fmt"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/platforms/keyboard"
)

func main() {
	keys := keyboard.NewDriver()

	work := func() {
		keys.On(keyboard.Key, func(data interface{}) {
			key := data.(keyboard.KeyEvent)

			if key.Key == keyboard.A {
				fmt.Println("A pressed!")
			} else {
				fmt.Println("keyboard event!", key, key.Char)
			}
		})
	}

	robot := gobot.NewRobot("keyboardbot",
		[]gobot.Connection{},
		[]gobot.Device{keys},
		work,
	)

	robot.Start()
}

Documentation

Overview

Package keyboard contains the Gobot drivers for keyboard support.

Installing:

Then you can install the package with:

go get gobot.io/x/gobot && go install gobot.io/x/gobot/platforms/keyboard

Example:

package main

import (
	"fmt"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/platforms/keyboard"
)

func main() {
	keys := keyboard.NewDriver()

	work := func() {
		keys.On(keyboard.Key, func(data interface{}) {
			key := data.(keyboard.KeyEvent)

			if key.Key == keyboard.A {
				fmt.Println("A pressed!")
			} else {
				fmt.Println("keyboard event!", key, key.Char)
			}
		})
	}

	robot := gobot.NewRobot("keyboardbot",
		[]gobot.Connection{},
		[]gobot.Device{keys},
		work,
	)

	robot.Start()
}

For further information refer to keyboard README: https://github.com/hybridgroup/gobot/blob/master/platforms/keyboard/README.md

Index

• Constants
• type Driver
  • func NewDriver() *Driver
  • func (k *Driver) Connection() gobot.Connection
  • func (k *Driver) Halt() (err error)
  • func (k *Driver) Name() string
  • func (k *Driver) SetName(n string)
  • func (k *Driver) Start() (err error)
• type KeyEvent
  • func Parse(input bytes) KeyEvent

Constants

const (
	Tilde = iota + 96
	A
	B
	C
	D
	E
	F
	G
	H
	I
	J
	K
	L
	M
	N
	O
	P
	Q
	R
	S
	T
	U
	V
	W
	X
	Y
	Z
)

const (
	Escape   = 27
	Spacebar = 32
)

const (
	Zero = iota + 48
	One
	Two
	Three
	Four
	Five
	Six
	Seven
	Eight
	Nine
)

const (
	ArrowUp = iota + 65
	ArrowDown
	ArrowRight
	ArrowLeft
)

const (
	// Key board event
	Key = "key"
)

Types

type Driver

type Driver struct {
	gobot.Eventer
	// contains filtered or unexported fields
}

Driver is gobot software device to the keyboard

func NewDriver

func NewDriver() *Driver

NewDriver returns a new keyboard Driver.

func (*Driver) Connection

func (k *Driver) Connection() gobot.Connection

Connection returns the Driver Connection

func (*Driver) Halt

func (k *Driver) Halt() (err error)

Halt stops keyboard driver

func (*Driver) Name

func (k *Driver) Name() string

Name returns the Driver Name

func (*Driver) SetName

func (k *Driver) SetName(n string)

SetName sets the Driver Name

func (*Driver) Start

func (k *Driver) Start() (err error)

Start initializes keyboard by grabbing key events as they come in and publishing each as a key event

type KeyEvent

type KeyEvent struct {
	Bytes bytes
	Key   int
	Char  string
}

KeyEvent contains data about a keyboard event

func Parse

func Parse(input bytes) KeyEvent