mirror of
https://github.com/hybridgroup/gobot.git
synced 2025-04-27 13:48:56 +08:00
docs: Add missing godocs for keyboard platform
Signed-off-by: deadprogram <ron@hybridgroup.com>
This commit is contained in:
parent
1b574b5d45
commit
eda472890f
@ -23,10 +23,10 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
keys := keyboard.NewDriver("keyboard")
|
keys := keyboard.NewDriver()
|
||||||
|
|
||||||
work := func() {
|
work := func() {
|
||||||
gobot.On(keys.Event("key"), func(data interface{}) {
|
keys.On(keyboard.Key, func(data interface{}) {
|
||||||
key := data.(keyboard.KeyEvent)
|
key := data.(keyboard.KeyEvent)
|
||||||
|
|
||||||
if key.Key == keyboard.A {
|
if key.Key == keyboard.A {
|
||||||
|
@ -22,7 +22,7 @@ Example:
|
|||||||
keys := keyboard.NewDriver()
|
keys := keyboard.NewDriver()
|
||||||
|
|
||||||
work := func() {
|
work := func() {
|
||||||
keys.On(keys.Event("key"), func(data interface{}) {
|
keys.On(keyboard.Key, func(data interface{}) {
|
||||||
key := data.(keyboard.KeyEvent)
|
key := data.(keyboard.KeyEvent)
|
||||||
|
|
||||||
if key.Key == keyboard.A {
|
if key.Key == keyboard.A {
|
||||||
@ -39,9 +39,10 @@ Example:
|
|||||||
work,
|
work,
|
||||||
)
|
)
|
||||||
|
|
||||||
gbot.Start()
|
robot.Start()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
For further information refer to keyboard README:
|
For further information refer to keyboard README:
|
||||||
https://github.com/hybridgroup/gobot/blob/master/platforms/keyboard/README.md
|
https://github.com/hybridgroup/gobot/blob/master/platforms/keyboard/README.md
|
||||||
*/
|
*/
|
||||||
|
@ -7,6 +7,7 @@ import (
|
|||||||
|
|
||||||
type bytes [3]byte
|
type bytes [3]byte
|
||||||
|
|
||||||
|
// KeyEvent contains data about a keyboard event
|
||||||
type KeyEvent struct {
|
type KeyEvent struct {
|
||||||
Bytes bytes
|
Bytes bytes
|
||||||
Key int
|
Key int
|
||||||
|
@ -12,6 +12,7 @@ const (
|
|||||||
Key = "key"
|
Key = "key"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Driver is gobot software device to the keyboard
|
||||||
type Driver struct {
|
type Driver struct {
|
||||||
name string
|
name string
|
||||||
connect func(*Driver) (err error)
|
connect func(*Driver) (err error)
|
||||||
@ -20,6 +21,8 @@ type Driver struct {
|
|||||||
gobot.Eventer
|
gobot.Eventer
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewDriver returns a new keyboard Driver.
|
||||||
|
//
|
||||||
func NewDriver() *Driver {
|
func NewDriver() *Driver {
|
||||||
k := &Driver{
|
k := &Driver{
|
||||||
name: "Keyboard",
|
name: "Keyboard",
|
||||||
@ -60,12 +63,17 @@ func NewDriver() *Driver {
|
|||||||
return k
|
return k
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Name returns the Driver Name
|
||||||
func (k *Driver) Name() string { return k.name }
|
func (k *Driver) Name() string { return k.name }
|
||||||
|
|
||||||
|
// SetName sets the Driver Name
|
||||||
func (k *Driver) SetName(n string) { k.name = n }
|
func (k *Driver) SetName(n string) { k.name = n }
|
||||||
|
|
||||||
|
// Connection returns the Driver Connection
|
||||||
func (k *Driver) Connection() gobot.Connection { return nil }
|
func (k *Driver) Connection() gobot.Connection { return nil }
|
||||||
|
|
||||||
// Start initializes keyboard by grabbing key events as they come in and
|
// 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) {
|
func (k *Driver) Start() (err error) {
|
||||||
if err = k.connect(k); err != nil {
|
if err = k.connect(k); err != nil {
|
||||||
return err
|
return err
|
||||||
@ -76,7 +84,7 @@ func (k *Driver) Start() (err error) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Halt stops camera driver
|
// Halt stops keyboard driver
|
||||||
func (k *Driver) Halt() (err error) {
|
func (k *Driver) Halt() (err error) {
|
||||||
if originalState != "" {
|
if originalState != "" {
|
||||||
return restore()
|
return restore()
|
||||||
|
Loading…
x
Reference in New Issue
Block a user