DOCS-2949: QA board examples #4661
Conversation
|
Warning your change may break code samples. If your change modifies any of the following functions please contact @viamrobotics/fleet-management. Thanks!
|
viambot
added
the
safe to test
viambot
added
safe to test
components/board/board.go
Outdated
| // myBoard, err := board.FromRobot(robot, "my_board") | ||
| // | ||
| // // Get the names of all known analog pins | ||
| // names := myBoard.AnalogNames() |
There was a problem hiding this comment.
I don't think AnalogNames is supported anymore
| @@ -27,7 +27,7 @@ import ( | |||
| // pin, err := myBoard.GPIOPinByName("15") | |||
| // | |||
| // // Get if it is true or false that the state of the pin is high. | |||
| // high := pin.Get(context.Background(), nil) | |||
| // high, err := pin.Get(context.Background(), nil) | |||
There was a problem hiding this comment.
did the returns of pin.Get change? like why is there an error now?
There was a problem hiding this comment.
Idk if it changed or if this was always wrong? But I'm seeing it returning bool, error: https://pkg.go.dev/go.viam.com/[email protected]/components/board#GPIOPin
| @@ -37,7 +37,7 @@ import ( | |||
| // pin, err := myBoard.GPIOPinByName("15") | |||
| // | |||
| // // Returns the duty cycle. | |||
| // duty_cycle := pin.PWM(context.Background(), nil) | |||
| // duty_cycle, err := pin.PWM(context.Background(), nil) | |||
There was a problem hiding this comment.
returns float64, err right? https://pkg.go.dev/go.viam.com/[email protected]/components/board#GPIOPin
| @@ -67,7 +67,7 @@ import ( | |||
| // pin, err := myBoard.GPIOPinByName("15") | |||
| // | |||
| // // Set the PWM frequency of this pin to 1600 Hz. | |||
| // high := pin.SetPWMFreq(context.Background(), 1600, nil) | |||
| // err = pin.SetPWMFreq(context.Background(), 1600, nil) | |||
There was a problem hiding this comment.
also did not know that this changed
There was a problem hiding this comment.
Maybe it has always returned an error but someone decided to name the error "high" or made a mistake? I just figured this makes more sense for consistency since looking at the interface it seems to return an error.
viambot
removed
the
safe to test
viambot
added
the
safe to test
No description provided.