Merge pull request magicmonkey#12 from lornajane/improve-examples

Start adding comments as documentation for examples

Author: lornajane

examples/client/client.go

@@ -19,47 +19,58 @@ func main() {
 	}
 	fmt.Printf("Found device [%s]\n", sd.GetName())
 
+	// Button in position 2, changes to "Bye!" at the end of the program
+	// When pressed, this prints "You pressed me" to the terminal
 	myButton := buttons.NewTextButton("Hi world")
 	myButton.SetActionHandler(&actionhandlers.TextPrintAction{Label: "You pressed me"})
 	sd.AddButton(2, myButton)
 
+	// Button in position 3, prints "5" to the terminal when pressed
 	myOtherButton := buttons.NewTextButton("4")
 	myOtherButton.SetActionHandler(&actionhandlers.NumberPrintAction{Number: 5})
 	sd.AddButton(3, myOtherButton)
 
+	// Button in position 7 (top right on Streamdeck XL), says 7
+	// When pressed, changes to display "8"
 	myNextButton := buttons.NewTextButton("7")
 	myNextButton.SetActionHandler(&actionhandlers.TextLabelChangeAction{NewLabel: "8"})
 	sd.AddButton(7, myNextButton)
 
+	// Image button, no action handler
 	anotherButton, err := buttons.NewImageFileButton("examples/test/play.jpg")
 	if err != nil {
 		panic(err)
 	}
 	sd.AddButton(9, anotherButton)
 
+	// Yellow button, no action handler but it goes to blue at the end of the program
 	cButton := buttons.NewColourButton(color.RGBA{255, 255, 0, 255})
 	sd.AddButton(26, cButton)
 
+	// One button, two actions (uses ChainedAction)
+	// Purple button, prints to the console and turns red when pressed
 	multiActionButton := buttons.NewColourButton(color.RGBA{255, 0, 255, 255})
 	thisActionHandler := &actionhandlers.ChainedAction{}
 	thisActionHandler.AddAction(&actionhandlers.TextPrintAction{Label: "Purple press"})
 	thisActionHandler.AddAction(&actionhandlers.ColourChangeAction{NewColour: color.RGBA{255, 0, 0, 255}})
 	multiActionButton.SetActionHandler(thisActionHandler)
 	sd.AddButton(27, multiActionButton)
 
+	// Text button, gets a red highlight after 2 seconds, then a green
+	// highlight after another 2 seconds
 	decoratedButton := buttons.NewTextButton("ABC")
 	sd.AddButton(19, decoratedButton)
-
 	time.Sleep(2 * time.Second)
 	decorator1 := decorators.NewBorder(10, color.RGBA{0, 255, 0, 255})
 	sd.SetDecorator(19, decorator1)
 	time.Sleep(2 * time.Second)
 	decorator2 := decorators.NewBorder(5, color.RGBA{255, 0, 0, 255})
 	sd.SetDecorator(19, decorator2)
-
 	time.Sleep(2 * time.Second)
 
+	// When this button says "Bye!", the program ends
 	myButton.SetText("Bye!")
+	// When this button goes blue, the program ends
 	cButton.SetColour(color.RGBA{0, 255, 255, 255})
 	sd.UnsetDecorator(19)
 }

examples/client2/client2.go

@@ -9,29 +9,36 @@ import (
 	"github.com/magicmonkey/go-streamdeck/actionhandlers"
 	"github.com/magicmonkey/go-streamdeck/buttons"
 	"github.com/magicmonkey/go-streamdeck/decorators"
+	_ "github.com/magicmonkey/go-streamdeck/devices"
 )
 
 func main() {
+	// store the currently selected button
 	var current int
 
+	// initialise the streamdeck
 	sd, err := streamdeck.New()
 	if err != nil {
 		panic(err)
 	}
 
+	// put a number onto each button
 	btns := make([]*buttons.TextButton, 32)
 	for i := 0; i < 32; i++ {
 		btns[i] = buttons.NewTextButton(strconv.Itoa(i))
 		sd.AddButton(i, btns[i])
 	}
 
+	// create some decorators for later use
 	greenBorder := decorators.NewBorder(10, color.RGBA{0, 255, 0, 255})
-
 	redBorder := decorators.NewBorder(5, color.RGBA{255, 0, 0, 255})
+
+	// add red borders to all buttons
 	for i := 0; i < 32; i++ {
 		sd.SetDecorator(i, redBorder)
 	}
 
+	// add action handlers as an inline function
 	for i := 0; i < 32; i++ {
 		h := actionhandlers.NewCustomAction(func(btn streamdeck.Button) {
 			sd.SetDecorator(current, redBorder)
@@ -41,8 +48,8 @@ func main() {
 		btns[i].SetActionHandler(h)
 	}
 
+	// don't end the program, keep running
 	var wg sync.WaitGroup
 	wg.Add(1)
 	wg.Wait()
-
 }

examples/client3/client3.go

@@ -10,24 +10,31 @@ import (
 )
 
 func main() {
-
+	// initialise the device
 	sd, err := streamdeck.New()
 	if err != nil {
 		panic(err)
 	}
 
+	// create a text button
 	btn1 := buttons.NewTextButton("Hello")
 	sd.AddButton(1, btn1)
+	// create an image button
 	btn2, _ := buttons.NewImageFileButton("examples/test/play.jpg")
 	sd.AddButton(2, btn2)
 
 
+	// set a green border on both buttons
 	greenBorder := decorators.NewBorder(10, color.RGBA{0, 255, 0, 255})
 	sd.SetDecorator(1, greenBorder)
 	sd.SetDecorator(2, greenBorder)
 
+	// wait for one second
 	time.Sleep(1 * time.Second)
 
+	// remove decorators
 	sd.UnsetDecorator(1)
 	sd.UnsetDecorator(2)
-}
+
+	// program exits
+}

examples/test/test.go

@@ -10,23 +10,25 @@ import (
 )
 
 func main() {
+	// connect to a streamdeck
 	sd, err := streamdeck.Open()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Printf("Found device [%s]\n", sd.GetName())
 
+	// remove all button content
 	sd.ClearButtons()
 
+	// manage brightness level
 	sd.SetBrightness(50)
 
+	// show text in increasing lengths on three buttons
 	sd.WriteTextToButton(2, "Hi!", color.RGBA{0, 0, 0, 255}, color.RGBA{0, 255, 255, 255})
 	sd.WriteTextToButton(3, "Hi again!", color.RGBA{0, 0, 0, 255}, color.RGBA{0, 255, 255, 255})
 	sd.WriteTextToButton(4, "Hi again again!", color.RGBA{0, 0, 0, 255}, color.RGBA{0, 255, 255, 255})
 
-	//sd.WriteImageToButton(9, "something.png")
-	//sd.WriteImageToButton(10, "play.jpg")
-	//sd.WriteColorToButton(color.RGBA{255, 0, 255, 0}, 1)
+	// when any button is pressed, clear all buttons, and set an image on the pressed button
 	sd.ButtonPress(func(btnIndex int, sd *streamdeck.Device, err error) {
 		if err != nil {
 			panic(err)
@@ -35,6 +37,7 @@ func main() {
 		sd.WriteImageToButton(btnIndex, "examples/test/play.jpg")
 	})
 
+	// keep the program running
 	var wg sync.WaitGroup
 	wg.Add(1)
 	wg.Wait()