buttons

Documentation

Index

• Constants
• Variables
• func ScanPeriodic(buttons *Buttons)
• type Button
  • func NewButton(name string, pin Pin, config *ButtonConfig) *Button
• type ButtonConfig
  • func NewButtonConfig(activeHigh, multiClicks bool, ...) *ButtonConfig
• type ButtonEvent
• type ButtonEventType
• type Buttons
  • func New(name string, button ...*Button) *Buttons
  • func (buttons *Buttons) GetEvent() *ButtonEvent
  • func (buttons *Buttons) GetName() string
  • func (buttons *Buttons) SetScanSkip(scanSkip uint8)
• type Pin

Constants

const ButtonEventChanSize = 16

Variables

var DefaultButtonMultiConfig = &ButtonConfig{
	activeHigh:        false,
	multiClicks:       true,
	filterSize:        1,
	actFinishCnt:      5,
	repeatDetectCnt:   0,
	repeatSkip:        2,
	longDetectCnt:     15,
	longLongDetectCnt: 39,
}

var DefaultButtonSingleConfig = &ButtonConfig{
	activeHigh:        false,
	multiClicks:       false,
	filterSize:        1,
	actFinishCnt:      0,
	repeatDetectCnt:   0,
	repeatSkip:        0,
	longDetectCnt:     0,
	longLongDetectCnt: 0,
}

var DefaultButtonSingleRepeatConfig = &ButtonConfig{
	activeHigh:        false,
	multiClicks:       false,
	filterSize:        1,
	actFinishCnt:      0,
	repeatDetectCnt:   10,
	repeatSkip:        2,
	longDetectCnt:     0,
	longLongDetectCnt: 0,
}

Functions

func ScanPeriodic

func ScanPeriodic(buttons *Buttons)

Types

type Button

type Button struct {
	// contains filtered or unexported fields
}

func NewButton

func NewButton(name string, pin Pin, config *ButtonConfig) *Button

type ButtonConfig

type ButtonConfig struct {
	// contains filtered or unexported fields
}

func NewButtonConfig

func NewButtonConfig(
	activeHigh, multiClicks bool,
	filterSize, actFinishCnt, repeatDetectCnt, repeatSkip, longDetectCnt, longLongDetectCnt uint8,
) *ButtonConfig

type ButtonEvent

type ButtonEvent struct {
	ButtonName  string
	Type        ButtonEventType
	ClickCount  uint8
	RepeatCount uint8
}

type ButtonEventType

type ButtonEventType int

const (
	EVT_NONE ButtonEventType = iota
	EVT_SINGLE
	EVT_MULTI
	EVT_LONG
	EVT_LONG_LONG
)

type Buttons

type Buttons struct {
	// contains filtered or unexported fields
}

func New

func New(name string, button ...*Button) *Buttons

func (*Buttons) GetEvent

func (buttons *Buttons) GetEvent() *ButtonEvent

func (*Buttons) GetName

func (buttons *Buttons) GetName() string

func (*Buttons) SetScanSkip

func (buttons *Buttons) SetScanSkip(scanSkip uint8)

type Pin

type Pin interface {
	Get() bool
}