3 releases

0.1.2 Jun 30, 2024
0.1.1 Apr 27, 2024
0.1.0 Apr 26, 2024

#349 in Hardware support

Download history 6/week @ 2024-09-10 2/week @ 2024-09-17 16/week @ 2024-09-24 7/week @ 2024-10-01

234 downloads per month

MIT license

87KB
2K SLoC

wiimote-rs

crates.io CI Documentation License

A Rust library to communicate with Wii remotes over Bluetooth.

Features

wiimote-rs is in development and currently supports:

  • Connect Wii remotes over Bluetooth by pressing the 1+2 buttons
  • Send data as output reports
  • Receive data as input reports
  • Read accelerometer calibration and convert from raw values
  • Read motion plus calibration and convert from raw values

Setup

Windows: no additional setup required

Linux: install the following packages on debian-based systems, or their equivalent on other distributions:

sudo apt install libudev-dev libbluetooth-dev clang

macOS: not supported at the moment

Examples

Check the examples directory for full examples.

Accept Wii remote connections

use wiimote_rs::prelude::*;

fn main() -> WiimoteResult<()> {
    let manager = WiimoteManager::get_instance();
    let new_devices = {
        let manager = manager.lock().unwrap();
        manager.new_devices_receiver()
    };

    new_devices.iter().try_for_each(|device| -> WiimoteResult<()> {
        // Do something with the connected Wii remote
        Ok(())
    })
}

Send data to Wii remotes

use std::sync::{Arc, Mutex};

use wiimote_rs::prelude::*;

use wiimote_rs::output::{OutputReport, PlayerLedFlags};

fn change_leds(device: Arc<Mutex<WiimoteDevice>>) -> WiimoteResult<()> {
    let led_report = OutputReport::PlayerLed(PlayerLedFlags::LED_2 | PlayerLedFlags::LED_3);
    device.lock().unwrap().write(&led_report)
}

Receive data from Wii remotes

use std::sync::{Arc, Mutex};

use wiimote_rs::prelude::*;

use wiimote_rs::input::InputReport;

fn read_buttons(device: Arc<Mutex<WiimoteDevice>>) -> WiimoteResult<()> {
    let input_report = device.lock().unwrap().read()?;
    match input_report {
        InputReport::DataReport(_, data) => {
            // All data reports except 0x3d contain button data
            let buttons = data.buttons();
        }
        _ => {}
    }
    Ok(())
}

Read accelerometer data

use std::sync::{Arc, Mutex};

use wiimote_rs::prelude::*;

use wiimote_rs::input::InputReport;

fn read_accelerometer(device: Arc<Mutex<WiimoteDevice>>) -> WiimoteResult<()> {
    // The accelerometer calibration can be stored and reused per WiimoteDevice
    let accelerometer_calibration = device.lock().unwrap().accelerometer_calibration().clone();

    let input_report = device.lock().unwrap().read()?;
    match input_report {
        // Note that the data report mode needs to be set to a mode that includes accelerometer data such as 0x31
        InputReport::DataReport(0x31, wiimote_data) => {
            let accelerometer_data = AccelerometerData::from_normal_reporting(&wiimote_data.data);
            let (x, y, z) = accelerometer_calibration.get_acceleration(&accelerometer_data);
        }
        _ => {}
    }
    Ok(())
}

Dependencies

~0.5–36MB
~542K SLoC