Arnaud VALLEY / Mbed 2 deprecated Pinscape_Controller_V2_arnoz

Mirror with some correction

Dependencies:   mbed FastIO FastPWM USBDevice

config.h@40:cc0d9814522b, 2016-02-03 (annotated)

Committer:
mjr
Date:
Wed Feb 03 22:57:25 2016 +0000
Revision:
40:cc0d9814522b
Parent:
39:b3815a1c3802
Child:
43:7a6364d82a41
Gamma correction option for outputs; work in progress on new config program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjr 17:ab3cec0c8bf4 1 // Pinscape Controller Configuration
mjr 17:ab3cec0c8bf4 2 //
mjr 35:e959ffba78fd 3 // New for 2016: dynamic configuration! To configure the controller, connect
mjr 35:e959ffba78fd 4 // the KL25Z to your PC, install the .bin file, and run the Windows config tool.
mjr 35:e959ffba78fd 5 // There's no need (as there was in the past) to edit this file or to compile a
mjr 35:e959ffba78fd 6 // custom version of the binary (.bin) to customize setup options.
mjr 35:e959ffba78fd 7 //
mjr 35:e959ffba78fd 8 // In earlier versions, configuration was largely handled with compile-time
mjr 35:e959ffba78fd 9 // constants. To customize the setup, you had to create a private forked copy
mjr 35:e959ffba78fd 10 // of the source code, edit the constants defined in config.h, and compile a
mjr 35:e959ffba78fd 11 // custom binary. That's no longer necessary!
mjr 35:e959ffba78fd 12 //
mjr 35:e959ffba78fd 13 // The new approach is to do everything (or as much as possible, anyway)
mjr 35:e959ffba78fd 14 // via the Windows config tool. You shouldn't have to recompile a custom
mjr 35:e959ffba78fd 15 // version just to make a configurable change. Of course, you're still free
mjr 35:e959ffba78fd 16 // to create a custom version if you need to add or change features in ways
mjr 35:e959ffba78fd 17 // that weren't anticipated in the original design.
mjr 35:e959ffba78fd 18 //
mjr 35:e959ffba78fd 19
mjr 17:ab3cec0c8bf4 20
mjr 25:e22b88bd783a 21 #ifndef CONFIG_H
mjr 25:e22b88bd783a 22 #define CONFIG_H
mjr 17:ab3cec0c8bf4 23
mjr 33:d832bcab089e 24
mjr 35:e959ffba78fd 25 // Plunger type codes
mjr 35:e959ffba78fd 26 // NOTE! These values are part of the external USB interface. New
mjr 35:e959ffba78fd 27 // values can be added, but the meaning of an existing assigned number
mjr 35:e959ffba78fd 28 // should remain fixed to keep the PC-side config tool compatible across
mjr 35:e959ffba78fd 29 // versions.
mjr 35:e959ffba78fd 30 const int PlungerType_None = 0; // no plunger
mjr 35:e959ffba78fd 31 const int PlungerType_TSL1410RS = 1; // TSL1410R linear image sensor (1280x1 pixels, 400dpi), serial mode
mjr 35:e959ffba78fd 32 const int PlungerType_TSL1410RP = 2; // TSL1410R, parallel mode (reads the two sensor sections concurrently)
mjr 35:e959ffba78fd 33 const int PlungerType_TSL1412RS = 3; // TSL1412R linear image sensor (1536x1 pixels, 400dpi), serial mode
mjr 35:e959ffba78fd 34 const int PlungerType_TSL1412RP = 4; // TSL1412R, parallel mode
mjr 35:e959ffba78fd 35 const int PlungerType_Pot = 5; // potentionmeter
mjr 35:e959ffba78fd 36 const int PlungerType_OptQuad = 6; // AEDR8300 optical quadrature sensor
mjr 35:e959ffba78fd 37 const int PlungerType_MagQuad = 7; // AS5304 magnetic quadrature sensor
mjr 21:5048e16cc9ef 38
mjr 35:e959ffba78fd 39 // Accelerometer orientation codes
mjr 35:e959ffba78fd 40 // These values are part of the external USB interface
mjr 35:e959ffba78fd 41 const int OrientationFront = 0; // USB ports pointed toward front of cabinet
mjr 35:e959ffba78fd 42 const int OrientationLeft = 1; // ports pointed toward left side of cabinet
mjr 35:e959ffba78fd 43 const int OrientationRight = 2; // ports pointed toward right side of cabinet
mjr 35:e959ffba78fd 44 const int OrientationRear = 3; // ports pointed toward back of cabinet
mjr 25:e22b88bd783a 45
mjr 35:e959ffba78fd 46 // input button types
mjr 35:e959ffba78fd 47 const int BtnTypeJoystick = 1; // joystick button
mjr 35:e959ffba78fd 48 const int BtnTypeKey = 2; // regular keyboard key
mjr 35:e959ffba78fd 49 const int BtnTypeModKey = 3; // keyboard modifier key (shift, ctrl, etc)
mjr 35:e959ffba78fd 50 const int BtnTypeMedia = 4; // media control key (volume up/down, etc)
mjr 38:091e511ce8a0 51 const int BtnTypeSpecial = 5; // special button (night mode switch, etc)
mjr 38:091e511ce8a0 52
mjr 38:091e511ce8a0 53 // input button flags
mjr 38:091e511ce8a0 54 const uint8_t BtnFlagPulse = 0x01; // pulse mode - reports each change in the physical switch state
mjr 38:091e511ce8a0 55 // as a brief press of the logical button/keyboard key
mjr 40:cc0d9814522b 56
mjr 40:cc0d9814522b 57 // button setup structure
mjr 40:cc0d9814522b 58 struct ButtonCfg
mjr 40:cc0d9814522b 59 {
mjr 40:cc0d9814522b 60 uint8_t pin; // physical input GPIO pin - a USB-to-PinName mapping index
mjr 40:cc0d9814522b 61 uint8_t typ; // key type reported to PC - a BtnTypeXxx value
mjr 40:cc0d9814522b 62 uint8_t val; // key value reported - meaning depends on 'typ' value
mjr 40:cc0d9814522b 63 uint8_t flags; // key flags - a bitwise combination of BtnFlagXxx values
mjr 40:cc0d9814522b 64
mjr 40:cc0d9814522b 65 void set(uint8_t pin, uint8_t typ, uint8_t val, uint8_t flags = 0)
mjr 40:cc0d9814522b 66 {
mjr 40:cc0d9814522b 67 this->pin = pin;
mjr 40:cc0d9814522b 68 this->typ = typ;
mjr 40:cc0d9814522b 69 this->val = val;
mjr 40:cc0d9814522b 70 this->flags = flags;
mjr 40:cc0d9814522b 71 }
mjr 40:cc0d9814522b 72
mjr 40:cc0d9814522b 73 } __attribute__((packed));
mjr 40:cc0d9814522b 74
mjr 33:d832bcab089e 75
mjr 35:e959ffba78fd 76 // maximum number of input button mappings
mjr 35:e959ffba78fd 77 const int MAX_BUTTONS = 32;
mjr 33:d832bcab089e 78
mjr 35:e959ffba78fd 79 // LedWiz output port type codes
mjr 35:e959ffba78fd 80 // These values are part of the external USB interface
mjr 35:e959ffba78fd 81 const int PortTypeDisabled = 0; // port is disabled - not visible to LedWiz/DOF host
mjr 35:e959ffba78fd 82 const int PortTypeGPIOPWM = 1; // GPIO port, PWM enabled
mjr 35:e959ffba78fd 83 const int PortTypeGPIODig = 2; // GPIO port, digital out
mjr 35:e959ffba78fd 84 const int PortTypeTLC5940 = 3; // TLC5940 port
mjr 35:e959ffba78fd 85 const int PortType74HC595 = 4; // 74HC595 port
mjr 35:e959ffba78fd 86 const int PortTypeVirtual = 5; // Virtual port - visible to host software, but not connected to a physical output
mjr 17:ab3cec0c8bf4 87
mjr 35:e959ffba78fd 88 // LedWiz output port flag bits
mjr 38:091e511ce8a0 89 const uint8_t PortFlagActiveLow = 0x01; // physical output is active-low
mjr 38:091e511ce8a0 90 const uint8_t PortFlagNoisemaker = 0x02; // noisemaker device - disable when night mode is engaged
mjr 40:cc0d9814522b 91 const uint8_t PortFlagGamma = 0x04; // apply gamma correction to this output
mjr 35:e959ffba78fd 92
mjr 35:e959ffba78fd 93 // maximum number of output ports
mjr 35:e959ffba78fd 94 const int MAX_OUT_PORTS = 203;
mjr 33:d832bcab089e 95
mjr 38:091e511ce8a0 96 // port configuration data
mjr 38:091e511ce8a0 97 struct LedWizPortCfg
mjr 38:091e511ce8a0 98 {
mjr 38:091e511ce8a0 99 uint8_t typ; // port type: a PortTypeXxx value
mjr 38:091e511ce8a0 100 uint8_t pin; // physical output pin: for a GPIO port, this is an index in the
mjr 38:091e511ce8a0 101 // USB-to-PinName mapping list; for a TLC5940 or 74HC595 port, it's
mjr 38:091e511ce8a0 102 // the output number, starting from 0 for OUT0 on the first chip in
mjr 38:091e511ce8a0 103 // the daisy chain. For inactive and virtual ports, it's unused.
mjr 38:091e511ce8a0 104 uint8_t flags; // flags: a combination of PortFlagXxx values
mjr 40:cc0d9814522b 105
mjr 40:cc0d9814522b 106 void set(uint8_t typ, uint8_t pin, uint8_t flags = 0)
mjr 40:cc0d9814522b 107 {
mjr 40:cc0d9814522b 108 this->typ = typ;
mjr 40:cc0d9814522b 109 this->pin = pin;
mjr 40:cc0d9814522b 110 this->flags = flags;
mjr 40:cc0d9814522b 111 }
mjr 40:cc0d9814522b 112
mjr 38:091e511ce8a0 113 } __attribute__((packed));
mjr 38:091e511ce8a0 114
mjr 38:091e511ce8a0 115
mjr 35:e959ffba78fd 116 struct Config
mjr 35:e959ffba78fd 117 {
mjr 35:e959ffba78fd 118 // set all values to factory defaults
mjr 35:e959ffba78fd 119 void setFactoryDefaults()
mjr 35:e959ffba78fd 120 {
mjr 35:e959ffba78fd 121 // By default, pretend to be LedWiz unit #8. This can be from 1 to 16. Real
mjr 35:e959ffba78fd 122 // LedWiz units have their unit number set at the factory, and the vast majority
mjr 35:e959ffba78fd 123 // are set up as unit #1, since that's the default for anyone who doesn't ask
mjr 35:e959ffba78fd 124 // for a different setting. It seems rare for anyone to use more than one unit
mjr 35:e959ffba78fd 125 // in a pin cab, but for the few who do, the others will probably be numbered
mjr 35:e959ffba78fd 126 // sequentially as #2, #3, etc. It seems safe to assume that no one out there
mjr 35:e959ffba78fd 127 // has a unit #8, so we'll use that as our default starting number. This can
mjr 35:e959ffba78fd 128 // be changed from the config tool, but for the sake of convenience we want the
mjr 35:e959ffba78fd 129 // default to be a value that most people won't have to change.
mjr 35:e959ffba78fd 130 usbVendorID = 0xFAFA; // LedWiz vendor code
mjr 38:091e511ce8a0 131 usbProductID = 0x00F0; // LedWiz product code for unit #1
mjr 35:e959ffba78fd 132 psUnitNo = 8;
mjr 35:e959ffba78fd 133
mjr 35:e959ffba78fd 134 // enable joystick reports
mjr 35:e959ffba78fd 135 joystickEnabled = true;
mjr 35:e959ffba78fd 136
mjr 35:e959ffba78fd 137 // assume standard orientation, with USB ports toward front of cabinet
mjr 35:e959ffba78fd 138 orientation = OrientationFront;
mjr 25:e22b88bd783a 139
mjr 35:e959ffba78fd 140 // assume no plunger is attached
mjr 35:e959ffba78fd 141 plunger.enabled = false;
mjr 35:e959ffba78fd 142 plunger.sensorType = PlungerType_None;
mjr 35:e959ffba78fd 143
mjr 35:e959ffba78fd 144 // assume that there's no calibration button
mjr 35:e959ffba78fd 145 plunger.cal.btn = NC;
mjr 35:e959ffba78fd 146 plunger.cal.led = NC;
mjr 35:e959ffba78fd 147
mjr 35:e959ffba78fd 148 // clear the plunger calibration
mjr 35:e959ffba78fd 149 plunger.cal.reset(4096);
mjr 35:e959ffba78fd 150
mjr 35:e959ffba78fd 151 // disable the ZB Launch Ball by default
mjr 35:e959ffba78fd 152 plunger.zbLaunchBall.port = 0;
mjr 35:e959ffba78fd 153 plunger.zbLaunchBall.btn = 0;
mjr 35:e959ffba78fd 154
mjr 35:e959ffba78fd 155 // assume no TV ON switch
mjr 38:091e511ce8a0 156 #if 1
mjr 38:091e511ce8a0 157 TVON.statusPin = PTD2;
mjr 38:091e511ce8a0 158 TVON.latchPin = PTE0;
mjr 38:091e511ce8a0 159 TVON.relayPin = PTD3;
mjr 38:091e511ce8a0 160 TVON.delayTime = 7;
mjr 38:091e511ce8a0 161 #else
mjr 35:e959ffba78fd 162 TVON.statusPin = NC;
mjr 35:e959ffba78fd 163 TVON.latchPin = NC;
mjr 35:e959ffba78fd 164 TVON.relayPin = NC;
mjr 35:e959ffba78fd 165 TVON.delayTime = 0;
mjr 38:091e511ce8a0 166 #endif
mjr 35:e959ffba78fd 167
mjr 35:e959ffba78fd 168 // assume no TLC5940 chips
mjr 38:091e511ce8a0 169 #if 1 // $$$
mjr 40:cc0d9814522b 170 tlc5940.nchips = 4;
mjr 38:091e511ce8a0 171 #else
mjr 35:e959ffba78fd 172 tlc5940.nchips = 0;
mjr 38:091e511ce8a0 173 #endif
mjr 38:091e511ce8a0 174
mjr 38:091e511ce8a0 175 // default TLC5940 pin assignments
mjr 38:091e511ce8a0 176 tlc5940.sin = PTC6;
mjr 38:091e511ce8a0 177 tlc5940.sclk = PTC5;
mjr 38:091e511ce8a0 178 tlc5940.xlat = PTC10;
mjr 38:091e511ce8a0 179 tlc5940.blank = PTC7;
mjr 38:091e511ce8a0 180 tlc5940.gsclk = PTA1;
mjr 35:e959ffba78fd 181
mjr 35:e959ffba78fd 182 // assume no 74HC595 chips
mjr 40:cc0d9814522b 183 #if 1 // $$$
mjr 40:cc0d9814522b 184 hc595.nchips = 1;
mjr 40:cc0d9814522b 185 #else
mjr 35:e959ffba78fd 186 hc595.nchips = 0;
mjr 40:cc0d9814522b 187 #endif
mjr 40:cc0d9814522b 188
mjr 38:091e511ce8a0 189 // default 74HC595 pin assignments
mjr 38:091e511ce8a0 190 hc595.sin = PTA5;
mjr 38:091e511ce8a0 191 hc595.sclk = PTA4;
mjr 38:091e511ce8a0 192 hc595.latch = PTA12;
mjr 38:091e511ce8a0 193 hc595.ena = PTD4;
mjr 38:091e511ce8a0 194
mjr 35:e959ffba78fd 195 // initially configure with no LedWiz output ports
mjr 35:e959ffba78fd 196 outPort[0].typ = PortTypeDisabled;
mjr 38:091e511ce8a0 197 for (int i = 0 ; i < sizeof(specialPort)/sizeof(specialPort[0]) ; ++i)
mjr 38:091e511ce8a0 198 specialPort[i].typ = PortTypeDisabled;
mjr 35:e959ffba78fd 199
mjr 35:e959ffba78fd 200 // initially configure with no input buttons
mjr 35:e959ffba78fd 201 for (int i = 0 ; i < MAX_BUTTONS ; ++i)
mjr 35:e959ffba78fd 202 button[i].pin = 0; // 0 == index of NC in USB-to-PinName mapping
mjr 38:091e511ce8a0 203
mjr 38:091e511ce8a0 204 #if 1
mjr 38:091e511ce8a0 205 for (int i = 0 ; i < 24 ; ++i) {
mjr 38:091e511ce8a0 206 static int bp[] = {
mjr 38:091e511ce8a0 207 21, // 1 = PTC2
mjr 38:091e511ce8a0 208 12, // 2 = PTB3
mjr 38:091e511ce8a0 209 11, // 3 = PTB2
mjr 38:091e511ce8a0 210 10, // 4 = PTB1
mjr 38:091e511ce8a0 211 54, // 5 = PTE30
mjr 38:091e511ce8a0 212 30, // 6 = PTC11
mjr 38:091e511ce8a0 213 48, // 7 = PTE5
mjr 38:091e511ce8a0 214 47, // 8 = PTE4
mjr 38:091e511ce8a0 215 46, // 9 = PTE3
mjr 38:091e511ce8a0 216 45, // 10 = PTE2
mjr 38:091e511ce8a0 217 16, // 11 = PTB11
mjr 38:091e511ce8a0 218 15, // 12 = PTB10
mjr 38:091e511ce8a0 219 14, // 13 = PTB9
mjr 38:091e511ce8a0 220 13, // 14 = PTB8
mjr 38:091e511ce8a0 221 31, // 15 = PTC12
mjr 38:091e511ce8a0 222 32, // 16 = PTC13
mjr 38:091e511ce8a0 223 33, // 17 = PTC16
mjr 38:091e511ce8a0 224 34, // 18 = PTC17
mjr 38:091e511ce8a0 225 7, // 19 = PTA16
mjr 38:091e511ce8a0 226 8, // 20 = PTA17
mjr 38:091e511ce8a0 227 55, // 21 = PTE31
mjr 38:091e511ce8a0 228 41, // 22 = PTD6
mjr 38:091e511ce8a0 229 42, // 23 = PTD7
mjr 38:091e511ce8a0 230 44 // 24 = PTE1
mjr 40:cc0d9814522b 231 };
mjr 40:cc0d9814522b 232 button[i].set(bp[i], BtnTypeKey, i+4); // A, B, C...
mjr 38:091e511ce8a0 233 }
mjr 38:091e511ce8a0 234 #endif
mjr 38:091e511ce8a0 235
mjr 38:091e511ce8a0 236 #if 0
mjr 38:091e511ce8a0 237 button[23].typ = BtnTypeJoystick;
mjr 38:091e511ce8a0 238 button[23].val = 5; // B
mjr 38:091e511ce8a0 239 button[23].flags = 0x01; // pulse button
mjr 38:091e511ce8a0 240
mjr 38:091e511ce8a0 241 button[22].typ = BtnTypeModKey;
mjr 38:091e511ce8a0 242 button[22].val = 0x02; // left shift
mjr 38:091e511ce8a0 243
mjr 38:091e511ce8a0 244 button[21].typ = BtnTypeMedia;
mjr 38:091e511ce8a0 245 button[21].val = 0x02; // vol down
mjr 38:091e511ce8a0 246
mjr 38:091e511ce8a0 247 button[20].typ = BtnTypeMedia;
mjr 38:091e511ce8a0 248 button[20].val = 0x01; // vol up
mjr 39:b3815a1c3802 249
mjr 38:091e511ce8a0 250 #endif
mjr 38:091e511ce8a0 251
mjr 38:091e511ce8a0 252 #if 1 // $$$
mjr 40:cc0d9814522b 253 // CONFIGURE EXPANSION BOARD PORTS
mjr 40:cc0d9814522b 254 //
mjr 40:cc0d9814522b 255 // We have the following hardware attached:
mjr 40:cc0d9814522b 256 //
mjr 40:cc0d9814522b 257 // Main board
mjr 40:cc0d9814522b 258 // TLC ports 0-15 -> flashers
mjr 40:cc0d9814522b 259 // TLC ports 16 -> strobe
mjr 40:cc0d9814522b 260 // TLC ports 17-31 -> flippers
mjr 40:cc0d9814522b 261 // Dig GPIO PTC8 -> knocker (timer-protected outputs)
mjr 40:cc0d9814522b 262 //
mjr 40:cc0d9814522b 263 // Power board:
mjr 40:cc0d9814522b 264 // TLC ports 32-63 -> general purpose outputs
mjr 40:cc0d9814522b 265 //
mjr 40:cc0d9814522b 266 // Chime board:
mjr 40:cc0d9814522b 267 // HC595 ports 0-7 -> timer-protected outputs
mjr 40:cc0d9814522b 268 //
mjr 38:091e511ce8a0 269 {
mjr 38:091e511ce8a0 270 int n = 0;
mjr 40:cc0d9814522b 271
mjr 40:cc0d9814522b 272 // 1-15 = flashers (TLC ports 0-15)
mjr 40:cc0d9814522b 273 // 16 = strobe (TLC port 15)
mjr 40:cc0d9814522b 274 for (int i = 0 ; i < 16 ; ++i)
mjr 40:cc0d9814522b 275 outPort[n++].set(PortTypeTLC5940, i, PortFlagGamma);
mjr 40:cc0d9814522b 276
mjr 40:cc0d9814522b 277 // 17 = knocker
mjr 40:cc0d9814522b 278 outPort[n++].set(PortTypeGPIODig, 27);
mjr 35:e959ffba78fd 279
mjr 40:cc0d9814522b 280 // 18-49 = power board outputs 1-32 (TLC ports 32-63)
mjr 40:cc0d9814522b 281 for (int i = 0 ; i < 32 ; ++i)
mjr 40:cc0d9814522b 282 outPort[n++].set(PortTypeTLC5940, i+32);
mjr 40:cc0d9814522b 283
mjr 40:cc0d9814522b 284 // 50-65 = flipper RGB (TLC ports 16-31)
mjr 40:cc0d9814522b 285 for (int i = 0 ; i < 16 ; ++i)
mjr 40:cc0d9814522b 286 outPort[n++].set(PortTypeTLC5940, i+16, PortFlagGamma);
mjr 40:cc0d9814522b 287
mjr 40:cc0d9814522b 288 // 66-73 = chime board ports 1-8 (74HC595 ports 0-7)
mjr 40:cc0d9814522b 289 for (int i = 0 ; i < 8 ; ++i)
mjr 40:cc0d9814522b 290 outPort[n++].set(PortType74HC595, i);
mjr 40:cc0d9814522b 291
mjr 40:cc0d9814522b 292 // set Disabled to signify end of configured outputs
mjr 38:091e511ce8a0 293 outPort[n].typ = PortTypeDisabled;
mjr 38:091e511ce8a0 294 }
mjr 38:091e511ce8a0 295 #endif
mjr 38:091e511ce8a0 296 #if 0
mjr 40:cc0d9814522b 297 // configure the on-board RGB LED as outputs 1,2,3
mjr 40:cc0d9814522b 298 outPort[0].set(PortTypeGPIOPWM, 17, PortFlagActiveLow); // PTB18 = LED1 = Red LED
mjr 40:cc0d9814522b 299 outPort[1].set(PortTypeGPIOPWM, 18, PortFlagActiveLow); // PTB19 = LED2 = Green LED
mjr 40:cc0d9814522b 300 outPort[2].set(PortTypeGPIOPWM, 36, PortFlagActiveLow); // PTD1 = LED3 = Blue LED
mjr 38:091e511ce8a0 301 outPort[3].typ = PortTypeDisabled;
mjr 38:091e511ce8a0 302 #endif
mjr 35:e959ffba78fd 303 }
mjr 35:e959ffba78fd 304
mjr 35:e959ffba78fd 305 // --- USB DEVICE CONFIGURATION ---
mjr 35:e959ffba78fd 306
mjr 35:e959ffba78fd 307 // USB device identification - vendor ID and product ID. For LedLWiz
mjr 35:e959ffba78fd 308 // emulation, use vendor ID 0xFAFA and product ID 0x00EF + unit#, where
mjr 35:e959ffba78fd 309 // unit# is the nominal LedWiz unit number from 1 to 16. Alternatively,
mjr 35:e959ffba78fd 310 // if LedWiz emulation isn't desired or causes any driver conflicts on
mjr 35:e959ffba78fd 311 // the host, we have a private Pinscape assignment as vendor ID 0x1209
mjr 35:e959ffba78fd 312 // and product ID 0xEAEA (registered with http://pid.codes, a registry
mjr 35:e959ffba78fd 313 // for open-source USB projects).
mjr 35:e959ffba78fd 314 uint16_t usbVendorID;
mjr 35:e959ffba78fd 315 uint16_t usbProductID;
mjr 35:e959ffba78fd 316
mjr 35:e959ffba78fd 317 // Pinscape Controller unit number. This is the nominal unit number,
mjr 35:e959ffba78fd 318 // from 1 to 16. We report this in the status query; DOF uses it to
mjr 35:e959ffba78fd 319 // distinguish multiple Pinscape units. Note that this doesn't affect
mjr 35:e959ffba78fd 320 // the LedWiz unit numbering, which is implied by the USB Product ID.
mjr 35:e959ffba78fd 321 uint8_t psUnitNo;
mjr 35:e959ffba78fd 322
mjr 35:e959ffba78fd 323 // Are joystick reports enabled? Joystick reports can be turned off, to
mjr 35:e959ffba78fd 324 // use the device as purely an output controller.
mjr 35:e959ffba78fd 325 char joystickEnabled;
mjr 35:e959ffba78fd 326
mjr 35:e959ffba78fd 327
mjr 35:e959ffba78fd 328 // --- ACCELEROMETER ---
mjr 35:e959ffba78fd 329
mjr 35:e959ffba78fd 330 // accelerometer orientation (ORIENTATION_xxx value)
mjr 35:e959ffba78fd 331 char orientation;
mjr 35:e959ffba78fd 332
mjr 35:e959ffba78fd 333
mjr 35:e959ffba78fd 334 // --- PLUNGER CONFIGURATION ---
mjr 35:e959ffba78fd 335 struct
mjr 35:e959ffba78fd 336 {
mjr 35:e959ffba78fd 337 // plunger enabled/disabled
mjr 35:e959ffba78fd 338 char enabled;
mjr 33:d832bcab089e 339
mjr 35:e959ffba78fd 340 // plunger sensor type
mjr 35:e959ffba78fd 341 char sensorType;
mjr 35:e959ffba78fd 342
mjr 35:e959ffba78fd 343 // Plunger sensor pins. To accommodate a wide range of sensor types,
mjr 35:e959ffba78fd 344 // we keep a generic list of 4 pin assignments. The use of each pin
mjr 35:e959ffba78fd 345 // varies by sensor. The lists below are in order of the generic
mjr 35:e959ffba78fd 346 // pins; NC means that the pin isn't used by the sensor. Each pin's
mjr 35:e959ffba78fd 347 // GPIO usage is also listed. Certain usages limit which physical
mjr 35:e959ffba78fd 348 // pins can be assigned (e.g., AnalogIn or PwmOut).
mjr 35:e959ffba78fd 349 //
mjr 35:e959ffba78fd 350 // TSL1410R/1412R, serial: SI (DigitalOut), CLK (DigitalOut), AO (AnalogIn), NC
mjr 35:e959ffba78fd 351 // TSL1410R/1412R, parallel: SI (DigitalOut), CLK (DigitalOut), AO1 (AnalogIn), AO2 (AnalogIn)
mjr 35:e959ffba78fd 352 // Potentiometer: AO (AnalogIn), NC, NC, NC
mjr 35:e959ffba78fd 353 // AEDR8300: A (InterruptIn), B (InterruptIn), NC, NC
mjr 35:e959ffba78fd 354 // AS5304: A (InterruptIn), B (InterruptIn), NC, NC
mjr 35:e959ffba78fd 355 PinName sensorPin[4];
mjr 35:e959ffba78fd 356
mjr 35:e959ffba78fd 357 // Pseudo LAUNCH BALL button.
mjr 35:e959ffba78fd 358 //
mjr 35:e959ffba78fd 359 // This configures the "ZB Launch Ball" feature in DOF, based on Zeb's (of
mjr 35:e959ffba78fd 360 // zebsboards.com) scheme for using a mechanical plunger as a Launch button.
mjr 35:e959ffba78fd 361 // Set the port to 0 to disable the feature.
mjr 35:e959ffba78fd 362 //
mjr 35:e959ffba78fd 363 // The port number is an LedWiz port number that we monitor for activation.
mjr 35:e959ffba78fd 364 // This port isn't connected to a physical device; rather, the host turns it
mjr 35:e959ffba78fd 365 // on to indicate that the pseudo Launch button mode is in effect.
mjr 35:e959ffba78fd 366 //
mjr 35:e959ffba78fd 367 // The button number gives the button that we "press" when a launch occurs.
mjr 35:e959ffba78fd 368 // This can be connected to the physical Launch button, or can simply be
mjr 35:e959ffba78fd 369 // an otherwise unused button.
mjr 35:e959ffba78fd 370 //
mjr 40:cc0d9814522b 371 // The "push distance" is the distance, in 1/1000 inch units, for registering a
mjr 40:cc0d9814522b 372 // push on the plunger as a button push. If the player pushes the plunger
mjr 40:cc0d9814522b 373 // forward of the rest position by this amount, we'll treat it as pushing the
mjr 40:cc0d9814522b 374 // button, even if the player didn't pull back the plunger first. This lets
mjr 40:cc0d9814522b 375 // the player treat the plunger knob as a button for games where it's meaningful
mjr 35:e959ffba78fd 376 // to hold down the Launch button for specific intervals (e.g., "Championship
mjr 35:e959ffba78fd 377 // Pub").
mjr 35:e959ffba78fd 378 struct
mjr 35:e959ffba78fd 379 {
mjr 35:e959ffba78fd 380 int port;
mjr 35:e959ffba78fd 381 int btn;
mjr 40:cc0d9814522b 382 int pushDistance;
mjr 35:e959ffba78fd 383
mjr 35:e959ffba78fd 384 } zbLaunchBall;
mjr 35:e959ffba78fd 385
mjr 35:e959ffba78fd 386 // --- PLUNGER CALIBRATION ---
mjr 35:e959ffba78fd 387 struct
mjr 35:e959ffba78fd 388 {
mjr 35:e959ffba78fd 389 // has the plunger been calibrated?
mjr 35:e959ffba78fd 390 int calibrated;
mjr 35:e959ffba78fd 391
mjr 35:e959ffba78fd 392 // calibration button switch pin
mjr 35:e959ffba78fd 393 PinName btn;
mjr 35:e959ffba78fd 394
mjr 35:e959ffba78fd 395 // calibration button indicator light pin
mjr 35:e959ffba78fd 396 PinName led;
mjr 35:e959ffba78fd 397
mjr 35:e959ffba78fd 398 // Plunger calibration min, zero, and max. The zero point is the
mjr 35:e959ffba78fd 399 // rest position (aka park position), where it's in equilibrium between
mjr 35:e959ffba78fd 400 // the main spring and the barrel spring. It can travel a small distance
mjr 35:e959ffba78fd 401 // forward of the rest position, because the barrel spring can be
mjr 35:e959ffba78fd 402 // compressed by the user pushing on the plunger or by the momentum
mjr 35:e959ffba78fd 403 // of a release motion. The minimum is the maximum forward point where
mjr 35:e959ffba78fd 404 // the barrel spring can't be compressed any further.
mjr 35:e959ffba78fd 405 int min;
mjr 35:e959ffba78fd 406 int zero;
mjr 35:e959ffba78fd 407 int max;
mjr 35:e959ffba78fd 408
mjr 35:e959ffba78fd 409 // reset the plunger calibration
mjr 35:e959ffba78fd 410 void reset(int npix)
mjr 35:e959ffba78fd 411 {
mjr 35:e959ffba78fd 412 calibrated = 0; // not calibrated
mjr 35:e959ffba78fd 413 min = 0; // assume we can go all the way forward...
mjr 35:e959ffba78fd 414 max = npix; // ...and all the way back
mjr 35:e959ffba78fd 415 zero = npix/6; // the rest position is usually around 1/2" back = 1/6 of total travel
mjr 35:e959ffba78fd 416 }
mjr 17:ab3cec0c8bf4 417
mjr 35:e959ffba78fd 418 } cal;
mjr 18:5e890ebd0023 419
mjr 35:e959ffba78fd 420 } plunger;
mjr 29:582472d0bc57 421
mjr 35:e959ffba78fd 422
mjr 35:e959ffba78fd 423 // --- TV ON SWITCH ---
mjr 35:e959ffba78fd 424 //
mjr 35:e959ffba78fd 425 // To use the TV ON switch feature, the special power sensing circuitry
mjr 35:e959ffba78fd 426 // implemented on the Expansion Board must be attached (or an equivalent
mjr 35:e959ffba78fd 427 // circuit, as described in the Build Guide). The circuitry lets us
mjr 35:e959ffba78fd 428 // detect power state changes on the secondary power supply.
mjr 35:e959ffba78fd 429 struct
mjr 35:e959ffba78fd 430 {
mjr 35:e959ffba78fd 431 // PSU2 power status sense (DigitalIn pin). This pin goes LOW when the
mjr 35:e959ffba78fd 432 // secondary power supply is turned off, and remains LOW until the LATCH
mjr 35:e959ffba78fd 433 // pin is raised high AND the secondary PSU is turned on. Once HIGH,
mjr 35:e959ffba78fd 434 // it remains HIGH as long as the secondary PSU is on.
mjr 35:e959ffba78fd 435 PinName statusPin;
mjr 35:e959ffba78fd 436
mjr 35:e959ffba78fd 437 // PSU2 power status latch (DigitalOut pin)
mjr 35:e959ffba78fd 438 PinName latchPin;
mjr 35:e959ffba78fd 439
mjr 35:e959ffba78fd 440 // TV ON relay pin (DigitalOut pin). This pin controls the TV switch
mjr 35:e959ffba78fd 441 // relay. Raising the pin HIGH turns the relay ON (energizes the coil).
mjr 35:e959ffba78fd 442 PinName relayPin;
mjr 35:e959ffba78fd 443
mjr 40:cc0d9814522b 444 // TV ON delay time, in 1/100 second units. This is the interval between
mjr 40:cc0d9814522b 445 // sensing that the secondary power supply has turned on and pulsing the
mjr 40:cc0d9814522b 446 // TV ON switch relay.
mjr 40:cc0d9814522b 447 int delayTime;
mjr 35:e959ffba78fd 448
mjr 35:e959ffba78fd 449 } TVON;
mjr 35:e959ffba78fd 450
mjr 29:582472d0bc57 451
mjr 35:e959ffba78fd 452 // --- TLC5940NT PWM Controller Chip Setup ---
mjr 35:e959ffba78fd 453 struct
mjr 35:e959ffba78fd 454 {
mjr 35:e959ffba78fd 455 // number of TLC5940NT chips connected in daisy chain
mjr 35:e959ffba78fd 456 int nchips;
mjr 35:e959ffba78fd 457
mjr 35:e959ffba78fd 458 // pin connections
mjr 35:e959ffba78fd 459 PinName sin; // Serial data - must connect to SPIO MOSI -> PTC6 or PTD2
mjr 35:e959ffba78fd 460 PinName sclk; // Serial clock - must connect to SPIO SCLK -> PTC5 or PTD1
mjr 35:e959ffba78fd 461 // (but don't use PTD1, since it's hard-wired to the on-board blue LED)
mjr 35:e959ffba78fd 462 PinName xlat; // XLAT (latch) signal - connect to any GPIO pin
mjr 35:e959ffba78fd 463 PinName blank; // BLANK signal - connect to any GPIO pin
mjr 35:e959ffba78fd 464 PinName gsclk; // Grayscale clock - must connect to a PWM-out capable pin
mjr 29:582472d0bc57 465
mjr 35:e959ffba78fd 466 } tlc5940;
mjr 35:e959ffba78fd 467
mjr 35:e959ffba78fd 468
mjr 35:e959ffba78fd 469 // --- 74HC595 Shift Register Setup ---
mjr 35:e959ffba78fd 470 struct
mjr 35:e959ffba78fd 471 {
mjr 35:e959ffba78fd 472 // number of 74HC595 chips attached in daisy chain
mjr 35:e959ffba78fd 473 int nchips;
mjr 35:e959ffba78fd 474
mjr 35:e959ffba78fd 475 // pin connections
mjr 35:e959ffba78fd 476 PinName sin; // Serial data - use any GPIO pin
mjr 35:e959ffba78fd 477 PinName sclk; // Serial clock - use any GPIO pin
mjr 35:e959ffba78fd 478 PinName latch; // Latch - use any GPIO pin
mjr 35:e959ffba78fd 479 PinName ena; // Enable signal - use any GPIO pin
mjr 35:e959ffba78fd 480
mjr 35:e959ffba78fd 481 } hc595;
mjr 34:6b981a2afab7 482
mjr 25:e22b88bd783a 483
mjr 35:e959ffba78fd 484 // --- Button Input Setup ---
mjr 40:cc0d9814522b 485 ButtonCfg button[MAX_BUTTONS] __attribute__((packed));
mjr 17:ab3cec0c8bf4 486
mjr 35:e959ffba78fd 487 // --- LedWiz Output Port Setup ---
mjr 38:091e511ce8a0 488 LedWizPortCfg outPort[MAX_OUT_PORTS] __attribute__((packed)); // LedWiz & extended output ports
mjr 38:091e511ce8a0 489 LedWizPortCfg specialPort[1]; // special ports (Night Mode indicator, etc)
mjr 17:ab3cec0c8bf4 490 };
mjr 17:ab3cec0c8bf4 491
mjr 35:e959ffba78fd 492 #endif