Skip to content

Commit

Permalink
GITBOOK-99: adding raytac pre-paired video
Browse files Browse the repository at this point in the history
  • Loading branch information
willwade authored and gitbook-bot committed Jul 3, 2024
1 parent 555b41c commit 73bc510
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
25 changes: 13 additions & 12 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,24 @@ Welcome to the RelayKeys Documentation! This comprehensive guide will help you s

### Introduction to RelayKeys

RelayKeys is an open-source software and hardware suite designed to facilitate seamless communication between computers, tablets, and phones via Bluetooth connections. Initially tailored for *AAC*[^1], its versatile technology extends its utility to a broader range of users who require text input or mouse commands to access Bluetooth-enabled devices.
RelayKeys is an open-source software and hardware suite designed to facilitate seamless communication between computers, tablets, and phones via Bluetooth connections. Initially tailored for _AAC_, its versatile technology extends its utility to a broader range of users who require text input or mouse commands to access Bluetooth-enabled devices.

#### Purpose and Benefits

RelayKeys serves various purposes:

* **Cost-Effective Solution**: For some, it offers a cost-effective alternative or replacement for pricey or obsolete hardware.
* **Accessibility for Disabilities**: Our primary focus is on empowering individuals with disabilities. RelayKeys enables users who rely on dedicated AAC systems, such as *Eyegaze*[^2], to access other devices essential for work or leisure. Unlike some commercial solutions, RelayKeys functions across devices without needing a shared network. It acts just like a Bluetooth keyboard and mouse, ensuring minimal lag.
* **Accessibility for Disabilities**: Our primary focus is on empowering individuals with disabilities. RelayKeys enables users who rely on dedicated AAC systems, such as _Eyegaze_, to access other devices essential for work or leisure. Unlike some commercial solutions, RelayKeys functions across devices without needing a shared network. It acts just like a Bluetooth keyboard and mouse, ensuring minimal lag.
* **Custom Control**: Users can utilize RelayKeys to control their tablets or phones, especially beneficial for tasks like music editing or photo manipulation, which typically require full-screen control. Any device responsive to a Bluetooth keyboard or mouse will work, e.g., smart TVs.
* **Open System**: RelayKeys' open architecture ensures longevity and promotes collaboration for system improvements, benefiting both individuals with disabilities and the general population.

{% embed url="https://www.youtube.com/watch?v=2wrZMGWgvcE" %}
Quick overview of features between devices
{% endembed %}

{% embed url="https://youtu.be/nEMUdILvEuA" %}
Using the raytac dongles prepaired to control a LG Smart TV
{% endembed %}

### Why Choose RelayKeys?

Expand All @@ -35,7 +41,7 @@ While other commercial solutions exist, RelayKeys offers unique advantages:

RelayKeys adheres to core principles that underpin its philosophy:

* **No Client Software/Hardware**: Catering to workplace and educational environments, RelayKeys functions without necessitating extra software or hardware on the client device. Provided *Bluetooth LE*[^3] support is available, RelayKeys operates seamlessly.
* **No Client Software/Hardware**: Catering to workplace and educational environments, RelayKeys functions without necessitating extra software or hardware on the client device. Provided _Bluetooth LE_ support is available, RelayKeys operates seamlessly.
* **Device Agnostic**: RelayKeys isn't restricted to specific devices or software solutions. Its adaptability allows developers to apply it diversely, promoting innovation.
* **Open Architecture**: RelayKeys is a transparent and open system, standing apart from closed, proprietary counterparts. This transparency fosters collaboration and ensures technology remains relevant despite shifting manufacturer priorities.

Expand All @@ -47,9 +53,9 @@ The RelayKeys ecosystem includes key components, each fulfilling a particular fu

Our standardized API ensures smooth communication with RelayKeys-compatible hardware devices over serial connections, encompassing USB buses and Bluetooth serial connections. More details are available at this [link](https://relaykeys.example.com/rk-serial).

#### RelayKeys-Service (RK-Service / *Daemon*)[^4]
#### RelayKeys-Service (RK-Service / _Daemon_)

The RK-Service acts as an *RPC*[^5] service, accepting incoming connections and interpreting commands. These commands are converted into *AT Commands*[^6], mimicking *HID*[^7] keyboard/mouse actions. The AT Commands are subsequently relayed through a serial connection to Bluetooth-integrated secondary devices. A Windows installer facilitates continuous operation.
The RK-Service acts as an _RPC_ service, accepting incoming connections and interpreting commands. These commands are converted into _AT Commands_, mimicking _HID_ keyboard/mouse actions. The AT Commands are subsequently relayed through a serial connection to Bluetooth-integrated secondary devices. A Windows installer facilitates continuous operation.

#### RelayKeys-QT (RK-Desktop)

Expand All @@ -61,10 +67,5 @@ The RK-CLI offers a command-line interface for RelayKeys interaction, serving as

Harness the full potential of RelayKeys with this documentation. Whether you're an AAC user aspiring for extensive accessibility or a developer pioneering innovative solutions, RelayKeys presents a platform championing accessibility and creativity.

[^1]: **AAC (Alternative and Augmentative Communication)**: Methods of communication that supplement or replace speech or writing for those with impairments in the production or comprehension of spoken or written language.
[^2]: **Eyegaze**: A technology that tracks where a user is looking on a screen, typically used as an input method for those with limited physical mobility.
[^3]: **Bluetooth LE (Low Energy)**: A power-conserving variant of the classic Bluetooth wireless communication standard.
[^4]: **Daemon**: A background process that runs on a computer system, often providing or facilitating services.
[^5]: **RPC (Remote Procedure Call)**: A protocol that allows programs to cause a procedure (subroutine) to execute in another address space (commonly on another computer on a shared network).
[^6]: **AT Commands**: A set of commands originally developed for controlling modems. The "AT" stands for "Attention." These commands have since been repurposed and expanded for a variety of other applications, including Bluetooth LE (BLE) devices.
[^7]: **HID (Human Interface Device)**: A type of computer device that interacts directly with, and most often takes input from, humans.
1. **Eyegaze**: A technology that tracks where a user is looking on a screen, typically used as an input method for those with limited physical mobility.
2. **Daemon**: A background process that runs on a computer system, often providing or facilitating services.
4 changes: 2 additions & 2 deletions docs/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* [Wired + Recieving Dongle](installation/connecting-with-relaykeys/wired-+-recieving-dongle.md)
* [Wireless Mode](installation/connecting-with-relaykeys/wireless-mode.md)
* [Checking it works](installation/checking-it-works.md)
* [🖥 Using RelayKeys](using-relaykeys/README.md)
* [🖥 Using RelayKeys](using-relaykeys/README.md)
* [RelayKeys Desktop (QT)](using-relaykeys/relaykeys-desktop-qt.md)
* [Command Line Usage](using-relaykeys/relaykeys-cli.md)
* [💬 Guides for use with AAC](using-relaykeys/guides/README.md)
Expand All @@ -23,7 +23,7 @@
* [Tobii Dynavox - Snap](using-relaykeys/guides/snap-corefirst.md)
* [Serial API](using-relaykeys/relaykeys-serial.md)
* [❓ Troubleshooting](troubleshooting.md)
* [👩💻 Developer Information](developers/README.md)
* [👩💻 Developer Information](developers/README.md)
* [Architecture of RelayKeys](developers/architecture.md)
* [Developing without a board](developers/developing-without-a-board.md)
* [Config File details](developers/relaykeys-cfg.md)
Expand Down

0 comments on commit 73bc510

Please sign in to comment.