docs: Add missing godocs for keyboard platform

Signed-off-by: deadprogram <ron@hybridgroup.com>
This commit is contained in:
deadprogram 2016-11-30 23:32:20 +01:00
parent 1b574b5d45
commit eda472890f
4 changed files with 19 additions and 9 deletions

View File

@ -23,10 +23,10 @@ import (
)
func main() {
keys := keyboard.NewDriver("keyboard")
keys := keyboard.NewDriver()
work := func() {
gobot.On(keys.Event("key"), func(data interface{}) {
keys.On(keyboard.Key, func(data interface{}) {
key := data.(keyboard.KeyEvent)
if key.Key == keyboard.A {

View File

@ -22,7 +22,7 @@ Example:
keys := keyboard.NewDriver()
work := func() {
keys.On(keys.Event("key"), func(data interface{}) {
keys.On(keyboard.Key, func(data interface{}) {
key := data.(keyboard.KeyEvent)
if key.Key == keyboard.A {
@ -39,9 +39,10 @@ Example:
work,
)
gbot.Start()
robot.Start()
}
For further information refer to keyboard README:
https://github.com/hybridgroup/gobot/blob/master/platforms/keyboard/README.md
*/

View File

@ -7,6 +7,7 @@ import (
type bytes [3]byte
// KeyEvent contains data about a keyboard event
type KeyEvent struct {
Bytes bytes
Key int

View File

@ -8,10 +8,11 @@ import (
)
const (
// Keyboard event
// Key board event
Key = "key"
)
// Driver is gobot software device to the keyboard
type Driver struct {
name string
connect func(*Driver) (err error)
@ -20,6 +21,8 @@ type Driver struct {
gobot.Eventer
}
// NewDriver returns a new keyboard Driver.
//
func NewDriver() *Driver {
k := &Driver{
name: "Keyboard",
@ -60,12 +63,17 @@ func NewDriver() *Driver {
return k
}
func (k *Driver) Name() string { return k.name }
func (k *Driver) SetName(n string) { k.name = n }
// Name returns the Driver Name
func (k *Driver) Name() string { return k.name }
// SetName sets the Driver Name
func (k *Driver) SetName(n string) { k.name = n }
// Connection returns the Driver Connection
func (k *Driver) Connection() gobot.Connection { return nil }
// Start initializes keyboard by grabbing key events as they come in and
// publishing a key event
// publishing each as a key event
func (k *Driver) Start() (err error) {
if err = k.connect(k); err != nil {
return err
@ -76,7 +84,7 @@ func (k *Driver) Start() (err error) {
return
}
// Halt stops camera driver
// Halt stops keyboard driver
func (k *Driver) Halt() (err error) {
if originalState != "" {
return restore()