Arnaud VALLEY / Mbed 2 deprecated Pinscape_Controller_V2_arnoz

Mirror with some correction

Dependencies:   mbed FastIO FastPWM USBDevice

config.h@90:aa4e571da8e8, 2017-10-17 (annotated)

Committer:
mjr
Date:
Tue Oct 17 22:27:48 2017 +0000
Revision:
90:aa4e571da8e8
Parent:
89:c43cd923401c
Child:
91:ae9be42652bf
Add Rx/Ry/Rz joystick reporting option

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjr 17:ab3cec0c8bf4 1 // Pinscape Controller Configuration
mjr 17:ab3cec0c8bf4 2 //
mjr 87:8d35c74403af 3 // !!! ATTENTION !!!
mjr 87:8d35c74403af 4 // If you've come here on advice in a forum to change a GPIO setting or
mjr 87:8d35c74403af 5 // to #define a macro to enable the expansion boards, >>>STOP NOW<<<. The
mjr 87:8d35c74403af 6 // advice you found is out of date and no longer applies. You don't need
mjr 87:8d35c74403af 7 // to edit this file or recompile the firmware, and you shouldn't. Instead,
mjr 87:8d35c74403af 8 // use the standard firmware, and set options using the Pinscape Config Tool
mjr 87:8d35c74403af 9 // on your Windows PC. All options that were formerly configurable by
mjr 87:8d35c74403af 10 // editing this file can be selected with the Config Tool. That's much
mjr 87:8d35c74403af 11 // cleaner and easier than editing the source code, and it eliminates the
mjr 87:8d35c74403af 12 // problem of re-synchronizing a private copy of the source code with future
mjr 87:8d35c74403af 13 // updates. With the config tool, you only need the standard firmware build,
mjr 87:8d35c74403af 14 // so future updates are a simple matter of downloading the latest version.
mjr 35:e959ffba78fd 15 //
mjr 35:e959ffba78fd 16 //
mjr 87:8d35c74403af 17 // IN THE PAST (but NOT NOW - see above), configuration was handled mostly
mjr 87:8d35c74403af 18 // with #defines and #ifdefs. To customize the setup, you had to create a
mjr 87:8d35c74403af 19 // private forked copy of the source code, edit the constants defined in
mjr 87:8d35c74403af 20 // config.h, and compile a custom binary. That's no longer necessary because
mjr 87:8d35c74403af 21 // the config tool lets you set all configurable options dynamically. Of
mjr 87:8d35c74403af 22 // course, you're still free to create a custom version if you want to add
mjr 87:8d35c74403af 23 // entirely new features or make changes that go beyond the configurable
mjr 87:8d35c74403af 24 // options.
mjr 35:e959ffba78fd 25 //
mjr 87:8d35c74403af 26 #ifndef CONFIG_H
mjr 87:8d35c74403af 27 #define CONFIG_H
mjr 35:e959ffba78fd 28
mjr 90:aa4e571da8e8 29 #include "USBJoystick.h"
mjr 90:aa4e571da8e8 30
mjr 87:8d35c74403af 31
mjr 87:8d35c74403af 32 // TEST SETTINGS - FOR DEBUGGING PURPOSES ONLY. The macros below select
mjr 87:8d35c74403af 33 // special option combinations for debugging purposes.
mjr 55:4db125cd11a0 34 //
mjr 87:8d35c74403af 35 // IMPORTANT! If you're trying to create a custom configuration because
mjr 87:8d35c74403af 36 // you have a pin conflict or because you're using the expansion boards,
mjr 87:8d35c74403af 37 // DON'T modify this file, DON'T use these macros, and DON'T recompile
mjr 87:8d35c74403af 38 // the firmware. Use the Config Tool on your Windows PC instead.
mjr 55:4db125cd11a0 39 #define STANDARD_CONFIG 1 // standard settings, based on v1 base settings
mjr 55:4db125cd11a0 40 #define TEST_CONFIG_EXPAN 0 // configuration for the expansion boards
mjr 80:94dc2946871b 41 #define TEST_KEEP_PRINTF 0 // for debugging purposes, keep printf() enabled
mjr 55:4db125cd11a0 42 // by leaving the SDA UART GPIO pins unallocated
mjr 48:058ace2aed1d 43
mjr 35:e959ffba78fd 44 // Plunger type codes
mjr 35:e959ffba78fd 45 // NOTE! These values are part of the external USB interface. New
mjr 35:e959ffba78fd 46 // values can be added, but the meaning of an existing assigned number
mjr 35:e959ffba78fd 47 // should remain fixed to keep the PC-side config tool compatible across
mjr 35:e959ffba78fd 48 // versions.
mjr 35:e959ffba78fd 49 const int PlungerType_None = 0; // no plunger
mjr 82:4f6209cb5c33 50 const int PlungerType_TSL1410R = 1; // TSL1410R linear image sensor (1280x1 pixels, 400dpi), serial mode, edge detection
mjr 82:4f6209cb5c33 51 const int PlungerType_TSL1412S = 3; // TSL1412S linear image sensor (1536x1 pixels, 400dpi), serial mode, edge detection
mjr 35:e959ffba78fd 52 const int PlungerType_Pot = 5; // potentionmeter
mjr 35:e959ffba78fd 53 const int PlungerType_OptQuad = 6; // AEDR8300 optical quadrature sensor
mjr 35:e959ffba78fd 54 const int PlungerType_MagQuad = 7; // AS5304 magnetic quadrature sensor
mjr 82:4f6209cb5c33 55 const int PlungerType_TSL1401CL = 8; // TSL1401CL linear image sensor (128x1 pixels, 400dpi), bar code sensing
mjr 82:4f6209cb5c33 56 const int PlungerType_VL6180X = 9; // VL6180X time-of-flight distance sensor
mjr 82:4f6209cb5c33 57
mjr 82:4f6209cb5c33 58 // Plunger auto-zero flags
mjr 82:4f6209cb5c33 59 const int PlungerAutoZeroEnabled = 0x01; // auto-zeroing enabled
mjr 21:5048e16cc9ef 60
mjr 35:e959ffba78fd 61 // Accelerometer orientation codes
mjr 35:e959ffba78fd 62 // These values are part of the external USB interface
mjr 35:e959ffba78fd 63 const int OrientationFront = 0; // USB ports pointed toward front of cabinet
mjr 35:e959ffba78fd 64 const int OrientationLeft = 1; // ports pointed toward left side of cabinet
mjr 35:e959ffba78fd 65 const int OrientationRight = 2; // ports pointed toward right side of cabinet
mjr 35:e959ffba78fd 66 const int OrientationRear = 3; // ports pointed toward back of cabinet
mjr 25:e22b88bd783a 67
mjr 77:0b96f6867312 68 // Accelerometer dynamic range codes
mjr 77:0b96f6867312 69 const int AccelRange1G = 0; // +/-1G
mjr 77:0b96f6867312 70 const int AccelRange2G = 1; // +/-2G
mjr 77:0b96f6867312 71 const int AccelRange4G = 2; // +/-4G
mjr 77:0b96f6867312 72 const int AccelRange8G = 3; // +/-8G
mjr 77:0b96f6867312 73
mjr 35:e959ffba78fd 74 // input button types
mjr 53:9b2611964afc 75 const int BtnTypeNone = 0; // unused
mjr 35:e959ffba78fd 76 const int BtnTypeJoystick = 1; // joystick button
mjr 53:9b2611964afc 77 const int BtnTypeKey = 2; // keyboard key
mjr 67:c39e66c4e000 78 const int BtnTypeMedia = 3; // media control key
mjr 38:091e511ce8a0 79
mjr 38:091e511ce8a0 80 // input button flags
mjr 38:091e511ce8a0 81 const uint8_t BtnFlagPulse = 0x01; // pulse mode - reports each change in the physical switch state
mjr 38:091e511ce8a0 82 // as a brief press of the logical button/keyboard key
mjr 40:cc0d9814522b 83
mjr 40:cc0d9814522b 84 // button setup structure
mjr 40:cc0d9814522b 85 struct ButtonCfg
mjr 40:cc0d9814522b 86 {
mjr 66:2e3583fbd2f4 87 // physical GPIO pin - a Wire-to-PinName mapping index
mjr 66:2e3583fbd2f4 88 uint8_t pin;
mjr 66:2e3583fbd2f4 89
mjr 66:2e3583fbd2f4 90 // Key type and value reported to the PC
mjr 40:cc0d9814522b 91 uint8_t typ; // key type reported to PC - a BtnTypeXxx value
mjr 53:9b2611964afc 92 uint8_t val; // key value reported - meaning depends on 'typ' value:
mjr 53:9b2611964afc 93 // none -> no PC input reports (val is unused)
mjr 53:9b2611964afc 94 // joystick -> val is joystick button number (1..32)
mjr 53:9b2611964afc 95 // keyboard -> val is USB scan code
mjr 77:0b96f6867312 96 uint8_t IRCommand; // IR command to send when the button is pressed, as
mjr 77:0b96f6867312 97 // an IR command slot number: 1..MAX_IR_CODES, or 0
mjr 77:0b96f6867312 98 // if no IR command is to be sent
mjr 66:2e3583fbd2f4 99
mjr 66:2e3583fbd2f4 100 // Shifted key type and value. These used when the button is pressed
mjr 66:2e3583fbd2f4 101 // while the Local Shift Button is being held down. We send the key
mjr 66:2e3583fbd2f4 102 // code given here instead of the regular typ/val code in this case.
mjr 66:2e3583fbd2f4 103 // If typ2 is BtnTypeNone, we use the regular typ/val code whether or
mjr 66:2e3583fbd2f4 104 // not the shift button is being held.
mjr 66:2e3583fbd2f4 105 uint8_t typ2; // shifted key type
mjr 66:2e3583fbd2f4 106 uint8_t val2; // shifted key value
mjr 77:0b96f6867312 107 uint8_t IRCommand2; // IR command to send when shifted button is pressed
mjr 66:2e3583fbd2f4 108
mjr 66:2e3583fbd2f4 109 // key flags - a bitwise combination of BtnFlagXxx values
mjr 66:2e3583fbd2f4 110 uint8_t flags;
mjr 40:cc0d9814522b 111
mjr 40:cc0d9814522b 112 void set(uint8_t pin, uint8_t typ, uint8_t val, uint8_t flags = 0)
mjr 40:cc0d9814522b 113 {
mjr 40:cc0d9814522b 114 this->pin = pin;
mjr 40:cc0d9814522b 115 this->typ = typ;
mjr 40:cc0d9814522b 116 this->val = val;
mjr 77:0b96f6867312 117 this->IRCommand = 0;
mjr 40:cc0d9814522b 118 this->flags = flags;
mjr 77:0b96f6867312 119 this->typ2 = 0;
mjr 77:0b96f6867312 120 this->val2 = 0;
mjr 77:0b96f6867312 121 this->IRCommand2 = 0;
mjr 40:cc0d9814522b 122 }
mjr 40:cc0d9814522b 123
mjr 40:cc0d9814522b 124 } __attribute__((packed));
mjr 40:cc0d9814522b 125
mjr 33:d832bcab089e 126
mjr 65:739875521aae 127 // maximum number of input button mappings in configuration
mjr 65:739875521aae 128 const int MAX_BUTTONS = 48;
mjr 65:739875521aae 129
mjr 65:739875521aae 130 // extra slots for virtual buttons (ZB Launch Ball)
mjr 89:c43cd923401c 131 const int VIRTUAL_BUTTONS = 1; // total number of buttons
mjr 89:c43cd923401c 132 const int ZBL_BUTTON_CFG = MAX_BUTTONS; // index of ZB Launch Ball slot
mjr 33:d832bcab089e 133
mjr 35:e959ffba78fd 134 // LedWiz output port type codes
mjr 35:e959ffba78fd 135 // These values are part of the external USB interface
mjr 89:c43cd923401c 136 const int PortTypeDisabled = 0; // port is disabled - not visible to LedWiz/DOF host
mjr 89:c43cd923401c 137 const int PortTypeGPIOPWM = 1; // GPIO port, PWM enabled
mjr 89:c43cd923401c 138 const int PortTypeGPIODig = 2; // GPIO port, digital out
mjr 89:c43cd923401c 139 const int PortTypeTLC5940 = 3; // TLC5940 port
mjr 89:c43cd923401c 140 const int PortType74HC595 = 4; // 74HC595 port
mjr 89:c43cd923401c 141 const int PortTypeVirtual = 5; // Virtual port - visible to host software, but not connected
mjr 89:c43cd923401c 142 // to a physical output
mjr 89:c43cd923401c 143 const int PortTypeTLC59116 = 6; // TLC59116 port
mjr 17:ab3cec0c8bf4 144
mjr 35:e959ffba78fd 145 // LedWiz output port flag bits
mjr 89:c43cd923401c 146 const uint8_t PortFlagActiveLow = 0x01; // physical output is active-low
mjr 89:c43cd923401c 147 const uint8_t PortFlagNoisemaker = 0x02; // noisemaker device - disable when night mode is engaged
mjr 89:c43cd923401c 148 const uint8_t PortFlagGamma = 0x04; // apply gamma correction to this output
mjr 89:c43cd923401c 149 const uint8_t PortFlagFlipperLogic = 0x08; // enable Flipper Logic on the port (timed power limitation)
mjr 35:e959ffba78fd 150
mjr 35:e959ffba78fd 151 // maximum number of output ports
mjr 48:058ace2aed1d 152 const int MAX_OUT_PORTS = 128;
mjr 33:d832bcab089e 153
mjr 38:091e511ce8a0 154 // port configuration data
mjr 38:091e511ce8a0 155 struct LedWizPortCfg
mjr 38:091e511ce8a0 156 {
mjr 89:c43cd923401c 157 // port type: a PortTypeXxx value
mjr 89:c43cd923401c 158 uint8_t typ;
mjr 40:cc0d9814522b 159
mjr 89:c43cd923401c 160 // physical output pin:
mjr 89:c43cd923401c 161 //
mjr 89:c43cd923401c 162 // - for a GPIO port, this is an index in the
mjr 89:c43cd923401c 163 // USB-to-PinName mapping list
mjr 89:c43cd923401c 164 //
mjr 89:c43cd923401c 165 // - for a TLC5940 or 74HC595 port, it's the output
mjr 89:c43cd923401c 166 // number in the overall daisy chain, starting
mjr 89:c43cd923401c 167 // from 0 for OUT0 on the first chip in the chain
mjr 89:c43cd923401c 168 //
mjr 89:c43cd923401c 169 // - for a TLC59116, the high 4 bits are the chip
mjr 89:c43cd923401c 170 // address (the low 4 bits of the address only),
mjr 89:c43cd923401c 171 // and the low 4 bits are the output number on
mjr 89:c43cd923401c 172 // the chip
mjr 89:c43cd923401c 173 //
mjr 89:c43cd923401c 174 // - for inactive and virtual ports, this is unused
mjr 89:c43cd923401c 175 //
mjr 89:c43cd923401c 176 uint8_t pin;
mjr 89:c43cd923401c 177
mjr 89:c43cd923401c 178 // flags: a combination of PortFlagXxx values
mjr 89:c43cd923401c 179 uint8_t flags;
mjr 89:c43cd923401c 180
mjr 89:c43cd923401c 181 // flipper logic properties:
mjr 89:c43cd923401c 182 //
mjr 89:c43cd923401c 183 // - high 4 bits (0xF0) give full-power time in 50ms
mjr 89:c43cd923401c 184 // intervals, starting at 0=50ms
mjr 89:c43cd923401c 185 //
mjr 89:c43cd923401c 186 // - low 4 bits (0x0F) give reduced power level (used
mjr 89:c43cd923401c 187 // after full-power time expires), in 6.66% units
mjr 89:c43cd923401c 188 //
mjr 89:c43cd923401c 189 uint8_t flipperLogic;
mjr 89:c43cd923401c 190
mjr 89:c43cd923401c 191 void set(uint8_t typ, uint8_t pin, uint8_t flags = 0, uint8_t flipperLogic = 0)
mjr 40:cc0d9814522b 192 {
mjr 40:cc0d9814522b 193 this->typ = typ;
mjr 40:cc0d9814522b 194 this->pin = pin;
mjr 40:cc0d9814522b 195 this->flags = flags;
mjr 89:c43cd923401c 196 this->flipperLogic = flipperLogic;
mjr 40:cc0d9814522b 197 }
mjr 40:cc0d9814522b 198
mjr 77:0b96f6867312 199 } __attribute__ ((packed));
mjr 77:0b96f6867312 200
mjr 77:0b96f6867312 201 // IR command configuration flags
mjr 77:0b96f6867312 202 const uint8_t IRFlagTVON = 0x01; // send command at TV ON time
mjr 77:0b96f6867312 203 const uint8_t IRFlagDittos = 0x02; // use "ditto" codes on send
mjr 77:0b96f6867312 204
mjr 77:0b96f6867312 205 // IR command configuration data
mjr 77:0b96f6867312 206 struct IRCommandCfg
mjr 77:0b96f6867312 207 {
mjr 77:0b96f6867312 208 uint8_t flags; // flags: a combination of IRFlagXxx values
mjr 77:0b96f6867312 209 uint8_t keytype; // key type to send when IR command is received
mjr 77:0b96f6867312 210 uint8_t keycode; // key code to send when IR command is received
mjr 77:0b96f6867312 211 uint8_t protocol; // IR protocol ID (see IRRemote/IRProtocolID.h)
mjr 77:0b96f6867312 212 struct
mjr 77:0b96f6867312 213 {
mjr 77:0b96f6867312 214 uint32_t lo; // low 32 bits of code
mjr 77:0b96f6867312 215 uint32_t hi; // high 32 bits of code
mjr 77:0b96f6867312 216 } code; // 64-bit command code (protocol-specific; see IRProtocols.h)
mjr 77:0b96f6867312 217 } __attribute__ ((packed));
mjr 77:0b96f6867312 218
mjr 77:0b96f6867312 219 // Maximum number of IR commands
mjr 77:0b96f6867312 220 const int MAX_IR_CODES = 16;
mjr 38:091e511ce8a0 221
mjr 38:091e511ce8a0 222
mjr 53:9b2611964afc 223 // Convert a physical pin name to a wire pin name
mjr 53:9b2611964afc 224 #define PINNAME_TO_WIRE(p) \
mjr 53:9b2611964afc 225 uint8_t((p) == NC ? 0xFF : \
mjr 53:9b2611964afc 226 (((p) & 0xF000 ) >> (PORT_SHIFT - 5)) | (((p) & 0xFF) >> 2))
mjr 53:9b2611964afc 227
mjr 35:e959ffba78fd 228 struct Config
mjr 35:e959ffba78fd 229 {
mjr 35:e959ffba78fd 230 // set all values to factory defaults
mjr 35:e959ffba78fd 231 void setFactoryDefaults()
mjr 35:e959ffba78fd 232 {
mjr 35:e959ffba78fd 233 // By default, pretend to be LedWiz unit #8. This can be from 1 to 16. Real
mjr 35:e959ffba78fd 234 // LedWiz units have their unit number set at the factory, and the vast majority
mjr 35:e959ffba78fd 235 // are set up as unit #1, since that's the default for anyone who doesn't ask
mjr 35:e959ffba78fd 236 // for a different setting. It seems rare for anyone to use more than one unit
mjr 35:e959ffba78fd 237 // in a pin cab, but for the few who do, the others will probably be numbered
mjr 35:e959ffba78fd 238 // sequentially as #2, #3, etc. It seems safe to assume that no one out there
mjr 48:058ace2aed1d 239 // has a unit #8, so we'll use that as our default. This can be changed from
mjr 48:058ace2aed1d 240 // the config tool, but for the sake of convenience, it's better to pick a
mjr 48:058ace2aed1d 241 // default that most people won't have to change.
mjr 54:fd77a6b2f76c 242 usbVendorID = 0xFAFA; // LedWiz vendor code
mjr 48:058ace2aed1d 243 usbProductID = 0x00F7; // LedWiz product code for unit #8
mjr 61:3c7e6e9ec355 244
mjr 55:4db125cd11a0 245 // Set the default Pinscape unit number to #1. This is a separate identifier
mjr 55:4db125cd11a0 246 // from the LedWiz ID, so you don't have to worry about making this different
mjr 55:4db125cd11a0 247 // from your LedWiz units. Each Pinscape unit should have a unique value for
mjr 55:4db125cd11a0 248 // this ID, though.
mjr 55:4db125cd11a0 249 //
mjr 55:4db125cd11a0 250 // Note that Pinscape unit #1 corresponds to DOF Pinscape #51, PS 2 -> DOF 52,
mjr 55:4db125cd11a0 251 // and so on - just add 50 to get the DOF ID.
mjr 55:4db125cd11a0 252 psUnitNo = 1;
mjr 35:e959ffba78fd 253
mjr 51:57eb311faafa 254 // set a disconnect reboot timeout of 10 seconds by default
mjr 55:4db125cd11a0 255 disconnectRebootTimeout = 10;
mjr 51:57eb311faafa 256
mjr 35:e959ffba78fd 257 // enable joystick reports
mjr 35:e959ffba78fd 258 joystickEnabled = true;
mjr 35:e959ffba78fd 259
mjr 90:aa4e571da8e8 260 // use the XYZ axis format
mjr 90:aa4e571da8e8 261 joystickAxisFormat = USBJoystick::AXIS_FORMAT_XYZ;
mjr 90:aa4e571da8e8 262
mjr 35:e959ffba78fd 263 // assume standard orientation, with USB ports toward front of cabinet
mjr 78:1e00b3fa11af 264 accel.orientation = OrientationFront;
mjr 78:1e00b3fa11af 265
mjr 78:1e00b3fa11af 266 // default dynamic range +/-1G
mjr 78:1e00b3fa11af 267 accel.range = AccelRange1G;
mjr 78:1e00b3fa11af 268
mjr 78:1e00b3fa11af 269 // default auto-centering time
mjr 78:1e00b3fa11af 270 accel.autoCenterTime = 0;
mjr 25:e22b88bd783a 271
mjr 52:8298b2a73eb2 272 // assume a basic setup with no expansion boards
mjr 53:9b2611964afc 273 expan.typ = 0;
mjr 53:9b2611964afc 274 expan.vsn = 0;
mjr 53:9b2611964afc 275 memset(expan.ext, 0, sizeof(expan.ext));
mjr 52:8298b2a73eb2 276
mjr 35:e959ffba78fd 277 // assume no plunger is attached
mjr 77:0b96f6867312 278 plunger.enabled = 0x00;
mjr 35:e959ffba78fd 279 plunger.sensorType = PlungerType_None;
mjr 35:e959ffba78fd 280
mjr 55:4db125cd11a0 281 #if TEST_CONFIG_EXPAN || STANDARD_CONFIG
mjr 77:0b96f6867312 282 plunger.enabled = 0x01;
mjr 82:4f6209cb5c33 283 plunger.sensorType = PlungerType_TSL1410R;
mjr 53:9b2611964afc 284 plunger.sensorPin[0] = PINNAME_TO_WIRE(PTE20); // SI
mjr 53:9b2611964afc 285 plunger.sensorPin[1] = PINNAME_TO_WIRE(PTE21); // SCLK
mjr 53:9b2611964afc 286 plunger.sensorPin[2] = PINNAME_TO_WIRE(PTB0); // AO1 = PTB0 = ADC0_SE8
mjr 53:9b2611964afc 287 plunger.sensorPin[3] = PINNAME_TO_WIRE(PTE22); // AO2 (parallel mode) = PTE22 = ADC0_SE3
mjr 43:7a6364d82a41 288 #endif
mjr 43:7a6364d82a41 289
mjr 48:058ace2aed1d 290 // default plunger calibration button settings
mjr 55:4db125cd11a0 291 plunger.cal.features = 0x03; // 0x01 = enable button, 0x02 = enable indicator lamp
mjr 55:4db125cd11a0 292 plunger.cal.btn = PINNAME_TO_WIRE(PTE29); // button input (DigitalIn port)
mjr 55:4db125cd11a0 293 plunger.cal.led = PINNAME_TO_WIRE(PTE23); // button output (DigitalOut port)
mjr 35:e959ffba78fd 294
mjr 44:b5ac89b9cd5d 295 // set the default plunger calibration
mjr 44:b5ac89b9cd5d 296 plunger.cal.setDefaults();
mjr 35:e959ffba78fd 297
mjr 35:e959ffba78fd 298 // disable the ZB Launch Ball by default
mjr 53:9b2611964afc 299 plunger.zbLaunchBall.port = 0; // 0 = disabled
mjr 65:739875521aae 300 plunger.zbLaunchBall.keytype = BtnTypeKey; // keyboard key
mjr 61:3c7e6e9ec355 301 plunger.zbLaunchBall.keycode = 0x28; // USB keyboard scan code for Enter key
mjr 61:3c7e6e9ec355 302 plunger.zbLaunchBall.pushDistance = 63; // 63/1000 in == .063" == about 1/16"
mjr 35:e959ffba78fd 303
mjr 35:e959ffba78fd 304 // assume no TV ON switch
mjr 53:9b2611964afc 305 TVON.statusPin = PINNAME_TO_WIRE(NC);
mjr 53:9b2611964afc 306 TVON.latchPin = PINNAME_TO_WIRE(NC);
mjr 53:9b2611964afc 307 TVON.relayPin = PINNAME_TO_WIRE(NC);
mjr 53:9b2611964afc 308 TVON.delayTime = 700; // 7 seconds
mjr 55:4db125cd11a0 309
mjr 55:4db125cd11a0 310 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 311 // expansion board TV ON wiring
mjr 53:9b2611964afc 312 TVON.statusPin = PINNAME_TO_WIRE(PTD2);
mjr 53:9b2611964afc 313 TVON.latchPin = PINNAME_TO_WIRE(PTE0);
mjr 53:9b2611964afc 314 TVON.relayPin = PINNAME_TO_WIRE(PTD3);
mjr 53:9b2611964afc 315 TVON.delayTime = 700; // 7 seconds
mjr 38:091e511ce8a0 316 #endif
mjr 53:9b2611964afc 317
mjr 53:9b2611964afc 318 // assume no night mode switch or indicator lamp
mjr 53:9b2611964afc 319 nightMode.btn = 0;
mjr 53:9b2611964afc 320 nightMode.flags = 0;
mjr 53:9b2611964afc 321 nightMode.port = 0;
mjr 35:e959ffba78fd 322
mjr 35:e959ffba78fd 323 // assume no TLC5940 chips
mjr 35:e959ffba78fd 324 tlc5940.nchips = 0;
mjr 55:4db125cd11a0 325
mjr 55:4db125cd11a0 326 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 327 // for expansion board testing purposes, assume the common setup
mjr 55:4db125cd11a0 328 // with one main board and one power board
mjr 48:058ace2aed1d 329 tlc5940.nchips = 4;
mjr 38:091e511ce8a0 330 #endif
mjr 38:091e511ce8a0 331
mjr 55:4db125cd11a0 332 // Default TLC5940 pin assignments. Note that it's harmless to set
mjr 55:4db125cd11a0 333 // these to valid pins even if no TLC5940 chips are actually present,
mjr 55:4db125cd11a0 334 // since the main program won't allocate the connections if 'nchips'
mjr 55:4db125cd11a0 335 // is zero. This means that the pins are free to be used for other
mjr 55:4db125cd11a0 336 // purposes (such as output ports) if not using TLC5940 chips.
mjr 53:9b2611964afc 337 tlc5940.sin = PINNAME_TO_WIRE(PTC6);
mjr 53:9b2611964afc 338 tlc5940.sclk = PINNAME_TO_WIRE(PTC5);
mjr 53:9b2611964afc 339 tlc5940.xlat = PINNAME_TO_WIRE(PTC10);
mjr 59:94eb9265b6d7 340 tlc5940.blank = PINNAME_TO_WIRE(PTC7);
mjr 59:94eb9265b6d7 341 #if TEST_KEEP_PRINTF
mjr 59:94eb9265b6d7 342 tlc5940.gsclk = PINNAME_TO_WIRE(PTA13); // PTA1 is reserved for SDA printf()
mjr 59:94eb9265b6d7 343 #else
mjr 53:9b2611964afc 344 tlc5940.gsclk = PINNAME_TO_WIRE(PTA1);
mjr 59:94eb9265b6d7 345 #endif
mjr 35:e959ffba78fd 346
mjr 35:e959ffba78fd 347 // assume no 74HC595 chips
mjr 35:e959ffba78fd 348 hc595.nchips = 0;
mjr 55:4db125cd11a0 349
mjr 55:4db125cd11a0 350 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 351 // for expansion board testing purposes, assume one chime board
mjr 48:058ace2aed1d 352 hc595.nchips = 1;
mjr 40:cc0d9814522b 353 #endif
mjr 40:cc0d9814522b 354
mjr 55:4db125cd11a0 355 // Default 74HC595 pin assignments. As with the TLC5940 pins, it's
mjr 55:4db125cd11a0 356 // harmless to assign pins here even if no 74HC595 chips are used,
mjr 55:4db125cd11a0 357 // since the main program won't actually allocate the pins if 'nchips'
mjr 55:4db125cd11a0 358 // is zero.
mjr 53:9b2611964afc 359 hc595.sin = PINNAME_TO_WIRE(PTA5);
mjr 53:9b2611964afc 360 hc595.sclk = PINNAME_TO_WIRE(PTA4);
mjr 53:9b2611964afc 361 hc595.latch = PINNAME_TO_WIRE(PTA12);
mjr 53:9b2611964afc 362 hc595.ena = PINNAME_TO_WIRE(PTD4);
mjr 38:091e511ce8a0 363
mjr 87:8d35c74403af 364 // disable all TLC59116 chips by default
mjr 87:8d35c74403af 365 tlc59116.chipMask = 0;
mjr 87:8d35c74403af 366
mjr 87:8d35c74403af 367 // Default TLC59116 pin assignments
mjr 87:8d35c74403af 368 tlc59116.sda = PINNAME_TO_WIRE(PTC6);
mjr 87:8d35c74403af 369 tlc59116.scl = PINNAME_TO_WIRE(PTC5);
mjr 87:8d35c74403af 370 tlc59116.reset = PINNAME_TO_WIRE(PTC10);
mjr 77:0b96f6867312 371
mjr 77:0b96f6867312 372 // Default IR hardware pin assignments. On the expansion boards,
mjr 77:0b96f6867312 373 // the sensor is connected to PTA13, and the emitter LED is on PTC9.
mjr 77:0b96f6867312 374 #if TEST_CONFIG_EXPAN
mjr 77:0b96f6867312 375 IR.sensor = PINNAME_TO_WIRE(PTA13);
mjr 77:0b96f6867312 376 IR.emitter = PINNAME_TO_WIRE(PTC9);
mjr 77:0b96f6867312 377 #else
mjr 77:0b96f6867312 378 IR.sensor = PINNAME_TO_WIRE(NC);
mjr 77:0b96f6867312 379 IR.emitter = PINNAME_TO_WIRE(NC);
mjr 77:0b96f6867312 380 #endif
mjr 77:0b96f6867312 381
mjr 77:0b96f6867312 382 // clear out all IR slots
mjr 77:0b96f6867312 383 memset(IRCommand, 0, sizeof(IRCommand));
mjr 77:0b96f6867312 384 for (int i = 0 ; i < MAX_IR_CODES ; ++i)
mjr 77:0b96f6867312 385 {
mjr 77:0b96f6867312 386 IRCommand[i].protocol = 0;
mjr 77:0b96f6867312 387 IRCommand[i].keytype = BtnTypeNone;
mjr 77:0b96f6867312 388 }
mjr 77:0b96f6867312 389
mjr 35:e959ffba78fd 390 // initially configure with no LedWiz output ports
mjr 35:e959ffba78fd 391 outPort[0].typ = PortTypeDisabled;
mjr 66:2e3583fbd2f4 392
mjr 66:2e3583fbd2f4 393 // initially configure with no shift key
mjr 78:1e00b3fa11af 394 shiftButton.idx = 0;
mjr 78:1e00b3fa11af 395 shiftButton.mode = 0;
mjr 53:9b2611964afc 396
mjr 35:e959ffba78fd 397 // initially configure with no input buttons
mjr 35:e959ffba78fd 398 for (int i = 0 ; i < MAX_BUTTONS ; ++i)
mjr 53:9b2611964afc 399 button[i].set(PINNAME_TO_WIRE(NC), BtnTypeNone, 0);
mjr 38:091e511ce8a0 400
mjr 55:4db125cd11a0 401 #if STANDARD_CONFIG | TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 402 // For the standard configuration, assign 24 input ports to
mjr 55:4db125cd11a0 403 // joystick buttons 1-24. Assign the same GPIO pins used
mjr 55:4db125cd11a0 404 // in the original v1 default configuration. For expansion
mjr 55:4db125cd11a0 405 // board testing purposes, also assign the input ports, with
mjr 55:4db125cd11a0 406 // the noted differences.
mjr 38:091e511ce8a0 407 for (int i = 0 ; i < 24 ; ++i) {
mjr 55:4db125cd11a0 408 static const int bp[] = {
mjr 53:9b2611964afc 409 PINNAME_TO_WIRE(PTC2), // 1
mjr 53:9b2611964afc 410 PINNAME_TO_WIRE(PTB3), // 2
mjr 53:9b2611964afc 411 PINNAME_TO_WIRE(PTB2), // 3
mjr 53:9b2611964afc 412 PINNAME_TO_WIRE(PTB1), // 4
mjr 53:9b2611964afc 413 PINNAME_TO_WIRE(PTE30), // 5
mjr 48:058ace2aed1d 414 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 415 PINNAME_TO_WIRE(PTC11), // 6 - expansion boards use PTC11 for this, since PTE22
mjr 55:4db125cd11a0 416 // is reserved for a plunger connection
mjr 55:4db125cd11a0 417 #elif STANDARD_CONFIG
mjr 55:4db125cd11a0 418 PINNAME_TO_WIRE(PTE22), // 6 - original standalone setup uses PTE22
mjr 48:058ace2aed1d 419 #endif
mjr 53:9b2611964afc 420 PINNAME_TO_WIRE(PTE5), // 7
mjr 53:9b2611964afc 421 PINNAME_TO_WIRE(PTE4), // 8
mjr 53:9b2611964afc 422 PINNAME_TO_WIRE(PTE3), // 9
mjr 53:9b2611964afc 423 PINNAME_TO_WIRE(PTE2), // 10
mjr 53:9b2611964afc 424 PINNAME_TO_WIRE(PTB11), // 11
mjr 53:9b2611964afc 425 PINNAME_TO_WIRE(PTB10), // 12
mjr 53:9b2611964afc 426 PINNAME_TO_WIRE(PTB9), // 13
mjr 53:9b2611964afc 427 PINNAME_TO_WIRE(PTB8), // 14
mjr 53:9b2611964afc 428 PINNAME_TO_WIRE(PTC12), // 15
mjr 53:9b2611964afc 429 PINNAME_TO_WIRE(PTC13), // 16
mjr 53:9b2611964afc 430 PINNAME_TO_WIRE(PTC16), // 17
mjr 53:9b2611964afc 431 PINNAME_TO_WIRE(PTC17), // 18
mjr 53:9b2611964afc 432 PINNAME_TO_WIRE(PTA16), // 19
mjr 53:9b2611964afc 433 PINNAME_TO_WIRE(PTA17), // 20
mjr 53:9b2611964afc 434 PINNAME_TO_WIRE(PTE31), // 21
mjr 53:9b2611964afc 435 PINNAME_TO_WIRE(PTD6), // 22
mjr 53:9b2611964afc 436 PINNAME_TO_WIRE(PTD7), // 23
mjr 53:9b2611964afc 437 PINNAME_TO_WIRE(PTE1) // 24
mjr 40:cc0d9814522b 438 };
mjr 48:058ace2aed1d 439 button[i].set(bp[i],
mjr 48:058ace2aed1d 440 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 441 // For expansion board testing only, assign the inputs
mjr 55:4db125cd11a0 442 // to keyboard keys A, B, etc. This isn't useful; it's
mjr 55:4db125cd11a0 443 // just for testing purposes. Note that the USB key code
mjr 55:4db125cd11a0 444 // for "A" is 4, "B" is 5, and so on sequentially through
mjr 55:4db125cd11a0 445 // the alphabet.
mjr 55:4db125cd11a0 446 BtnTypeKey, i+4);
mjr 55:4db125cd11a0 447 #elif STANDARD_CONFIG
mjr 55:4db125cd11a0 448 // For the standard configuration, assign the input to
mjr 55:4db125cd11a0 449 // joystick buttons 1-24, as in the original v1 default
mjr 55:4db125cd11a0 450 // configuration.
mjr 55:4db125cd11a0 451 BtnTypeJoystick, i+1);
mjr 48:058ace2aed1d 452 #endif
mjr 48:058ace2aed1d 453
mjr 38:091e511ce8a0 454 }
mjr 38:091e511ce8a0 455 #endif
mjr 38:091e511ce8a0 456
mjr 55:4db125cd11a0 457 #if TEST_CONFIG_EXPAN
mjr 55:4db125cd11a0 458 // For testing purposes, configure the basic complement of
mjr 55:4db125cd11a0 459 // expansion board ports. AS MENTIONED ABOVE, THIS IS PURELY FOR
mjr 55:4db125cd11a0 460 // TESTING. DON'T USE THIS METHOD TO CONFIGURE YOUR EXPANSION
mjr 55:4db125cd11a0 461 // BOARDS FOR ACTUAL DEPLOYMENT. It's much easier and cleaner
mjr 55:4db125cd11a0 462 // to use the unmodified standard build, and customize your
mjr 55:4db125cd11a0 463 // installation with the Pinscape Config Tool on Windows.
mjr 40:cc0d9814522b 464 //
mjr 55:4db125cd11a0 465 // For this testing setup, we'll configure one main board, one
mjr 55:4db125cd11a0 466 // power board, and one chime board. The *physical* ports on
mjr 55:4db125cd11a0 467 // the board are shown below. The logical (LedWiz/DOF) numbering
mjr 55:4db125cd11a0 468 // ISN'T sequential through the physical ports, because we want
mjr 55:4db125cd11a0 469 // to arrange the DOF ports so that the most important and most
mjr 55:4db125cd11a0 470 // common toys are assigned to ports 1-32. Those ports are
mjr 55:4db125cd11a0 471 // special because they're accessible to ALL software on the PC,
mjr 55:4db125cd11a0 472 // including older LedWiz-only software such as Future Pinball.
mjr 55:4db125cd11a0 473 // Ports above 32 are accessible only to modern DOF software,
mjr 55:4db125cd11a0 474 // like Visual Pinball and PinballX.
mjr 40:cc0d9814522b 475 //
mjr 40:cc0d9814522b 476 // Main board
mjr 40:cc0d9814522b 477 // TLC ports 0-15 -> flashers
mjr 40:cc0d9814522b 478 // TLC ports 16 -> strobe
mjr 40:cc0d9814522b 479 // TLC ports 17-31 -> flippers
mjr 40:cc0d9814522b 480 // Dig GPIO PTC8 -> knocker (timer-protected outputs)
mjr 40:cc0d9814522b 481 //
mjr 40:cc0d9814522b 482 // Power board:
mjr 40:cc0d9814522b 483 // TLC ports 32-63 -> general purpose outputs
mjr 40:cc0d9814522b 484 //
mjr 40:cc0d9814522b 485 // Chime board:
mjr 40:cc0d9814522b 486 // HC595 ports 0-7 -> timer-protected outputs
mjr 40:cc0d9814522b 487 //
mjr 38:091e511ce8a0 488 {
mjr 38:091e511ce8a0 489 int n = 0;
mjr 40:cc0d9814522b 490
mjr 40:cc0d9814522b 491 // 1-15 = flashers (TLC ports 0-15)
mjr 40:cc0d9814522b 492 // 16 = strobe (TLC port 15)
mjr 40:cc0d9814522b 493 for (int i = 0 ; i < 16 ; ++i)
mjr 40:cc0d9814522b 494 outPort[n++].set(PortTypeTLC5940, i, PortFlagGamma);
mjr 40:cc0d9814522b 495
mjr 53:9b2611964afc 496 // 17 = knocker (PTC8)
mjr 53:9b2611964afc 497 outPort[n++].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC8));
mjr 35:e959ffba78fd 498
mjr 40:cc0d9814522b 499 // 18-49 = power board outputs 1-32 (TLC ports 32-63)
mjr 40:cc0d9814522b 500 for (int i = 0 ; i < 32 ; ++i)
mjr 40:cc0d9814522b 501 outPort[n++].set(PortTypeTLC5940, i+32);
mjr 40:cc0d9814522b 502
mjr 40:cc0d9814522b 503 // 50-65 = flipper RGB (TLC ports 16-31)
mjr 40:cc0d9814522b 504 for (int i = 0 ; i < 16 ; ++i)
mjr 40:cc0d9814522b 505 outPort[n++].set(PortTypeTLC5940, i+16, PortFlagGamma);
mjr 59:94eb9265b6d7 506
mjr 40:cc0d9814522b 507 // 66-73 = chime board ports 1-8 (74HC595 ports 0-7)
mjr 40:cc0d9814522b 508 for (int i = 0 ; i < 8 ; ++i)
mjr 40:cc0d9814522b 509 outPort[n++].set(PortType74HC595, i);
mjr 59:94eb9265b6d7 510
mjr 40:cc0d9814522b 511 // set Disabled to signify end of configured outputs
mjr 38:091e511ce8a0 512 outPort[n].typ = PortTypeDisabled;
mjr 38:091e511ce8a0 513 }
mjr 38:091e511ce8a0 514 #endif
mjr 48:058ace2aed1d 515
mjr 55:4db125cd11a0 516 #if STANDARD_CONFIG
mjr 55:4db125cd11a0 517 //
mjr 55:4db125cd11a0 518 // For the standard build, set up the original complement
mjr 55:4db125cd11a0 519 // of 22 ports from the v1 default onfiguration.
mjr 55:4db125cd11a0 520 //
mjr 55:4db125cd11a0 521 // IMPORTANT! As mentioned above, don't edit this file to
mjr 55:4db125cd11a0 522 // customize this for your machine. Instead, use the unmodified
mjr 55:4db125cd11a0 523 // standard build, and customize your installation using the
mjr 55:4db125cd11a0 524 // Pinscape Config Tool on Windows.
mjr 55:4db125cd11a0 525 //
mjr 48:058ace2aed1d 526 #if TEST_KEEP_PRINTF
mjr 55:4db125cd11a0 527 outPort[ 0].set(PortTypeVirtual, PINNAME_TO_WIRE(NC)); // port 1 = NC to keep debug printf (PTA1 is SDA UART)
mjr 55:4db125cd11a0 528 outPort[ 1].set(PortTypeVirtual, PINNAME_TO_WIRE(NC)); // port 2 = NC to keep debug printf (PTA2 is SDA UART)
mjr 48:058ace2aed1d 529 #else
mjr 53:9b2611964afc 530 outPort[ 0].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA1)); // port 1 = PTA1
mjr 53:9b2611964afc 531 outPort[ 1].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA2)); // port 2 = PTA2
mjr 48:058ace2aed1d 532 #endif
mjr 53:9b2611964afc 533 outPort[ 2].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTD4)); // port 3 = PTD4
mjr 53:9b2611964afc 534 outPort[ 3].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA12)); // port 4 = PTA12
mjr 53:9b2611964afc 535 outPort[ 4].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA4)); // port 5 = PTA4
mjr 53:9b2611964afc 536 outPort[ 5].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA5)); // port 6 = PTA5
mjr 53:9b2611964afc 537 outPort[ 6].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTA13)); // port 7 = PTA13
mjr 53:9b2611964afc 538 outPort[ 7].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTD5)); // port 8 = PTD5
mjr 53:9b2611964afc 539 outPort[ 8].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTD0)); // port 9 = PTD0
mjr 53:9b2611964afc 540 outPort[ 9].set(PortTypeGPIOPWM, PINNAME_TO_WIRE(PTD3)); // port 10 = PTD3
mjr 53:9b2611964afc 541 outPort[10].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTD2)); // port 11 = PTD2
mjr 53:9b2611964afc 542 outPort[11].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC8)); // port 12 = PTC8
mjr 53:9b2611964afc 543 outPort[12].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC9)); // port 13 = PTC9
mjr 53:9b2611964afc 544 outPort[13].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC7)); // port 14 = PTC7
mjr 53:9b2611964afc 545 outPort[14].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC0)); // port 15 = PTC0
mjr 53:9b2611964afc 546 outPort[15].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC3)); // port 16 = PTC3
mjr 53:9b2611964afc 547 outPort[16].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC4)); // port 17 = PTC4
mjr 53:9b2611964afc 548 outPort[17].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC5)); // port 18 = PTC5
mjr 53:9b2611964afc 549 outPort[18].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC6)); // port 19 = PTC6
mjr 53:9b2611964afc 550 outPort[19].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC10)); // port 20 = PTC10
mjr 53:9b2611964afc 551 outPort[20].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTC11)); // port 21 = PTC11
mjr 53:9b2611964afc 552 outPort[21].set(PortTypeGPIODig, PINNAME_TO_WIRE(PTE0)); // port 22 = PTE0
mjr 48:058ace2aed1d 553 #endif
mjr 35:e959ffba78fd 554 }
mjr 35:e959ffba78fd 555
mjr 35:e959ffba78fd 556 // --- USB DEVICE CONFIGURATION ---
mjr 35:e959ffba78fd 557
mjr 35:e959ffba78fd 558 // USB device identification - vendor ID and product ID. For LedLWiz
mjr 35:e959ffba78fd 559 // emulation, use vendor ID 0xFAFA and product ID 0x00EF + unit#, where
mjr 35:e959ffba78fd 560 // unit# is the nominal LedWiz unit number from 1 to 16. Alternatively,
mjr 35:e959ffba78fd 561 // if LedWiz emulation isn't desired or causes any driver conflicts on
mjr 35:e959ffba78fd 562 // the host, we have a private Pinscape assignment as vendor ID 0x1209
mjr 35:e959ffba78fd 563 // and product ID 0xEAEA (registered with http://pid.codes, a registry
mjr 35:e959ffba78fd 564 // for open-source USB projects).
mjr 35:e959ffba78fd 565 uint16_t usbVendorID;
mjr 35:e959ffba78fd 566 uint16_t usbProductID;
mjr 35:e959ffba78fd 567
mjr 35:e959ffba78fd 568 // Pinscape Controller unit number. This is the nominal unit number,
mjr 35:e959ffba78fd 569 // from 1 to 16. We report this in the status query; DOF uses it to
mjr 53:9b2611964afc 570 // distinguish among Pinscape units. Note that this doesn't affect
mjr 35:e959ffba78fd 571 // the LedWiz unit numbering, which is implied by the USB Product ID.
mjr 35:e959ffba78fd 572 uint8_t psUnitNo;
mjr 35:e959ffba78fd 573
mjr 35:e959ffba78fd 574 // Are joystick reports enabled? Joystick reports can be turned off, to
mjr 35:e959ffba78fd 575 // use the device as purely an output controller.
mjr 77:0b96f6867312 576 uint8_t joystickEnabled;
mjr 35:e959ffba78fd 577
mjr 90:aa4e571da8e8 578 // Joystick axis report format, as a USBJoystick::AXIS_FORMAT_xxx value.
mjr 90:aa4e571da8e8 579 uint8_t joystickAxisFormat;
mjr 90:aa4e571da8e8 580
mjr 51:57eb311faafa 581 // Timeout for rebooting the KL25Z when the connection is lost. On some
mjr 51:57eb311faafa 582 // hosts, the mbed USB stack has problems reconnecting after an initial
mjr 51:57eb311faafa 583 // connection is dropped. As a workaround, we can automatically reboot
mjr 51:57eb311faafa 584 // the KL25Z when it detects that it's no longer connected, after the
mjr 51:57eb311faafa 585 // interval set here expires. The timeout is in seconds; setting this
mjr 51:57eb311faafa 586 // to 0 disables the automatic reboot.
mjr 51:57eb311faafa 587 uint8_t disconnectRebootTimeout;
mjr 35:e959ffba78fd 588
mjr 35:e959ffba78fd 589 // --- ACCELEROMETER ---
mjr 78:1e00b3fa11af 590 struct
mjr 78:1e00b3fa11af 591 {
mjr 78:1e00b3fa11af 592 // accelerometer orientation (OrientationXxx value)
mjr 78:1e00b3fa11af 593 uint8_t orientation;
mjr 35:e959ffba78fd 594
mjr 78:1e00b3fa11af 595 // dynamic range (AccelRangeXxx value)
mjr 78:1e00b3fa11af 596 uint8_t range;
mjr 77:0b96f6867312 597
mjr 78:1e00b3fa11af 598 // Auto-centering mode:
mjr 78:1e00b3fa11af 599 // 0 = auto-centering on, 5-second timer
mjr 78:1e00b3fa11af 600 // 1-60 = auto-centering on with the given timer in seconds
mjr 78:1e00b3fa11af 601 // 255 = auto-centering off
mjr 78:1e00b3fa11af 602 uint8_t autoCenterTime;
mjr 78:1e00b3fa11af 603
mjr 78:1e00b3fa11af 604 } accel;
mjr 35:e959ffba78fd 605
mjr 35:e959ffba78fd 606
mjr 52:8298b2a73eb2 607 // --- EXPANSION BOARDS ---
mjr 52:8298b2a73eb2 608 struct
mjr 52:8298b2a73eb2 609 {
mjr 53:9b2611964afc 610 uint8_t typ; // expansion board set type:
mjr 53:9b2611964afc 611 // 1 -> Pinscape expansion boards
mjr 53:9b2611964afc 612 uint8_t vsn; // board set interface version
mjr 53:9b2611964afc 613 uint8_t ext[3]; // board set type-specific extended data
mjr 52:8298b2a73eb2 614
mjr 52:8298b2a73eb2 615 } expan;
mjr 52:8298b2a73eb2 616
mjr 52:8298b2a73eb2 617
mjr 35:e959ffba78fd 618 // --- PLUNGER CONFIGURATION ---
mjr 35:e959ffba78fd 619 struct
mjr 35:e959ffba78fd 620 {
mjr 77:0b96f6867312 621 // Plunger enabled/disabled. Note that we use the status flag
mjr 77:0b96f6867312 622 // bit 0x01 if enabled, 0x00 if disabled. This conveniently
mjr 77:0b96f6867312 623 // can be tested as though it's a bool, but should always be
mjr 77:0b96f6867312 624 // stored as 0x01 or 0x00 so that it can be OR'ed into the
mjr 77:0b96f6867312 625 // status report flag bits.
mjr 77:0b96f6867312 626 uint8_t enabled;
mjr 33:d832bcab089e 627
mjr 35:e959ffba78fd 628 // plunger sensor type
mjr 77:0b96f6867312 629 uint8_t sensorType;
mjr 35:e959ffba78fd 630
mjr 35:e959ffba78fd 631 // Plunger sensor pins. To accommodate a wide range of sensor types,
mjr 35:e959ffba78fd 632 // we keep a generic list of 4 pin assignments. The use of each pin
mjr 35:e959ffba78fd 633 // varies by sensor. The lists below are in order of the generic
mjr 35:e959ffba78fd 634 // pins; NC means that the pin isn't used by the sensor. Each pin's
mjr 35:e959ffba78fd 635 // GPIO usage is also listed. Certain usages limit which physical
mjr 35:e959ffba78fd 636 // pins can be assigned (e.g., AnalogIn or PwmOut).
mjr 35:e959ffba78fd 637 //
mjr 82:4f6209cb5c33 638 // TSL1410R/1412S/1401CL: SI (GPIO), CLK (GPIO), AO (AnalogIn), NC
mjr 35:e959ffba78fd 639 // Potentiometer: AO (AnalogIn), NC, NC, NC
mjr 35:e959ffba78fd 640 // AEDR8300: A (InterruptIn), B (InterruptIn), NC, NC
mjr 35:e959ffba78fd 641 // AS5304: A (InterruptIn), B (InterruptIn), NC, NC
mjr 82:4f6209cb5c33 642 // VL6180X: SDA (GPIO), SCL (GPIO), GPIO0/CE (GPIO)
mjr 53:9b2611964afc 643 //
mjr 53:9b2611964afc 644 // Note! These are stored in uint8_t WIRE format, not PinName format.
mjr 53:9b2611964afc 645 uint8_t sensorPin[4];
mjr 35:e959ffba78fd 646
mjr 82:4f6209cb5c33 647 // Automatic zeroing. If enabled, we'll reset the plunger position to
mjr 82:4f6209cb5c33 648 // the park position after a period of inactivity. This only applies
mjr 82:4f6209cb5c33 649 // to certain sensor types; sensors that don't use it simply ignore it.
mjr 82:4f6209cb5c33 650 struct
mjr 82:4f6209cb5c33 651 {
mjr 82:4f6209cb5c33 652 uint8_t flags; // flags bits - combination of PlungerAutoZeroXxx flags
mjr 82:4f6209cb5c33 653 uint8_t t; // inactivity time in seconds
mjr 82:4f6209cb5c33 654 } autoZero;
mjr 82:4f6209cb5c33 655
mjr 85:3c28aee81cde 656 // Jitter filter. This is the size of the hysteresis window, in joystick
mjr 85:3c28aee81cde 657 // units (-4095..+4095). One joystick unit is approximately 1/10000" of
mjr 85:3c28aee81cde 658 // physical travel. Zero disables the jitter filter.
mjr 85:3c28aee81cde 659 uint16_t jitterWindow;
mjr 85:3c28aee81cde 660
mjr 87:8d35c74403af 661 // bar code sensor parameters
mjr 87:8d35c74403af 662 struct
mjr 87:8d35c74403af 663 {
mjr 87:8d35c74403af 664 uint16_t startPix; // starting pixel offset
mjr 87:8d35c74403af 665 } barCode;
mjr 87:8d35c74403af 666
mjr 53:9b2611964afc 667 // ZB LAUNCH BALL button setup.
mjr 35:e959ffba78fd 668 //
mjr 35:e959ffba78fd 669 // This configures the "ZB Launch Ball" feature in DOF, based on Zeb's (of
mjr 35:e959ffba78fd 670 // zebsboards.com) scheme for using a mechanical plunger as a Launch button.
mjr 35:e959ffba78fd 671 // Set the port to 0 to disable the feature.
mjr 35:e959ffba78fd 672 //
mjr 35:e959ffba78fd 673 // The port number is an LedWiz port number that we monitor for activation.
mjr 53:9b2611964afc 674 // This port isn't meant to be connected to a physical device, although it
mjr 53:9b2611964afc 675 // can be if desired. It's primarily to let the host tell the controller
mjr 53:9b2611964afc 676 // when the ZB Launch feature is active. The port numbering starts at 1;
mjr 53:9b2611964afc 677 // set this to zero to disable the feature.
mjr 35:e959ffba78fd 678 //
mjr 53:9b2611964afc 679 // The key type and code has the same meaning as for a button mapping. This
mjr 53:9b2611964afc 680 // sets the key input sent to the PC when the plunger triggers a launch when
mjr 53:9b2611964afc 681 // the mode is active. For example, set keytype=2 and keycode=0x28 to send
mjr 53:9b2611964afc 682 // the Enter key (which is the key almost all PC pinball software uses for
mjr 53:9b2611964afc 683 // plunger and Launch button input).
mjr 35:e959ffba78fd 684 //
mjr 40:cc0d9814522b 685 // The "push distance" is the distance, in 1/1000 inch units, for registering a
mjr 40:cc0d9814522b 686 // push on the plunger as a button push. If the player pushes the plunger
mjr 40:cc0d9814522b 687 // forward of the rest position by this amount, we'll treat it as pushing the
mjr 40:cc0d9814522b 688 // button, even if the player didn't pull back the plunger first. This lets
mjr 40:cc0d9814522b 689 // the player treat the plunger knob as a button for games where it's meaningful
mjr 35:e959ffba78fd 690 // to hold down the Launch button for specific intervals (e.g., "Championship
mjr 35:e959ffba78fd 691 // Pub").
mjr 35:e959ffba78fd 692 struct
mjr 35:e959ffba78fd 693 {
mjr 53:9b2611964afc 694 uint8_t port;
mjr 53:9b2611964afc 695 uint8_t keytype;
mjr 53:9b2611964afc 696 uint8_t keycode;
mjr 53:9b2611964afc 697 uint16_t pushDistance;
mjr 35:e959ffba78fd 698
mjr 35:e959ffba78fd 699 } zbLaunchBall;
mjr 35:e959ffba78fd 700
mjr 35:e959ffba78fd 701 // --- PLUNGER CALIBRATION ---
mjr 35:e959ffba78fd 702 struct
mjr 35:e959ffba78fd 703 {
mjr 35:e959ffba78fd 704 // has the plunger been calibrated?
mjr 53:9b2611964afc 705 bool calibrated;
mjr 55:4db125cd11a0 706
mjr 55:4db125cd11a0 707 // Feature enable mask:
mjr 55:4db125cd11a0 708 //
mjr 55:4db125cd11a0 709 // 0x01 = calibration button enabled
mjr 55:4db125cd11a0 710 // 0x02 = indicator light enabled
mjr 55:4db125cd11a0 711 uint8_t features;
mjr 35:e959ffba78fd 712
mjr 35:e959ffba78fd 713 // calibration button switch pin
mjr 53:9b2611964afc 714 uint8_t btn;
mjr 35:e959ffba78fd 715
mjr 35:e959ffba78fd 716 // calibration button indicator light pin
mjr 53:9b2611964afc 717 uint8_t led;
mjr 35:e959ffba78fd 718
mjr 48:058ace2aed1d 719 // Plunger calibration min, zero, and max. These are in terms of the
mjr 48:058ace2aed1d 720 // unsigned 16-bit scale (0x0000..0xffff) that we use for the raw sensor
mjr 48:058ace2aed1d 721 // readings.
mjr 48:058ace2aed1d 722 //
mjr 48:058ace2aed1d 723 // The zero point is the rest position (aka park position), where the
mjr 48:058ace2aed1d 724 // plunger is in equilibrium between the main spring and the barrel
mjr 48:058ace2aed1d 725 // spring. In the standard setup, the plunger can travel a small
mjr 48:058ace2aed1d 726 // distance forward of the rest position, because the barrel spring
mjr 48:058ace2aed1d 727 // can be compressed a bit. The minimum is the maximum forward point
mjr 48:058ace2aed1d 728 // where the barrel spring can't be compressed any further.
mjr 48:058ace2aed1d 729 uint16_t min;
mjr 48:058ace2aed1d 730 uint16_t zero;
mjr 48:058ace2aed1d 731 uint16_t max;
mjr 52:8298b2a73eb2 732
mjr 52:8298b2a73eb2 733 // Measured release time, in milliseconds.
mjr 52:8298b2a73eb2 734 uint8_t tRelease;
mjr 35:e959ffba78fd 735
mjr 44:b5ac89b9cd5d 736 // Reset the plunger calibration
mjr 44:b5ac89b9cd5d 737 void setDefaults()
mjr 35:e959ffba78fd 738 {
mjr 44:b5ac89b9cd5d 739 calibrated = false; // not calibrated
mjr 48:058ace2aed1d 740 min = 0; // assume we can go all the way forward...
mjr 48:058ace2aed1d 741 max = 0xffff; // ...and all the way back
mjr 48:058ace2aed1d 742 zero = max/6; // the rest position is usually around 1/2" back = 1/6 of total travel
mjr 52:8298b2a73eb2 743 tRelease = 65; // standard 65ms release time
mjr 44:b5ac89b9cd5d 744 }
mjr 44:b5ac89b9cd5d 745
mjr 44:b5ac89b9cd5d 746 // Begin calibration. This sets each limit to the worst
mjr 44:b5ac89b9cd5d 747 // case point - for example, we set the retracted position
mjr 44:b5ac89b9cd5d 748 // to all the way forward. Each actual reading that comes
mjr 44:b5ac89b9cd5d 749 // in is then checked against the current limit, and if it's
mjr 44:b5ac89b9cd5d 750 // outside of the limit, we reset the limit to the new reading.
mjr 44:b5ac89b9cd5d 751 void begin()
mjr 44:b5ac89b9cd5d 752 {
mjr 48:058ace2aed1d 753 min = 0; // we don't calibrate the maximum forward position, so keep this at zero
mjr 48:058ace2aed1d 754 zero = 0xffff; // set the zero position all the way back
mjr 48:058ace2aed1d 755 max = 0; // set the retracted position all the way forward
mjr 52:8298b2a73eb2 756 tRelease = 65; // revert to a default release time
mjr 35:e959ffba78fd 757 }
mjr 17:ab3cec0c8bf4 758
mjr 35:e959ffba78fd 759 } cal;
mjr 18:5e890ebd0023 760
mjr 35:e959ffba78fd 761 } plunger;
mjr 29:582472d0bc57 762
mjr 35:e959ffba78fd 763
mjr 35:e959ffba78fd 764 // --- TV ON SWITCH ---
mjr 35:e959ffba78fd 765 //
mjr 35:e959ffba78fd 766 // To use the TV ON switch feature, the special power sensing circuitry
mjr 35:e959ffba78fd 767 // implemented on the Expansion Board must be attached (or an equivalent
mjr 35:e959ffba78fd 768 // circuit, as described in the Build Guide). The circuitry lets us
mjr 35:e959ffba78fd 769 // detect power state changes on the secondary power supply.
mjr 35:e959ffba78fd 770 struct
mjr 35:e959ffba78fd 771 {
mjr 35:e959ffba78fd 772 // PSU2 power status sense (DigitalIn pin). This pin goes LOW when the
mjr 35:e959ffba78fd 773 // secondary power supply is turned off, and remains LOW until the LATCH
mjr 35:e959ffba78fd 774 // pin is raised high AND the secondary PSU is turned on. Once HIGH,
mjr 35:e959ffba78fd 775 // it remains HIGH as long as the secondary PSU is on.
mjr 53:9b2611964afc 776 uint8_t statusPin;
mjr 35:e959ffba78fd 777
mjr 35:e959ffba78fd 778 // PSU2 power status latch (DigitalOut pin)
mjr 53:9b2611964afc 779 uint8_t latchPin;
mjr 35:e959ffba78fd 780
mjr 35:e959ffba78fd 781 // TV ON relay pin (DigitalOut pin). This pin controls the TV switch
mjr 35:e959ffba78fd 782 // relay. Raising the pin HIGH turns the relay ON (energizes the coil).
mjr 53:9b2611964afc 783 uint8_t relayPin;
mjr 35:e959ffba78fd 784
mjr 40:cc0d9814522b 785 // TV ON delay time, in 1/100 second units. This is the interval between
mjr 40:cc0d9814522b 786 // sensing that the secondary power supply has turned on and pulsing the
mjr 40:cc0d9814522b 787 // TV ON switch relay.
mjr 40:cc0d9814522b 788 int delayTime;
mjr 35:e959ffba78fd 789
mjr 35:e959ffba78fd 790 } TVON;
mjr 35:e959ffba78fd 791
mjr 53:9b2611964afc 792 // --- Night Mode ---
mjr 53:9b2611964afc 793 struct
mjr 53:9b2611964afc 794 {
mjr 55:4db125cd11a0 795 uint8_t btn; // night mode button number (1..MAX_BUTTONS, 0 = no button)
mjr 53:9b2611964afc 796 uint8_t flags; // flags:
mjr 53:9b2611964afc 797 // 0x01 = on/off switch (if not set, it's a momentary button)
mjr 55:4db125cd11a0 798 uint8_t port; // indicator output port number (1..MAX_OUT_PORTS, 0 = no indicator)
mjr 53:9b2611964afc 799 } nightMode;
mjr 53:9b2611964afc 800
mjr 29:582472d0bc57 801
mjr 35:e959ffba78fd 802 // --- TLC5940NT PWM Controller Chip Setup ---
mjr 35:e959ffba78fd 803 struct
mjr 35:e959ffba78fd 804 {
mjr 35:e959ffba78fd 805 // number of TLC5940NT chips connected in daisy chain
mjr 87:8d35c74403af 806 uint8_t nchips;
mjr 35:e959ffba78fd 807
mjr 53:9b2611964afc 808 // pin connections (wire pin IDs)
mjr 53:9b2611964afc 809 uint8_t sin; // Serial data - must connect to SPIO MOSI -> PTC6 or PTD2
mjr 53:9b2611964afc 810 uint8_t sclk; // Serial clock - must connect to SPIO SCLK -> PTC5 or PTD1
mjr 35:e959ffba78fd 811 // (but don't use PTD1, since it's hard-wired to the on-board blue LED)
mjr 53:9b2611964afc 812 uint8_t xlat; // XLAT (latch) signal - connect to any GPIO pin
mjr 53:9b2611964afc 813 uint8_t blank; // BLANK signal - connect to any GPIO pin
mjr 53:9b2611964afc 814 uint8_t gsclk; // Grayscale clock - must connect to a PWM-out capable pin
mjr 29:582472d0bc57 815
mjr 35:e959ffba78fd 816 } tlc5940;
mjr 35:e959ffba78fd 817
mjr 35:e959ffba78fd 818
mjr 35:e959ffba78fd 819 // --- 74HC595 Shift Register Setup ---
mjr 35:e959ffba78fd 820 struct
mjr 35:e959ffba78fd 821 {
mjr 35:e959ffba78fd 822 // number of 74HC595 chips attached in daisy chain
mjr 87:8d35c74403af 823 uint8_t nchips;
mjr 35:e959ffba78fd 824
mjr 35:e959ffba78fd 825 // pin connections
mjr 53:9b2611964afc 826 uint8_t sin; // Serial data - use any GPIO pin
mjr 53:9b2611964afc 827 uint8_t sclk; // Serial clock - use any GPIO pin
mjr 53:9b2611964afc 828 uint8_t latch; // Latch - use any GPIO pin
mjr 53:9b2611964afc 829 uint8_t ena; // Enable signal - use any GPIO pin
mjr 35:e959ffba78fd 830
mjr 35:e959ffba78fd 831 } hc595;
mjr 77:0b96f6867312 832
mjr 87:8d35c74403af 833 // --- TLC59116 PWM Controller Chip Setup --
mjr 87:8d35c74403af 834 struct
mjr 87:8d35c74403af 835 {
mjr 87:8d35c74403af 836 // Chip mask. Each bit represents an enabled chip at the
mjr 87:8d35c74403af 837 // corresponding 4-bit address (i.e., bit 1<<addr represents
mjr 87:8d35c74403af 838 // the chip at 'addr').
mjr 87:8d35c74403af 839 uint16_t chipMask;
mjr 87:8d35c74403af 840
mjr 87:8d35c74403af 841 // pin connections
mjr 87:8d35c74403af 842 uint8_t sda; // I2C SDA
mjr 87:8d35c74403af 843 uint8_t scl; // I2C SCL
mjr 87:8d35c74403af 844 uint8_t reset; // !RESET (hardware reset line, active low)
mjr 87:8d35c74403af 845
mjr 87:8d35c74403af 846 } tlc59116;
mjr 87:8d35c74403af 847
mjr 77:0b96f6867312 848
mjr 77:0b96f6867312 849 // --- IR Remote Control Hardware Setup ---
mjr 77:0b96f6867312 850 struct
mjr 77:0b96f6867312 851 {
mjr 77:0b96f6867312 852 // sensor (receiver) GPIO input pin; must be interrupt-capable
mjr 77:0b96f6867312 853 uint8_t sensor;
mjr 77:0b96f6867312 854
mjr 77:0b96f6867312 855 // IR emitter LED GPIO output pin; must be PWM-capable
mjr 77:0b96f6867312 856 uint8_t emitter;
mjr 77:0b96f6867312 857 } IR;
mjr 77:0b96f6867312 858
mjr 77:0b96f6867312 859
mjr 35:e959ffba78fd 860 // --- Button Input Setup ---
mjr 65:739875521aae 861 ButtonCfg button[MAX_BUTTONS + VIRTUAL_BUTTONS] __attribute__((packed));
mjr 66:2e3583fbd2f4 862
mjr 78:1e00b3fa11af 863 // Shift button. This can be used to give each physical button a
mjr 78:1e00b3fa11af 864 // second meaning.
mjr 78:1e00b3fa11af 865 struct
mjr 78:1e00b3fa11af 866 {
mjr 78:1e00b3fa11af 867 // Shift button index, 1..MAX_BUTTONS. If this is zero, there's
mjr 78:1e00b3fa11af 868 // no shift button.
mjr 78:1e00b3fa11af 869 uint8_t idx;
mjr 78:1e00b3fa11af 870
mjr 78:1e00b3fa11af 871 // Shift button mode. If the shift button has a key mapping or
mjr 78:1e00b3fa11af 872 // IR command assigned, this determines what happens when the
mjr 78:1e00b3fa11af 873 // shift button is pressed in combination with another key.
mjr 78:1e00b3fa11af 874 //
mjr 78:1e00b3fa11af 875 // 0 = Shift OR Key mode. In this mode, when you initially press
mjr 78:1e00b3fa11af 876 // the shift button, nothing happens. Instead, we wait to see if
mjr 78:1e00b3fa11af 877 // any other buttons are pressed. If so, we use the shifted meaning
mjr 78:1e00b3fa11af 878 // of the other button, and we DON'T send the shift button's key or
mjr 78:1e00b3fa11af 879 // IR command at all.
mjr 78:1e00b3fa11af 880 //
mjr 78:1e00b3fa11af 881 // 1 = Shift AND Key mode. In this mode, the shift button acts like
mjr 78:1e00b3fa11af 882 // any other button: its assigned key is sent to the PC as soon as
mjr 78:1e00b3fa11af 883 // you press it. If you also press another button while the shift
mjr 78:1e00b3fa11af 884 // button is down, the shifted meaning of the other button is used.
mjr 78:1e00b3fa11af 885 //
mjr 78:1e00b3fa11af 886 // Mode 0, the "OR" mode, is the default. This allows a button with
mjr 78:1e00b3fa11af 887 // a key assignment to do double duty as the shift button without
mjr 78:1e00b3fa11af 888 // creating any confusing situations where the shift button's own
mjr 78:1e00b3fa11af 889 // key is also sent to the PC during shift usage.
mjr 78:1e00b3fa11af 890 uint8_t mode;
mjr 78:1e00b3fa11af 891
mjr 78:1e00b3fa11af 892 } shiftButton;
mjr 17:ab3cec0c8bf4 893
mjr 35:e959ffba78fd 894 // --- LedWiz Output Port Setup ---
mjr 77:0b96f6867312 895 LedWizPortCfg outPort[MAX_OUT_PORTS] __attribute__ ((packed)); // LedWiz & extended output ports
mjr 48:058ace2aed1d 896
mjr 77:0b96f6867312 897 // --- IR Command Slots ---
mjr 77:0b96f6867312 898 IRCommandCfg IRCommand[MAX_IR_CODES] __attribute__ ((packed));
mjr 17:ab3cec0c8bf4 899 };
mjr 17:ab3cec0c8bf4 900
mjr 35:e959ffba78fd 901 #endif