easystepper

Documentation

Overview

Package easystepper provides a simple driver to rotate a 4-wire stepper motor.

Index

• type Device
  • func New(config DeviceConfig) (*Device, error)
  • func (d *Device) Configure()
  • func (d *Device) Move(steps int32)
  • func (d *Device) Off()
• type DeviceConfig
• type DualDevice
  • func NewDual(config DualDeviceConfig) (*DualDevice, error)
  • func (d *DualDevice) Configure()
  • func (d *DualDevice) Move(stepsA, stepsB int32)
  • func (d *DualDevice) Off()
• type DualDeviceConfig
• type StepMode

Types

type Device

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

Device holds the pins and the delay between steps

func New

func New(config DeviceConfig) (*Device, error)

New returns a new single easystepper driver given a DeviceConfig

func (*Device) Configure

func (d *Device) Configure()

Configure configures the pins of the Device

func (*Device) Move

func (d *Device) Move(steps int32)

Move rotates the motor the number of given steps (negative steps will rotate it the opposite direction)

func (*Device) Off

func (d *Device) Off()

Off turns off all motor pins

type DeviceConfig

type DeviceConfig struct {
	// Pin1 ... Pin4 determines the pins to configure and use for the device
	Pin1, Pin2, Pin3, Pin4 machine.Pin
	// StepCount is the number of steps required to perform a full revolution of the stepper motor
	StepCount uint
	// RPM determines the speed of the stepper motor in 'Revolutions per Minute'
	RPM uint
	// Mode determines the coil sequence used to perform a single step
	Mode StepMode
}

DeviceConfig contains the configuration data for a single easystepper driver

type DualDevice

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

DualDevice holds information for controlling 2 motors

func NewDual

func NewDual(config DualDeviceConfig) (*DualDevice, error)

NewDual returns a new dual easystepper driver given 8 pins, number of steps and rpm

func (*DualDevice) Configure

func (d *DualDevice) Configure()

Configure configures the pins of the DualDevice

func (*DualDevice) Move

func (d *DualDevice) Move(stepsA, stepsB int32)

Move rotates the motors the number of given steps (negative steps will rotate it the opposite direction)

func (*DualDevice) Off

func (d *DualDevice) Off()

Off turns off all motor pins

type DualDeviceConfig

type DualDeviceConfig struct {
	DeviceConfig
	// Pin5 ... Pin8 determines the pins to configure and use for the second device
	Pin5, Pin6, Pin7, Pin8 machine.Pin
}

DualDeviceConfig contains the configuration data for a dual easystepper driver

type StepMode

type StepMode uint8

StepMode determines the coil sequence used to perform a single step

const (
	// ModeFour uses a 'four step' coil sequence (12-23-34-41). This is the default (zero-value) mode
	ModeFour StepMode = iota
	// ModeEight uses an 'eight step' coil sequence (1-12-2-23-3-34-4-41)
	ModeEight
)

Valid values for StepMode