Mike R / Mbed 2 deprecated Pinscape_Controller

An input/output controller for virtual pinball machines, with plunger position tracking, accelerometer-based nudge sensing, button input encoding, and feedback device control.

Dependencies:   USBDevice mbed FastAnalogIn FastIO FastPWM SimpleDMA

The Pinscape Controller is a special-purpose software project that I wrote for my virtual pinball machine.

New version: V2 is now available! The information below is for version 1, which will continue to be available for people who prefer the original setup.

What exactly is a virtual pinball machine? It's basically a video-game pinball emulator built to look like a real pinball machine. (The picture at right is the one I built.) You start with a standard pinball cabinet, either built from scratch or salvaged from a real machine. Inside, you install a PC motherboard to run the software, and install TVs in place of the playfield and backglass. Several Windows pinball programs can take advantage of this setup, including the open-source project Visual Pinball, which has hundreds of tables available. Building one of these makes a great DIY project, and it's a good way to add to your skills at woodworking, computers, and electronics. Check out the Cabinet Builders' Forum on vpforums.org for lots of examples and advice.

This controller project is a key piece in my setup that helps integrate the video game into the pinball cabinet. It handles several input/output tasks that are unique to virtual pinball machines. First, it lets you connect a mechanical plunger to the software, so you can launch the ball like on a real machine. Second, it sends "nudge" data to the software, based on readings from an accelerometer. This lets you interact with the game physically, which makes the playing experience more realistic and immersive. Third, the software can handle button input (for wiring flipper buttons and other cabinet buttons), and fourth, it can control output devices (for tactile feedback, button lights, flashers, and other special effects).

Documentation

The Hardware Build Guide (PDF) has detailed instructions on how to set up a Pinscape Controller for your own virtual pinball cabinet.

Update notes

December 2015 version: This version fully supports the new Expansion Board project, but it'll also run without it. The default configuration settings haven't changed, so existing setups should continue to work as before.

August 2015 version: Be sure to get the latest version of the Config Tool for windows if you're upgrading from an older version of the firmware. This update adds support for TSL1412R sensors (a version of the 1410 sensor with a slightly larger pixel array), and a config option to set the mounting orientation of the board in the firmware rather than in VP (for better support for FP and other pinball programs that don't have VP's flexibility for setting the rotation).

Feb/March 2015 software versions: If you have a CCD plunger that you've been using with the older versions, and the plunger stops working (or doesn't work as well) after you update to the latest version, you might need to increase the brightness of your light source slightly. Check the CCD exposure with the Windows config tool to see if it looks too dark. The new software reads the CCD much more quickly than the old versions did. This makes the "shutter speed" faster, which might require a little more light to get the same readings. The CCD is actually really tolerant of varying light levels, so you probably won't have to change anything for the update - I didn't. But if you do have any trouble, have a look at the exposure meter and try a slightly brighter light source if the exposure looks too dark.

Downloads

• Config tool for Windows (.exe and C# source): this is a Windows program that lets you view the raw pixel data from the CCD sensor, trigger plunger calibration mode, and configure some of the software options on the controller.

• Custom VP builds: I created modified versions of Visual Pinball 9.9 and Physmod5 that you might want to use in combination with this controller. The modified versions have special handling for plunger calibration specific to the Pinscape Controller, as well as some enhancements to the nudge physics. If you're not using the plunger, you might still want it for the nudge improvements. The modified version also works with any other input controller, so you can get the enhanced nudging effects even if you're using a different plunger/nudge kit. The big change in the modified versions is a "filter" for accelerometer input that's designed to make the response to cabinet nudges more realistic. It also makes the response more subdued than in the standard VP, so it's not to everyone's taste. The downloads include both the updated executables and the source code changes, in case you want to merge the changes into your own custom version(s).
  
  Note! These features are now standard in the official VP 9.9.1 and VP 10 releases, so you don't need my custom builds if you're using 9.9.1 or 10 or later. I don't think there's any reason to use my 9.9 instead of the official 9.9.1, but I'm leaving it here just in case. In the official VP releases, look for the checkbox "Enable Nudge Filter" in the Keys preferences dialog. (There's no checkbox in my custom builds, though; the filter is simply always on in those.)

• Output circuit shopping list: This is a saved shopping cart at mouser.com with the parts needed for each output driver, if you want to use the LedWiz emulator feature. Note that quantities in the cart are for one output channel, so multiply everything by the number of channels you plan to use, except that you only need one of the ULN2803 transistor array chips for each eight output circuits.

• Lemming77's potentiometer mounting bracket and shooter rod connecter: Sketchup designs for 3D-printable parts for mounting a slide potentiometer as the plunger sensor. These were designed for a particular slide potentiometer that used to be available from an Aliexpress.com seller but is no longer listed. You can probably use this design as a starting point for other similar devices; just check the dimensions before committing the design to plastic.

Features

• Plunger position sensing, using a TAOS TSL 1410R CCD linear array sensor. This sensor is a 1280 x 1 pixel array at 400 dpi, which makes it about 3" long - almost exactly the travel distance of a standard pinball plunger. The idea is that you install the sensor just above (within a few mm of) the shooter rod on the inside of the cabinet, with the CCD window facing down, aligned with and centered on the long axis of the shooter rod, and positioned so that the rest position of the tip is about 1/2" from one end of the window. As you pull back the plunger, the tip will travel down the length of the window, and the maximum retraction point will put the tip just about at the far end of the window. Put a light source below, facing the sensor - I'm using two typical 20 mA blue LEDs about 8" away (near the floor of the cabinet) with good results. The principle of operation is that the shooter rod casts a shadow on the CCD, so pixels behind the rod will register lower brightness than pixels that aren't in the shadow. We scan down the length of the sensor for the edge between darker and brighter, and this tells us how far back the rod has been pulled. We can read the CCD at about 25-30 ms intervals, so we can get rapid updates. We pass the readings reports to VP via our USB joystick reports.
  
  The hardware build guide includes schematics showing how to wire the CCD to the KL25Z. It's pretty straightforward - five wires between the two devices, no external components needed. Two GPIO ports are used as outputs to send signals to the device and one is used as an ADC in to read the pixel brightness inputs. The config tool has a feature that lets you display the raw pixel readings across the array, so you can test that the CCD is working and adjust the light source to get the right exposure level.
  
  Alternatively, you can use a slide potentiometer as the plunger sensor. This is a cheaper and somewhat simpler option that seems to work quite nicely, as you can see in Lemming77's video of this setup in action. This option is also explained more fully in the build guide.

• Nudge sensing via the KL25Z's on-board accelerometer. Mounting the board in your cabinet makes it feel the same accelerations the cabinet experiences when you nudge it. Visual Pinball already knows how to interpret accelerometer input as nudging, so we simply feed the acceleration readings to VP via the joystick interface.

• Cabinet button wiring. Up to 24 pushbuttons and switches can be wired to the controller for input controls (for example, flipper buttons, the Start button, the tilt bob, coin slot switches, and service door buttons). These appear to Windows as joystick buttons. VP can map joystick buttons to pinball inputs via its keyboard preferences dialog. (You can raise the 24-button limit by editing the source code, but since all of the GPIO pins are allocated, you'll have to reassign pins currently used for other functions.)

• LedWiz emulation (limited). In addition to emulating a joystick, the device emulates the LedWiz USB interface, so controllers on the PC side such as DirectOutput Framework can recognize it and send it commands to control lights, solenoids, and other feedback devices. 22 GPIO ports are assigned by default as feedback device outputs. This feature has some limitations. The big one is that the KL25Z hardware only has 10 PWM channels, which isn't enough for a fully decked-out cabinet. You also need to build some external power driver circuitry to use this feature, because of the paltry 4mA output capacity of the KL25Z GPIO ports. The build guide includes instructions for a simple and robust output circuit, including part numbers for the exact components you need. It's not hard if you know your way around a soldering iron, but just be aware that it'll take a little work.

Warning: This is not replacement software for the VirtuaPin plunger kit. If you bought the VirtuaPin kit, please don't try to install this software. The VP kit happens to use the same microcontroller board, but the rest of its hardware is incompatible. The VP kit uses a different type of sensor for its plunger and has completely different button wiring, so the Pinscape software won't work properly with it.

--- a/config.h	Sat Feb 28 00:32:57 2015 +0000
+++ b/config.h	Sat Mar 28 07:59:47 2015 +0000
@@ -7,40 +7,78 @@
 
 
 // --------------------------------------------------------------------------
+//
+// Enable/disable joystick functions.
+//
+// This controls whether or not we send joystick reports to the PC with the 
+// plunger and accelerometer readings.  By default, this is enabled.   If
+// you want to use two or more physical KL25Z Pinscape controllers in your
+// system (e.g., if you want to increase the number of output ports
+// available by using two or more KL25Z's), you should disable the joystick
+// features on the second (and third+) controller.  It's not useful to have
+// more than one board reporting the accelerometer readings to the host -
+// doing so will just add USB overhead.  This setting lets you turn off the
+// reports for the secondary controllers, turning the secondary boards into
+// output-only devices.
+//
+// Note that you can't use button inputs on a controller that has the
+// joystick features disabled, because the buttons are handled via the
+// joystick reports.  Wire all of your buttons to the primary KL25Z that
+// has the joystick features enabled.
+//
+// To disable the joystick features, just comment out the next line (add
+// two slashes at the beginning of the line).
+//
+#define ENABLE_JOYSTICK
+
+
+// --------------------------------------------------------------------------
 // 
 // LedWiz default unit number.
 //
-// Each LedWiz device has a unit number, from 0 to 15.  This lets you install
+// Each LedWiz device has a unit number, from 1 to 16.  This lets you install
 // more than one LedWiz in your system: as long as each one has a different
 // unit number, the software on the PC can tell them apart and route commands 
 // to the right device.
 //
-// A *real* LedWiz has its unit number set at the factory.  This will be 0
-// unless you specifically request a different number.
+// A *real* LedWiz has its unit number set at the factory; they set it to
+// unit 1 unless you specifically request a different number when you place
+// your order.
+//
+// For our *emulated* LedWiz, we default to unit #8.  However, if we're set 
+// up as a secondary Pinscape controller with the joystick functions turned 
+// off, we'll use unit #9 instead.  
 //
-// We use 7 as our default unit number, to avoid conflicting with any real 
-// LedWiz devices that you might have in your system.  If you have a real 
-// one, it will most likely be unit #0.  If you have two real ones, you
-// probably asked for the second one to be unit #1.  If you have three,
-// the third is probably #2.  And so on.  I don't think *anyone* has seven
-// of these things - that would be 224 separate channels, which seems like
-// a lot.  That's why I set the default to #7.  But if you do happen to have
-// a conflict, you can just change this number to one that you're not using
-// for one of your real LedWiz devices.
+// The reason we start at unit #8 is that we want to avoid conflicting with
+// any real LedWiz devices you have in your system.  If you have a real
+// LedWiz, it's probably unit #1, since that's the standard factor setting.
+// If you have two real LedWiz's, they're probably units #1 and #2.  If you 
+// have three... well, I don't think anyone actually has three, but if you 
+// did it would probably be unit #3.  And so on.  That's why we start at #8 - 
+// it seems really unlikely that this will conflict with anybody's existing 
+// setup.  On the off chance it does, simply change the setting here to a 
+// different unit number that's not already used in your system.
 //
-// Note 1:  on the PC side, all of the software adds 1 to the number you
-// see here.  0 here will show up as unit #1 on the PC; 7 here will be #8
-// on the PC.  They do it that way because programmers like to start
-// counting from 0, but they figure that civilians can't handle that and
-// have to start counting at 1.
+// Note 1:  the unit number here is the *user visible* unit number that
+// you use on the PC side.  It's the number you specify in your DOF
+// configuration and so forth.  Internally, the USB reports subtract
+// one from this number - e.g., nominal unit #1 shows up as 0 in the USB
+// reports.  If you're trying to puzzle out why all of the USB reports
+// are all off by one from the unit number you select here, that's why.
 //
 // Note 2:  the DOF Configtool (google it) knows about the Pinscape 
-// controller and knows that it uses 7 as its default unit number, so it
-// will name the .ini file for this controller xxx8.ini (the 7 becomes
-// an 8 on the PC side as described in the note above).  If you change
-// this number, you'll have to compensate by changing the number at the
-// end of the .ini filename to match.
-const uint8_t DEFAULT_LEDWIZ_UNIT_NUMBER = 0x07;
+// controller (it's known there as just a "KL25Z" rather than Pinscape).
+// And the DOF tool knows that it uses #8 as its default unit number, so
+// it names the .ini file for this controller xxx8.ini.  If you change the 
+// unit number here, remember to rename the DOF-generated .ini file to 
+// match, by changing the "8" at the end of the filename to the new number
+// you set here.
+const uint8_t DEFAULT_LEDWIZ_UNIT_NUMBER = 
+#ifdef ENABLE_JOYSTICK
+   0x08;   // joystick enabled - assume we're the primary KL25Z, so use unit #8
+#else
+   0x09;   // joystick disabled - assume we're a secondary, output-only KL25Z, so use #9
+#endif
 
 // --------------------------------------------------------------------------
 //
@@ -49,7 +87,7 @@
 // If you're NOT using the CCD sensor, comment out the next line (by adding
 // two slashes at the start of the line).
 
-#define ENABLE_CCD_SENSOR 1
+#define ENABLE_CCD_SENSOR
 
 // The KL25Z pins that the CCD sensor is physically attached to:
 //
@@ -78,7 +116,7 @@
 // next line (by removing the two slashes at the start of the line), and be
 // sure to comment out the ENABLE_CCD_SENSOR line above.
 
-//#define ENABLE_POT_SENSOR 1
+//#define ENABLE_POT_SENSOR
 
 // The KL25Z pin that your potentiometer is attached to.  Wire the end of
 // the potentiometer at the retracted end of the plunger to the 3.3V output
@@ -159,8 +197,7 @@
 // dialog, and find the Plunger item.  Open the drop-down list under that
 // item and select the button number defined below.
 //
-// If you wish to disable this feature, just set the LedWiz port number
-// to 0.
+// To disable this feature, just set ZBLaunchBallPort to 0 here.
 
 const int ZBLaunchBallPort = 32;
 const int LaunchBallButton = 24;
@@ -186,6 +223,7 @@
 const float LaunchBallPushDistance = .08;
 
 
+#ifdef DECL_EXTERNS
 // --------------------------------------------------------------------------
 //
 
@@ -374,3 +412,5 @@
     { NC, false }        // Not used,  LW port 32
 };
 
+
+#endif // DECL_EXTERNS
\ No newline at end of file