Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (61 sloc) 3.21 KB
layout title permalink
Quick Start: Das Keyboard Q REST API

Das Keyboard Q devices RGB LEDs are very simple to program.

Copy the `shell` code below and paste it into a bash compatible terminal to start experimenting (Windows, Linux or macOS).

{% include /script-examples/signal-resource/create-signal/ %}

NOTE: Examples uses Linux-style shell command line. It is also available on Windows:

This quick start document covers the following:

  1. How it works: key concepts
  2. Getting authentication tokens
  3. Sending a signal to a Q device

Key Q concepts: How it works

In order to control the RGB LEDs of a Q device, a user must send authenticated HTTP JSON requests to a Q REST API.

Q cloud services provides a REST API that talks to Q devices. Alternatively, one can also write a script that directly interacts with a Q device via your workstation (i.e.: http://localhost:/#port...).

Therefore there are two ways to send a signal to a Q device:

  • From the Q cloud:
Your script on any computer --> Q clould service --> Q desktop app on your computer --> Q enabled device
  • Directly from your machine:
Your script on your computer --> Q desktop app on your computer --> Q enabled device

The example in this document uses the Q cloud service.

Getting authentication tokens

Since Q cloud service requires authenticated requests, you need to get an OAuth access token and refresh token.

To get them, first signup for an account at then find your client id and secret here:

Run this command to get your tokens:

curl -X POST -H "Content-Type: application/json" -d '{"client_id": "CLIENT_ID", "client_secret": "CLIENT_SECRET", "grant_type": "client_credentials"}'

Result format:


Sending a signal to a Q device

Now that you got your access token from the previous command, replace the ACCESS TOKEN below with the access_token value. Then, when you run the command, the A key should light up green.

curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" -X POST -d '{"name": "Apple stock increase", "pid": "DK5QPID", "zoneId": "KEY_A", "color": "#0F0"}'

It takes only few milliseconds for Q cloud service to send a signal to a Q device, so don't blink.

At this point you should see your Q device A-key colored in green. If you push the Q button on your Q keyboard, you'll see the message "Apple stock increase".

Next steps

As seen in this simple example, once authenticated, it is very easy to send a signal to a Q device. Ready to program your dashboard keyboard? Head over to the full API documentation: Q cloud documentation