HID Wiimote 0.3.0.2

Recently some users were asking about compatibility and related issues. However it took some time until one was finally dropping a name and i figured all issue were about the same game. Just to make things quick in the future, if you have any game/tool/program that HID Wiimote does not work with, state its name along with the issue in detail. That way i can specifically look into it. If the particular piece of software is either still in active development or open source, there is a good chance i am able to fix it.

So this update is mainly for Clone Hero and Rewired, along with a minor fix for some rare Nunchuk regression. The update is available on the HID Wiimote page.

Extension Subtypes

Extensions for the Wii Remotes are using a six byte long identifier in a format of 0xXXXX A420 ZZZZ. The ZZZZ part is the extension type, as in class of extension. It is different for all the various extensions (Nunchuk, Classic Controller (Pro), Balance Board, Guitar Hero Accessory). The XXXX part is for most extensions just 0x0000 and does not need any special attention. However the Classic Controller and Classic Controller Pro are using the same extension type identifier (the ZZZZ part) and differ in their XXXX part. Classic Controller are using 0x0000, whereas the Classic Controller Pro reports 0x0100. So the XXXX can be viewed as subtype identifier, to distinguish between the normal and Pro variant. Another example are the Guitar Hero accessories, as they’re all using the same extension type identifier of 0x0103. Their subtype is different though (Guitars 0x0000, Drum Sets 0x0100 and Turn Tables 0x0300).

With 0.3.0.0 i changed the extension identification process. For the bumper and trigger mapping the driver needs distinguish between the Classic Controller and Pro variant. The non-Pro variant  has some analog triggers and therefore needs some special handling. So the identification process was changed to check against a composite identifier composed of the extension type and subtype parts. However one user reported a regression, that his Nunchuck doesn’t work anymore (it works in pre 0.3.0.0 and other Nunchucks work fine in 0.3.0.0+). It seems some other extensions are also using the subtype identifier for purposes that are unknown. In order to fix the regression, the identification process was reverted back. An explicit subtype check is only used for the Classic Controller (Pro) extension type.

Product and Serial String

As mentioned users were reporting that the driver wasn’t working with the game Clone Hero. I tried it myself and indeed for some reason it wasn’t working at all. You can tell by its directory layout that it is obviously made with Unity. In the past i already tested compatibility with Unity and verified it. So that was weird. After looking through the game folder i found some DLLs named Rewired. Rewired is a third-party Unity package for extensive input support. It adds various controllers, native APIs and their support, as well as button remapping tools.

Rewired provides a Trial. After downloading and doing some tests, its DirectInput mode was working fine. However RawInput was not at all, as in the controller didn’t even show up. A simple RawInput implementation was working fine though. I contacted the developer of Rewired about any special handling or filtering done by the package. They did some tests themselves and reported back quite quickly, so props for them.

The Windows HID API provides methods to retrieve a Product, Manufacturer and Serial string from the device. Apparently the default HidBth minidriver simply reports back the Bluetooth address as serial number. This can then be used to retrieve additional information about the actual Bluetooth device node. Rewired relies on that particular behavior and therefore was ignoring the controllers. The implementation of those strings were on the feature list for HID Wiimote. Though somewhere down the list at “Implement when necessary”. That case was apparently now. After adding support for the Product and Serial strings HID Wiimote is now compatible with Clone Hero, Rewired and any other that relies on that behavior.

Changes

  • Change checking Extension subtype
  • Add Product and Serial string support
  • Add minor delay to update process for UX
  • Change wording from “Switch” to “Swap”

HID Wiimote 0.3.0.0

Long time no see/read/update….

So far my development and release strategy for the multi driver mode feature was to design, implement and release it in one go. However such multi mode driver design isn’t that trivial. Combine that with my lack of development time for this project and the result was being stuck for a long time.

But that is changing now. I am going to release the multi driver mode feature in multiple steps as i progress development. The benefit is that new features are available earlier. On the downside development time may increase, as i need to reimplement and refactor the codebase. Furthermore settings  are not guaranteed to be stable among releases. But slow progress is better than no progress at all.

What’s new?

This update introduces the Control Center. That is an user mode application, that’ll act as installer and device settings tool. The installer let’s one easily enable and disable Driver Signature Verification (via Test Mode) and install and remove the HID Wiimote device driver. Furthermore for future updates it will automatically detect whether the device driver is installed and replace it (This does not work with pre 0.3.0.0 drivers, so for this update one has to manually remove any previous driver version). The Control Center shows all connected Wiimotes and let’s one apply device specific settings. Those settings include disabling a Wiimote’s accelerometers and some Classic Controller/Wii U Pro Controller mapping variations.

Installer Window
HID Wiimote Installer Window
HID Wiimote Control Center
HID Wiimote Control Center

Upcoming & Roadmap

The current release only includes the gamepad mode. The following updates are going to resolve around adding further driver modes. The goal is to finally have one driver supporting all kinds of different mode, i.e. IR mouse, DPad mouse, etc.

Next up is the raw/passthrough mode. That’ll make HID Wiimote compatible with third party applications, by letting them access the Wii Remote through my driver. So no more annoying driver switching. After that the mouse modes will be added. So long the old mouse version are still available, but won’t get any updates.

Final Words

As said the current release only includes the gamepad mode. So no update for people that use the Wiimote as mouse. Also to simplify the development process a Control Center is only compatible with its accompanied device driver version.

Before updating please remove any previous HID Wiimote Version.
As always downloads are available on the HID Wiimote page.

Change Log

  • Implement #2: Basic Tool for device specific settings, including an installer replacing TinyInstaller
  • Fix phony button presses when connecting extension

HID Wiimote Gamepad 0.2.7.0

Rather small technical changes for HID Wiimote. First one is primary a fix for Unity3D, when you want to use the Wiimote as gamepad. Unity3D uses RawInput instead if DirectInput, when reading from generic non XInput Gamepads. It seems RawInput has some issues with axes that have a negative value range, e.g. -127 to 127. So the change is to simply use a value range from 0 to 255.

The support for the Balance Board and Guitar Hero Guitar are completely untested and therefore pure experimental. I do not have a Balance Board nor a Guitar, therefore i am not able to test it(i might get a Balance Board in February). So use on your own risk, but you are welcome to report any issues and i’ll attempt to fix them.

Downloads are available on the HID Wiimote page.

Changes

  • Fix RawInput not reading the primary axes correctly
  • Add experimental untested Balance Board support
  • Add experimental untested Guitar Hero Guitar support

Current State of Windows HIDAPI and Wiimotes

Introduction

This is a small follow up on my testings. Long time it was believed that the PlusInside Wiimotes (“-TR”) are not working with the default Bluetooth Windows Stack. Every program and library recommends the common Toshiba Bluetooth “hack” to get “-TR” Wiimotes and Wii U Pro controllers working on Windows. I did some research with the HIDAPI on Windows and came to the result, that on Windows 8 and above using the proper API Calls, “-TR” Wiimotes, as well as the Wii U Pro Controller is working perfectly fine.

I implemented and fixed the Wiimote Code in the Dolphin Project, which also lead to improved Wiimote Audio for “-TR” Wiimotes.

TLDR;

Using the proper API Calls the Toshiba Bluetooth Stack is not needed anymore on Windows 8 and above. Both Wiimotes types (TR & non-TR) and the Wii U Pro are working fine. Here is the code repository of my test program.

The following post is basically just a copy & paste of the Readme, as it got quite extensive.

Windows 7

The API Calls would also work fine on Windows 7, but there is a bug in the Microsoft HID Class Driver. This renders the “WriteFile”-Method unusable on Windows 7, therefore it is not possible to use the HIDAPI to send data to “-TR” Wiimotes.

HIDAPI

Sending & Receiving

Sending HID Reports:

Recieving HID Reports:

The MSDN Design Guides Sending HID Reports and Obtaining HID Reports are stating, that WriteFile and ReadFile are the preferred methods to send and recieve data from the device. Additionally sending data to a “-TR” Wiimote via WriteFile is working fine, whereas using HidD_SetOutputReport will result in the Wiimote turning off.

Issues with WriteFile

As the MSDN Desgin Guide Sending HID Reports by Kernel-Mode Drivers (WriteFile will send out an IRP_MJ_WRITE request to the driver interface) suggests, the output report buffers shall have the size of the largest output report supported by the device. In case of the Wiimote this is 22 Byte.

This seems to be currently enforced by the Microsoft HID Class Driver on Windows 7 and the Toshiba Bluetooth Stack, as they will fail WriteFile attempts with the error ERROR_INVALID_USER_BUFFER, when the buffer size is less.

On Windows 7 however more bytes than the acutal report are sent to the device, which produces an error on the Wiimote. It is unknown whether this is a bug or intented behaviour. The Toshiba Bluetooth Stack in contrast only sends the appropiate amount of bytes according to the used report to the device.

On Windows 8 and higher, the output report buffer can be arbitrary in size, as the given amount of byte are submitted to the device.

This results in the following table of compability.

Table of compability

x Toshiba Stack Win 7 Win 8.1 Win 10
WriteFile Largest Report Size +
WriteFile Acutal Report Size + +
SetOutputReport +* +* +*

* does not support “-TR” when connected via Bluetooth

Method Priority Order

This leads us to the following order of prioritized methods:

  1. Detect whether the Microsoft Stack or the Toshiba Stack is used for the Wii Remote.
  2. In case of Toshiba Stack, use WriteFile with the largest report size for the buffer
  3. In case of Microsoft Stack, try WriteFile with the actual report size
  4. If WriteFile fails, fall back to HidD_SetOutputReport

Detecting Stack

To detect the used stack for the Wiimote, the provider property of the used HID Class Driver is evaluated. As the enumerated Wiimote Devices are just raw PDO’s, that are acting as interfaces for the HID Class Driver and don’t have a driver directly associated with, it is neccessary to move one node up in the device tree to get to the device node that is associated with the HID Class Driver. To do so the PnP Configuration Manager API is used.

Why WriteFile supports “-TR”

It is believed, that the usage of HidD_SetOutputReport will result in sending the output report via the Control Channel. This is not supported by “-TR” Wiimotes, as they will immediately shut down. In contrast WriteFile seems to send the data to device via the Interrput/Data Channel.

DolphinBar

The Mayflash DolphinBar enumerates Wiimotes as USB Devices, resulting in using the Microsoft HID Class Driver. Therefore WriteFile won’t work on Windows 7 for Wiimotes connected through the DolphinBar either. However as the DolphinBar takes care of the Bluetooth communication and the outgoing data is send via USB to the DolphinBar, HidD_SetOutputReport does support “-TR” Wiimotes as long as they are connected through a DolphinBar.

HID Wiimote 0.2.6

New Year; i am back in Berlin and can continue to work on HID Wiimote. Yay!

Rather small update with just one and a half fix. Regarding the connectivity issue on Windows 10 Version 1511, i had no issues while testing. Therefore i assume either the updated WDK or another Windows update fixed it. If the problem persists, please report back, so i can take another look at it.

Direct Download Links: Gamepad, IR-Mouse, DPad-Mouse

Links have been replaced with Hotfix 0.2.6.1 0.2.6.2: The installer had some problems on non English Windows Systems (and then i messed up the installer config).

Changes

  • Fix #11: Improved Extension Controller detection
  • Package now includes EULA and Readme file
  • Replaced Multilingual Driver Package Installer with only-English one
  • Introduced proper versioning, starting with 0.2.6
  • Build with WDK 10.0.10586.15, to hopefully fix connectivity issues with Windows 10 Version 1511 (November Update)

HID Wiimote Windows 10 Builds

Nyhet!

HID Wiimote Windows 10 Builds

Some more information

From now on there will be a unified build for Windows Desktop systems. The new WDK 10 makes it possible and in return it means less mess with different packages.

This build has nothing new except that is has been rebuild with the newest Visual Studio 2015 and Windows Driver Kit 10. So for non Windows 10 users there is no urgent need to download/update it. But you can if you like to, just make sure to uninstall the previous/old driver.

This new build was tested on a Windows 10 system with a build-in Bluetooth adapter and a separate Bluetooth Dongle, as well as on a Windows 8.1 system with a Bluetooth Dongle. I wasn’t able to test it on Windows 7, because i have currently no Windows 7 system here around, so please report back if there is any issue.

Windows 10 Universal Driver: Coming Soon™

So this is a multi-system Desktop build and not an Universal Driver. I am going to provide an Universal Driver as well soon, but there is some work to be done. The driver compiles fine and without any error. The only issue is that i have to make an universal .inf file, which simply requires me to read through the MSDN documentation.  However, i am currently not able to test the Universal Driver on a Windows Phone nor on an IoT-System, so the build is going to be purely experimental and for people that just want to give it a try.

I am also not quite certain about the driver signing regarding the Universal Driver. I have no clue whether it is possible to deactivate the driver verification on Mobile and IoT-Systems and get an unsigned driver loaded. I would assume there is some way, because devs need the ability to test drivers on the device, but that might require additional test modes, which in turn may have side effects.

Changes

  • Windows 10 Desktop Build

HID Wiimote Update – 13.07.15

Just two small fixes.

Changes

  • Fixed LED Battery Level display for Wii U Pro Controller
  • Each Classic Controller (Pro) & Wii U Pro Controller Trigger has its own input axis

HID Wiimote Source Code available

Wuhu! I have published the Source Code of HID Wiimote on Github.
Some have already asked for it, now i finally did it!

Check it out: https://github.com/jloehr/HID-Wiimote

I am going to fill it with Issues and Milestones in the next days.
But you can add Issues on your own, when encountering a bug.
If you manage to fix a bug, or come up with a cool feature, feel free to contribute.
Fork it, fix it, send a Pull Request!

 

IR-Mouse HID Wiimote Hotfix

Small hotfix for the IR-Mouse version of HID Wiimote. I stupidly removed the Hardware ID from the .inf file, thinking the IR-Mouse doesn’t need it, because the “-TR” Wii Remote shares it with the Wii U Pro Controller.

Added it back to the .inf file and made a new package batch. When you want to use the newer Wii Remotes with the IR-Mouse driver, uninstall the old one and get the fresh packages from the download page.

Since the Wii U Pro Controller has the same Hardware ID as the newer Wiimotes, the IR-Mouse driver gets also loaded for the Wii U Pro Controller, although it doesn’t have an IR-Sensor.

Changes to IR-Mouse

  • Hotfix for IR-Mouse to enable “-TR” Wii Remotes

HID Wiimote Update 01.06.15

I’ve finally finished the IR-Mouse Version of HID Wiimote!
With that driver you are able to control your mouse pointer by pointing your Wii Remote at your screen. You just need some kind of IR source with up to four points, but best is a Sensor Bar.
The input is slightly steadied but has therefore a small input delay. You can download the driver from the HID Wiimote page. If you are looking for the old DPad-Version you can find it here.

Additionally i made a small update to the Gamepad Version. I fixed a small issue, so the input state is reset when the connection to the controller is lost. You can get the update from the project site as well.

Next i am going to work on the XUSB communication, so i can create a XUSB/XInput Driver for the Wii U Pro Controller.

New IR-Mouse Version

  • Tracks up to four IR-Points
  • Interpolates with previous points to steady
  • Therefore slight delay

Changes to Gamepad

  • Input State is reset, when the connection is lost