hybridgroup.gobot/platforms/keyboard/doc.go

51 lines
1005 B
Go

/*
Package keyboard contains the Gobot drivers for keyboard support.
Installing:
Then you can install the package with:
Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
Example:
package main
import (
"fmt"
"gobot.io/x/gobot/v2"
"gobot.io/x/gobot/v2/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,
)
if err := robot.Start(); err != nil {
panic(err)
}
}
For further information refer to keyboard README:
https://github.com/hybridgroup/gobot/blob/release/platforms/keyboard/README.md
*/
package keyboard // import "gobot.io/x/gobot/v2/platforms/keyboard"