mikro

README

mikro

Go driver for the Native Instruments Maschine Mikro Mk3.

Documentation

Index

• Constants
• type Button
  • func (i Button) String() string
• type ButtonMessage
  • func (b *ButtonMessage) EncoderPosition() uint8
  • func (b *ButtonMessage) IsButtonPressed(btn Button) bool
  • func (b *ButtonMessage) IsEncoderTouched() bool
  • func (b *ButtonMessage) PressedButtons() []Button
  • func (b *ButtonMessage) StripPosition() uint8
  • func (b *ButtonMessage) StripSecondPosition() uint8
• type Color
  • func (i Color) String() string
• type ColorLevel
  • func (i ColorLevel) String() string
• type ColoredLight
• type Intensity
  • func (i Intensity) String() string
• type Lights
  • func NewLights() Lights
• type Mk3
  • func OpenMk3() (*Mk3, error)
  • func (m *Mk3) Close() error
  • func (m *Mk3) Lights() Lights
  • func (m *Mk3) Run(ctx context.Context) error
  • func (m *Mk3) SetLights(lights Lights) error
  • func (m *Mk3) SetOnButtonFunc(fn OnButtonFunc)
  • func (m *Mk3) SetOnPadFunc(fn OnPadPunc)
  • func (m *Mk3) SetScreen(img image.Image) error
• type OnButtonFunc
• type OnPadPunc
• type Pad
  • func (i Pad) String() string
• type PadAction
  • func (i PadAction) String() string
• type PadMessage
  • func (p *PadMessage) Action() PadAction
  • func (p *PadMessage) Pad() Pad
  • func (p *PadMessage) Velocity() uint16

Constants

const (
	Mk3VID = 0x17cc
	Mk3PID = 0x1700
)

const (
	PadNumber13 Pad = iota
	PadNumber14
	PadNumber15
	PadNumber16

	PadNumber9
	PadNumber10
	PadNumber11
	PadNumber12

	PadNumber5
	PadNumber6
	PadNumber7
	PadNumber8

	PadNumber1
	PadNumber2
	PadNumber3
	PadNumber4

	PadUndo     = PadNumber1
	PadRedo     = PadNumber2
	PadStepUndo = PadNumber3
	PadStepRedo = PadNumber4

	PadQuantize   = PadNumber5
	PadQuantize50 = PadNumber6
	PadNudgeLeft  = PadNumber7
	PadNudgeRight = PadNumber8

	PadClear     = PadNumber9
	PadClearAuto = PadNumber10
	PadCopy      = PadNumber11
	PadPaste     = PadNumber12

	PadSemitoneMinus = PadNumber13
	PadSemitonePlus  = PadNumber14
	PadOctaveMinus   = PadNumber15
	PadOctavePlus    = PadNumber16
)

Types

type Button

type Button int

const (
	ButtonProject Button = iota
	ButtonFavorites
	ButtonBrowser

	ButtonVolume
	ButtonSwing
	ButtonTempo
	ButtonPlugin
	ButtonSampling

	ButtonArrowLeft
	ButtonArrowRight

	ButtonPitch
	ButtonMod
	ButtonPerform
	ButtonNotes

	ButtonGroup
	ButtonAuto
	ButtonLock
	ButtonNoteRepeat

	ButtonRestart
	ButtonErase
	ButtonTap
	ButtonFollow

	ButtonPlay
	ButtonRec
	ButtonStop
	ButtonShift

	ButtonFixedVel
	ButtonPadMode
	ButtonKeyboard
	ButtonChords
	ButtonStep

	ButtonScene
	ButtonPattern
	ButtonEvents
	ButtonVariation
	ButtonDuplicate
	ButtonSelect
	ButtonSolo
	ButtonMute

	ButtonEncoder
)

func (Button) String

func (i Button) String() string

type ButtonMessage

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

func (*ButtonMessage) EncoderPosition

func (b *ButtonMessage) EncoderPosition() uint8

func (*ButtonMessage) IsButtonPressed

func (b *ButtonMessage) IsButtonPressed(btn Button) bool

func (*ButtonMessage) IsEncoderTouched

func (b *ButtonMessage) IsEncoderTouched() bool

func (*ButtonMessage) PressedButtons

func (b *ButtonMessage) PressedButtons() []Button

func (*ButtonMessage) StripPosition

func (b *ButtonMessage) StripPosition() uint8

func (*ButtonMessage) StripSecondPosition

func (b *ButtonMessage) StripSecondPosition() uint8

type Color

type Color uint8

const (
	ColorOff Color = iota
	ColorRed
	ColorOrange
	ColorLightOrange
	ColorWarmYellow
	ColorYellow
	ColorLime
	ColorGreen
	ColorMint
	ColorCyan
	ColorTurquoise
	ColorBlue
	ColorPlum
	ColorViolet
	ColorPurple
	ColorMagenta
	ColorFuchsia
	ColorWhite
)

func (Color) String

func (i Color) String() string

type ColorLevel

type ColorLevel uint8

const (
	ColorLevelLow ColorLevel = iota
	ColorLevelMedium
	ColorLevelHigh
	ColorLevelFaded
)

func (ColorLevel) String

func (i ColorLevel) String() string

type ColoredLight

type ColoredLight struct {
	Level ColorLevel
	Color Color
}

type Intensity

type Intensity uint8

const (
	IntensityLow Intensity = iota
	IntensityOff
	IntensityMedium
	IntensityHigh
)

func (Intensity) String

func (i Intensity) String() string

type Lights

type Lights struct {
	Buttons [39]Intensity
	Pads    [16]ColoredLight
	Strip   [35]ColoredLight
}

func NewLights

func NewLights() Lights

type Mk3

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

func OpenMk3

func OpenMk3() (*Mk3, error)

func (*Mk3) Close

func (m *Mk3) Close() error

func (*Mk3) Lights

func (m *Mk3) Lights() Lights

func (*Mk3) Run

func (m *Mk3) Run(ctx context.Context) error

func (*Mk3) SetLights

func (m *Mk3) SetLights(lights Lights) error

func (*Mk3) SetOnButtonFunc

func (m *Mk3) SetOnButtonFunc(fn OnButtonFunc)

func (*Mk3) SetOnPadFunc

func (m *Mk3) SetOnPadFunc(fn OnPadPunc)

func (*Mk3) SetScreen

func (m *Mk3) SetScreen(img image.Image) error

type OnButtonFunc

type OnButtonFunc func(msg ButtonMessage)

type OnPadPunc

type OnPadPunc func(msg PadMessage)

type Pad

type Pad uint8

func (Pad) String

func (i Pad) String() string

type PadAction

type PadAction uint8

const (
	PadActionPressed PadAction = iota + 1
	PadActionTouched
	PadActionReleased
)

func (PadAction) String

func (i PadAction) String() string

type PadMessage

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

func (*PadMessage) Action

func (p *PadMessage) Action() PadAction

func (*PadMessage) Pad

func (p *PadMessage) Pad() Pad

func (*PadMessage) Velocity

func (p *PadMessage) Velocity() uint16