Mirror with some correction
Dependencies: mbed FastIO FastPWM USBDevice
cfgVarMsgMap.h@65:739875521aae, 2016-11-23 (annotated)
- Committer:
- mjr
- Date:
- Wed Nov 23 19:49:20 2016 +0000
- Revision:
- 65:739875521aae
- Parent:
- 61:3c7e6e9ec355
- Child:
- 66:2e3583fbd2f4
Increased button limit to 48; allocate live button structures dynamically
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mjr | 40:cc0d9814522b | 1 | // Define the configuration variable USB get/set mapper. We use |
mjr | 40:cc0d9814522b | 2 | // macros for the get/set operations to allow for common source |
mjr | 40:cc0d9814522b | 3 | // code for the two operations. main.cpp #includes this file twice: |
mjr | 40:cc0d9814522b | 4 | // once for the SET function and once for the GET function. main.cpp |
mjr | 40:cc0d9814522b | 5 | // redefines the v_xxx macros according to the current inclusion mode. |
mjr | 40:cc0d9814522b | 6 | // |
mjr | 40:cc0d9814522b | 7 | // This is a little tricky to follow because of the macros, but the |
mjr | 40:cc0d9814522b | 8 | // benefit is that the get and set functions automatically stay in |
mjr | 40:cc0d9814522b | 9 | // sync in terms of the variable types and byte mappings in the USB |
mjr | 40:cc0d9814522b | 10 | // messages, since they're both generated automatically from the |
mjr | 40:cc0d9814522b | 11 | // same code. |
mjr | 40:cc0d9814522b | 12 | // |
mjr | 40:cc0d9814522b | 13 | // The SET function is called directly from the corresponding USB |
mjr | 40:cc0d9814522b | 14 | // protocol message to set one variable. The data buffer is simply |
mjr | 40:cc0d9814522b | 15 | // the data passed in from the USB message. |
mjr | 40:cc0d9814522b | 16 | // |
mjr | 40:cc0d9814522b | 17 | // The GET function is called in a loop from our configuration |
mjr | 40:cc0d9814522b | 18 | // variable reporting function. The report function loops through |
mjr | 40:cc0d9814522b | 19 | // each variable in turn to generate a series of reports. The |
mjr | 40:cc0d9814522b | 20 | // caller in this case fills in data[1] with the variable ID, and |
mjr | 40:cc0d9814522b | 21 | // it also fills in data[2] with the current index being queried |
mjr | 40:cc0d9814522b | 22 | // for the array variables (buttons, outputs). We fill in the |
mjr | 40:cc0d9814522b | 23 | // rest of the data[] bytes with the current variable value(s), |
mjr | 40:cc0d9814522b | 24 | // encoded for the USB protocol message. |
mjr | 40:cc0d9814522b | 25 | |
mjr | 40:cc0d9814522b | 26 | |
mjr | 40:cc0d9814522b | 27 | void v_func(uint8_t *data) |
mjr | 40:cc0d9814522b | 28 | { |
mjr | 40:cc0d9814522b | 29 | switch (data[1]) |
mjr | 40:cc0d9814522b | 30 | { |
mjr | 61:3c7e6e9ec355 | 31 | // ********** UNRECOGNIZED VARIABLE IDs ********** |
mjr | 61:3c7e6e9ec355 | 32 | // For any variable ID we don't recognize, we'll ignore SET |
mjr | 61:3c7e6e9ec355 | 33 | // requests and return all zeroes on QUERY requests. This |
mjr | 61:3c7e6e9ec355 | 34 | // provides sensible default behavior if a newer version of |
mjr | 61:3c7e6e9ec355 | 35 | // the config tool is used with an older version of the |
mjr | 61:3c7e6e9ec355 | 36 | // firwmare. Because of the default all-zero query response, |
mjr | 61:3c7e6e9ec355 | 37 | // new variable added over time should use zero values as |
mjr | 61:3c7e6e9ec355 | 38 | // the standard defaults whenever possible. Note that the |
mjr | 61:3c7e6e9ec355 | 39 | // config tool can also use QUERY VARIABLE 0 to determine |
mjr | 61:3c7e6e9ec355 | 40 | // the number of variables supported by the firmware it's |
mjr | 61:3c7e6e9ec355 | 41 | // talking to, if it needs to know whether or not a |
mjr | 61:3c7e6e9ec355 | 42 | // particular variable exists (a variable exists if its ID |
mjr | 61:3c7e6e9ec355 | 43 | // is within the range returned by the QUERY 0 call). |
mjr | 61:3c7e6e9ec355 | 44 | // |
mjr | 61:3c7e6e9ec355 | 45 | default: |
mjr | 61:3c7e6e9ec355 | 46 | break; |
mjr | 61:3c7e6e9ec355 | 47 | |
mjr | 61:3c7e6e9ec355 | 48 | |
mjr | 53:9b2611964afc | 49 | // ********** DESCRIBE CONFIGURATION VARIABLES ********** |
mjr | 53:9b2611964afc | 50 | case 0: |
mjr | 53:9b2611964afc | 51 | v_byte_ro(15, 2); // number of SCALAR variables |
mjr | 53:9b2611964afc | 52 | v_byte_ro(2, 3); // number of ARRAY variables |
mjr | 53:9b2611964afc | 53 | break; |
mjr | 53:9b2611964afc | 54 | |
mjr | 53:9b2611964afc | 55 | // ********** SCALAR VARIABLES ********** |
mjr | 53:9b2611964afc | 56 | |
mjr | 40:cc0d9814522b | 57 | case 1: |
mjr | 40:cc0d9814522b | 58 | // USB identification (Vendor ID, Product ID) |
mjr | 40:cc0d9814522b | 59 | v_ui16(usbVendorID, 2); |
mjr | 40:cc0d9814522b | 60 | v_ui16(usbProductID, 4); |
mjr | 40:cc0d9814522b | 61 | break; |
mjr | 40:cc0d9814522b | 62 | |
mjr | 40:cc0d9814522b | 63 | case 2: |
mjr | 40:cc0d9814522b | 64 | // Pinscape Controller unit number (nominal unit number, 1-16) |
mjr | 40:cc0d9814522b | 65 | if_msg_valid(data[2] >= 1 && data[2] <= 16) |
mjr | 40:cc0d9814522b | 66 | v_byte(psUnitNo, 2); |
mjr | 40:cc0d9814522b | 67 | break; |
mjr | 40:cc0d9814522b | 68 | |
mjr | 40:cc0d9814522b | 69 | case 3: |
mjr | 40:cc0d9814522b | 70 | // Enable/disable joystick |
mjr | 40:cc0d9814522b | 71 | v_byte(joystickEnabled, 2); |
mjr | 40:cc0d9814522b | 72 | break; |
mjr | 40:cc0d9814522b | 73 | |
mjr | 40:cc0d9814522b | 74 | case 4: |
mjr | 40:cc0d9814522b | 75 | // Accelerometer orientation |
mjr | 40:cc0d9814522b | 76 | v_byte(orientation, 2); |
mjr | 40:cc0d9814522b | 77 | break; |
mjr | 40:cc0d9814522b | 78 | |
mjr | 40:cc0d9814522b | 79 | case 5: |
mjr | 40:cc0d9814522b | 80 | // Plunger sensor type |
mjr | 40:cc0d9814522b | 81 | v_byte(plunger.sensorType, 2); |
mjr | 40:cc0d9814522b | 82 | break; |
mjr | 40:cc0d9814522b | 83 | |
mjr | 40:cc0d9814522b | 84 | case 6: |
mjr | 40:cc0d9814522b | 85 | // Plunger sensor pin assignments |
mjr | 53:9b2611964afc | 86 | v_byte(plunger.sensorPin[0], 2); |
mjr | 53:9b2611964afc | 87 | v_byte(plunger.sensorPin[1], 3); |
mjr | 53:9b2611964afc | 88 | v_byte(plunger.sensorPin[2], 4); |
mjr | 53:9b2611964afc | 89 | v_byte(plunger.sensorPin[3], 5); |
mjr | 40:cc0d9814522b | 90 | break; |
mjr | 40:cc0d9814522b | 91 | |
mjr | 40:cc0d9814522b | 92 | case 7: |
mjr | 40:cc0d9814522b | 93 | // Plunger calibration button and indicator light pin assignments |
mjr | 55:4db125cd11a0 | 94 | v_byte(plunger.cal.features, 2); |
mjr | 55:4db125cd11a0 | 95 | v_byte(plunger.cal.btn, 3); |
mjr | 55:4db125cd11a0 | 96 | v_byte(plunger.cal.led, 4); |
mjr | 40:cc0d9814522b | 97 | break; |
mjr | 40:cc0d9814522b | 98 | |
mjr | 40:cc0d9814522b | 99 | case 8: |
mjr | 40:cc0d9814522b | 100 | // ZB Launch Ball setup |
mjr | 40:cc0d9814522b | 101 | v_byte(plunger.zbLaunchBall.port, 2); |
mjr | 53:9b2611964afc | 102 | v_byte(plunger.zbLaunchBall.keytype, 3); |
mjr | 53:9b2611964afc | 103 | v_byte(plunger.zbLaunchBall.keycode, 4); |
mjr | 53:9b2611964afc | 104 | v_ui16(plunger.zbLaunchBall.pushDistance, 5); |
mjr | 40:cc0d9814522b | 105 | break; |
mjr | 40:cc0d9814522b | 106 | |
mjr | 40:cc0d9814522b | 107 | case 9: |
mjr | 40:cc0d9814522b | 108 | // TV ON setup |
mjr | 53:9b2611964afc | 109 | v_byte(TVON.statusPin, 2); |
mjr | 53:9b2611964afc | 110 | v_byte(TVON.latchPin, 3); |
mjr | 53:9b2611964afc | 111 | v_byte(TVON.relayPin, 4); |
mjr | 40:cc0d9814522b | 112 | v_ui16(TVON.delayTime, 5); |
mjr | 40:cc0d9814522b | 113 | break; |
mjr | 40:cc0d9814522b | 114 | |
mjr | 40:cc0d9814522b | 115 | case 10: |
mjr | 40:cc0d9814522b | 116 | // TLC5940NT PWM controller chip setup |
mjr | 40:cc0d9814522b | 117 | v_byte(tlc5940.nchips, 2); |
mjr | 53:9b2611964afc | 118 | v_byte(tlc5940.sin, 3); |
mjr | 53:9b2611964afc | 119 | v_byte(tlc5940.sclk, 4); |
mjr | 53:9b2611964afc | 120 | v_byte(tlc5940.xlat, 5); |
mjr | 53:9b2611964afc | 121 | v_byte(tlc5940.blank, 6); |
mjr | 53:9b2611964afc | 122 | v_byte(tlc5940.gsclk, 7); |
mjr | 40:cc0d9814522b | 123 | break; |
mjr | 40:cc0d9814522b | 124 | |
mjr | 40:cc0d9814522b | 125 | case 11: |
mjr | 40:cc0d9814522b | 126 | // 74HC595 shift register chip setup |
mjr | 40:cc0d9814522b | 127 | v_byte(hc595.nchips, 2); |
mjr | 53:9b2611964afc | 128 | v_byte(hc595.sin, 3); |
mjr | 53:9b2611964afc | 129 | v_byte(hc595.sclk, 4); |
mjr | 53:9b2611964afc | 130 | v_byte(hc595.latch, 5); |
mjr | 53:9b2611964afc | 131 | v_byte(hc595.ena, 6); |
mjr | 40:cc0d9814522b | 132 | break; |
mjr | 40:cc0d9814522b | 133 | |
mjr | 40:cc0d9814522b | 134 | case 12: |
mjr | 53:9b2611964afc | 135 | // Disconnect reboot timeout |
mjr | 53:9b2611964afc | 136 | v_byte(disconnectRebootTimeout, 2); |
mjr | 53:9b2611964afc | 137 | break; |
mjr | 53:9b2611964afc | 138 | |
mjr | 53:9b2611964afc | 139 | case 13: |
mjr | 53:9b2611964afc | 140 | // plunger calibration |
mjr | 53:9b2611964afc | 141 | v_ui16(plunger.cal.zero, 2); |
mjr | 53:9b2611964afc | 142 | v_ui16(plunger.cal.max, 4); |
mjr | 53:9b2611964afc | 143 | v_byte(plunger.cal.tRelease, 6); |
mjr | 53:9b2611964afc | 144 | break; |
mjr | 53:9b2611964afc | 145 | |
mjr | 53:9b2611964afc | 146 | case 14: |
mjr | 53:9b2611964afc | 147 | // expansion board configuration |
mjr | 53:9b2611964afc | 148 | v_byte(expan.typ, 2); |
mjr | 53:9b2611964afc | 149 | v_byte(expan.vsn, 3); |
mjr | 53:9b2611964afc | 150 | v_byte(expan.ext[0], 4); |
mjr | 53:9b2611964afc | 151 | v_byte(expan.ext[1], 5); |
mjr | 53:9b2611964afc | 152 | v_byte(expan.ext[2], 6); |
mjr | 53:9b2611964afc | 153 | break; |
mjr | 53:9b2611964afc | 154 | |
mjr | 53:9b2611964afc | 155 | case 15: |
mjr | 53:9b2611964afc | 156 | // night mode configuration |
mjr | 53:9b2611964afc | 157 | v_byte(nightMode.btn, 2); |
mjr | 53:9b2611964afc | 158 | v_byte(nightMode.flags, 3); |
mjr | 53:9b2611964afc | 159 | v_byte(nightMode.port, 4); |
mjr | 53:9b2611964afc | 160 | break; |
mjr | 53:9b2611964afc | 161 | |
mjr | 53:9b2611964afc | 162 | |
mjr | 53:9b2611964afc | 163 | // case n: // new scalar variable |
mjr | 53:9b2611964afc | 164 | // |
mjr | 53:9b2611964afc | 165 | // ATTENTION! |
mjr | 53:9b2611964afc | 166 | // UPDATE CASE 0 ABOVE WHEN ADDING A NEW VARIABLE!!! |
mjr | 53:9b2611964afc | 167 | |
mjr | 53:9b2611964afc | 168 | // ********** ARRAY VARIABLES ********** |
mjr | 53:9b2611964afc | 169 | |
mjr | 53:9b2611964afc | 170 | // case n: // new array variable |
mjr | 53:9b2611964afc | 171 | // |
mjr | 53:9b2611964afc | 172 | // ATTENTION! |
mjr | 53:9b2611964afc | 173 | // UPDATE CASE 0 ABOVE WHEN ADDING A NEW ARRAY VARIABLE!!! |
mjr | 53:9b2611964afc | 174 | |
mjr | 53:9b2611964afc | 175 | case 254: |
mjr | 40:cc0d9814522b | 176 | // button setup |
mjr | 40:cc0d9814522b | 177 | { |
mjr | 40:cc0d9814522b | 178 | // get the button number |
mjr | 40:cc0d9814522b | 179 | int idx = data[2]; |
mjr | 40:cc0d9814522b | 180 | |
mjr | 40:cc0d9814522b | 181 | // if it's in range, set the button data |
mjr | 53:9b2611964afc | 182 | if (idx == 0) |
mjr | 53:9b2611964afc | 183 | { |
mjr | 53:9b2611964afc | 184 | // index 0 on query retrieves number of slots |
mjr | 65:739875521aae | 185 | v_byte_ro(MAX_BUTTONS, 3); |
mjr | 53:9b2611964afc | 186 | } |
mjr | 65:739875521aae | 187 | else if (idx > 0 && idx <= MAX_BUTTONS) |
mjr | 40:cc0d9814522b | 188 | { |
mjr | 40:cc0d9814522b | 189 | // adjust to an array index |
mjr | 40:cc0d9814522b | 190 | --idx; |
mjr | 40:cc0d9814522b | 191 | |
mjr | 40:cc0d9814522b | 192 | // set the values |
mjr | 40:cc0d9814522b | 193 | v_byte(button[idx].pin, 3); |
mjr | 40:cc0d9814522b | 194 | v_byte(button[idx].typ, 4); |
mjr | 40:cc0d9814522b | 195 | v_byte(button[idx].val, 5); |
mjr | 40:cc0d9814522b | 196 | v_byte(button[idx].flags, 6); |
mjr | 40:cc0d9814522b | 197 | } |
mjr | 40:cc0d9814522b | 198 | } |
mjr | 40:cc0d9814522b | 199 | break; |
mjr | 40:cc0d9814522b | 200 | |
mjr | 53:9b2611964afc | 201 | case 255: |
mjr | 40:cc0d9814522b | 202 | // LedWiz output port setup |
mjr | 40:cc0d9814522b | 203 | { |
mjr | 40:cc0d9814522b | 204 | // get the port number |
mjr | 40:cc0d9814522b | 205 | int idx = data[2]; |
mjr | 40:cc0d9814522b | 206 | |
mjr | 40:cc0d9814522b | 207 | // if it's in range, set the port data |
mjr | 53:9b2611964afc | 208 | if (idx == 0) |
mjr | 53:9b2611964afc | 209 | { |
mjr | 53:9b2611964afc | 210 | // index 0 on query retrieves number of slots |
mjr | 53:9b2611964afc | 211 | v_byte_ro(MAX_OUT_PORTS, 3); |
mjr | 53:9b2611964afc | 212 | } |
mjr | 53:9b2611964afc | 213 | else if (idx > 0 && idx <= MAX_OUT_PORTS) |
mjr | 40:cc0d9814522b | 214 | { |
mjr | 40:cc0d9814522b | 215 | // adjust to an array index |
mjr | 40:cc0d9814522b | 216 | --idx; |
mjr | 40:cc0d9814522b | 217 | |
mjr | 40:cc0d9814522b | 218 | // set the values |
mjr | 40:cc0d9814522b | 219 | v_byte(outPort[idx].typ, 3); |
mjr | 40:cc0d9814522b | 220 | v_byte(outPort[idx].pin, 4); |
mjr | 40:cc0d9814522b | 221 | v_byte(outPort[idx].flags, 5); |
mjr | 40:cc0d9814522b | 222 | } |
mjr | 40:cc0d9814522b | 223 | } |
mjr | 40:cc0d9814522b | 224 | break; |
mjr | 40:cc0d9814522b | 225 | } |
mjr | 40:cc0d9814522b | 226 | } |
mjr | 40:cc0d9814522b | 227 |