# logitech-lcd
[![Build status](https://ci.appveyor.com/api/projects/status/sf8ladr0v2pdqigd?svg=true)](https://ci.appveyor.com/project/henninglive/logitech-lcd)
[![crates.io](https://img.shields.io/crates/v/logitech-lcd.svg)](https://crates.io/crates/logitech-lcd)
[![docs.rs](https://docs.rs/logitech-lcd/badge.svg)](https://docs.rs/logitech-lcd/)

Rust bindings for the [Logitech Gaming LCD/Gamepanel SDK][SDK]

## Overview
The Logitech LCD/GamePanel SDK introduces second screen capability that allows GamePanel-enabled Logitech gaming keyboards to display in-game info, system statistics, and more. The SDK enables integration of GamePanel functionality within your code.

[Documentation](https://docs.rs/logitech-lcd/)

## Supported Devices
- G19 - 320x240 Full RGBA **(Untested)**
- G510 - 160x43 Monochrome **(Working)**
- G13 - 160x43 Monochrome **(Untested)**
- G15 v1 - 160x43 Monochrome **(Untested)**
- G15 v2 - 160x43 Monochrome **(Untested)**
- LCD emulator - 160x43 Monochrome  **(Working)**
- LCD emulator - 320x240 Full RGBA  **(Working)**

### LCD Emulator
The Logitech Gaming Software comes with an LCD emulator. You can access it by going to your task bar tray `CTRL + SHIFT + RIGHT CLICK` on Logitech Gaming Software tray icon and press "LCD Emulator"

## Requirements
- **[Logitech Gaming Software][LGS]**

### Dynamic Loading
This crate will try to locate and load `LogitechLcd.dll` at runtime. We start by looking up the `CLSID` in the Windows registry, if it’s found we load the library with a call to [`LoadLibrary()`][LoadLibrary] with the full path. If it fails we call [`LoadLibrary()`][LoadLibrary] with just the DLL name. This will search your `PATH` for the library.

## Examples
### Hello World Monochrome
```rust
extern crate logitech_lcd;
use logitech_lcd::Lcd;

fn main() {
    let mut lcd = logitech_lcd::Lcd::init_mono("Hello World").unwrap();

    lcd.set_mono_text(1, "        Hello World!").unwrap();
    lcd.update();

    std::thread::sleep(std::time::Duration::from_millis(5000));
}
```
![hello-world-mono](https://github.com/henninglive/logitech-lcd/raw/master/examples/mono-hello-world.png)

### Hello World Color
```rust
extern crate logitech_lcd;
use logitech_lcd::{Lcd, COLOR_WIDTH, COLOR_HEIGHT, COLOR_BYTES_PER_PIXEL};

fn main() {
    let blank_screen = std::iter::repeat(255u8).take(
        COLOR_WIDTH * COLOR_HEIGHT * COLOR_BYTES_PER_PIXEL).collect::<Vec<u8>>();

    let mut lcd = Lcd::init_color("Color image app").unwrap();
    lcd.set_color_background(&blank_screen[..]).unwrap();

    lcd.set_color_title("  Hello World!", 0, 0, 0).unwrap();

    lcd.set_color_text(0, "Red",     0xFF, 0x00, 0x00).unwrap();
    lcd.set_color_text(1, "Green",   0x00, 0xFF, 0x00).unwrap();
    lcd.set_color_text(2, "Blue",    0x00, 0x00, 0xFF).unwrap();
    lcd.set_color_text(3, "Yellow",  0xFF, 0xFF, 0x00).unwrap();
    lcd.set_color_text(4, "Cyan ",   0x00, 0xFF, 0xFF).unwrap();
    lcd.set_color_text(5, "Magenta", 0xFF, 0x00, 0xFF).unwrap();
    lcd.update();

    std::thread::sleep(std::time::Duration::from_millis(10000));
}
```
![hello-world-color](https://github.com/henninglive/logitech-lcd/raw/master/examples/color-hello-world.png)

The artifacts should only be visible in the emulator.

### Monochrome Image
[`/examples/mono-image.rs`](https://github.com/henninglive/logitech-lcd/raw/master/examples/mono-image.rs)

![image-mono](https://github.com/henninglive/logitech-lcd/raw/master/examples/mono-image.png)

### Color Image
[`/examples/color-image.rs`](https://github.com/henninglive/logitech-lcd/raw/master/examples/color-image.rs)

![image-color](https://github.com/henninglive/logitech-lcd/raw/master/examples/color-image.png)

## License
### Code
Licensed under either of
 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.

### Art
The Rust and Cargo logos (bitmap and vector) are owned by Mozilla and distributed under the terms of the [Creative Commons Attribution license (CC-BY)](https://creativecommons.org/licenses/by/4.0/)

## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you shall be dual licensed as above, without any
additional terms or conditions.

[SDK]: http://gaming.logitech.com/en-us/developers
[LGS]: http://support.logitech.com/en_us/software/lgs
[LoadLibrary]: https://msdn.microsoft.com/en-us/library/windows/desktop/ms684175.aspx