├── LICENSE.txt ├── README.md ├── diagrams ├── basic_ir_receiver.fzz └── magi-spin.fzz ├── images ├── basic_ir_receiver_bb.png └── magi_spin_bb.png ├── magi-spin └── magi-spin.ino └── magiquest-sensor-irremote └── magiquest-sensor-irremote.ino /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | GNU LESSER GENERAL PUBLIC LICENSE 3 | Version 2.1, February 1999 4 | 5 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 6 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | [This is the first released version of the Lesser GPL. It also counts 11 | as the successor of the GNU Library Public License, version 2, hence 12 | the version number 2.1.] 13 | 14 | Preamble 15 | 16 | The licenses for most software are designed to take away your 17 | freedom to share and change it. By contrast, the GNU General Public 18 | Licenses are intended to guarantee your freedom to share and change 19 | free software--to make sure the software is free for all its users. 20 | 21 | This license, the Lesser General Public License, applies to some 22 | specially designated software packages--typically libraries--of the 23 | Free Software Foundation and other authors who decide to use it. You 24 | can use it too, but we suggest you first think carefully about whether 25 | this license or the ordinary General Public License is the better 26 | strategy to use in any particular case, based on the explanations below. 27 | 28 | When we speak of free software, we are referring to freedom of use, 29 | not price. Our General Public Licenses are designed to make sure that 30 | you have the freedom to distribute copies of free software (and charge 31 | for this service if you wish); that you receive source code or can get 32 | it if you want it; that you can change the software and use pieces of 33 | it in new free programs; and that you are informed that you can do 34 | these things. 35 | 36 | To protect your rights, we need to make restrictions that forbid 37 | distributors to deny you these rights or to ask you to surrender these 38 | rights. These restrictions translate to certain responsibilities for 39 | you if you distribute copies of the library or if you modify it. 40 | 41 | For example, if you distribute copies of the library, whether gratis 42 | or for a fee, you must give the recipients all the rights that we gave 43 | you. You must make sure that they, too, receive or can get the source 44 | code. If you link other code with the library, you must provide 45 | complete object files to the recipients, so that they can relink them 46 | with the library after making changes to the library and recompiling 47 | it. And you must show them these terms so they know their rights. 48 | 49 | We protect your rights with a two-step method: (1) we copyright the 50 | library, and (2) we offer you this license, which gives you legal 51 | permission to copy, distribute and/or modify the library. 52 | 53 | To protect each distributor, we want to make it very clear that 54 | there is no warranty for the free library. Also, if the library is 55 | modified by someone else and passed on, the recipients should know 56 | that what they have is not the original version, so that the original 57 | author's reputation will not be affected by problems that might be 58 | introduced by others. 59 | 60 | Finally, software patents pose a constant threat to the existence of 61 | any free program. We wish to make sure that a company cannot 62 | effectively restrict the users of a free program by obtaining a 63 | restrictive license from a patent holder. Therefore, we insist that 64 | any patent license obtained for a version of the library must be 65 | consistent with the full freedom of use specified in this license. 66 | 67 | Most GNU software, including some libraries, is covered by the 68 | ordinary GNU General Public License. This license, the GNU Lesser 69 | General Public License, applies to certain designated libraries, and 70 | is quite different from the ordinary General Public License. We use 71 | this license for certain libraries in order to permit linking those 72 | libraries into non-free programs. 73 | 74 | When a program is linked with a library, whether statically or using 75 | a shared library, the combination of the two is legally speaking a 76 | combined work, a derivative of the original library. The ordinary 77 | General Public License therefore permits such linking only if the 78 | entire combination fits its criteria of freedom. The Lesser General 79 | Public License permits more lax criteria for linking other code with 80 | the library. 81 | 82 | We call this license the "Lesser" General Public License because it 83 | does Less to protect the user's freedom than the ordinary General 84 | Public License. It also provides other free software developers Less 85 | of an advantage over competing non-free programs. These disadvantages 86 | are the reason we use the ordinary General Public License for many 87 | libraries. However, the Lesser license provides advantages in certain 88 | special circumstances. 89 | 90 | For example, on rare occasions, there may be a special need to 91 | encourage the widest possible use of a certain library, so that it becomes 92 | a de-facto standard. To achieve this, non-free programs must be 93 | allowed to use the library. A more frequent case is that a free 94 | library does the same job as widely used non-free libraries. In this 95 | case, there is little to gain by limiting the free library to free 96 | software only, so we use the Lesser General Public License. 97 | 98 | In other cases, permission to use a particular library in non-free 99 | programs enables a greater number of people to use a large body of 100 | free software. For example, permission to use the GNU C Library in 101 | non-free programs enables many more people to use the whole GNU 102 | operating system, as well as its variant, the GNU/Linux operating 103 | system. 104 | 105 | Although the Lesser General Public License is Less protective of the 106 | users' freedom, it does ensure that the user of a program that is 107 | linked with the Library has the freedom and the wherewithal to run 108 | that program using a modified version of the Library. 109 | 110 | The precise terms and conditions for copying, distribution and 111 | modification follow. Pay close attention to the difference between a 112 | "work based on the library" and a "work that uses the library". The 113 | former contains code derived from the library, whereas the latter must 114 | be combined with the library in order to run. 115 | 116 | GNU LESSER GENERAL PUBLIC LICENSE 117 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 118 | 119 | 0. This License Agreement applies to any software library or other 120 | program which contains a notice placed by the copyright holder or 121 | other authorized party saying it may be distributed under the terms of 122 | this Lesser General Public License (also called "this License"). 123 | Each licensee is addressed as "you". 124 | 125 | A "library" means a collection of software functions and/or data 126 | prepared so as to be conveniently linked with application programs 127 | (which use some of those functions and data) to form executables. 128 | 129 | The "Library", below, refers to any such software library or work 130 | which has been distributed under these terms. A "work based on the 131 | Library" means either the Library or any derivative work under 132 | copyright law: that is to say, a work containing the Library or a 133 | portion of it, either verbatim or with modifications and/or translated 134 | straightforwardly into another language. (Hereinafter, translation is 135 | included without limitation in the term "modification".) 136 | 137 | "Source code" for a work means the preferred form of the work for 138 | making modifications to it. For a library, complete source code means 139 | all the source code for all modules it contains, plus any associated 140 | interface definition files, plus the scripts used to control compilation 141 | and installation of the library. 142 | 143 | Activities other than copying, distribution and modification are not 144 | covered by this License; they are outside its scope. The act of 145 | running a program using the Library is not restricted, and output from 146 | such a program is covered only if its contents constitute a work based 147 | on the Library (independent of the use of the Library in a tool for 148 | writing it). Whether that is true depends on what the Library does 149 | and what the program that uses the Library does. 150 | 151 | 1. You may copy and distribute verbatim copies of the Library's 152 | complete source code as you receive it, in any medium, provided that 153 | you conspicuously and appropriately publish on each copy an 154 | appropriate copyright notice and disclaimer of warranty; keep intact 155 | all the notices that refer to this License and to the absence of any 156 | warranty; and distribute a copy of this License along with the 157 | Library. 158 | 159 | You may charge a fee for the physical act of transferring a copy, 160 | and you may at your option offer warranty protection in exchange for a 161 | fee. 162 | 163 | 2. You may modify your copy or copies of the Library or any portion 164 | of it, thus forming a work based on the Library, and copy and 165 | distribute such modifications or work under the terms of Section 1 166 | above, provided that you also meet all of these conditions: 167 | 168 | a) The modified work must itself be a software library. 169 | 170 | b) You must cause the files modified to carry prominent notices 171 | stating that you changed the files and the date of any change. 172 | 173 | c) You must cause the whole of the work to be licensed at no 174 | charge to all third parties under the terms of this License. 175 | 176 | d) If a facility in the modified Library refers to a function or a 177 | table of data to be supplied by an application program that uses 178 | the facility, other than as an argument passed when the facility 179 | is invoked, then you must make a good faith effort to ensure that, 180 | in the event an application does not supply such function or 181 | table, the facility still operates, and performs whatever part of 182 | its purpose remains meaningful. 183 | 184 | (For example, a function in a library to compute square roots has 185 | a purpose that is entirely well-defined independent of the 186 | application. Therefore, Subsection 2d requires that any 187 | application-supplied function or table used by this function must 188 | be optional: if the application does not supply it, the square 189 | root function must still compute square roots.) 190 | 191 | These requirements apply to the modified work as a whole. If 192 | identifiable sections of that work are not derived from the Library, 193 | and can be reasonably considered independent and separate works in 194 | themselves, then this License, and its terms, do not apply to those 195 | sections when you distribute them as separate works. But when you 196 | distribute the same sections as part of a whole which is a work based 197 | on the Library, the distribution of the whole must be on the terms of 198 | this License, whose permissions for other licensees extend to the 199 | entire whole, and thus to each and every part regardless of who wrote 200 | it. 201 | 202 | Thus, it is not the intent of this section to claim rights or contest 203 | your rights to work written entirely by you; rather, the intent is to 204 | exercise the right to control the distribution of derivative or 205 | collective works based on the Library. 206 | 207 | In addition, mere aggregation of another work not based on the Library 208 | with the Library (or with a work based on the Library) on a volume of 209 | a storage or distribution medium does not bring the other work under 210 | the scope of this License. 211 | 212 | 3. You may opt to apply the terms of the ordinary GNU General Public 213 | License instead of this License to a given copy of the Library. To do 214 | this, you must alter all the notices that refer to this License, so 215 | that they refer to the ordinary GNU General Public License, version 2, 216 | instead of to this License. (If a newer version than version 2 of the 217 | ordinary GNU General Public License has appeared, then you can specify 218 | that version instead if you wish.) Do not make any other change in 219 | these notices. 220 | 221 | Once this change is made in a given copy, it is irreversible for 222 | that copy, so the ordinary GNU General Public License applies to all 223 | subsequent copies and derivative works made from that copy. 224 | 225 | This option is useful when you wish to copy part of the code of 226 | the Library into a program that is not a library. 227 | 228 | 4. You may copy and distribute the Library (or a portion or 229 | derivative of it, under Section 2) in object code or executable form 230 | under the terms of Sections 1 and 2 above provided that you accompany 231 | it with the complete corresponding machine-readable source code, which 232 | must be distributed under the terms of Sections 1 and 2 above on a 233 | medium customarily used for software interchange. 234 | 235 | If distribution of object code is made by offering access to copy 236 | from a designated place, then offering equivalent access to copy the 237 | source code from the same place satisfies the requirement to 238 | distribute the source code, even though third parties are not 239 | compelled to copy the source along with the object code. 240 | 241 | 5. A program that contains no derivative of any portion of the 242 | Library, but is designed to work with the Library by being compiled or 243 | linked with it, is called a "work that uses the Library". Such a 244 | work, in isolation, is not a derivative work of the Library, and 245 | therefore falls outside the scope of this License. 246 | 247 | However, linking a "work that uses the Library" with the Library 248 | creates an executable that is a derivative of the Library (because it 249 | contains portions of the Library), rather than a "work that uses the 250 | library". The executable is therefore covered by this License. 251 | Section 6 states terms for distribution of such executables. 252 | 253 | When a "work that uses the Library" uses material from a header file 254 | that is part of the Library, the object code for the work may be a 255 | derivative work of the Library even though the source code is not. 256 | Whether this is true is especially significant if the work can be 257 | linked without the Library, or if the work is itself a library. The 258 | threshold for this to be true is not precisely defined by law. 259 | 260 | If such an object file uses only numerical parameters, data 261 | structure layouts and accessors, and small macros and small inline 262 | functions (ten lines or less in length), then the use of the object 263 | file is unrestricted, regardless of whether it is legally a derivative 264 | work. (Executables containing this object code plus portions of the 265 | Library will still fall under Section 6.) 266 | 267 | Otherwise, if the work is a derivative of the Library, you may 268 | distribute the object code for the work under the terms of Section 6. 269 | Any executables containing that work also fall under Section 6, 270 | whether or not they are linked directly with the Library itself. 271 | 272 | 6. As an exception to the Sections above, you may also combine or 273 | link a "work that uses the Library" with the Library to produce a 274 | work containing portions of the Library, and distribute that work 275 | under terms of your choice, provided that the terms permit 276 | modification of the work for the customer's own use and reverse 277 | engineering for debugging such modifications. 278 | 279 | You must give prominent notice with each copy of the work that the 280 | Library is used in it and that the Library and its use are covered by 281 | this License. You must supply a copy of this License. If the work 282 | during execution displays copyright notices, you must include the 283 | copyright notice for the Library among them, as well as a reference 284 | directing the user to the copy of this License. Also, you must do one 285 | of these things: 286 | 287 | a) Accompany the work with the complete corresponding 288 | machine-readable source code for the Library including whatever 289 | changes were used in the work (which must be distributed under 290 | Sections 1 and 2 above); and, if the work is an executable linked 291 | with the Library, with the complete machine-readable "work that 292 | uses the Library", as object code and/or source code, so that the 293 | user can modify the Library and then relink to produce a modified 294 | executable containing the modified Library. (It is understood 295 | that the user who changes the contents of definitions files in the 296 | Library will not necessarily be able to recompile the application 297 | to use the modified definitions.) 298 | 299 | b) Use a suitable shared library mechanism for linking with the 300 | Library. A suitable mechanism is one that (1) uses at run time a 301 | copy of the library already present on the user's computer system, 302 | rather than copying library functions into the executable, and (2) 303 | will operate properly with a modified version of the library, if 304 | the user installs one, as long as the modified version is 305 | interface-compatible with the version that the work was made with. 306 | 307 | c) Accompany the work with a written offer, valid for at 308 | least three years, to give the same user the materials 309 | specified in Subsection 6a, above, for a charge no more 310 | than the cost of performing this distribution. 311 | 312 | d) If distribution of the work is made by offering access to copy 313 | from a designated place, offer equivalent access to copy the above 314 | specified materials from the same place. 315 | 316 | e) Verify that the user has already received a copy of these 317 | materials or that you have already sent this user a copy. 318 | 319 | For an executable, the required form of the "work that uses the 320 | Library" must include any data and utility programs needed for 321 | reproducing the executable from it. However, as a special exception, 322 | the materials to be distributed need not include anything that is 323 | normally distributed (in either source or binary form) with the major 324 | components (compiler, kernel, and so on) of the operating system on 325 | which the executable runs, unless that component itself accompanies 326 | the executable. 327 | 328 | It may happen that this requirement contradicts the license 329 | restrictions of other proprietary libraries that do not normally 330 | accompany the operating system. Such a contradiction means you cannot 331 | use both them and the Library together in an executable that you 332 | distribute. 333 | 334 | 7. You may place library facilities that are a work based on the 335 | Library side-by-side in a single library together with other library 336 | facilities not covered by this License, and distribute such a combined 337 | library, provided that the separate distribution of the work based on 338 | the Library and of the other library facilities is otherwise 339 | permitted, and provided that you do these two things: 340 | 341 | a) Accompany the combined library with a copy of the same work 342 | based on the Library, uncombined with any other library 343 | facilities. This must be distributed under the terms of the 344 | Sections above. 345 | 346 | b) Give prominent notice with the combined library of the fact 347 | that part of it is a work based on the Library, and explaining 348 | where to find the accompanying uncombined form of the same work. 349 | 350 | 8. You may not copy, modify, sublicense, link with, or distribute 351 | the Library except as expressly provided under this License. Any 352 | attempt otherwise to copy, modify, sublicense, link with, or 353 | distribute the Library is void, and will automatically terminate your 354 | rights under this License. However, parties who have received copies, 355 | or rights, from you under this License will not have their licenses 356 | terminated so long as such parties remain in full compliance. 357 | 358 | 9. You are not required to accept this License, since you have not 359 | signed it. However, nothing else grants you permission to modify or 360 | distribute the Library or its derivative works. These actions are 361 | prohibited by law if you do not accept this License. Therefore, by 362 | modifying or distributing the Library (or any work based on the 363 | Library), you indicate your acceptance of this License to do so, and 364 | all its terms and conditions for copying, distributing or modifying 365 | the Library or works based on it. 366 | 367 | 10. Each time you redistribute the Library (or any work based on the 368 | Library), the recipient automatically receives a license from the 369 | original licensor to copy, distribute, link with or modify the Library 370 | subject to these terms and conditions. You may not impose any further 371 | restrictions on the recipients' exercise of the rights granted herein. 372 | You are not responsible for enforcing compliance by third parties with 373 | this License. 374 | 375 | 11. If, as a consequence of a court judgment or allegation of patent 376 | infringement or for any other reason (not limited to patent issues), 377 | conditions are imposed on you (whether by court order, agreement or 378 | otherwise) that contradict the conditions of this License, they do not 379 | excuse you from the conditions of this License. If you cannot 380 | distribute so as to satisfy simultaneously your obligations under this 381 | License and any other pertinent obligations, then as a consequence you 382 | may not distribute the Library at all. For example, if a patent 383 | license would not permit royalty-free redistribution of the Library by 384 | all those who receive copies directly or indirectly through you, then 385 | the only way you could satisfy both it and this License would be to 386 | refrain entirely from distribution of the Library. 387 | 388 | If any portion of this section is held invalid or unenforceable under any 389 | particular circumstance, the balance of the section is intended to apply, 390 | and the section as a whole is intended to apply in other circumstances. 391 | 392 | It is not the purpose of this section to induce you to infringe any 393 | patents or other property right claims or to contest validity of any 394 | such claims; this section has the sole purpose of protecting the 395 | integrity of the free software distribution system which is 396 | implemented by public license practices. Many people have made 397 | generous contributions to the wide range of software distributed 398 | through that system in reliance on consistent application of that 399 | system; it is up to the author/donor to decide if he or she is willing 400 | to distribute software through any other system and a licensee cannot 401 | impose that choice. 402 | 403 | This section is intended to make thoroughly clear what is believed to 404 | be a consequence of the rest of this License. 405 | 406 | 12. If the distribution and/or use of the Library is restricted in 407 | certain countries either by patents or by copyrighted interfaces, the 408 | original copyright holder who places the Library under this License may add 409 | an explicit geographical distribution limitation excluding those countries, 410 | so that distribution is permitted only in or among countries not thus 411 | excluded. In such case, this License incorporates the limitation as if 412 | written in the body of this License. 413 | 414 | 13. The Free Software Foundation may publish revised and/or new 415 | versions of the Lesser General Public License from time to time. 416 | Such new versions will be similar in spirit to the present version, 417 | but may differ in detail to address new problems or concerns. 418 | 419 | Each version is given a distinguishing version number. If the Library 420 | specifies a version number of this License which applies to it and 421 | "any later version", you have the option of following the terms and 422 | conditions either of that version or of any later version published by 423 | the Free Software Foundation. If the Library does not specify a 424 | license version number, you may choose any version ever published by 425 | the Free Software Foundation. 426 | 427 | 14. If you wish to incorporate parts of the Library into other free 428 | programs whose distribution conditions are incompatible with these, 429 | write to the author to ask for permission. For software which is 430 | copyrighted by the Free Software Foundation, write to the Free 431 | Software Foundation; we sometimes make exceptions for this. Our 432 | decision will be guided by the two goals of preserving the free status 433 | of all derivatives of our free software and of promoting the sharing 434 | and reuse of software generally. 435 | 436 | NO WARRANTY 437 | 438 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 439 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 440 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 441 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 442 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 443 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 444 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 445 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 446 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 447 | 448 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 449 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 450 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 451 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 452 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 453 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 454 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 455 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 456 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 457 | DAMAGES. 458 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Read the Wand ID and shake magnitude of a MagiQuest wand, using an Arduino and IR sensor. 2 | 3 | ```sh 4 | Comms enabled - beginning sensing 5 | wand_id: 683915009 6 | magnitude: 33114 7 | wand_id: 683915009 8 | magnitude: 33114 9 | wand_id: 809765633 10 | magnitude: 383 11 | wand_id: 809765633 12 | magnitude: 33278 13 | ``` 14 | 15 | # MagiQuest Wand "hello world" 16 | 17 | ## Parts List 18 | 19 | *Hardware*: 20 | 21 | * Arduino Uno 22 | * IR Receiver (I used an [OSEPP IR Receiver Module](https://www.osepp.com/electronic-modules/sensor-modules/66-ir-receiver-module), [AdaFruit IR Receiver Sensor](https://www.adafruit.com/products/157) should also work) 23 | * MagiQuest Wand 24 | 25 | *Software - Arduino IR Support*: 26 | 27 | 1. Arduino -> Sketch -> IRRemote 28 | 29 | *Or if IR support isn't alrady installed*: 30 | 31 | 1. or Arduino -> Sketch -> Include Library -> Manage Libraries... 32 | 2. search IRRemote 33 | 3. Install 34 | 35 | ## Wiring it up 36 | 37 | ![Wiring Diagram](images/basic_ir_receiver_bb.png) 38 | 39 | 40 | # Basic Project - Servo and MagiQuest 41 | 42 | The `magi-spin` project is a basic example of using a MagiQuest wand to control a servo. In repsonse to a wand wave, a 43 | servo will quickly swing back and forth. 44 | 45 | ## Parts List 46 | 47 | *Hardware*: 48 | 49 | * Arduino Uno 50 | * IR Receiver (I used an [OSEPP IR Receiver Module](https://www.osepp.com/electronic-modules/sensor-modules/66-ir-receiver-module), [AdaFruit IR Receiver Sensor](https://www.adafruit.com/products/157) should also work) 51 | * Servo (I used an [Adafruit Micro Servo](https://www.adafruit.com/products/169)) 52 | * MagiQuest wand 53 | 54 | *Software - Arduino IR Support*: 55 | 56 | 1. Arduino -> Sketch -> IRRemote 57 | 58 | *Or if IR support isn't alrady installed*: 59 | 60 | 1. or Arduino -> Sketch -> Include Library -> Manage Libraries... 61 | 2. search IRRemote 62 | 3. Install 63 | 64 | ## Wiring Diagram 65 | 66 | ![magi-spin wiring diagram](images/magi_spin_bb.png) 67 | 68 | ## Code 69 | 70 | See [magi-spin source](magi-spin/magi-spin.ino) 71 | 72 | # Decoding MagiQuest 73 | 74 | A breakdown of the [signal characteristics of a MagiQuest Wand](http://openschemes.com/2013/03/13/mq-widget-part-iii/) is available over at OpenSchemes. Instead of hand decoding the entire IR signal, we piggyback on the IRremote Arduino library, with a few modifications courtesy of [mpflaga's MagiQuest fork of IRremote](https://github.com/mpflaga/Arduino-IRremote). 75 | 76 | We lifted the MagiQuest specific code from *mpflaga* and, with a few changes, directly included the relevant decode functions 77 | in the Arduino Sketch. The function of interest is *decodeMagicQuest*, which is called with a pointer to an `IRremote::decode_results` structure, 78 | and the `magiquest` structure we declare at the top of the sketch. Calling the *decodeMagiQuest* will decode and fill in the 79 | data in both the `decode_results` and `magiquest` structures: 80 | 81 | ```c 82 | decodeMagiQuest(&results, &data); 83 | 84 | // the wand id is also in results.value 85 | Serial.print("wand_id: "); 86 | Serial.println(data.cmd.wand_id); 87 | 88 | Serial.print("magnitude: "); 89 | Serial.println(data.cmd.magnitude); 90 | ``` 91 | 92 | # IR Sensors 93 | 94 | I've used the following sensors successfully (with no code changes): 95 | 96 | * [OSEPP IR Receiver Module](https://www.osepp.com/electronic-modules/sensor-modules/66-ir-receiver-module) 97 | * [SunFounder Infrared Receiver Module](https://www.sunfounder.com/infrared-receiver-module.html) 98 | * [Adafruit IR Receiver Sensor](https://www.adafruit.com/product/157) -------------------------------------------------------------------------------- /diagrams/basic_ir_receiver.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/patricknevindwyer/arduino-magiquest/9123e5b1e0be00d4793efd2545230571ba948e66/diagrams/basic_ir_receiver.fzz -------------------------------------------------------------------------------- /diagrams/magi-spin.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/patricknevindwyer/arduino-magiquest/9123e5b1e0be00d4793efd2545230571ba948e66/diagrams/magi-spin.fzz -------------------------------------------------------------------------------- /images/basic_ir_receiver_bb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/patricknevindwyer/arduino-magiquest/9123e5b1e0be00d4793efd2545230571ba948e66/images/basic_ir_receiver_bb.png -------------------------------------------------------------------------------- /images/magi_spin_bb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/patricknevindwyer/arduino-magiquest/9123e5b1e0be00d4793efd2545230571ba948e66/images/magi_spin_bb.png -------------------------------------------------------------------------------- /magi-spin/magi-spin.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | // MagiQuest protocol for IR 6 | #define MAGIQUEST_PERIOD 1150 7 | #define MAGIQUEST_MARK_ZERO 280 8 | #define MAGIQUEST_SPACE_ZERO 850 9 | #define MAGIQUEST_MARK_ONE 580 10 | #define MAGIQUEST_SPACE_ONE 600 11 | #define MAGIQUEST_BITS 56 12 | 13 | // we use an alternate `decode_type` for our IRremote decoding 14 | #define MAGIQUEST 11 15 | 16 | // The magiquest payload is a bit different from the 17 | // standard IRremote payload 18 | union magiquest { 19 | uint64_t llword; 20 | uint8_t byte[8]; 21 | uint32_t lword[2]; 22 | struct { 23 | uint16_t magnitude; 24 | uint32_t wand_id; 25 | uint8_t padding; 26 | uint8_t scrap; 27 | } cmd ; 28 | } ; 29 | 30 | // hoist IRremote DEFs into our namespace for quick compatibility 31 | #define ERR 0 32 | #define DECODED 1 33 | 34 | // Use analog 0 as our receiver 35 | int recv_pin = A0; 36 | IRrecv irrecv(recv_pin); 37 | 38 | // Results as read from the IR sensor. We need to run this through 39 | // the decodeMagiQuest function to get useful data. 40 | decode_results results; 41 | magiquest data; 42 | 43 | // The PWM pin for our motor, as well as the target speed, 44 | // and how long to activate it (in milliseconds) 45 | int servo_pin = 9; 46 | int servo_pos = 0; 47 | 48 | Servo magi_servo; 49 | 50 | void setup() { 51 | 52 | // Let's use comms for debug 53 | Serial.begin(9600); 54 | 55 | while (!Serial) { 56 | ; 57 | } 58 | 59 | Serial.println("Comms enabled - beginning sensing"); 60 | 61 | // setup the servo 62 | magi_servo.attach(servo_pin); 63 | magi_servo.write(0); 64 | 65 | // turn on IR receiver 66 | irrecv.enableIRIn(); 67 | } 68 | 69 | void loop() { 70 | 71 | // Wait and decode 72 | if (irrecv.decode(&results)) { 73 | 74 | // translate the bit stream into something we can use 75 | // to understand a MagiQuest wand 76 | decodeMagiQuest(&results, &data); 77 | Serial.print("wand_id: "); 78 | Serial.println(data.cmd.wand_id); 79 | Serial.print("magnitude: "); 80 | Serial.println(data.cmd.magnitude); 81 | 82 | // set the servo 83 | servo_pos = 180; 84 | 85 | while (servo_pos > 0) { 86 | magi_servo.write(servo_pos); 87 | servo_pos -= 5; 88 | delay(10); 89 | } 90 | 91 | // keep receiving data 92 | irrecv.resume(); 93 | } 94 | 95 | // // reset our motor speed, as we've activated it for long enough already 96 | // if (servo_pos > 0) { 97 | // servo_pos--; 98 | // } 99 | // 100 | // if (servo_pos > 0) { 101 | // magi_servo.write(servo_pos); 102 | // } 103 | 104 | } 105 | 106 | /* 107 | * This decodeMagiQuest method cribbed from mpflaga (https://github.com/mpflaga/Arduino-IRremote) 108 | * mode of the Arduino IRremote library. Excised and updated to work with current IRremote 109 | * library. 110 | * 111 | * https://github.com/mpflaga/Arduino-IRremote/blob/master/IRremote.cpp 112 | * 113 | */ 114 | int32_t decodeMagiQuest(decode_results *results, magiquest *mdata) { 115 | magiquest data; 116 | data.llword = 0; 117 | 118 | int16_t offset = 1; 119 | uint16_t mark_; 120 | uint16_t space_; 121 | uint8_t multiple_; 122 | 123 | if (irparams.rawlen < 2 * MAGIQUEST_BITS) { 124 | return ERR; 125 | } 126 | 127 | while (offset + 1 < irparams.rawlen) { 128 | mark_ = results->rawbuf[offset]; 129 | space_ = results->rawbuf[offset+1]; 130 | multiple_ = space_ / mark_; 131 | // it is either 25% + 75% or 50% + 50% 132 | 133 | if (MATCH_MARK(space_ + mark_, MAGIQUEST_PERIOD)) { 134 | if (multiple_ > 1) { 135 | data.llword <<= 1; 136 | } else { 137 | data.llword = (data.llword << 1) | 1; 138 | } 139 | } else { 140 | return ERR; 141 | } 142 | offset++; 143 | offset++; 144 | } 145 | // Success 146 | results->bits = (offset + 1) / 2; 147 | if (results->bits < 12) { 148 | results->bits = 0; 149 | return ERR; 150 | } 151 | //results->magiquestMagnitude = data.cmd.magnitude; 152 | results->value = data.cmd.wand_id; 153 | results->decode_type = MAGIQUEST; 154 | 155 | // fill in our magiquest struct 156 | mdata->cmd.magnitude = data.cmd.magnitude; 157 | mdata->cmd.wand_id = data.cmd.wand_id; 158 | return DECODED; 159 | } 160 | -------------------------------------------------------------------------------- /magiquest-sensor-irremote/magiquest-sensor-irremote.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | // MagiQuest protocol for IR 5 | #define MAGIQUEST_PERIOD 1150 6 | #define MAGIQUEST_MARK_ZERO 280 7 | #define MAGIQUEST_SPACE_ZERO 850 8 | #define MAGIQUEST_MARK_ONE 580 9 | #define MAGIQUEST_SPACE_ONE 600 10 | #define MAGIQUEST_BITS 56 11 | 12 | // we use an alternate `decode_type` for our IRremote decoding 13 | #define MAGIQUEST 11 14 | 15 | // The magiquest payload is a bit different from the 16 | // standard IRremote payload 17 | union magiquest { 18 | uint64_t llword; 19 | uint8_t byte[8]; 20 | uint32_t lword[2]; 21 | struct { 22 | uint16_t magnitude; 23 | uint32_t wand_id; 24 | uint8_t padding; 25 | uint8_t scrap; 26 | } cmd ; 27 | } ; 28 | 29 | // hoist IRremote DEFs into our namespace for quick compatibility 30 | #define ERR 0 31 | #define DECODED 1 32 | 33 | // Use analog 0 as our receiver 34 | int recv_pin = A0; 35 | IRrecv irrecv(recv_pin); 36 | 37 | // Results as read from the IR sensor. We need to run this through 38 | // the decodeMagiQuest function to get useful data. 39 | decode_results results; 40 | magiquest data; 41 | 42 | void setup() { 43 | 44 | // Let's use comms for debug 45 | Serial.begin(9600); 46 | 47 | while (!Serial) { 48 | ; 49 | } 50 | 51 | Serial.println("Comms enabled - beginning sensing"); 52 | 53 | // turn on IR receiver 54 | irrecv.enableIRIn(); 55 | } 56 | 57 | void loop() { 58 | 59 | // Wait and decode 60 | if (irrecv.decode(&results)) { 61 | 62 | // translate the bit stream into something we can use 63 | // to understand a MagiQuest wand 64 | decodeMagiQuest(&results, &data); 65 | Serial.print("wand_id: "); 66 | Serial.println(data.cmd.wand_id); 67 | Serial.print("magnitude: "); 68 | Serial.println(data.cmd.magnitude); 69 | 70 | // keep receiving data 71 | irrecv.resume(); 72 | } 73 | 74 | // wait a bit, and then back to receiving and decoding 75 | delay(100); 76 | } 77 | 78 | /* 79 | * This decodeMagiQuest method cribbed from mpflaga (https://github.com/mpflaga/Arduino-IRremote) 80 | * mode of the Arduino IRremote library. Excised and updated to work with current IRremote 81 | * library. 82 | * 83 | * https://github.com/mpflaga/Arduino-IRremote/blob/master/IRremote.cpp 84 | * 85 | */ 86 | int32_t decodeMagiQuest(decode_results *results, magiquest *mdata) { 87 | magiquest data; 88 | data.llword = 0; 89 | 90 | int16_t offset = 1; 91 | uint16_t mark_; 92 | uint16_t space_; 93 | uint8_t multiple_; 94 | 95 | if (irparams.rawlen < 2 * MAGIQUEST_BITS) { 96 | return ERR; 97 | } 98 | 99 | while (offset + 1 < irparams.rawlen) { 100 | mark_ = results->rawbuf[offset]; 101 | space_ = results->rawbuf[offset+1]; 102 | multiple_ = space_ / mark_; 103 | // it is either 25% + 75% or 50% + 50% 104 | 105 | if (MATCH_MARK(space_ + mark_, MAGIQUEST_PERIOD)) { 106 | if (multiple_ > 1) { 107 | data.llword <<= 1; 108 | } else { 109 | data.llword = (data.llword << 1) | 1; 110 | } 111 | } else { 112 | return ERR; 113 | } 114 | offset++; 115 | offset++; 116 | } 117 | // Success 118 | results->bits = (offset + 1) / 2; 119 | if (results->bits < 12) { 120 | results->bits = 0; 121 | return ERR; 122 | } 123 | //results->magiquestMagnitude = data.cmd.magnitude; 124 | results->value = data.cmd.wand_id; 125 | results->decode_type = MAGIQUEST; 126 | 127 | // fill in our magiquest struct 128 | mdata->cmd.magnitude = data.cmd.magnitude; 129 | mdata->cmd.wand_id = data.cmd.wand_id; 130 | return DECODED; 131 | } 132 | --------------------------------------------------------------------------------