Go Client for Das Keyboard Q Service

A simple Go client that can be used to send messages to a Q-enabled device via a Das Keyboard Q service. It supports both a locally-running service and the official Q Cloud.

Signals may contain lighting color and effect information, as well as a message for a human.

https://www.daskeyboard.io/get-started/

How to use this

This builds a SignalRequest value to trigger a popup message and set the Q key to solid red, which it effects by using the client’s CreateSignal method to send a message to the Q API.

package main
import (
    "context"
    "encoding/json"
    "log"
    "time"
    qclient "github.com/clockworksoul/daskeyboard-q-client"
)
func main() {
    client, err := qclient.New()
    if err != nil {
        log.Fatal("client error:", err)
    }
    // Create the signal request. Required fields are the name, color, and zone ID.
    // To know more about zone IDs, see https://www.daskeyboard.io/q-zone-id-explanation/.
    signal := qclient.NewSignalRequest("New Q app version available", "#FF0000", qclient.KeyQ).
        WithMessage("Q App version 3 is available.").
        WithEffect(qclient.EffectSetColor)
    ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
    defer cancel()
    // Send the signal creation request to the API. Returns a *SignalResponse
    // value or an error.
    response, err := client.CreateSignal(ctx, signal)
    if err != nil {
        log.Fatal("signal creation error:", err)
    }
    // Return the response as a string, just for fun.
    bytes, _ := json.MarshalIndent(response, "", "  ")
    log.Println(string(bytes))
}

The output would look something like:

{
  "name": "New Q app version available",
  "message": "Q App version 3 is available.",
  "zoneId": "KEY_Q",
  "color": "#FF0000",
  "effect": "SET_COLOR",
  "pid": "Q_MATRIX",
  "clientName": "GoClient",
  "id": -590,
  "userId": 14339,
  "createdAt": 1619815234590,
  "updatedAt": 1619815234590
}