Kaleidoscope/README.md

Kaleidoscope-HostOS

The HostOS extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same guesswork and logic. Its primary purpose is to help either detect, or keep track of the host operating system. The detection part is not the most reliable thing, mind you.

The goal is to have a single place that remembers the host OS, either detected, or set by the end-user, in a Sketch, or via a macro, or some other way. This information can then be reused by other plugins.

See the Unicode extension for an example about how to use HostOS in practice.

Using the extension

The extension provides a HostOS singleton object. It can either be a simple one without auto-detection (the default), or one that will try to detect the Host OS, using the FingerprintUSBHost library. To enable auto-detection, KALEIDOSCOPE_HOSTOS_GUESSER must be defined before including the HostOS library header.

#define KALEIDOSCOPE_HOSTOS_GUESSER 1

#include <Kaleidoscope.h>
#include <Kaleidoscope-HostOS.h>

void someFunction (void) {
  if (HostOS.os() == Kaleidoscope::HostOS::LINUX) {
    // do something linux-y
  }
  if (HostOS.os() == Kaleidoscope::HostOS::OSX) {
    // do something OSX-y
  }
}

void setup (void) {
  Kaleidoscope.setup (KEYMAP_SIZE);
  Kaleidoscope.use (&HostOS);
}

Extension methods

The extension provides the following methods on the HostOS singleton:

.os()

Returns the stored type of the Host OS.

.os(type)

Sets the type of the host OS, overriding any previous value. The type is then stored in EEPROM for persistence.

Further reading

Starting from the example is the recommended way of getting started with the extension.