Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.85 KB

docs.md

File metadata and controls

73 lines (52 loc) · 2.85 KB
layout title permalink
page
Das Keyboard Q software documentation
/docs/
    {% for card in site.data.docs_cards %}
  • {{card.description}}

  • {% endfor %}

 

Warning: the Q software is in very early stage. It's buggy, incomplete, and poorly documented. However it is improving quickly. Only use it if you are comfortable being a beta software and contributing useful feedback.

Q Desktop Software Installation

Download and install Q clients software

Q clients can be downloaded from the Q website: https://www.daskeyboard.com/technology/q-software/

Create a Das Keyboard Q account

In order to use the Q client, you'll need to create an account at https://q.daskeyboard.com/

Signup for the Q forum

The Q forum is an online discussion for technical discussion: https://qforum.daskeyboard.com

Sending Signals to your 5Q keyboard + developer API

A bit of lingo first: a signal is a message that contains color information (and more) to be displayed on a 5Q keyboard. All 3rd party platforms communicate with the Q clients by sending signals very much like your friends send text messages to your phone. Instead of being a text message, a signal contains also key color information.

Even without a real Q device, you can play with Signals. Signals will be displayed on the Q desktop "dashboard mode" and the Q Android app.

There are several possibilities to send signals to the 5Q keyboard:

Q Developer API

The developer Q API is an easy to use JSON REST API to send signals to the Q device.

Contributing

At this point of the development, we would like to ask the community for input on all aspects of the project: features, API, ideas, etc...

Please use the Q forum to interact.