Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-2949: QA board examples #4661

Merged
merged 3 commits into from
Jan 7, 2025
Merged

DOCS-2949: QA board examples #4661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8bc066c
QA board examples
JessamyT Dec 31, 2024
8de749c
lint
JessamyT Dec 31, 2024
3b20aae
Update components/board/board.go
JessamyT Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/board/board.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ type Board interface {
// analog, err := myBoard.AnalogByName("my_example_analog")
//
// // Set the pin to value 48.
// err := analog.Write(context.Background(), 48, nil)
// err = analog.Write(context.Background(), 48, nil)
type Analog interface {
// Read reads off the current value.
Read(ctx context.Context, extra map[string]interface{}) (AnalogValue, error)
Expand Down
10 changes: 5 additions & 5 deletions components/board/gpio_pin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
// pin, err := myBoard.GPIOPinByName("15")
//
// // Set the pin to high.
// err := pin.Set(context.Background(), "true", nil)
// err = pin.Set(context.Background(), true, nil)
//
// Get example:
//
Expand All @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did the returns of pin.Get change? like why is there an error now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

//
// PWM example:
//
Expand All @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

returns float64, err right? https://pkg.go.dev/go.viam.com/[email protected]/components/board#GPIOPin

//
// SetPWM example:
//
Expand All @@ -47,7 +47,7 @@ import (
// pin, err := myBoard.GPIOPinByName("15")
//
// // Set the duty cycle to .6, meaning that this pin will be in the high state for 60% of the duration of the PWM interval period.
// err := pin.SetPWM(context.Background(), .6, nil)
// err = pin.SetPWM(context.Background(), .6, nil)
//
// PWMFreq example:
//
Expand All @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also did not know that this changed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

type GPIOPin interface {
// Set sets the pin to either low or high.
Set(ctx context.Context, high bool, extra map[string]interface{}) error
Expand Down
Loading