Added Process, Stop and RawData.

Author: YonicDev

GCAdapter.cc

@@ -117,7 +117,7 @@ int AddAdapter(libusb_device *dev) {
 }
 NAN_METHOD(Load) {
     if(info.Length()>0) {
-        Nan::ThrowError("Load() must not have arguments");
+        Nan::ThrowError("Process() must not have arguments");
         return;
     }
 	int payload_size = 0, tmp = 0;
@@ -126,6 +126,10 @@ NAN_METHOD(Load) {
 	info.GetReturnValue().Set(return_value);
 }
 NAN_METHOD(Request) {
+	if (info.Length()>0) {
+		Nan::ThrowError("Load() must not have arguments");
+		return;
+	}
 	adapter_thread_running.Set(true);
 	adapter_thread = thread(Read);
 	auto return_string = PollBytes(controller_payload);
@@ -204,12 +208,79 @@ unsigned int GetNthBit(uint8_t number,int n) {
 	unsigned int bit = (unsigned)(number & (1 << n - 1));
 	return bit >> n-1;
 }
+NAN_METHOD(Process) {
+	if (info.Length()>0) {
+		Nan::ThrowError("Process() must not have arguments");
+		return;
+	}
+	adapter_thread_running.Set(true);
+	adapter_thread = thread(Read);
+	Nan::HandleScope arr_scope;
+	v8::Handle<v8::Array> arr = Nan::New<v8::Array>();
+	for (int i = 0; i < 4; i++) {
+		arr->Set(i,GetGamepadStatus(controller_payload, i+1));
+	}
+	info.GetReturnValue().Set(arr);
+}
+NAN_METHOD(RawData) {
+	if (info.Length()>0) {
+		Nan::ThrowError("RawData() must not have arguments");
+		return;
+	}
+	adapter_thread_running.Set(true);
+	adapter_thread = thread(Read);
+	stringstream return_value;
+	return_value << "[";
+	for (int i = 0; i < 10; i++) {
+		return_value << bitset<8>(controller_payload[i]) << ",";
+	}
+	return_value << bitset<8>(controller_payload[10]) << "]";
+	auto chain = Nan::New<v8::String>(return_value.str()).ToLocalChecked();
+	info.GetReturnValue().Set(chain);
+}
+
+v8::Local<v8::Object> GetGamepadStatus(uint8_t * results, int port)
+{
+	using namespace v8;
+	using namespace Nan;
+	Local<Object> status = New<Object>();
+
+	status->Set(New<String>("connected").ToLocalChecked(), New<Boolean>(GetNthBit(results[1 * port], 5)));
+
+	status->Set(New<String>("buttonA").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 1)));
+	status->Set(New<String>("buttonB").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 2)));
+	status->Set(New<String>("buttonX").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 3)));
+	status->Set(New<String>("buttonY").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 4)));
+
+	status->Set(New<String>("padLeft").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 5)));
+	status->Set(New<String>("padRight").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 6)));
+	status->Set(New<String>("padDown").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 7)));
+	status->Set(New<String>("padUp").ToLocalChecked(), New<Boolean>(GetNthBit(results[2 * port], 8)));
+
+	status->Set(New<String>("buttonL").ToLocalChecked(), New<Boolean>(GetNthBit(results[3 * port], 4)));
+	status->Set(New<String>("buttonR").ToLocalChecked(), New<Boolean>(GetNthBit(results[3 * port], 3)));
+	status->Set(New<String>("buttonZ").ToLocalChecked(), New<Boolean>(GetNthBit(results[3 * port], 2)));
+	status->Set(New<String>("buttonStart").ToLocalChecked(), New<Boolean>(GetNthBit(results[3 * port], 1)));
+
+	status->Set(New<String>("mainStickHorizontal").ToLocalChecked(), New<Number>(results[4 * port]/128.0 - 1));
+	status->Set(New<String>("mainVertical").ToLocalChecked(), New<Number>(results[5 * port]/128.0 - 1));
+
+	status->Set(New<String>("cStickHorizontal").ToLocalChecked(), New<Number>(results[6 * port]/128.0 -1));
+	status->Set(New<String>("cStickVertical").ToLocalChecked(), New<Number>(results[7 * port]/128.0 -1));
+
+	status->Set(New<String>("triggerL").ToLocalChecked(), New<Number>(results[8 * port]/256.0));
+	status->Set(New<String>("triggerR").ToLocalChecked(), New<Number>(results[9 * port]/256.0));
+
+	return status;
+}
 
 NAN_MODULE_INIT(Bridge) {
     NAN_EXPORT(target,Load);
     NAN_EXPORT(target,Setup);
 	NAN_EXPORT(target,Request);
+	NAN_EXPORT(target, Process);
 	NAN_EXPORT(target, Stop);
+	NAN_EXPORT(target, RawData);
 }
 
-NODE_MODULE(BridgeTest_2,Bridge)
+NODE_MODULE(gca_node,Bridge)

GCAdapter.h

@@ -4,18 +4,21 @@
 #include <libusb-1.0/libusb.h>
 #endif
 #include <sstream>
-#include <nan.h>
 
 #pragma once
 
 int AddAdapter(libusb_device *dev);
 NAN_METHOD(Load);
 NAN_METHOD(Setup);
 NAN_METHOD(Request);
+NAN_METHOD(Process);
+NAN_METHOD(Stop);
+NAN_METHOD(RawData);
 void Read();
 bool IsAccessible(libusb_device *dev);
 std::string PollBytes(uint8_t *results);
 unsigned int GetNthBit(uint8_t number, int n);
+v8::Local<v8::Object> GetGamepadStatus(uint8_t * results, int port);
 
 const uint16_t GAMECUBE_VID = 0x057E;
 const uint16_t GAMECUBE_PID = 0x0337;

README.md

@@ -4,7 +4,7 @@ gca-node is a NodeJS addon that adds Nintendo® Wii U GameCube™ Adapter
 
 ## Usage
 
-**gca-node currently only builds on Windows 7+**, although there is planned support for Linux and Mac OS.
+**gca-node currently only builds on Windows 7+ 64-bit**, although there is planned support for Linux and Mac OS.
 As of now, it can only be used on NW.js.
 
 ### Prerequisites
@@ -20,15 +20,17 @@ As of now, it can only be used on NW.js.
  3. Open the CLI inside the repository and execute `node-gyp rebuild`.
 
 ### NW.js
-1. Copy the included `configure.bat` to your NW.js project.
-2. Open the CLI inside your NW.js project, and run the `configure.bat` file to install the addon.
-3. Whenever you need to use gca-node, use an alias for require so that other NodeJS tools like webpack do not mistake it as a NodeJS module.
+1. Add `gca-node` to your project's `package.json` dependencies.
+2. Copy the included `configure.bat` to your NW.js project.
+3. Open the CLI inside your NW.js project, and run the `configure.bat` file to install the addon.
+4. **[Tip]:** Whenever you need to use gca-node, use an alias for require so that other NodeJS tools like webpack do not mistake it as a NodeJS module.
    ```
       var native_require = eval('require');
-      gca_node = native_require('gca-node.node')
+      gca_node = native_require('gca-node.node');
    ```
 
 ## gca-node API
+To be added on Wiki pages.
 
 ### Setup()
 Detects the first Nintendo® Wii U GameCube™ Adapter connected in your computer.
@@ -38,19 +40,49 @@ Returns 0 if the setup has detected one.
 Claims the interface to be used on the NodeJS application.
 Returns 0 if an interface has been succesfully claimed.
 
-### Read()
-TODO. Returns an object with the current status of the GameCube controller.
+### Process()
+Returns an array of 4 objects with the current status of each port of the adapter.
+Each object contains a status for each port, whether if there is a GameCube™ Controller connected or not.
 
 ### Request()
-Obtains debug information about the current status of the GameCube controllers.
+Returns debug information about the current status of the GameCube controllers.
 
+### RawData()
+Returns raw binary data of the status of the Adapter.
 
 ### Unload()
 Releases the interface so that it can be used by other applications.
 Returns 0 if succesful.
 
-### Shutdown()
+### Stop()
 Closes the Nintendo® Wii U GameCube™ Adapter so that it can be safely unplugged.
 Returns 0 if succesful.
 
-[logo]: http://i.imgur.com/quWt3jK.png
+## FAQ
+  * **What is the difference between gca-node and gca+?**
+     *  gca-node and the upcoming sister project [gca+][1] share almost the same source code. gca-node is designed for NodeJS applications, and gca+ is designed for C++ applications such as Unreal Engine.
+  * **Will gca-node support rumble?**
+     * gca-node 2.0 will be able to send rumble commands to the controllers.
+  * **Will gca-node support third party GameCube Controllers?**
+     * This has not been tested, but in theory it is very likely that third party GameCube controllers are compatible with gca-node. However, their extra features (i.e. turbo mode) will most likely be not supported due to the adapter's specifications.
+  * **Will gca-node support third party GameCube USB Adapters?**
+     * It is very unlikely due to the structure of gca-node as of now.
+  * **Will gca-node support connection with Game Boy Advance with GBA Link?**
+     * No. Unfortunately, the specifications of the adapter make it incompatible with the GBA Link. Even if it were to be compatible, remotely interfacing with the Game Boy Advance is currently impossible.
+  * **When will gca-node be cross-platform?**
+     * We expect support in Linux in gca-node 1.4.x.
+  * **Will gca-node br available for 32-bit platforms?**
+     * gca-node 1.5.x will start experimenting with 32-bit platforms.
+  * **Will gca-node support [electron][2] and apm?**
+     * Probably not. Testings with electron have reported problems due to using a different version of NodeJS and incomaptibilities with apm. We will investigate on a workaround during gca-node 2.x.
+  * **[Windows] Why is it necessary to use just Zadig? Can't I just use [ElMassivo's USB GameCube Adapter][3] instead?** 
+     * *ElMassivo's USB GameCube Adapter must remain inactive while gca-node is running*, as it claims the only interface available of the adapter. Without any other free interfaces, gca-node is unable to use the adapter, and viceversa.
+     * However, you can install ElMassivo's USB GameCube Adapter and not use it, since Zadig is a component of this program.
+  * **Why is gca-node better than HTML5 Gamepad API?**
+     * HTML5 Gamepad API requires ElMassivo's USB GameCube Adapter, which does not bring all native capabilities that gca-node offers, like real-time input or rumble support.
+     * Chromium's support for Nintendo® Wii U GameCube™ Adapter is currently incomplete and glitchy.
+
+[logo]: http://i.imgur.com/quWt3jK.png
+[1]: https://github.com/yonicstudios/gca-plus
+[2]: https://github.com/electron/electron
+[3]: http://m4sv.com/page/wii-u-gcn-usb-driver

test.js

@@ -1,3 +1,17 @@
-exports.gcaInit = function() {
-    console.log("GCA Node has been succesfully loaded.");
+gca_node = require("./build/Release/gca-node.node");
+
+var loop;
+
+loop = gca_node.Setup()
+if(loop>0) {
+    var loop = gca_node.Load();
+    var count = 0;
+    console.log(loop);
+    while(loop===0&&count<10000) {
+        console.log(gca_node.Process()[0]);
+        count+=1;
+    }
+    console.log(gca_node.Stop());
+} else {
+    console.log("Aaah " + loop)
 }