The Big Rename

Renamed the library to Kaleidoscope-HostOS, and followed up with other renames.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent d1b6e77504
commit d2d0193129

@ -1,4 +1,4 @@
# Akela-HostOS
# Kaleidoscope-HostOS
![status][st:stable]
@ -19,35 +19,36 @@ information can then be reused by other plugins.
See the [Unicode][plugin:unicode] extension for an example about how to use
`HostOS` in practice.
[plugin:unicode]: https://github.com/keyboardio/Akela-Unicode
[plugin:unicode]: https://github.com/keyboardio/Kaleidoscope-Unicode
## 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][fprdetect] library. To enable
auto-detection, `AKELA_HOSTOS_GUESSER` must be defined before including the
`HostOS` library header.
auto-detection, `KALEIDOSCOPE_HOSTOS_GUESSER` must be defined before including
the `HostOS` library header.
[fprdetect]: https://github.com/keyboardio/FingerprintUSBHost
```c++
#define AKELA_HOSTOS_GUESSER 1
#define KALEIDOSCOPE_HOSTOS_GUESSER 1
#include <Akela-HostOS.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-HostOS.h>
void someFunction (void) {
if (HostOS.os() == Akela::HostOS::LINUX) {
if (HostOS.os() == Kaleidoscope::HostOS::LINUX) {
// do something linux-y
}
if (HostOS.os() == Akela::HostOS::OSX) {
if (HostOS.os() == Kaleidoscope::HostOS::OSX) {
// do something OSX-y
}
}
void setup (void) {
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&HostOS);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&HostOS);
}
```
@ -69,4 +70,4 @@ The extension provides the following methods on the `HostOS` singleton:
Starting from the [example][plugin:example] is the recommended way of getting
started with the extension.
[plugin:example]: https://github.com/keyboardio/Akela-HostOS/blob/master/examples/HostOS/HostOS.ino
[plugin:example]: https://github.com/keyboardio/Kaleidoscope-HostOS/blob/master/examples/HostOS/HostOS.ino

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -16,7 +16,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Akela-HostOS.h>
#include <Kaleidoscope-HostOS.h>
const Key keymaps[][ROWS][COLS] PROGMEM = {
[0] = KEYMAP_STACKED
@ -42,13 +42,13 @@ const Key keymaps[][ROWS][COLS] PROGMEM = {
void setup () {
Serial.begin (9600);
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&HostOS, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&HostOS, NULL);
Serial.print ("Host OS id is: ");
Serial.println (HostOS.os (), DEC);
}
void loop () {
Keyboardio.loop ();
Kaleidoscope.loop ();
}

@ -1,10 +1,10 @@
name=Akela-HostOS
name=Kaleidoscope-HostOS
version=0.0.0
author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu>
sentence=Host OS detection and tracking for Keyboardio boards.
maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
sentence=Host OS detection and tracking for Kaleidoscope.
paragraph=Provides functions to help guessing and/or tracking the host OS.
category=Communication
url=https://github.com/keyboardio/Akela-HostOS
url=https://github.com/keyboardio/Kaleidoscope-HostOS
architectures=avr
dot_a_linkage=true

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,12 +18,12 @@
#pragma once
#include <Akela/HostOS.h>
#include <Akela/HostOS-Tracker.h>
#include <Akela/HostOS-Guesser.h>
#include <Kaleidoscope/HostOS.h>
#include <Kaleidoscope/HostOS-Tracker.h>
#include <Kaleidoscope/HostOS-Guesser.h>
#ifdef AKELA_HOSTOS_GUESSER
extern Akela::HostOS::Guesser HostOS;
#ifdef KALEIDOSCOPE_HOSTOS_GUESSER
extern KaleidoscopePlugins::HostOS::Guesser HostOS;
#else
extern Akela::HostOS::Tracker HostOS;
extern KaleidoscopePlugins::HostOS::Tracker HostOS;
#endif

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -16,11 +16,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Akela/HostOS-Guesser.h>
#include <Kaleidoscope/HostOS-Guesser.h>
#include <FingerprintUSBHost.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace HostOS {
Guesser::Guesser (void) {
}
@ -49,4 +49,4 @@ namespace Akela {
};
};
Akela::HostOS::Guesser HostOS;
KaleidoscopePlugins::HostOS::Guesser HostOS;

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,9 +18,9 @@
#pragma once
#include <Akela/HostOS.h>
#include <Kaleidoscope/HostOS.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace HostOS {
class Guesser : public Base {
public:

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -16,6 +16,6 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Akela/HostOS-Tracker.h>
#include <Kaleidoscope/HostOS-Tracker.h>
Akela::HostOS::Tracker HostOS;
KaleidoscopePlugins::HostOS::Tracker HostOS;

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,9 +18,9 @@
#pragma once
#include <Akela/HostOS.h>
#include <Kaleidoscope/HostOS.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace HostOS {
class Tracker : public Base {
public:

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -16,13 +16,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Akela/HostOS.h>
#include <Kaleidoscope/HostOS.h>
#include <EEPROM.h>
#define EEPROM_HOSTOS_TYPE_LOCATION 2
namespace Akela {
namespace KaleidoscopePlugins {
namespace HostOS {
void
Base::begin (void) {

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-HostOS -- Host OS detection and tracking for Kaleidoscope
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,9 +18,9 @@
#pragma once
#include <Akela-Core.h>
#include <Kaleidoscope.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace HostOS {
typedef enum {
LINUX,
@ -31,7 +31,7 @@ namespace Akela {
AUTO = 0xff,
} Type;
class Base : public KeyboardioPlugin {
class Base : public KaleidoscopePlugin {
public:
virtual void begin (void) final;
Loading…
Cancel
Save