Markus Kalkbrenner / Mbed 2 deprecated Pinscape_Controller

work in progress

Dependencies:   FastAnalogIn FastIO USBDevice mbed FastPWM SimpleDMA

Fork of Pinscape_Controller by Mike R

config.h@21:5048e16cc9ef, 2015-03-28 (annotated)

Committer:
mjr
Date:
Sat Mar 28 07:59:47 2015 +0000
Revision:
21:5048e16cc9ef
Parent:
18:5e890ebd0023
Child:
23:14f8c5004cd0
New No-Joystick configuration option (for secondary devices that only act as output controllers)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjr 17:ab3cec0c8bf4 1 // Pinscape Controller Configuration
mjr 17:ab3cec0c8bf4 2 //
mjr 17:ab3cec0c8bf4 3 // To customize your private configuration, simply open this file in the
mjr 17:ab3cec0c8bf4 4 // mbed on-line IDE, make your changes, save the file, and click the Compile
mjr 17:ab3cec0c8bf4 5 // button at the top of the window. That will generate a customized .bin
mjr 17:ab3cec0c8bf4 6 // file that you can download onto your KL25Z board.
mjr 17:ab3cec0c8bf4 7
mjr 17:ab3cec0c8bf4 8
mjr 17:ab3cec0c8bf4 9 // --------------------------------------------------------------------------
mjr 21:5048e16cc9ef 10 //
mjr 21:5048e16cc9ef 11 // Enable/disable joystick functions.
mjr 21:5048e16cc9ef 12 //
mjr 21:5048e16cc9ef 13 // This controls whether or not we send joystick reports to the PC with the
mjr 21:5048e16cc9ef 14 // plunger and accelerometer readings. By default, this is enabled. If
mjr 21:5048e16cc9ef 15 // you want to use two or more physical KL25Z Pinscape controllers in your
mjr 21:5048e16cc9ef 16 // system (e.g., if you want to increase the number of output ports
mjr 21:5048e16cc9ef 17 // available by using two or more KL25Z's), you should disable the joystick
mjr 21:5048e16cc9ef 18 // features on the second (and third+) controller. It's not useful to have
mjr 21:5048e16cc9ef 19 // more than one board reporting the accelerometer readings to the host -
mjr 21:5048e16cc9ef 20 // doing so will just add USB overhead. This setting lets you turn off the
mjr 21:5048e16cc9ef 21 // reports for the secondary controllers, turning the secondary boards into
mjr 21:5048e16cc9ef 22 // output-only devices.
mjr 21:5048e16cc9ef 23 //
mjr 21:5048e16cc9ef 24 // Note that you can't use button inputs on a controller that has the
mjr 21:5048e16cc9ef 25 // joystick features disabled, because the buttons are handled via the
mjr 21:5048e16cc9ef 26 // joystick reports. Wire all of your buttons to the primary KL25Z that
mjr 21:5048e16cc9ef 27 // has the joystick features enabled.
mjr 21:5048e16cc9ef 28 //
mjr 21:5048e16cc9ef 29 // To disable the joystick features, just comment out the next line (add
mjr 21:5048e16cc9ef 30 // two slashes at the beginning of the line).
mjr 21:5048e16cc9ef 31 //
mjr 21:5048e16cc9ef 32 #define ENABLE_JOYSTICK
mjr 21:5048e16cc9ef 33
mjr 21:5048e16cc9ef 34
mjr 21:5048e16cc9ef 35 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 36 //
mjr 17:ab3cec0c8bf4 37 // LedWiz default unit number.
mjr 17:ab3cec0c8bf4 38 //
mjr 21:5048e16cc9ef 39 // Each LedWiz device has a unit number, from 1 to 16. This lets you install
mjr 17:ab3cec0c8bf4 40 // more than one LedWiz in your system: as long as each one has a different
mjr 17:ab3cec0c8bf4 41 // unit number, the software on the PC can tell them apart and route commands
mjr 17:ab3cec0c8bf4 42 // to the right device.
mjr 17:ab3cec0c8bf4 43 //
mjr 21:5048e16cc9ef 44 // A *real* LedWiz has its unit number set at the factory; they set it to
mjr 21:5048e16cc9ef 45 // unit 1 unless you specifically request a different number when you place
mjr 21:5048e16cc9ef 46 // your order.
mjr 21:5048e16cc9ef 47 //
mjr 21:5048e16cc9ef 48 // For our *emulated* LedWiz, we default to unit #8. However, if we're set
mjr 21:5048e16cc9ef 49 // up as a secondary Pinscape controller with the joystick functions turned
mjr 21:5048e16cc9ef 50 // off, we'll use unit #9 instead.
mjr 17:ab3cec0c8bf4 51 //
mjr 21:5048e16cc9ef 52 // The reason we start at unit #8 is that we want to avoid conflicting with
mjr 21:5048e16cc9ef 53 // any real LedWiz devices you have in your system. If you have a real
mjr 21:5048e16cc9ef 54 // LedWiz, it's probably unit #1, since that's the standard factor setting.
mjr 21:5048e16cc9ef 55 // If you have two real LedWiz's, they're probably units #1 and #2. If you
mjr 21:5048e16cc9ef 56 // have three... well, I don't think anyone actually has three, but if you
mjr 21:5048e16cc9ef 57 // did it would probably be unit #3. And so on. That's why we start at #8 -
mjr 21:5048e16cc9ef 58 // it seems really unlikely that this will conflict with anybody's existing
mjr 21:5048e16cc9ef 59 // setup. On the off chance it does, simply change the setting here to a
mjr 21:5048e16cc9ef 60 // different unit number that's not already used in your system.
mjr 17:ab3cec0c8bf4 61 //
mjr 21:5048e16cc9ef 62 // Note 1: the unit number here is the *user visible* unit number that
mjr 21:5048e16cc9ef 63 // you use on the PC side. It's the number you specify in your DOF
mjr 21:5048e16cc9ef 64 // configuration and so forth. Internally, the USB reports subtract
mjr 21:5048e16cc9ef 65 // one from this number - e.g., nominal unit #1 shows up as 0 in the USB
mjr 21:5048e16cc9ef 66 // reports. If you're trying to puzzle out why all of the USB reports
mjr 21:5048e16cc9ef 67 // are all off by one from the unit number you select here, that's why.
mjr 17:ab3cec0c8bf4 68 //
mjr 17:ab3cec0c8bf4 69 // Note 2: the DOF Configtool (google it) knows about the Pinscape
mjr 21:5048e16cc9ef 70 // controller (it's known there as just a "KL25Z" rather than Pinscape).
mjr 21:5048e16cc9ef 71 // And the DOF tool knows that it uses #8 as its default unit number, so
mjr 21:5048e16cc9ef 72 // it names the .ini file for this controller xxx8.ini. If you change the
mjr 21:5048e16cc9ef 73 // unit number here, remember to rename the DOF-generated .ini file to
mjr 21:5048e16cc9ef 74 // match, by changing the "8" at the end of the filename to the new number
mjr 21:5048e16cc9ef 75 // you set here.
mjr 21:5048e16cc9ef 76 const uint8_t DEFAULT_LEDWIZ_UNIT_NUMBER =
mjr 21:5048e16cc9ef 77 #ifdef ENABLE_JOYSTICK
mjr 21:5048e16cc9ef 78 0x08; // joystick enabled - assume we're the primary KL25Z, so use unit #8
mjr 21:5048e16cc9ef 79 #else
mjr 21:5048e16cc9ef 80 0x09; // joystick disabled - assume we're a secondary, output-only KL25Z, so use #9
mjr 21:5048e16cc9ef 81 #endif
mjr 17:ab3cec0c8bf4 82
mjr 17:ab3cec0c8bf4 83 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 84 //
mjr 17:ab3cec0c8bf4 85 // Plunger CCD sensor.
mjr 17:ab3cec0c8bf4 86 //
mjr 17:ab3cec0c8bf4 87 // If you're NOT using the CCD sensor, comment out the next line (by adding
mjr 17:ab3cec0c8bf4 88 // two slashes at the start of the line).
mjr 17:ab3cec0c8bf4 89
mjr 21:5048e16cc9ef 90 #define ENABLE_CCD_SENSOR
mjr 17:ab3cec0c8bf4 91
mjr 17:ab3cec0c8bf4 92 // The KL25Z pins that the CCD sensor is physically attached to:
mjr 17:ab3cec0c8bf4 93 //
mjr 17:ab3cec0c8bf4 94 // CCD_SI_PIN = the SI (sensor data input) pin
mjr 17:ab3cec0c8bf4 95 // CCD_CLOCK_PIN = the sensor clock pin
mjr 17:ab3cec0c8bf4 96 // CCD_SO_PIN = the SO (sensor data output) pin
mjr 17:ab3cec0c8bf4 97 //
mjr 17:ab3cec0c8bf4 98 // The SI an Clock pins are DigitalOut pins, so these can be set to just
mjr 17:ab3cec0c8bf4 99 // about any gpio pins that aren't used for something else. The SO pin must
mjr 17:ab3cec0c8bf4 100 // be an AnalogIn capable pin - only a few of the KL25Z gpio pins qualify,
mjr 17:ab3cec0c8bf4 101 // so check the pinout diagram to find suitable candidates if you need to
mjr 17:ab3cec0c8bf4 102 // change this. Note that some of the gpio pins shown in the mbed pinout
mjr 17:ab3cec0c8bf4 103 // diagrams are committed to other uses by the mbed software or by the KL25Z
mjr 17:ab3cec0c8bf4 104 // wiring itself, so if you do change these, be sure that the new pins you
mjr 17:ab3cec0c8bf4 105 // select are really available.
mjr 17:ab3cec0c8bf4 106
mjr 17:ab3cec0c8bf4 107 const PinName CCD_SI_PIN = PTE20;
mjr 17:ab3cec0c8bf4 108 const PinName CCD_CLOCK_PIN = PTE21;
mjr 17:ab3cec0c8bf4 109 const PinName CCD_SO_PIN = PTB0;
mjr 17:ab3cec0c8bf4 110
mjr 17:ab3cec0c8bf4 111 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 112 //
mjr 17:ab3cec0c8bf4 113 // Plunger potentiometer sensor.
mjr 17:ab3cec0c8bf4 114 //
mjr 17:ab3cec0c8bf4 115 // If you ARE using a potentiometer as the plunger sensor, un-comment the
mjr 17:ab3cec0c8bf4 116 // next line (by removing the two slashes at the start of the line), and be
mjr 17:ab3cec0c8bf4 117 // sure to comment out the ENABLE_CCD_SENSOR line above.
mjr 17:ab3cec0c8bf4 118
mjr 21:5048e16cc9ef 119 //#define ENABLE_POT_SENSOR
mjr 17:ab3cec0c8bf4 120
mjr 17:ab3cec0c8bf4 121 // The KL25Z pin that your potentiometer is attached to. Wire the end of
mjr 17:ab3cec0c8bf4 122 // the potentiometer at the retracted end of the plunger to the 3.3V output
mjr 17:ab3cec0c8bf4 123 // from the KL25Z. Wire the variable output from the potentiometer to the
mjr 17:ab3cec0c8bf4 124 // gpio pin below. This must be an AnalogIn capable pin - only a few of the
mjr 17:ab3cec0c8bf4 125 // KL25Z gpio pins qualify, so check the pinout diagram to find a suitable
mjr 17:ab3cec0c8bf4 126 // candidate if you need to change this for any reason. Note that we use
mjr 17:ab3cec0c8bf4 127 // the same analog input that the CCD sensor would use if it were enabled,
mjr 17:ab3cec0c8bf4 128 // which is why you have to be sure to disable the CCD code if you're using
mjr 17:ab3cec0c8bf4 129 // this.
mjr 17:ab3cec0c8bf4 130
mjr 17:ab3cec0c8bf4 131 const PinName POT_PIN = PTB0;
mjr 17:ab3cec0c8bf4 132
mjr 17:ab3cec0c8bf4 133 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 134 //
mjr 17:ab3cec0c8bf4 135 // Plunger calibration button and indicator light.
mjr 17:ab3cec0c8bf4 136 //
mjr 17:ab3cec0c8bf4 137 // These specify the pin names of the plunger calibration button connections.
mjr 17:ab3cec0c8bf4 138 // If you're not using these, you can set these to NC. (You can even use the
mjr 17:ab3cec0c8bf4 139 // button but not the LED; set the LED to NC if you're only using the button.)
mjr 17:ab3cec0c8bf4 140 //
mjr 17:ab3cec0c8bf4 141 // If you're using the button, wire one terminal of a momentary switch or
mjr 17:ab3cec0c8bf4 142 // pushbutton to the input pin you select, and wire the other terminal to the
mjr 17:ab3cec0c8bf4 143 // KL25Z ground. Push and hold the button for a few seconds to enter plunger
mjr 17:ab3cec0c8bf4 144 // calibration mode.
mjr 17:ab3cec0c8bf4 145 //
mjr 17:ab3cec0c8bf4 146 // If you're using the LED, you'll need to build a little transistor power
mjr 17:ab3cec0c8bf4 147 // booster circuit to power the LED, as described in the build guide. The
mjr 17:ab3cec0c8bf4 148 // LED gives you visual confirmation that the you've triggered calibration
mjr 17:ab3cec0c8bf4 149 // mode and lets you know when the mode times out. Note that the LED on
mjr 17:ab3cec0c8bf4 150 // board the KL25Z also changes color to indicate the same information, so
mjr 17:ab3cec0c8bf4 151 // if the KL25Z is positioned so that you can see it while you're doing the
mjr 17:ab3cec0c8bf4 152 // calibration, you don't really need a separate button LED. But the
mjr 17:ab3cec0c8bf4 153 // separate LED is spiffy, especially if it's embedded in the pushbutton.
mjr 17:ab3cec0c8bf4 154 //
mjr 17:ab3cec0c8bf4 155 // Note that you can skip the pushbutton altogether and trigger calibration
mjr 17:ab3cec0c8bf4 156 // from the Windows control software. But again, the button is spiffier.
mjr 17:ab3cec0c8bf4 157
mjr 17:ab3cec0c8bf4 158 // calibration button input
mjr 17:ab3cec0c8bf4 159 const PinName CAL_BUTTON_PIN = PTE29;
mjr 17:ab3cec0c8bf4 160
mjr 17:ab3cec0c8bf4 161 // calibration button indicator LED
mjr 17:ab3cec0c8bf4 162 const PinName CAL_BUTTON_LED = PTE23;
mjr 17:ab3cec0c8bf4 163
mjr 17:ab3cec0c8bf4 164
mjr 17:ab3cec0c8bf4 165 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 166 //
mjr 17:ab3cec0c8bf4 167 // Pseudo "Launch Ball" button.
mjr 17:ab3cec0c8bf4 168 //
mjr 17:ab3cec0c8bf4 169 // Zeb of zebsboards.com came up with a clever scheme for his plunger kit
mjr 17:ab3cec0c8bf4 170 // that lets the plunger simulate a Launch Ball button for tables where
mjr 17:ab3cec0c8bf4 171 // the original used a Launch button instead of a plunger (e.g., Medieval
mjr 17:ab3cec0c8bf4 172 // Madness, T2, or Star Trek: The Next Generation). The scheme uses an
mjr 17:ab3cec0c8bf4 173 // LedWiz output to tell us when such a table is loaded. On the DOF
mjr 17:ab3cec0c8bf4 174 // Configtool site, this is called "ZB Launch Ball". When this LedWiz
mjr 17:ab3cec0c8bf4 175 // output is ON, it tells us that the table will ignore the analog plunger
mjr 17:ab3cec0c8bf4 176 // because it doesn't have a plunger object, so the analog plunger should
mjr 17:ab3cec0c8bf4 177 // send a Launch Ball button press signal when the user releases the plunger.
mjr 17:ab3cec0c8bf4 178 //
mjr 17:ab3cec0c8bf4 179 // If you wish to use this feature, you need to do two things:
mjr 17:ab3cec0c8bf4 180 //
mjr 17:ab3cec0c8bf4 181 // First, adjust the two lines below to set the LedWiz output and joystick
mjr 17:ab3cec0c8bf4 182 // button you wish to use for this feature. The defaults below should be
mjr 17:ab3cec0c8bf4 183 // fine for most people, but if you're using the Pinscape controller for
mjr 17:ab3cec0c8bf4 184 // your physical button wiring, you should set the launch button to match
mjr 17:ab3cec0c8bf4 185 // where you physically wired your actual Launch Ball button. Likewise,
mjr 17:ab3cec0c8bf4 186 // change the LedWiz port if you're using the one below for some actual
mjr 17:ab3cec0c8bf4 187 // hardware output. This is a virtual port that won't control any hardware;
mjr 17:ab3cec0c8bf4 188 // it's just for signaling the plunger that we're in "button mode". Note
mjr 17:ab3cec0c8bf4 189 // that the numbering for the both the LedWiz port and joystick button
mjr 17:ab3cec0c8bf4 190 // start at 1 to match the DOF Configtool and VP dialog numbering.
mjr 17:ab3cec0c8bf4 191 //
mjr 17:ab3cec0c8bf4 192 // Second, in the DOF Configtool, make sure you have a Pinscape controller
mjr 17:ab3cec0c8bf4 193 // in your cabinet configuration, then go to your Port Assignments and set
mjr 17:ab3cec0c8bf4 194 // the port defined below to "ZB Launch Ball".
mjr 17:ab3cec0c8bf4 195 //
mjr 17:ab3cec0c8bf4 196 // Third, open the Visual Pinball editor, open the Preferences | Keys
mjr 17:ab3cec0c8bf4 197 // dialog, and find the Plunger item. Open the drop-down list under that
mjr 17:ab3cec0c8bf4 198 // item and select the button number defined below.
mjr 17:ab3cec0c8bf4 199 //
mjr 21:5048e16cc9ef 200 // To disable this feature, just set ZBLaunchBallPort to 0 here.
mjr 17:ab3cec0c8bf4 201
mjr 17:ab3cec0c8bf4 202 const int ZBLaunchBallPort = 32;
mjr 17:ab3cec0c8bf4 203 const int LaunchBallButton = 24;
mjr 17:ab3cec0c8bf4 204
mjr 18:5e890ebd0023 205 // Distance necessary to push the plunger to activate the simulated
mjr 18:5e890ebd0023 206 // launch ball button, in inches. A standard pinball plunger can be
mjr 18:5e890ebd0023 207 // pushed forward about 1/2". However, the barrel spring is very
mjr 18:5e890ebd0023 208 // stiff, and anything more than about 1/8" requires quite a bit
mjr 18:5e890ebd0023 209 // of force. Ideally the force required should be about the same as
mjr 18:5e890ebd0023 210 // for any ordinary pushbutton.
mjr 18:5e890ebd0023 211 //
mjr 18:5e890ebd0023 212 // On my cabinet, empirically, a distance around 2mm (.08") seems
mjr 18:5e890ebd0023 213 // to work pretty well. It's far enough that it doesn't trigger
mjr 18:5e890ebd0023 214 // spuriously, but short enough that it responds to a reasonably
mjr 18:5e890ebd0023 215 // light push.
mjr 18:5e890ebd0023 216 //
mjr 18:5e890ebd0023 217 // You might need to adjust this up or down to get the right feel.
mjr 18:5e890ebd0023 218 // Alternatively, if you don't like the "push" gesture at all and
mjr 18:5e890ebd0023 219 // would prefer to only make the plunger respond to a pull-and-release
mjr 18:5e890ebd0023 220 // motion, simply set this to, say, 2.0 - it's impossible to push a
mjr 18:5e890ebd0023 221 // plunger forward that far, so that will effectively turn off the
mjr 18:5e890ebd0023 222 // push mode.
mjr 18:5e890ebd0023 223 const float LaunchBallPushDistance = .08;
mjr 18:5e890ebd0023 224
mjr 17:ab3cec0c8bf4 225
mjr 21:5048e16cc9ef 226 #ifdef DECL_EXTERNS
mjr 17:ab3cec0c8bf4 227 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 228 //
mjr 17:ab3cec0c8bf4 229
mjr 17:ab3cec0c8bf4 230 // Joystick button input pin assignments.
mjr 17:ab3cec0c8bf4 231 //
mjr 17:ab3cec0c8bf4 232 // You can wire up to 32 GPIO ports to buttons (equipped with
mjr 17:ab3cec0c8bf4 233 // momentary switches). Connect each switch between the desired
mjr 17:ab3cec0c8bf4 234 // GPIO port and ground (J9 pin 12 or 14). When the button is pressed,
mjr 17:ab3cec0c8bf4 235 // we'll tell the host PC that the corresponding joystick button is
mjr 17:ab3cec0c8bf4 236 // pressed. We debounce the keystrokes in software, so you can simply
mjr 17:ab3cec0c8bf4 237 // wire directly to pushbuttons with no additional external hardware.
mjr 17:ab3cec0c8bf4 238 //
mjr 17:ab3cec0c8bf4 239 // Note that we assign 24 buttons by default, even though the USB
mjr 17:ab3cec0c8bf4 240 // joystick interface can handle up to 32 buttons. VP itself only
mjr 17:ab3cec0c8bf4 241 // allows mapping of up to 24 buttons in the preferences dialog
mjr 17:ab3cec0c8bf4 242 // (although it can recognize 32 buttons internally). If you want
mjr 17:ab3cec0c8bf4 243 // more buttons, you can reassign pins that are assigned by default
mjr 17:ab3cec0c8bf4 244 // as LedWiz outputs. To reassign a pin, find the pin you wish to
mjr 17:ab3cec0c8bf4 245 // reassign in the LedWizPortMap array below, and change the pin name
mjr 17:ab3cec0c8bf4 246 // there to NC (for Not Connected). You can then change one of the
mjr 17:ab3cec0c8bf4 247 // "NC" entries below to the reallocated pin name. The limit is 32
mjr 17:ab3cec0c8bf4 248 // buttons total.
mjr 17:ab3cec0c8bf4 249 //
mjr 17:ab3cec0c8bf4 250 // Note: PTD1 (pin J2-12) should NOT be assigned as a button input,
mjr 17:ab3cec0c8bf4 251 // as this pin is physically connected on the KL25Z to the on-board
mjr 17:ab3cec0c8bf4 252 // indicator LED's blue segment. This precludes any other use of
mjr 17:ab3cec0c8bf4 253 // the pin.
mjr 17:ab3cec0c8bf4 254 PinName buttonMap[] = {
mjr 17:ab3cec0c8bf4 255 PTC2, // J10 pin 10, joystick button 1
mjr 17:ab3cec0c8bf4 256 PTB3, // J10 pin 8, joystick button 2
mjr 17:ab3cec0c8bf4 257 PTB2, // J10 pin 6, joystick button 3
mjr 17:ab3cec0c8bf4 258 PTB1, // J10 pin 4, joystick button 4
mjr 17:ab3cec0c8bf4 259
mjr 17:ab3cec0c8bf4 260 PTE30, // J10 pin 11, joystick button 5
mjr 17:ab3cec0c8bf4 261 PTE22, // J10 pin 5, joystick button 6
mjr 17:ab3cec0c8bf4 262
mjr 17:ab3cec0c8bf4 263 PTE5, // J9 pin 15, joystick button 7
mjr 17:ab3cec0c8bf4 264 PTE4, // J9 pin 13, joystick button 8
mjr 17:ab3cec0c8bf4 265 PTE3, // J9 pin 11, joystick button 9
mjr 17:ab3cec0c8bf4 266 PTE2, // J9 pin 9, joystick button 10
mjr 17:ab3cec0c8bf4 267 PTB11, // J9 pin 7, joystick button 11
mjr 17:ab3cec0c8bf4 268 PTB10, // J9 pin 5, joystick button 12
mjr 17:ab3cec0c8bf4 269 PTB9, // J9 pin 3, joystick button 13
mjr 17:ab3cec0c8bf4 270 PTB8, // J9 pin 1, joystick button 14
mjr 17:ab3cec0c8bf4 271
mjr 17:ab3cec0c8bf4 272 PTC12, // J2 pin 1, joystick button 15
mjr 17:ab3cec0c8bf4 273 PTC13, // J2 pin 3, joystick button 16
mjr 17:ab3cec0c8bf4 274 PTC16, // J2 pin 5, joystick button 17
mjr 17:ab3cec0c8bf4 275 PTC17, // J2 pin 7, joystick button 18
mjr 17:ab3cec0c8bf4 276 PTA16, // J2 pin 9, joystick button 19
mjr 17:ab3cec0c8bf4 277 PTA17, // J2 pin 11, joystick button 20
mjr 17:ab3cec0c8bf4 278 PTE31, // J2 pin 13, joystick button 21
mjr 17:ab3cec0c8bf4 279 PTD6, // J2 pin 17, joystick button 22
mjr 17:ab3cec0c8bf4 280 PTD7, // J2 pin 19, joystick button 23
mjr 17:ab3cec0c8bf4 281
mjr 17:ab3cec0c8bf4 282 PTE1, // J2 pin 20, joystick button 24
mjr 17:ab3cec0c8bf4 283
mjr 17:ab3cec0c8bf4 284 NC, // not used, joystick button 25
mjr 17:ab3cec0c8bf4 285 NC, // not used, joystick button 26
mjr 17:ab3cec0c8bf4 286 NC, // not used, joystick button 27
mjr 17:ab3cec0c8bf4 287 NC, // not used, joystick button 28
mjr 17:ab3cec0c8bf4 288 NC, // not used, joystick button 29
mjr 17:ab3cec0c8bf4 289 NC, // not used, joystick button 30
mjr 17:ab3cec0c8bf4 290 NC, // not used, joystick button 31
mjr 17:ab3cec0c8bf4 291 NC // not used, joystick button 32
mjr 17:ab3cec0c8bf4 292 };
mjr 17:ab3cec0c8bf4 293
mjr 17:ab3cec0c8bf4 294 // --------------------------------------------------------------------------
mjr 17:ab3cec0c8bf4 295 //
mjr 17:ab3cec0c8bf4 296 // LED-Wiz emulation output pin assignments.
mjr 17:ab3cec0c8bf4 297 //
mjr 17:ab3cec0c8bf4 298 // The LED-Wiz protocol allows setting individual intensity levels
mjr 17:ab3cec0c8bf4 299 // on all outputs, with 48 levels of intensity. This can be used
mjr 17:ab3cec0c8bf4 300 // to control lamp brightness and motor speeds, among other things.
mjr 17:ab3cec0c8bf4 301 // Unfortunately, the KL25Z only has 10 PWM channels, so while we
mjr 17:ab3cec0c8bf4 302 // can support the full complement of 32 outputs, we can only provide
mjr 17:ab3cec0c8bf4 303 // PWM dimming/speed control on 10 of them. The remaining outputs
mjr 17:ab3cec0c8bf4 304 // can only be switched fully on and fully off - we can't support
mjr 17:ab3cec0c8bf4 305 // dimming on these, so they'll ignore any intensity level setting
mjr 17:ab3cec0c8bf4 306 // requested by the host. Use these for devices that don't have any
mjr 17:ab3cec0c8bf4 307 // use for intensity settings anyway, such as contactors and knockers.
mjr 17:ab3cec0c8bf4 308 //
mjr 17:ab3cec0c8bf4 309 // Ports with pins assigned as "NC" are not connected. That is,
mjr 17:ab3cec0c8bf4 310 // there's no physical pin for that LedWiz port number. You can
mjr 17:ab3cec0c8bf4 311 // send LedWiz commands to turn NC ports on and off, but doing so
mjr 17:ab3cec0c8bf4 312 // will have no effect. The reason we leave some ports unassigned
mjr 17:ab3cec0c8bf4 313 // is that we don't have enough physical GPIO pins to fill out the
mjr 17:ab3cec0c8bf4 314 // full LedWiz complement of 32 ports. Many pins are already taken
mjr 17:ab3cec0c8bf4 315 // for other purposes, such as button inputs or the plunger CCD
mjr 17:ab3cec0c8bf4 316 // interface.
mjr 17:ab3cec0c8bf4 317 //
mjr 17:ab3cec0c8bf4 318 // The mapping between physical output pins on the KL25Z and the
mjr 17:ab3cec0c8bf4 319 // assigned LED-Wiz port numbers is essentially arbitrary - you can
mjr 17:ab3cec0c8bf4 320 // customize this by changing the entries in the array below if you
mjr 17:ab3cec0c8bf4 321 // wish to rearrange the pins for any reason. Be aware that some
mjr 17:ab3cec0c8bf4 322 // of the physical outputs are already used for other purposes
mjr 17:ab3cec0c8bf4 323 // (e.g., some of the GPIO pins on header J10 are used for the
mjr 17:ab3cec0c8bf4 324 // CCD sensor - but you can of course reassign those as well by
mjr 17:ab3cec0c8bf4 325 // changing the corresponding declarations elsewhere in this module).
mjr 17:ab3cec0c8bf4 326 // The assignments we make here have two main objectives: first,
mjr 17:ab3cec0c8bf4 327 // to group the outputs on headers J1 and J2 (to facilitate neater
mjr 17:ab3cec0c8bf4 328 // wiring by keeping the output pins together physically), and
mjr 17:ab3cec0c8bf4 329 // second, to make the physical pin layout match the LED-Wiz port
mjr 17:ab3cec0c8bf4 330 // numbering order to the extent possible. There's one big wrench
mjr 17:ab3cec0c8bf4 331 // in the works, though, which is the limited number and discontiguous
mjr 17:ab3cec0c8bf4 332 // placement of the KL25Z PWM-capable output pins. This prevents
mjr 17:ab3cec0c8bf4 333 // us from doing the most obvious sequential ordering of the pins,
mjr 17:ab3cec0c8bf4 334 // so we end up with the outputs arranged into several blocks.
mjr 17:ab3cec0c8bf4 335 // Hopefully this isn't too confusing; for more detailed rationale,
mjr 17:ab3cec0c8bf4 336 // read on...
mjr 17:ab3cec0c8bf4 337 //
mjr 17:ab3cec0c8bf4 338 // With the LED-Wiz, the host software configuration usually
mjr 17:ab3cec0c8bf4 339 // assumes that each RGB LED is hooked up to three consecutive ports
mjr 17:ab3cec0c8bf4 340 // (for the red, green, and blue components, which need to be
mjr 17:ab3cec0c8bf4 341 // physically wired to separate outputs to allow each color to be
mjr 17:ab3cec0c8bf4 342 // controlled independently). To facilitate this, we arrange the
mjr 17:ab3cec0c8bf4 343 // PWM-enabled outputs so that they're grouped together in the
mjr 17:ab3cec0c8bf4 344 // port numbering scheme. Unfortunately, these outputs aren't
mjr 17:ab3cec0c8bf4 345 // together in a single group in the physical pin layout, so to
mjr 17:ab3cec0c8bf4 346 // group them logically in the LED-Wiz port numbering scheme, we
mjr 17:ab3cec0c8bf4 347 // have to break up the overall numbering scheme into several blocks.
mjr 17:ab3cec0c8bf4 348 // So our port numbering goes sequentially down each column of
mjr 17:ab3cec0c8bf4 349 // header pins, but there are several break points where we have
mjr 17:ab3cec0c8bf4 350 // to interrupt the obvious sequence to keep the PWM pins grouped
mjr 17:ab3cec0c8bf4 351 // logically.
mjr 17:ab3cec0c8bf4 352 //
mjr 17:ab3cec0c8bf4 353 // In the list below, "pin J1-2" refers to pin 2 on header J1 on
mjr 17:ab3cec0c8bf4 354 // the KL25Z, using the standard pin numbering in the KL25Z
mjr 17:ab3cec0c8bf4 355 // documentation - this is the physical pin that the port controls.
mjr 17:ab3cec0c8bf4 356 // "LW port 1" means LED-Wiz port 1 - this is the LED-Wiz port
mjr 17:ab3cec0c8bf4 357 // number that you use on the PC side (in the DirectOutput config
mjr 17:ab3cec0c8bf4 358 // file, for example) to address the port. PWM-capable ports are
mjr 17:ab3cec0c8bf4 359 // marked as such - we group the PWM-capable ports into the first
mjr 17:ab3cec0c8bf4 360 // 10 LED-Wiz port numbers.
mjr 17:ab3cec0c8bf4 361 //
mjr 17:ab3cec0c8bf4 362 // If you wish to reallocate a pin in the array below to some other
mjr 17:ab3cec0c8bf4 363 // use, such as a button input port, simply change the pin name in
mjr 17:ab3cec0c8bf4 364 // the entry to NC (for Not Connected). This will disable the given
mjr 17:ab3cec0c8bf4 365 // logical LedWiz port number and free up the physical pin.
mjr 17:ab3cec0c8bf4 366 //
mjr 17:ab3cec0c8bf4 367 // If you wish to reallocate a pin currently assigned to the button
mjr 17:ab3cec0c8bf4 368 // input array, simply change the entry for the pin in the buttonMap[]
mjr 17:ab3cec0c8bf4 369 // array above to NC (for "not connected"), and plug the pin name into
mjr 17:ab3cec0c8bf4 370 // a slot of your choice in the array below.
mjr 17:ab3cec0c8bf4 371 //
mjr 17:ab3cec0c8bf4 372 // Note: PTD1 (pin J2-12) should NOT be assigned as an LedWiz output,
mjr 17:ab3cec0c8bf4 373 // as this pin is physically connected on the KL25Z to the on-board
mjr 17:ab3cec0c8bf4 374 // indicator LED's blue segment. This precludes any other use of
mjr 17:ab3cec0c8bf4 375 // the pin.
mjr 17:ab3cec0c8bf4 376 //
mjr 17:ab3cec0c8bf4 377 struct {
mjr 17:ab3cec0c8bf4 378 PinName pin;
mjr 17:ab3cec0c8bf4 379 bool isPWM;
mjr 17:ab3cec0c8bf4 380 } ledWizPortMap[32] = {
mjr 17:ab3cec0c8bf4 381 { PTA1, true }, // pin J1-2, LW port 1 (PWM capable - TPM 2.0 = channel 9)
mjr 17:ab3cec0c8bf4 382 { PTA2, true }, // pin J1-4, LW port 2 (PWM capable - TPM 2.1 = channel 10)
mjr 17:ab3cec0c8bf4 383 { PTD4, true }, // pin J1-6, LW port 3 (PWM capable - TPM 0.4 = channel 5)
mjr 17:ab3cec0c8bf4 384 { PTA12, true }, // pin J1-8, LW port 4 (PWM capable - TPM 1.0 = channel 7)
mjr 17:ab3cec0c8bf4 385 { PTA4, true }, // pin J1-10, LW port 5 (PWM capable - TPM 0.1 = channel 2)
mjr 17:ab3cec0c8bf4 386 { PTA5, true }, // pin J1-12, LW port 6 (PWM capable - TPM 0.2 = channel 3)
mjr 17:ab3cec0c8bf4 387 { PTA13, true }, // pin J2-2, LW port 7 (PWM capable - TPM 1.1 = channel 13)
mjr 17:ab3cec0c8bf4 388 { PTD5, true }, // pin J2-4, LW port 8 (PWM capable - TPM 0.5 = channel 6)
mjr 17:ab3cec0c8bf4 389 { PTD0, true }, // pin J2-6, LW port 9 (PWM capable - TPM 0.0 = channel 1)
mjr 17:ab3cec0c8bf4 390 { PTD3, true }, // pin J2-10, LW port 10 (PWM capable - TPM 0.3 = channel 4)
mjr 17:ab3cec0c8bf4 391 { PTD2, false }, // pin J2-8, LW port 11
mjr 17:ab3cec0c8bf4 392 { PTC8, false }, // pin J1-14, LW port 12
mjr 17:ab3cec0c8bf4 393 { PTC9, false }, // pin J1-16, LW port 13
mjr 17:ab3cec0c8bf4 394 { PTC7, false }, // pin J1-1, LW port 14
mjr 17:ab3cec0c8bf4 395 { PTC0, false }, // pin J1-3, LW port 15
mjr 17:ab3cec0c8bf4 396 { PTC3, false }, // pin J1-5, LW port 16
mjr 17:ab3cec0c8bf4 397 { PTC4, false }, // pin J1-7, LW port 17
mjr 17:ab3cec0c8bf4 398 { PTC5, false }, // pin J1-9, LW port 18
mjr 17:ab3cec0c8bf4 399 { PTC6, false }, // pin J1-11, LW port 19
mjr 17:ab3cec0c8bf4 400 { PTC10, false }, // pin J1-13, LW port 20
mjr 17:ab3cec0c8bf4 401 { PTC11, false }, // pin J1-15, LW port 21
mjr 17:ab3cec0c8bf4 402 { PTE0, false }, // pin J2-18, LW port 22
mjr 17:ab3cec0c8bf4 403 { NC, false }, // Not used, LW port 23
mjr 17:ab3cec0c8bf4 404 { NC, false }, // Not used, LW port 24
mjr 17:ab3cec0c8bf4 405 { NC, false }, // Not used, LW port 25
mjr 17:ab3cec0c8bf4 406 { NC, false }, // Not used, LW port 26
mjr 17:ab3cec0c8bf4 407 { NC, false }, // Not used, LW port 27
mjr 17:ab3cec0c8bf4 408 { NC, false }, // Not used, LW port 28
mjr 17:ab3cec0c8bf4 409 { NC, false }, // Not used, LW port 29
mjr 17:ab3cec0c8bf4 410 { NC, false }, // Not used, LW port 30
mjr 17:ab3cec0c8bf4 411 { NC, false }, // Not used, LW port 31
mjr 17:ab3cec0c8bf4 412 { NC, false } // Not used, LW port 32
mjr 17:ab3cec0c8bf4 413 };
mjr 17:ab3cec0c8bf4 414
mjr 21:5048e16cc9ef 415
mjr 21:5048e16cc9ef 416 #endif // DECL_EXTERNS