Skip to content

Commit

Permalink
rename and reorder commands
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmowcomber
dmowcomber committed Nov 17, 2019
1 parent 96ac82c commit ea9a189
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 143 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# go-ws2812fx-firmata
go-ws2812fx-firmata is a Golang client for the ws2812fx-firmata Arduino library.
go-ws2812fx-firmata is a Golang client for the [ws2812fx-firmata](github.com/dmowcomber/ws2812fx-firmata) Arduino library.

## What?
Write Go code to control Neopixels.
14 changes: 7 additions & 7 deletions example/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ func main() {
arduinoAddress := "192.168.1.113:3030"
firmataAdaptor := firmata.NewTCPAdaptor(arduinoAddress)

neoPixelPin := "5"
neoPixelCount := uint16(7)
neoPixel := ws2812fxfirmata.NewNeopixelDriver(firmataAdaptor.Adaptor, neoPixelPin, neoPixelCount)
ws2812fx := ws2812fxfirmata.NewNeopixelDriver(firmataAdaptor.Adaptor)

fmt.Println("connecting")
err := firmataAdaptor.Connect()
Expand All @@ -23,13 +21,15 @@ func main() {
return
}

// TODO: this is redundant but without it pixels don't show correctly. need to fix this
neoPixel.SetConfig(5, 7)
ws2812fxPin := uint8(5)
ws2812fxCount := uint16(7)
ws2812fx.SetConfig(ws2812fxPin, ws2812fxCount)

ws2812fx.SetBrightness(uint8(1))

neoPixel.SetBrightness(uint8(255))
for {
time.Sleep(5 * time.Second)
neoPixel.RandomMode()
ws2812fx.ModeCycle()
}

}
230 changes: 95 additions & 135 deletions neopixel.go
View file
Original file line number Diff line number Diff line change
@@ -1,175 +1,144 @@
package ws2812fxfirmata

import (
"strconv"

"gobot.io/x/gobot"
"gobot.io/x/gobot/platforms/firmata"
)

const (
// serial commands
NEOPIXEL_CMD = 0x51
// turn strip off
NEOPIXEL_OFF = 0x00
// configure the strip
NEOPIXEL_CONFIG = 0x01
// show currently set pixels
NEOPIXEL_SHOW = 0x02
// set the color value of pixel n using 32bit packed color value
NEOPIXEL_SET_PIXEL = 0x03
NEOPIXEL_SET_STRIP = 0x04
// TODO: shift all the pixels n places along the strip
NEOPIXEL_SHIFT = 0x05

PIXEL_RANDOM_MODE = 0x06
PIXEL_SET_MODE = 0x07
// TODO: resort these
NEOPIXEL_ON = 0x08
NEOPIXEL_SET_COLOR = 0x09
NEOPIXEL_SET_BRIGHTNESS = 0x10
neopixelCmd = 0x51
neopixelSetBrightness = 0x00
neopixelSetColor = 0x01
neopixelSetPixel = 0x02
neopixelSetStrip = 0x03
neopixelShift = 0x04
neopixelSetMode = 0x05
neopixelModeCycle = 0x06
neopixelStart = 0x07
neopixelStop = 0x08
neopixelConfig = 0x09

// WS2812FX neopixel modes
// a list of modes can be found in the WS2812FX repo:
// https://github.com/kitesurfer1404/WS2812FX/blob/837b7dd843f0e0c38347c13e4b4594d6dc603162/src/WS2812FX.h#L120-L180
FX_MODE_STATIC = 0
FX_MODE_BLINK = 1
FX_MODE_BREATH = 2
FX_MODE_COLOR_WIPE = 3
FX_MODE_COLOR_WIPE_INV = 4
FX_MODE_COLOR_WIPE_REV = 5
FX_MODE_COLOR_WIPE_REV_INV = 6
FX_MODE_COLOR_WIPE_RANDOM = 7
FX_MODE_RANDOM_COLOR = 8
FX_MODE_SINGLE_DYNAMIC = 9
FX_MODE_MULTI_DYNAMIC = 10
FX_MODE_RAINBOW = 11
FX_MODE_RAINBOW_CYCLE = 12
FX_MODE_SCAN = 13
FX_MODE_DUAL_SCAN = 14
FX_MODE_FADE = 15
FX_MODE_THEATER_CHASE = 16
FX_MODE_THEATER_CHASE_RAINBOW = 17
FX_MODE_RUNNING_LIGHTS = 18
FX_MODE_TWINKLE = 19
FX_MODE_TWINKLE_RANDOM = 20
FX_MODE_TWINKLE_FADE = 21
FX_MODE_TWINKLE_FADE_RANDOM = 22
FX_MODE_SPARKLE = 23
FX_MODE_FLASH_SPARKLE = 24
FX_MODE_HYPER_SPARKLE = 25
FX_MODE_STROBE = 26
FX_MODE_STROBE_RAINBOW = 27
FX_MODE_MULTI_STROBE = 28
FX_MODE_BLINK_RAINBOW = 29
FX_MODE_CHASE_WHITE = 30
FX_MODE_CHASE_COLOR = 31
FX_MODE_CHASE_RANDOM = 32
FX_MODE_CHASE_RAINBOW = 33
FX_MODE_CHASE_FLASH = 34
FX_MODE_CHASE_FLASH_RANDOM = 35
FX_MODE_CHASE_RAINBOW_WHITE = 36
FX_MODE_CHASE_BLACKOUT = 37
FX_MODE_CHASE_BLACKOUT_RAINBOW = 38
FX_MODE_COLOR_SWEEP_RANDOM = 39
FX_MODE_RUNNING_COLOR = 40
FX_MODE_RUNNING_RED_BLUE = 41
FX_MODE_RUNNING_RANDOM = 42
FX_MODE_LARSON_SCANNER = 43
FX_MODE_COMET = 44
FX_MODE_FIREWORKS = 45
FX_MODE_FIREWORKS_RANDOM = 46
FX_MODE_MERRY_CHRISTMAS = 47
FX_MODE_FIRE_FLICKER = 48
FX_MODE_FIRE_FLICKER_SOFT = 49
FX_MODE_FIRE_FLICKER_INTENSE = 50
FX_MODE_CIRCUS_COMBUSTUS = 51
FX_MODE_HALLOWEEN = 52
FX_MODE_BICOLOR_CHASE = 53
FX_MODE_TRICOLOR_CHASE = 54
FX_MODE_ICU = 55
FX_MODE_CUSTOM = 56
FX_MODE_CUSTOM_0 = 56
FX_MODE_CUSTOM_1 = 57
FX_MODE_CUSTOM_2 = 58
FX_MODE_CUSTOM_3 = 59
FXModeStatic = 0
FXModeBlink = 1
FXModeBreath = 2
FXModeColorWipe = 3
FXModeColorWipeInv = 4
FXModeColorWipeRev = 5
FXModeColorWipeRevInv = 6
FXModeColorWipeRandom = 7
FXModeRandomColor = 8
FXModeSingleDynamic = 9
FXModeMultiDynamic = 10
FXModeRainbow = 11
FXModeRainbowCycle = 12
FXModeScan = 13
FXModeDualScan = 14
FXModeFade = 15
FXModeTheaterChase = 16
FXModeTheaterChaseRainbow = 17
FXModeRunningLights = 18
FXModeTwinkle = 19
FXModeTwinkleRandom = 20
FXModeTwinkleFade = 21
FXModeTwinkleFadeRandom = 22
FXModeSparkle = 23
FXModeFlashSparkle = 24
FXModeHyperSparkle = 25
FXModeStrobe = 26
FXModeStrobeRainbow = 27
FXModeMultiStrobe = 28
FXModeBlinkRainbow = 29
FXModeChaseWhite = 30
FXModeChaseColor = 31
FXModeChaseRandom = 32
FXModeChaseRainbow = 33
FXModeChaseFlash = 34
FXModeChaseFlashRandom = 35
FXModeChaseRainbowWhite = 36
FXModeChaseBlackout = 37
FXModeChaseBlackoutRainbow = 38
FXModeColorSweepRandom = 39
FXModeRunningColor = 40
FXModeRunningRedBlue = 41
FXModeRunningRandom = 42
FXModeLarsonScanner = 43
FXModeComet = 44
FXModeFireworks = 45
FXModeFireworksRandom = 46
FXModeMerryChristmas = 47
FXModeFireFlicker = 48
FXModeFireFlickerSoft = 49
FXModeFireFlickerIntense = 50
FXModeCircusCombustus = 51
FXModeHalloween = 52
FXModeBicolorChase = 53
FXModeTricolorChase = 54
FXModeIcu = 55
FXModeCustom = 56
FXModeCustom0 = 56
FXModeCustom1 = 57
FXModeCustom2 = 58
FXModeCustom3 = 59
)

// NeopixelDriver represents a connection to a NeoPixel
type NeopixelDriver struct {
name string
pin string
pixelCount uint16
connection *firmata.Adaptor
gobot.Eventer
}

// NewNeopixelDriver returns a new NeopixelDriver
func NewNeopixelDriver(a *firmata.Adaptor, pin string, pixelCount uint16) *NeopixelDriver {
func NewNeopixelDriver(a *firmata.Adaptor) *NeopixelDriver {
neo := &NeopixelDriver{
name: gobot.DefaultName("Neopixel"),
connection: a,
pin: pin,
pixelCount: pixelCount,
Eventer: gobot.NewEventer(),
}

return neo
}

// Start starts up the NeopixelDriver
func (neo *NeopixelDriver) Start() (err error) {
i, _ := strconv.Atoi(neo.pin)
return neo.SetConfig(uint8(i), neo.pixelCount)
}

// Halt stops the NeopixelDriver
func (neo *NeopixelDriver) Halt() (err error) {
return neo.Off()
}

// Name returns the Driver's name
func (neo *NeopixelDriver) Name() string { return neo.name }

// SetName sets the Driver's name
func (neo *NeopixelDriver) SetName(n string) { neo.name = n }

// Pin returns the Driver's pin
func (neo *NeopixelDriver) Pin() string { return neo.pin }

// Connection returns the Driver's Connection
func (neo *NeopixelDriver) Connection() gobot.Connection { return neo.connection }

// Off turns off all the Neopixels in the strip
func (neo *NeopixelDriver) Off() error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_OFF})
// SetConfig sets the pin and pixel count for the Neopixel strip
func (neo *NeopixelDriver) SetConfig(pin uint8, pixelCount uint16) error {
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelConfig,
byte(pin),
byte(pixelCount & 0x7F),
byte((pixelCount >> 7) & 0x7F),
})
}

// On turns on all the Neopixels in the strip
func (neo *NeopixelDriver) On() error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_ON})
// Stop turns off all the Neopixels in the strip
func (neo *NeopixelDriver) Stop() error {
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelStop})
}

// Show activates all the Neopixels in the strip
func (neo *NeopixelDriver) Show() error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_SHOW})
// Start turns on all the Neopixels in the strip
func (neo *NeopixelDriver) Start() error {
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelStart})
}

func (neo *NeopixelDriver) RandomMode() error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, PIXEL_RANDOM_MODE})
// ModeCycle cycles through modes
func (neo *NeopixelDriver) ModeCycle() error {
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelModeCycle})
}

// SetMode sets the mode
func (neo *NeopixelDriver) SetMode(mode uint8) error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, PIXEL_SET_MODE, byte(mode)})
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelSetMode, byte(mode)})
}

// SetBrightness sets the brightness
func (neo *NeopixelDriver) SetBrightness(brightness uint8) error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_SET_BRIGHTNESS, byte(brightness)})
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelSetBrightness, byte(brightness)})
}

// SetPixel sets the color of one specific Neopixel in the strip
func (neo *NeopixelDriver) SetPixel(pix uint16, color uint32) error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_SET_PIXEL,
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelSetPixel,
byte(pix & 0x7F),
byte((pix >> 7) & 0x7F),
byte(color & 0x7F),
Expand All @@ -181,19 +150,10 @@ func (neo *NeopixelDriver) SetPixel(pix uint16, color uint32) error {

// SetColor sets the color of the strip
func (neo *NeopixelDriver) SetColor(color uint32) error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_SET_COLOR,
return neo.connection.WriteSysex([]byte{neopixelCmd, neopixelSetColor,
byte(color & 0x7F),
byte((color >> 7) & 0x7F),
byte((color >> 14) & 0x7F),
byte((color >> 21) & 0x7F),
})
}

// SetConfig sets the config info for the Neopixel strip
func (neo *NeopixelDriver) SetConfig(pin uint8, len uint16) error {
return neo.connection.WriteSysex([]byte{NEOPIXEL_CMD, NEOPIXEL_CONFIG,
byte(pin),
byte(len & 0x7F),
byte((len >> 7) & 0x7F),
})
}

0 comments on commit ea9a189

Please sign in to comment.