From beaefb764b8f568b65e970aed9984c5d525322df Mon Sep 17 00:00:00 2001 From: Thomas Kohler Date: Fri, 7 Jul 2023 11:35:24 +0200 Subject: [PATCH] dragonboard: fix example and documentation (#977) --- examples/dragonboard_button.go | 4 ++-- platforms/chip/README.md | 37 +---------------------------- platforms/dragonboard/README.md | 42 ++++----------------------------- 3 files changed, 7 insertions(+), 76 deletions(-) diff --git a/examples/dragonboard_button.go b/examples/dragonboard_button.go index 101ec5003..1a7f01fff 100644 --- a/examples/dragonboard_button.go +++ b/examples/dragonboard_button.go @@ -11,11 +11,11 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/chip" + "gobot.io/x/gobot/v2/platforms/dragonboard" ) func main() { - dragonAdaptor := chip.NewAdaptor() + dragonAdaptor := dragonboard.NewAdaptor() button := gpio.NewButtonDriver(dragonAdaptor, "GPIO_A") work := func() { diff --git a/platforms/chip/README.md b/platforms/chip/README.md index 4b62bbc83..40f6e79ce 100644 --- a/platforms/chip/README.md +++ b/platforms/chip/README.md @@ -40,43 +40,8 @@ Reboot the device to make sure the init script loads the overlay on boot. ## How to Use +Please refer to one example for your platform, e.g. [chip_button.go](https://github.com/hybridgroup/gobot/blob/release/examples/chip_button.go). The pin numbering used by your Gobot program should match the way your board is labeled right on the board itself. - -```go -package main - -import ( - "fmt" - - "gobot.io/x/gobot/v2" - "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/chip" -) - -func main() { - chipAdaptor := chip.NewAdaptor() - button := gpio.NewButtonDriver(chipAdaptor, "XIO-P0") - - work := func() { - gobot.On(button.Event("push"), func(data interface{}) { - fmt.Println("button pressed") - }) - - gobot.On(button.Event("release"), func(data interface{}) { - fmt.Println("button released") - }) - } - - robot := gobot.NewRobot("buttonBot", - []gobot.Connection{chipAdaptor}, - []gobot.Device{button}, - work, - ) - - robot.Start() -} -``` - If you want to use the C.H.I.P. Pro, use the `NewProAdaptor()` function like this: ```go diff --git a/platforms/dragonboard/README.md b/platforms/dragonboard/README.md index 30862006a..f7911b2a9 100644 --- a/platforms/dragonboard/README.md +++ b/platforms/dragonboard/README.md @@ -16,43 +16,9 @@ transfer the final executable to your DragonBoard and run the program on the Dra ## How to Use +Please refer to one example for your platform, e.g. [dragonboard_button.go](https://github.com/hybridgroup/gobot/blob/release/examples/dragonboard_button.go). The pin numbering used by your Gobot program should match the way your board is labeled right on the board itself. See [here](https://www.96boards.org/db410c-getting-started/HardwareDocs/HWUserManual.md/). -```go -package main - -import ( - "fmt" - - "gobot.io/x/gobot/v2" - "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/dragonboard" -) - -func main() { - dragonAdaptor := dragonboard.NewAdaptor() - button := gpio.NewButtonDriver(dragonAdaptor, "GPIO_A") - - work := func() { - gobot.On(button.Event("push"), func(data interface{}) { - fmt.Println("button pressed") - }) - - gobot.On(button.Event("release"), func(data interface{}) { - fmt.Println("button released") - }) - } - - robot := gobot.NewRobot("buttonBot", - []gobot.Connection{chipAdaptor}, - []gobot.Device{button}, - work, - ) - - robot.Start() -} -``` - ## How to Connect ### Compiling @@ -60,13 +26,13 @@ func main() { Compile your Gobot program on your workstation like this: ```sh -GOARCH=arm64 GOOS=linux go build examples/dragon_button.go +GOARCH=arm64 GOOS=linux go build examples/dragonboard_button.go ``` Once you have compiled your code, you can you can upload your program and execute it on the DragonBoard from your workstation using the `scp` and `ssh` commands like this: ```sh -scp dragon_button root@192.168.1.xx: -ssh -t root@192.168.1.xx "./dragon_button" +scp dragonboard_button root@192.168.1.xx: +ssh -t root@192.168.1.xx "./dragonboard_button" ```