feat: forked from 'github.com/ralvarezdev/tinygo-pullup

Author: ralvarezdev

enabler/interfaces.go

@@ -0,0 +1,16 @@
+//go:build tinygo && (rp2040 || rp2350)
+
+package enabler
+
+import (
+	tinygopullup "github.com/ralvarezdev/tinygo-pullup"
+)
+
+type (
+	// Handler is the interface to handle pull-up resistor operations for enabling features
+	Handler interface {
+		tinygopullup.Handler
+		IsEnabled() bool
+		IsDisabled() bool
+	}
+)

enabler/types.go

@@ -0,0 +1,57 @@
+//go:build tinygo && (rp2040 || rp2350)
+
+package enabler
+
+import (
+	"machine"
+
+	tinygopullup "github.com/ralvarezdev/tinygo-pullup"
+	tinygotypes "github.com/ralvarezdev/tinygo-types"
+)
+
+type (
+	// DefaultHandler is the default implementation of the Handler interface.
+	DefaultHandler struct {
+		tinygopullup.Handler
+	}
+)
+
+// NewDefaultHandler creates a new default debug handler with the given pull-up handler.
+//
+// Parameters:
+//
+//	pullUpHandler: The pull-up handler to use
+//
+// Returns:
+//
+//	An instance of DefaultHandler, or an error if the pull-up handler is nil
+func NewDefaultHandler(
+	pullUpHandler tinygopullup.Handler,
+) (*DefaultHandler, tinygotypes.ErrorCode) {
+	if pullUpHandler == nil {
+		return nil, tinygopullup.ErrorCodePullUpResistorNilHandler
+	}
+
+	return &DefaultHandler{
+		pullUpHandler,
+	}, tinygotypes.ErrorCodeNil
+}
+
+// NewDefaultHandlerFromPin creates a new default debug handler with a pull-up handler created from the given pin.
+func NewDefaultHandlerFromPin(pin machine.Pin) *DefaultHandler {
+	pullUpHandler := tinygopullup.NewDefaultHandler(pin)
+
+	return &DefaultHandler{
+		pullUpHandler,
+	}
+}
+
+// IsEnabled checks if the debug mode is enabled.
+func (d *DefaultHandler) IsEnabled() bool {
+	return d.IsShorted()
+}
+
+// IsDisabled checks if the debug mode is disabled.
+func (d *DefaultHandler) IsDisabled() bool {
+	return d.IsOpen()
+}

errors.go

@@ -0,0 +1,16 @@
+//go:build tinygo && (rp2040 || rp2350)
+
+package tinygo_pullup
+
+import (
+	tinygotypes "github.com/ralvarezdev/tinygo-types"
+)
+
+const (
+	// ErrorCodePullUpResistorStartNumber is the starting number for Pull-Up Resistor-related error codes.
+	ErrorCodePullUpResistorStartNumber uint16 = 5200
+)
+
+const (
+	ErrorCodePullUpResistorNilHandler = tinygotypes.ErrorCode(iota + ErrorCodePullUpResistorStartNumber)
+)

go.mod

@@ -0,0 +1,5 @@
+module github.com/ralvarezdev/tinygo-pullup
+
+go 1.25.0
+
+require github.com/ralvarezdev/tinygo-types v0.0.3

go.sum

@@ -0,0 +1,2 @@
+github.com/ralvarezdev/tinygo-types v0.0.3 h1:h8ogOD2lOVxR+w5i6o+v/8qTROFA2KBjVXBM7NT3SMc=
+github.com/ralvarezdev/tinygo-types v0.0.3/go.mod h1:2u3ApwAtIqGZ6wDsmUYt44bIk1DEn06INNjtfWndCr4=

interfaces.go

@@ -0,0 +1,14 @@
+//go:build tinygo && (rp2040 || rp2350)
+
+package tinygo_pullup
+
+type (
+	// Handler is the interface to handle pull-up resistor operations
+	Handler interface {
+		Setup()
+		IsHigh() bool
+		IsLow() bool
+		IsOpen() bool
+		IsShorted() bool
+	}
+)

types.go

@@ -0,0 +1,70 @@
+//go:build tinygo && (rp2040 || rp2350)
+
+package tinygo_pullup
+
+import (
+	"machine"
+)
+
+type (
+	// DefaultHandler is the default implementation to handle pull-up resistor.
+	DefaultHandler struct {
+		inputPin machine.Pin
+	}
+)
+
+// NewDefaultHandler creates a new instance of DefaultHandler
+//
+// Parameters:
+//
+// inputPin: The GPIO pin to be used as the input pin.
+//
+// Returns:
+//
+// An instance of DefaultHandler.
+func NewDefaultHandler(inputPin machine.Pin) *DefaultHandler {
+	return &DefaultHandler{
+		inputPin,
+	}
+}
+
+// Setup initializes the input pin for the DefaultHandler
+func (d *DefaultHandler) Setup() {
+	d.inputPin.Configure(machine.PinConfig{Mode: machine.PinInputPullup})
+}
+
+// IsHigh checks if the input pin is high.
+//
+// Returns:
+//
+// True if the input pin is high, otherwise false.
+func (d *DefaultHandler) IsHigh() bool {
+	return d.inputPin.Get()
+}
+
+// IsLow checks if the input pin is low.
+//
+// Returns:
+//
+// True if the input pin is low, otherwise false.
+func (d *DefaultHandler) IsLow() bool {
+	return !d.inputPin.Get()
+}
+
+// IsOpen checks if the input pin is open (not connected).
+//
+// Returns:
+//
+// True if the input pin is open, otherwise false.
+func (d *DefaultHandler) IsOpen() bool {
+	return d.IsHigh()
+}
+
+// IsShorted checks if the input pin is shorted (connected to ground).
+//
+// Returns:
+//
+// True if the input pin is shorted, otherwise false.
+func (d *DefaultHandler) IsShorted() bool {
+	return d.IsLow()
+}