PageRenderTime 34ms CodeModel.GetById 20ms RepoModel.GetById 1ms app.codeStats 0ms

/Help/GiiMote Help/GiiMote.htm

https://code.google.com/p/giimote/
HTML | 380 lines | 370 code | 9 blank | 1 comment | 0 complexity | cf6e02e2d1453d75d83725ff7c646e3b MD5 | raw file
Possible License(s): AGPL-3.0, CC-BY-SA-3.0, GPL-3.0, LGPL-3.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

    2. 

  2. 

    3. 

  3. <html>

    4. 

  4. <head>

    5. 

  5. <title>GiiMote Help</title>

    6. 

  6. <link href="style.css" rel="stylesheet" type="text/css">

    7. 

  7. </head>

    8. 

  8. <body background="back.gif">

    9. 

  9. <!--START-->

    10. 

  10. 

    11. 

  11. <h1><a name="GiiMote">GiiMote</a></h1>

    12. 

  12. 

    13. 

  13. <p>

    14. 

  14. This package allows Game Maker to read and write state information to and from a Nintendo Wii Remote (unofficially, &quot;Wiimote&quot;) connected wirelessly via a Bluetooth connection. For this extension to work you will need the latest version of the Microsoft .NET Framework installed on your computer.

    15. 

  15. 

    16. 

  16. <p>To use this package in a game, select the item <b>Select Extension Packages</b> in the

    17. 

  17. <b>Resources</b> menu. In the form that appears 

    18. 

  18. click on the <b>GiiMote</b> item in the right list and press the button to 

    19. 

  19. move it to the left list.</p>

    20. 

  20. <h2><a name="Connecting">Connecting the Wii Remote</a></h2>

    21. 

  21. <p>Before the Wii Remote can be used in your game it must be connected to the computer wirelessly via Bluetooth. This is much easier said than done. The Wii Remote will not pair successfully with every Bluetooth device or stack so make sure your device and stack are compatible.<br>

    22. 

  22. To pair your Wii Remote with your computer follow these steps:</p>

    23. 

  23. <ol>

    24. 

  24.     <li>Start your Bluetooth software and search for devices.</li>

    25. 

  25.     <li>Hold down the 1 and 2 buttons on the bottom of the Wii Remote (Or press the Sync button under the battery case if you don't mind losing the pairing with your Wii). The blue LED's should start to flash. Hold these buttons until the process is complete.</li>

    26. 

  26.     <li>If all is well the Wii Remote should show up in the device list as <b>Nintendo RVL-CNT-01</b>. If not, start the process over.</li>

    27. 

  27.     <li>Follow the directions given by your Bluetooth software.</li>

    28. 

  28.     <li>If you are asked to supply a password or PIN number press skip or leave this value blank.</li>

    29. 

  29.     <li>If you are asked which service to use for the Wii Remote select the keyboard/mouse/HID service.</li>

    30. 

  30. </ol>

    31. 

  31. <p>

    32. 

  32. <h2><a name="setup">Setting Up and Tearing Down GiiMote</a></h2>

    33. 

  33. <p>Once we have our Wii Remote(s) paired successfully with our computer, we can use them in our game. To check if any Wii Remotes are paired correctly you may call the function <b><a name="wm_find_all">wm_find_all()</a></b>. 

    34. 

  34.     After you have found all of the paired Wii Remotes you may use the function <b><a name="wm_found">wm_found()</a></b> to 

    35. 

  35.     see how many Wii Remotes are currently recognized by the system. Just because a Wii Remote is found does not mean it is currently available for connecting, to see if the current Wii Remote is 

    36. 

  36.     available you may call <b><a name="wm_exists">wm_exists()</a></b>. To check the current number of 

    37. 

  37.     available Wii Remotes you can use <b><a name="wm_num_exists">wm_num_exists()</a></b>.

    38. 

  38.     To change the active Wii 

    39. 

  39.     Remote you may call the function <b><a name="wm_set_using">wm_set_using(wm)</a></b> where wm is the index, id, or guid of the Wii Remote to use for future function calls. 

    40. 

  40.     Each Wii Remote attatched to the system has two unique values which may be used 

    41. 

  41.     to identify it, the index, which may change as other Wii Remotes are 

    42. 

  42.     disconnected, and the guid which can be expressed either as a string, or, 

    43. 

  43.     numerically. The index is an integer between 0 and the number of connected Wii 

    44. 

  44.     Remotes - 1, so the first Wii Remote always has an index of 0. To get the index or guid of a Wii Remote, the following functions may 

    45. 

  45.     be used:</p>

    46. 

  46. <blockquote>

    47. 

  47. 	<tt><b><a name="wm_get_index">wm_get_index()</a></b></tt>

    48. 

  48. 		Gets the index of the active Wii Remote.<br>

    49. 

  49. 	<tt><b><a name="wm_get_index">wm_get_index(guid)</a></b></tt>

    50. 

  50. 		Gets the index of the Wii Remote with the given guid.<br>

    51. 

  51. 	<tt><b><a name="wm_get_index">wm_get_index(id)</a></b></tt>

    52. 

  52. 		Gets the index of the Wii Remote with the given ID.<br>

    53. 

  53. 	<tt><b><a name="wm_get_index">wm_get_guid()</a></b></tt>

    54. 

  54. 	

    55. 

  55. 		Gets the unique guid of the active Wii Remote as a string.<br>

    56. 

  56. 	<tt><b><a name="wm_get_index">wm_get_guid(id)></b></tt>

    57. 

  57. 		Gets the unique guid of the Wii Remote with the given id as a string.<br>

    58. 

  58. 	<tt><b><a name="wm_get_id">wm_get_id()</a></b></tt>

    59. 

  59. 	

    60. 

  60. 		Gets the unique ID of the active Wii Remote as a real value.<br>

    61. 

  61. 	<tt><b><a name="wm_get_id">wm_get_id(guid)></b></tt>

    62. 

  62. 		Gets the unique ID of the Wii Remote with the given guid as a real value.<br>

    63. 

  63. </blockquote>

    64. 

  64. <p>It is also possible to retreive the HID device path using the function <b><a name="wm_get_hid_device_path">wm_get_hid_device_path()</a></b></p>

    65. 

  65. <p>To connect to a single Wii Remote you can call <b><a name="wm_connect">wm_connect()</a></b> which will return either 1 if successful, 0 if the connection failed, or -1 if a Wii Remote is already connected. To connect all discovered Wii Remotes at once you may use <b><a name="wm_connect_all">wm_connect_all()</a></b>. When you are done using the Wii Remote

    66. 

  66. you can call <b><a name="wm_disconnect">wm_disconnect()</a></b>

    67. 

  67. to release the Wii Remote or <b><a name="wm_disconnect">wm_disconnect_all()</a></b> to release all connected Wii Remotes. Please note that these functions do not stop the Wii Remote(s) from being paired with your computer! You must disconnect the Wii Remote manually to stop it from using its battery power (Press the power button on the Wii Remote or disconnect via your bluetooth stack). We can also check to see if the active Wii Remote is currently connected to our application by using <b><a name="wm_connected">wm_connected()</a></b>. After the Wii Remote is connected,

    68. 

  68. we can find out information about the currently plugged in extension (if any) by

    69. 

  69. calling <b><a name="wm_check_extension">wm_check_extension()</a></b>. This will return one of the following constants:</p>

    70. 

  70. <blockquote>

    71. 

  71. 	<tt><b><a name="ext_classic">ext_classic</a></b></tt><br>

    72. 

  72. 	<tt><b><a name="ext_nunchuck">ext_nunchuck</a></b></tt><br>

    73. 

  73. 	<tt><b><a name="ext_guitar">ext_guitar</a></b></tt><br>

    74. 

  74. 	<tt><b><a name="ext_drums">ext_drums</a></b></tt><br>

    75. 

  75. 	<tt><b><a name="ext_balanceboard">ext_balanceboard</a></b></tt><br>

    76. 

  76. 	<tt><b><a name="ext_none">ext_none</a></b></tt><br>

    77. 

  77. 	<tt><b><a name="ext_unknown">ext_unknown</a></b></tt><br>

    78. 

  78. </blockquote>

    79. 

  79. <p>There are two types of Guitar extension for the Wii Remote. You can check which is plugged in by calling the function <b><a name="wm_guitar_get_type">wm_guitar_get_type()</a></b> which returns either 1 (Guitar Hero World Tour) or 0 (Guitar Hero 3).</p>

    80. 

  80. <p>GiiMote stores data about the Wii Remote inside the extension. Anytime you set 

    81. 

  81.     the rumble, check the battery life, or change the status of the Wii Remote in any way (by 

    82. 

  82.     turning off an LED for instance) this data is updated and when you call a function which returns some data (wm_get_rumble for instance) it checks this data, not the Wii Remote directly. Most of the time this information is up to date, but sometimes it is still useful to update the status of the Wii Remote manually.

    83. 

  83. This can be accomplished by calling <b><a name="wm_get_status">wm_get_status()</a></b>. This function sends a request to the Wii Remote which will then send back 

    84. 

  84.     its current status. The function returns weather or not the update was

    85. 

  85. a success.</p>

    86. 

  86. <h2><a name="buttons">Reading Buttons</a></h2>

    87. 

  87. <p>You can find the status of buttons on the Wii Remote and supported expansion controllers by calling the following functions:</p>

    88. 

  88. <blockquote>

    89. 

  89. 	<tt><b><a name="wm_check_button">wm_check_button(button)</a></b></tt>

    90. 

  90. 		Gets the status (boolean) of the given button on the Wii Remote.<br>

    91. 

  91. 	<tt><b><a name="wm_classic_check_button">wm_classic_check_button(button)</a></b></tt>

    92. 

  92. 		Gets the status of the given button on the Classic Controller (if inserted).<br>

    93. 

  93. 	<tt><b><a name="wm_nunchuck_check_button">wm_nunchuck_check_button(button)</a></b></tt>

    94. 

  94. 		Gets the status of the given button on the Nunchuck (if inserted).<br>

    95. 

  95. 	<tt><b><a name="wm_guitar_check_button">wm_guitar_check_button(button)</a></b></tt>

    96. 

  96. 		Gets the status of the given button on the guitar (if inserted).<br>

    97. 

  97.     <tt><b><a name="wm_drum_check_button">wm_drum_check_button(button)</a></b></tt>

    98. 

  98. 		Gets the status of the given button, head, or pedal on the drum set (if inserted).<br>

    99. 

  99. </blockquote>

    100. 

  100. <p>There is also an additional function for checking the pressure of L and R on the classic controller:</p>

    101. 

  101. <blockquote>

    102. 

  102. 		<p><tt><b><a name="wm_classic_trigger_pressure">wm_classic_trigger_pressure(trigger)</a></b></tt>

    103. 

  103. 		This function returns a value between 0.0 and 1.0 depending on the amount the trigger is being pushed in with 1 being all the way in and 0 being released. You may define a &quot;dead zone&quot; for the function by calling <a href="#wm_set_dead_zone">wm_set_dead_zone</a>.</p>

    104. 

  104. </blockquote>

    105. 

  105. <p>Another for checking the pressure on the Whammy bar on the Guitar:</p>

    106. 

  106. <blockquote>

    107. 

  107. 		<p><tt><b><a name="wm_guitar_whammybar_pos">wm_guitar_whammybar_pos()</a></b></tt> The position of the Guitar's whammy bar as a value between 0.0 and 1.0.</p>

    108. 

  108. </blockquote>

    109. 

  109. 

    110. 

  110. <p>And another for checking the velocity with which the drum heads and pedal on the drum set are hit:</p>

    111. 

  111. <blockquote>

    112. 

  112. 		<p><tt><b><a name="wm_drum_get_velocity">wm_drum_get_velocity(head)</a></b></tt> The velocity with which the drum head or pedal was hit from 0.0 (hard) to 6.0 (soft).</p>

    113. 

  113. </blockquote>

    114. 

  114. 

    115. 

  115. <p>

    116. 

  116. The following button key codes exist for use in any function that requires a button (not all buttons are available on all controllers):</p>

    117. 

  117. <blockquote>

    118. 

  118. 	<tt><b><a name="wm_a">wm_a</a></b></tt><br>

    119. 

  119. 	<tt><b><a name="wm_b">wm_b</a></b></tt><br>

    120. 

  120. 	<tt><b><a name="wm_up">wm_up</a></b></tt><br>

    121. 

  121. 	<tt><b><a name="wm_down">wm_down</a></b></tt><br>

    122. 

  122. 	<tt><b><a name="wm_left">wm_left</a></b></tt><br>

    123. 

  123. 	<tt><b><a name="wm_right">wm_right</a></b></tt><br>

    124. 

  124. 	<tt><b><a name="wm_one">wm_one</a></b></tt><br>

    125. 

  125. 	<tt><b><a name="wm_two">wm_two</a></b></tt><br>

    126. 

  126. 	<tt><b><a name="wm_plus">wm_plus</a></b></tt><br>

    127. 

  127. 	<tt><b><a name="wm_minus">wm_minus</a></b></tt><br>

    128. 

  128. 	<tt><b><a name="wm_home">wm_home</a></b></tt><br>

    129. 

  129. 	<tt><b><a name="wm_x">wm_x</a></b></tt><br>

    130. 

  130. 	<tt><b><a name="wm_y">wm_y</a></b></tt><br>

    131. 

  131. 	<tt><b><a name="wm_l">wm_l</a></b></tt><br>

    132. 

  132. 	<tt><b><a name="wm_r">wm_r</a></b></tt><br>

    133. 

  133. 	<tt><b><a name="wm_zl">wm_zl</a></b></tt><br>

    134. 

  134. 	<tt><b><a name="wm_c">wm_c</a></b></tt><br>

    135. 

  135. 	<tt><b><a name="wm_z">wm_z</a></b></tt><br>

    136. 

  136. 	<tt><b><a name="wm_blue">wm_blue</a></b></tt><br>

    137. 

  137. 	<tt><b><a name="wm_green">wm_green</a></b></tt><br>

    138. 

  138. 	<tt><b><a name="wm_orange">wm_orange</a></b></tt><br>

    139. 

  139. 	<tt><b><a name="wm_red">wm_red</a></b></tt><br>

    140. 

  140. 	<tt><b><a name="wm_yellow">wm_yellow</a></b></tt><br>

    141. 

  141. 	<tt><b><a name="wm_touch_blue">wm_touch_blue</a></b></tt><br>

    142. 

  142. 	<tt><b><a name="wm_touch_green">wm_touch_green</a></b></tt><br>

    143. 

  143. 	<tt><b><a name="wm_touch_orange">wm_touch_orange</a></b></tt><br>

    144. 

  144. 	<tt><b><a name="wm_touch_red">wm_touch_red</a></b></tt><br>

    145. 

  145. 	<tt><b><a name="wm_touch_yellow">wm_touch_yellow</a></b></tt><br>

    146. 

  146. 	<tt><b><a name="wm_strum_up">wm_strum_up</a></b></tt><br>

    147. 

  147. 	<tt><b><a name="wm_strum_down">wm_strum_down</a></b></tt><br>

    148. 

  148. 	<tt><b><a name="wm_pedal">wm_pedal</a></b></tt><br>

    149. 

  149. </blockquote>

    150. 

  150. <h2><a name="joystick">Joystick Positions</a></h2>

    151. 

  151. <p>The Nunchuck, Classic Controller, Guitar controller, and Drum set both contain one or more joysticks which can be utilized with the following functions:</p>

    152. 

  152. <blockquote>

    153. 

  153. 	<tt><b><a name="wm_nunchuck_xpos">wm_nunchuck_xpos()</a></b></tt> From -0.5 (left) to 0.5 (right).<br>

    154. 

  154. 	<tt><b><a name="wm_nunchuck_ypos">wm_nunchuck_ypos()</a></b></tt><br>

    155. 

  155. 	<tt><b><a name="wm_nunchuck_direction">wm_nunchuck_direction()</a></b></tt> Returns a value from 0 to ?180 degrees.<br>

    156. 

  156. 	<tt><b><a name="wm_nunchuck_pressure">wm_nunchuck_pressure()</a></b></tt> Returns the pressure on the joystick as a value between 0 and 1 disregarding direction.<br>

    157. 

  157. 	<tt><b><a name="wm_classic_xpos">wm_classic_xpos(joystick)</a></b></tt><br>

    158. 

  158. 	<tt><b><a name="wm_classic_ypos">wm_classic_ypos(joystick)</a></b></tt><br>

    159. 

  159. 	<tt><b><a name="wm_classic_direction">wm_classic_direction(joystick)</a></b></tt><br>

    160. 

  160. 	<tt><b><a name="wm_classic_pressure">wm_classic_pressure(joystick)</a></b></tt><br>

    161. 

  161. 	<tt><b><a name="wm_guitar_xpos">wm_guitar_xpos()</a></b></tt><br>

    162. 

  162. 	<tt><b><a name="wm_guitar_ypos">wm_guitar_ypos()</a></b></tt><br>

    163. 

  163. 	<tt><b><a name="wm_guitar_direction">wm_guitar_direction()</a></b></tt><br>

    164. 

  164. 	<tt><b><a name="wm_guitar_pressure">wm_guitar_pressure()</a></b></tt><br>

    165. 

  165. 	<tt><b><a name="wm_drum_xpos">wm_drum_xpos()</a></b></tt><br>

    166. 

  166. 	<tt><b><a name="wm_drum_ypos">wm_drum_ypos()</a></b></tt><br>

    167. 

  167. 	<tt><b><a name="wm_drum_direction">wm_drum_direction()</a></b></tt><br>

    168. 

  168. 	<tt><b><a name="wm_drum_pressure">wm_drum_pressure()</a></b></tt><br>

    169. 

  169. </blockquote>

    170. 

  170. <p>For the Classic Controller you must specify which joystick to check the values of, for this the following constants are defined:</p>

    171. 

  171. <blockquote>

    172. 

  172. 	<tt><b><a name="wm_joy_left">wm_joy_left</a></b></tt><br>

    173. 

  173. 	<tt><b><a name="wm_joy_right">wm_joy_right</a></b></tt><br>

    174. 

  174. </blockquote>

    175. 

  175. <h2><a name="accel">Accelerometer Data</a></h2>

    176. 

  176. <p>You can also get data from the Wii Remote and Nunchuck's accelerometers using the following functions:</p>

    177. 

  177. <blockquote>

    178. 

  178. 	<tt><b><a name="wm_get_accel_x">wm_get_accel_x()</a></b></tt><br>

    179. 

  179. 	<tt><b><a name="wm_get_accel_y">wm_get_accel_y()</a></b></tt><br>

    180. 

  180. 	<tt><b><a name="wm_get_accel_z">wm_get_accel_z()</a></b></tt><br>

    181. 

  181. 	<tt><b><a name="wm_nunchuck_get_accel_x">wm_nunchuck_get_accel_x()</a></b></tt><br>

    182. 

  182. 	<tt><b><a name="wm_nunchuck_get_accel_y">wm_nunchuck_get_accel_y()</a></b></tt><br>

    183. 

  183. 	<tt><b><a name="wm_nunchuck_get_accel_z">wm_nunchuck_get_accel_z()</a></b></tt><br>

    184. 

  184. </blockquote>

    185. 

  185. <p>Please note that when you set the remote on a flat surface a value of approximately 1 will be returned on the Z axis. This is because the table is exerting an upwards force on your Wii Remote equal to 1G against the force of gravity. When the remote is in free fall this value will fall to near zero.<br>GiiMote also provides limited higher level functionality which utilizes the accelerometers:</p>

    186. 

  186. <blockquote>

    187. 

  187. 	<tt><b><a name="wm_get_moving">wm_get_moving()</a></b> Checks to see if the Wii Remote is moving or not</tt><br>

    188. 

  188. </blockquote>

    189. 

  189. <h2><a name="dead_zone">Dead Zone's</a></h2>

    190. 

  190. <p>With any joystick, pressure sensitive trigger, or accelerometer differences in calibration can cause slight deviations from zero. For instance, a joystick centered at (0,0) may return (0.1,0) instead, or, an accelerometer sitting still may feel a slight tremor and read 0.01 when the user intended it to be 0. To address this issue one must define a &quot;dead zone,&quot; or, an amount of tolerance under which no change of value will occur. To set the tolerance level for all joysticks, triggers, and/or accelerometers the following functions may be called (default for all is no-tolerance):</p>

    191. 

  191. <blockquote>

    192. 

  192. 	<tt><b><a name="wm_set_accel_dead_zone_x">wm_set_accel_dead_zone_x(val)</a></b></tt> Domain from 0 to infinity.<br>

    193. 

  193. 	<tt><b><a name="wm_set_accel_dead_zone_y">wm_set_accel_dead_zone_y(val)</a></b></tt><br>

    194. 

  194. 	<tt><b><a name="wm_set_accel_dead_zone_x">wm_set_accel_dead_zone_z(val)</a></b></tt><br>

    195. 

  195. 	<tt><b><a name="wm_get_accel_dead_zone_x">wm_get_accel_dead_zone_x()</a></b></tt><br>

    196. 

  196. 	<tt><b><a name="wm_get_accel_dead_zone_y">wm_get_accel_dead_zone_y()</a></b></tt><br>

    197. 

  197. 	<tt><b><a name="wm_get_accel_dead_zone_z">wm_get_accel_dead_zone_z()</a></b></tt><br>

    198. 

  198. 	<tt><b><a name="wm_nunchuck_set_accel_dead_zone_x">wm_nunchuck_set_accel_dead_zone_x(val)</a></b></tt><br>

    199. 

  199. 	<tt><b><a name="wm_nunchuck_set_accel_dead_zone_y">wm_nunchuck_set_accel_dead_zone_y(val)</a></b></tt><br>

    200. 

  200. 	<tt><b><a name="wm_nunchuck_set_accel_dead_zone_z">wm_nunchuck_set_accel_dead_zone_z(val)</a></b></tt><br>

    201. 

  201. 	<tt><b><a name="wm_nunchuck_get_accel_dead_zone_x">wm_nunchuck_get_accel_dead_zone_x()</a></b></tt><br>

    202. 

  202. 	<tt><b><a name="wm_nunchuck_get_accel_dead_zone_y">wm_nunchuck_get_accel_dead_zone_z()</a></b></tt><br>

    203. 

  203. 	<tt><b><a name="wm_nunchuck_get_accel_dead_zone_y">wm_nunchuck_get_accel_dead_zone_z()</a></b></tt><br>

    204. 

  204. 	<tt><b><a name="wm_set_joystick_dead_zone">wm_set_joystick_dead_zone(val)</a></b></tt> Domain from 0 to 0.5.<br>

    205. 

  205. 	<tt><b><a name="wm_get_joystick_dead_zone">wm_get_joystick_dead_zone()</a></b></tt><br>

    206. 

  206. 	<tt><b><a name="wm_set_trigger_dead_zone">wm_set_trigger_dead_zone(val)</a></b></tt><br>

    207. 

  207. 	<tt><b><a name="wm_get_trigger_dead_zone">wm_get_trigger_dead_zone()</a></b></tt> Domain from 0 to 1.<br>

    208. 

  208. </blockquote>

    209. 

  209. <p>Values outside of the feasible domain will be corrected to the nearest number in the domain.</p>

    210. 

  210. <h2><a name="IR">Infrared Readout</a></h2>

    211. 

  211. <p>To utilize pointer functionality in your games you will need to use the Wii Remotes final input method, infrared. To use infrared you will need to place the Wii's sensor bar above or below your screen and supply it with a 12 volt power supply. The sensor bar does not do any &quot;sensing&quot; itself, rather, it outputs infrared light from two sets of five infrared LED's spaced 7.5 inches apart on the bar. This light is picked up by an infrared camera on top of the Wii Remote which can then triangulate

    212. 

  212. its orientation relative to the sensor bar. The following functions exist to use the Wii Remotes infrared capabilities, please note that values returned by these functions are relative to the Wii Remote, not to your screen.</p>

    213. 

  213. <blockquote>

    214. 

  214. 		<p><tt><b><a name="wm_ir_found_dot">wm_ir_found_dot(dot)</a></b></tt> Returns weather the Wii Remote can see the given dot (1, 2, 3, or 4) or not.<br>

    215. 

  215. 		<tt><b><a name="wm_ir_dot_size">wm_ir_dot_size(dot)</a></b></tt> Returns the size of dot 1, 2, 3, or 4 as a value between 0 and 15.<br>

    216. 

  216. 		<tt><b><a name="wm_ir_dot_get_x">wm_ir_dot_get_x(dot)</a></b></tt> Returns a normalized value between 0.0 and 1.0 for dot 1, 2, 3, or 4 along the x axis.<br>

    217. 

  217. 		<tt><b><a name="wm_ir_dot_get_y">wm_ir_dot_get_y(dot)</a></b></tt> Returns a normalized value between 0.0 and 1.0 for dot 1, 2, 3, or 4 along the y axis.<br>

    218. 

  218. 		<tt><b><a name="wm_ir_dot_get_midx">wm_ir_dot_get_midx()</a></b></tt> Returns the normalized x value of the midpoint between 0.0 and 1.0 for the first two IR points.<br>

    219. 

  219. 		<tt><b><a name="wm_ir_dot_get_midy">wm_ir_dot_get_midy()</a></b></tt> Returns the normalized y value of the midpoint between 0.0 and 1.0 for the first two IR points.<br>

    220. 

  220. 		<tt><b><a name="wm_ir_dot_get_delta_x">wm_ir_dot_get_delta_x(dot)</a></b></tt> Returns the change in the given dot's x value (&Delta;x) for the most recent update.<br>

    221. 

  221. 		<tt><b><a name="wm_ir_dot_get_delta_y">wm_ir_dot_get_delta_y(dot)</a></b></tt> Returns the change in the given dot's y value (&Delta;y) for the most recent update.<br>

    222. 

  222. 		<tt><b><a name="wm_ir_dot_get_delta_y">wm_ir_dot_get_delta_midx()</a></b></tt> Returns the change in the midpoint's x value for the most recent update.<br>

    223. 

  223. 		<tt><b><a name="wm_ir_dot_get_delta_y">wm_ir_dot_get_delta_midy()</a></b></tt> Returns the change in the midpoint's y value for the most recent update.<br>

    224. 

  224. </p>

    225. 

  225. </blockquote>

    226. 

  226. <p>The functions above get data directly from the Wii Remote and normalize it to fall in the specified domain. GiiMote provides several higher-level functions for getting points from the infrared data relative to the screen and window.</p>

    227. 

  227. <blockquote>

    228. 

  228. 		<p><tt><b><a name="wm_ir_display_get_x">wm_ir_display_get_x()</a></b></tt> Returns the x location on the display pointed at by the Wii Remote.<br>

    229. 

  229. 		<tt><b><a name="wm_ir_display_get_y">wm_ir_display_get_y()</a></b></tt> Returns the y location on the display pointed at by the Wii Remote.<br>

    230. 

  230. 		<tt><b><a name="wm_ir_window_get_x">wm_ir_window_get_x()</a></b></tt> Returns the x location in the window pointed at by the Wii Remote.<br>

    231. 

  231. 		<tt><b><a name="wm_ir_window_get_y">wm_ir_window_get_y()</a></b></tt> Returns the y location in the window pointed at by the Wii Remote.<br>

    232. 

  232. </p>

    233. 

  233. </blockquote>

    234. 

  234. <p>Finally, to change the sensitivity of the IR camera, the following functions may be called:</p>

    235. 

  235. <blockquote>

    236. 

  236. 		<p><tt><b><a name="wm_ir_set_sensitivity">wm_ir_set_sensitivity(sensitivity)</a></b></tt> Sets the sensitivity level of the IR camera (1-6, 3 is default)<br>

    237. 

  237. 		<tt><b><a name="wm_ir_get_sensitivity">wm_ir_get_sensitivity()</a></b></tt> Returns the current sensitivity level of the Wii Remote.<br>

    238. 

  238. </p>

    239. 

  239. </blockquote>

    240. 

  240. <h2><a name="MISC">Feedback</a></h2>

    241. 

  241. <p>The Wii Remote can provide direct feedback to its users in several ways including four LED's on the front of the controller as well as force feedback by means of a weighted motor or by playing sounds through the embedded speaker. It is also possible to have the Wii Remote report the remaining battery life. Out of these options currently only sound is not supported.</p>

    242. 

  242. <blockquote>

    243. 

  243. 	<tt><b><a name="wm_get_led">wm_get_led(LED)</a></b></tt> Gets the status of LED 1, 2, 3 or 4 as a boolean value.<br>

    244. 

  244. 	<tt><b><a name="wm_set_led">wm_set_led(LED,on)</a></b></tt> Sets the status of LED 1, 2, 3, or 4.<br>

    245. 

  245. 	<tt><b><a name="wm_set_leds">wm_set_leds(led1,led2,led3,led4)</a></b></tt> Sets the status of LED's 1 - 4.<br>

    246. 

  246. 	<tt><b><a name="wm_set_leds_int">wm_set_leds_int(leds)</a></b></tt> Sets the state of all LED's using an integer representation of the binary value which defines the LED's (1-15).<br>

    247. 

  247. 	<tt><b><a name="wm_clear_leds">wm_clear_leds()</a></b></tt> Turns all four LED's off. (Same as calling wm_set_leds(0,0,0,0))<br>

    248. 

  248. 	<tt><b><a name="wm_get_battery">wm_get_battery()</a></b></tt> Returns the remaining battery power of the Wii Remote as a byte between $00 (0) to roughly $C8 (200).<br>

    249. 

  249. 	<tt><b><a name="wm_set_rumble">wm_set_rumble(rumble)</a></b></tt> Turns the Wii Remote's motor on or off.<br>

    250. 

  250. 	<tt><b><a name="wm_get_rumble">wm_get_rumble()</a></b></tt> Checks to see if the Wii Remote's motor is currently active.<br>

    251. 

  251. </blockquote>

    252. 

  252. <p>The Wii Remote provides several different methods of feedback which can be utilized by the user. To save battery power, not all of these methods need to be turned on all the time. For instance, if we are not using the infrared capabilities of the Wii Remote it would save power to turn off the infrared camera. To do this we must change the report type of the Wii Remote. The following functions exist to deal with the various report types:</p>

    253. 

  253. <blockquote>

    254. 

  254. 	<tt><b><a name="wm_set_report_type">wm_set_report_type(report_type,continuous)</a></b></tt> Sets the report type of the Wii Remote. If continuous is false the Wii Remote only sends reports when it undergoes a status change.<br>

    255. 

  255. 	<tt><b><a name="wm_get_report_type">wm_get_report_type()</a></b></tt> Returns the report type of the Wii Remote.<br>

    256. 

  256. 	<tt><b><a name="wm_get_report_continuous">wm_get_report_continuous()</a></b></tt> Returns true if the Wii Remote is set to update continuously and false otherwise.<br>

    257. 

  257. </blockquote>

    258. 

  258. <p>The report type can be set using any of the following constants. Please note that the status of the Wii Remote's buttons is included in every report type and that only supported report types are listed here.</p>

    259. 

  259. <blockquote>

    260. 

  260. 	<tt><b><a name="rt_auto">rt_auto</a></b></tt> Automatically determine the report type. (Default)<br>

    261. 

  261. 	<tt><b><a name="rt_buttons">rt_buttons</a></b></tt> Reports the status of the buttons on the Wii Remote only.<br>

    262. 

  262. 	<tt><b><a name="rt_buttonsaccel">rt_buttonsaccel</a></b></tt> Reports the status of the buttons and accelerometers of the Wii Remote only.<br>

    263. 

  263. 	<tt><b><a name="rt_buttonsextension">rt_buttonsextension</a></b></tt> Returns the status of the Wii Remote's buttons and current extension only.<br>

    264. 

  264. 	<tt><b><a name="rt_extensionaccel">rt_extensionaccel</a></b></tt> Returns the status of the Wii Remote's buttons, current extension, and accelerometers.<br>

    265. 

  265. 	<tt><b><a name="rt_iraccel">rt_iraccel</a></b></tt> Returns the status of the Wii Remote's buttons, infrared camera, and accelerometers.<br>

    266. 

  266. 	<tt><b><a name="rt_irextensionaccel">rt_irextensionaccel</a></b></tt> Returns the status of the Wii Remote's buttons, infrared camera, current extension, and accelerometers.<br>

    267. 

  267. 	<tt><b><a name="rt_readdata">rt_readdata</a></b></tt> Read data from the Wii Remote's memory space/registers only.<br>

    268. 

  268. 	<tt><b><a name="rt_status">rt_status</a></b></tt> Returns the status of the Wii Remote only.<br>

    269. 

  269. </blockquote>

    270. 

  270. <h2><a name="orientation">Orientation</a></h2>

    271. 

  271. <p>Several routines are defined to get the orientation of the Wii Remote. For most, the accelerometer data is all you will need, but for a few IR must be used as well.</p>

    272. 

  272. <blockquote>

    273. 

  273. 	<tt><b><a name="wm_get_roll">wm_get_roll()</a></b></tt> Returns the roll of the Wii Remote.<br>

    274. 

  274. 	<tt><b><a name="wm_get_pitch">wm_get_pitch()</a></b></tt> Returns the pitch of the Wii Remote.<br>

    275. 

  275. 	<tt><b><a name="wm_get_yaw">wm_get_yaw()</a></b></tt> Attempts to estimate the Yaw of the Wii Remote. Requires IR.<br>

    276. 

  276. 	<tt><b><a name="wm_get_altitude">wm_get_altitude()</a></b></tt> Returns the distance from the sensor bar to the Wii Remote in meters. Requires IR.<br>

    277. 

  277. </blockquote>

    278. 

  278. <h2><a name="BB">Balance Board</a></h2>

    279. 

  279. <p>The Balance Board accessory for the Wii contains four sensors at each corner of the board which each measure weight. The following functions can be used to obtain data (in either pounds or kilograms) from one or more of these sensors:</p>

    280. 

  280. <blockquote>

    281. 

  281. 	<tt><b><a name="wm_bb_get_weight_kgs">wm_bb_get_weight_kgs()</a></b></tt> The total mass on the Balance Board in kilograms.<br>

    282. 

  282. 	<tt><b><a name="wm_bb_get_weight_lbs">wm_bb_get_weight_lbs()</a></b></tt> The total weight on the Balance Board in pounds.<br>

    283. 

  283. 	<tt><b><a name="wm_bb_get_sensor_kgs">wm_bb_get_sensor_kgs(sensor)</a></b></tt> The mass on a particular sensor in kilograms.<br>

    284. 

  284. 	<tt><b><a name="wm_bb_get_sensor_lbs">wm_bb_get_sensor_lbs(sensor)</a></b></tt> The mass on a particular sensor in pounds.<br>

    285. 

  285. </blockquote>

    286. 

  286. <p>To specify a sensor to read from one of the following constants may be used:</p>

    287. 

  287. <blockquote>

    288. 

  288. 	<tt><b><a name="bb_btmleft">bb_btmleft</a></b></tt><br>

    289. 

  289. 	<tt><b><a name="bb_btmright">bb_btmright</a></b></tt><br>

    290. 

  290. 	<tt><b><a name="bb_topleft">bb_topleft</a></b></tt><br>

    291. 

  291. 	<tt><b><a name="bb_topright">bb_topright</a></b></tt><br>

    292. 

  292. </blockquote>

    293. 

  293. <p>Besides weight one can also calculate the center of gravity of the person on the balance board. To this end, the following functions can be used:</p>

    294. 

  294. <blockquote>

    295. 

  295. 	<tt><b><a name="wm_bb_get_center_of_gravity_x">wm_bb_get_center_of_gravity_x()</a></b></tt><br>

    296. 

  296. 	<tt><b><a name="wm_bb_get_center_of_gravity_y">wm_bb_get_center_of_gravity_y()</a></b></tt><br>

    297. 

  297. </blockquote>

    298. 

  298. <h2><a name="MII">Mii Data</a></h2>

    299. 

  299. <p>Mii's are avatars that a user can design on the Wii and use as a character in supported channels and games. Mii's can be stored on the Wii Remote to take between consoles. Mii's found in Mii Parade are also stored on the Wii Remote and occupy any space not taken up by user saved Mii data. Mii data comes in two 750 byte blocks each followed by a two byte CRC hash. The Wii console reads the first block of Mii data and then checks the CRC checksum, if they match the block

    300. 

  300. is used, if not it goes onto the second block and if that does not check out no Mii's are displayed. The following functions allow you to dump and inject Mii data to and from the Wii Remote; if you wish to change the Mii's properties you will have to do so using Game Maker's built in file functions.</p>

    301. 

  301. <blockquote>

    302. 

  302. 	<tt><b><a name="wm_mii_data_dump">wm_mii_data_dump(path,block,mii)</a></b></tt> Dumps a single Mii from block 1 or 2 from the Wii Remote to the specified file. If no Mii is specified the entire block is dumped, if no block is specified both blocks are dumped.<br>

    303. 

  303. 	<tt><b><a name="wm_mii_data_inject">wm_mii_data_inject(path,block,mii)</a></b></tt> Injects a Mii to the Wii Remote from the specified file. The file may contain either one or two blocks of data. If no Mii is specified the entire block is injected, if no block is specified then both blocks are injected. The CRC checksum is automatically updated for Mii's injected into the Wii Remote when this function is called, but not in the original file.<br>

    304. 

  304. 	<tt><b><a name="wm_mii_update_crc">wm_mii_update_crc(path)</a></b></tt> Updates the CRC for a modified Mii data file dumped using wm_mii_data_dump. This does not update the CRC on the Wii Remote; to do this you must use wm_mii_data_inject!<br>

    305. 

  305. 	<tt><b><a name="wm_mii_get_address">wm_mii_get_address(mii, block)</a></b></tt> Returns the address of a specific Mii (1-10) in a specific block (1 or 2).<br>

    306. 

  306. </blockquote>

    307. 

  307. <p>Please note that dumping and injecting Mii's is an <i>extremely</i> slow process. Use sparingly.</p>

    308. 

  308. <h2><a name="fStream">Reading and Writing Data</a></h2>

    309. 

  309. <p>There are two functions to read and write raw data from and to the Wii Remote. These functions allow you to define your own routines for changing unsupported settings. Please be warned: you can easily destroy the data on your Wii Remote using these functions. Use at your own risk! With that said, the functions are:</p>

    310. 

  310. <blockquote>

    311. 

  311. 	<tt><b><a name="wm_bin_write_byte">wm_bin_write_byte(address, byte)</a></b></tt><br>

    312. 

  312. 	<tt><b><a name="wm_bin_write_byte">wm_bin_read_byte(address)</a></b></tt><br>

    313. 

  313. </blockquote>

    314. 

  314. <p>These functions require that you know something about how the Wii Remote stores data. More information can be found online.</p>

    315. 

  315. <h2><a name="hidden">Raw Data Functions</a></h2>

    316. 

  316. There are several functions to get raw, unprocessed data from the Wii Remote:

    317. 

  317. <blockquote>

    318. 

  318. 	<tt><b><a name="wm_get_accel_rawx">wm_get_accel_rawx()</a></b></tt><br>

    319. 

  319. 	<tt><b><a name="wm_get_accel_rawy">wm_get_accel_rawy()</a></b></tt><br>

    320. 

  320. 	<tt><b><a name="wm_get_accel_rawz">wm_get_accel_rawz()</a></b></tt><br>

    321. 

  321. 	<tt><b><a name="wm_get_battery_raw">wm_get_battery_raw()</a></b></tt><br>

    322. 

  322. 	<tt><b><a name="wm_nunchuck_get_accel_rawx">wm_nunchuck_get_accel_rawx()</a></b></tt><br>

    323. 

  323. 	<tt><b><a name="wm_nunchuck_get_accel_rawy">wm_nunchuck_get_accel_rawy()</a></b></tt><br>

    324. 

  324. 	<tt><b><a name="wm_nunchuck_get_accel_rawz">wm_nunchuck_get_accel_rawz()</a></b></tt><br>

    325. 

  325. 	<tt><b><a name="wm_ir_dot_get_rawx">wm_ir_dot_get_rawx(dot)</a></b></tt><br>

    326. 

  326. 	<tt><b><a name="wm_ir_dot_get_rawy">wm_ir_dot_get_rawy(dot)</a></b></tt><br>

    327. 

  327. 	<tt><b><a name="wm_ir_dot_get_rawmidx">wm_ir_dot_get_rawmidx()</a></b></tt><br>

    328. 

  328. 	<tt><b><a name="wm_ir_dot_get_rawmidy">wm_ir_dot_get_rawmidy()</a></b></tt><br>

    329. 

  329. 	<tt><b><a name="wm_ir_dot_get_delta_rawx">wm_ir_dot_get_delta_rawx(dot)</a></b></tt><br>

    330. 

  330. 	<tt><b><a name="wm_ir_dot_get_delta_rawy">wm_ir_dot_get_delta_rawy(dot)</a></b></tt><br>

    331. 

  331. 	<tt><b><a name="wm_ir_dot_get_delta_rawmidx">wm_ir_dot_get_delta_rawmidx()</a></b></tt><br>

    332. 

  332. 	<tt><b><a name="wm_ir_dot_get_delta_rawmidy">wm_ir_dot_get_delta_rawmidy()</a></b></tt><br>

    333. 

  333. 	<tt><b><a name="wm_classic_trigger_raw">wm_classic_trigger_raw(trigger)</a></b></tt><br>

    334. 

  334. 	<tt><b><a name="wm_nunchuck_rawx">wm_nunchuck_rawx()</a></b></tt><br>

    335. 

  335. 	<tt><b><a name="wm_nunchuck_rawy">wm_nunchuck_rawy()</a></b></tt><br>

    336. 

  336. 	<tt><b><a name="wm_classic_rawx">wm_classic_rawx(joystick)</a></b></tt><br>

    337. 

  337. 	<tt><b><a name="wm_classic_rawy">wm_classic_rawy(joystick)</a></b></tt><br>

    338. 

  338. 	<tt><b><a name="wm_guitar_rawx">wm_guitar_rawx()</a></b></tt><br>

    339. 

  339. 	<tt><b><a name="wm_guitar_rawy">wm_guitar_rawy()</a></b></tt><br>

    340. 

  340. 	<tt><b><a name="wm_guitar_whammybar_rawpos">wm_guitar_whammybar_rawpos()</a></b></tt><br>

    341. 

  341. 	<tt><b><a name="wm_bb_get_sensor_raw">wm_bb_get_sensor_raw(sensor)</a></b></tt><br>

    342. 

  342. 	<tt><b><a name="wm_drum_rawx">wm_drum_rawx()</a></b></tt><br>

    343. 

  343. 	<tt><b><a name="wm_drum_rawy">wm_drum_rawy()</a></b></tt><br>

    344. 

  344. </blockquote>

    345. 

  345. <p>These functions are for advanced use only and return data that has not been normalized.</p>

    346. 

  346. 

    347. 

  347. <h2><a name="calibration">Calibration</a></h2>

    348. 

  348. It is also possible to set the calibration data for the Wii Remote and extensions. The following functions exist to deal with calibration data:

    349. 

  349. <blockquote>

    350. 

  350. 		<p><tt><b><a name="wm_get_calibration_x0">wm_get_calibration_x0,y0, and z0()</a></b></tt> Returns the zero points for the x, y and z axes<br>

    351. 

  351. 	<tt><b><a name="wm_get_calibration_xg">wm_get_calibration_xg,yg, and zg()</a></b></tt> Returns the +1G points for the x, y and z axes<br>

    352. 

  352. 	<tt><b><a name="wm_set_calibration_x0">wm_set_calibration_x0,y0, and z0(val)</a></b></tt> Sets the zero points for the x, y and z axes<br>

    353. 

  353. 	<tt><b><a name="wm_set_calibration_xg">wm_set_calibration_xg,yg, and zg(val)</a></b></tt> Sets the +1G points for the x, y and z axes<br>

    354. 

  354. 	<tt><b><a name="wm_nunchuck_get_calibration_x0">wm_nunchuck_get_calibration_x0,y0, and z0()</a></b></tt> Returns the zero points for the x, y and z axes<br>

    355. 

  355. 	<tt><b><a name="wm_nunchuck_get_calibration_xg">wm_nunchuck_get_calibration_xg,yg, and zg()</a></b></tt> Returns the +1G points for the x, y and z axes<br>

    356. 

  356. 	<tt><b><a name="wm_nunchuck_get_calibration_maxx">wm_nunchuck_get_calibration_maxx and maxy()</a></b></tt> Returns the joystick X/Y-axis' maximum value<br>

    357. 

  357. 	<tt><b><a name="wm_nunchuck_get_calibration_midx">wm_nunchuck_get_calibration_midx and midy()</a></b></tt> Returns the joystick X/Y-axis' center value<br>

    358. 

  358. 	<tt><b><a name="wm_nunchuck_get_calibration_minx">wm_nunchuck_get_calibration_miny and miny()</a></b></tt> Returns the joystick X/Y-axis' minimum value<br>

    359. 

  359. 	<tt><b><a name="wm_nunchuck_set_calibration_xg">wm_nunchuck_set_calibration_xg,yg, and zg(val)</a></b></tt> Sets the +1G points for the x, y and z axes<br>

    360. 

  360. 	<tt><b><a name="wm_nunchuck_set_calibration_x0">wm_nunchuck_set_calibration_x0,y0, and z0(val)</a></b></tt> Sets the zero points for the x, y and z axes<br>

    361. 

  361. 	<tt><b><a name="wm_nunchuck_set_calibration_maxx">wm_nunchuck_set_calibration_maxx and maxy(val)</a></b></tt> Sets the joystick X/Y-axis' maximum value<br>

    362. 

  362. 	<tt><b><a name="wm_nunchuck_set_calibration_midx">wm_nunchuck_set_calibration_midx and midy(val)</a></b></tt> Sets the joystick X/Y-axis' center value<br>

    363. 

  363. 	<tt><b><a name="wm_nunchuck_set_calibration_minx">wm_nunchuck_set_calibration_minx and miny(val)</a></b></tt> Sets the joystick X/Y-axis' minimum value<br>

    364. 

  364. 	<tt><b><a name="wm_classic_get_calibration_trigger">wm_classic_get_calibration_maxtrigger and mintrigger(trigger)</a></b></tt> Returns the maximum and minimum trigger values<br>

    365. 

  365. 	<tt><b><a name="wm_classic_get_calibration_maxx">wm_classic_get_calibration_maxx and maxy(joystick)</a></b></tt> Returns maximum joystick values for the x or y axis<br>

    366. 

  366. 	<tt><b><a name="wm_classic_get_calibration_midx">wm_classic_get_calibration_midx and midy(joystick)</a></b></tt> Returns the centered joystick values for the x or y axis<br>

    367. 

  367. 	<tt><b><a name="wm_classic_get_calibration_minx">wm_classic_get_calibration_minx and miny(joystick)</a></b></tt> Returns the minimum joystick values for the x or y axis<br>

    368. 

  368. 	<tt><b><a name="wm_classic_set_calibration_trigger">wm_classic_set_calibration_maxtrigger and mintrigger(trigger, val)</a></b></tt> Sets the maximum and minimum trigger values<br>

    369. 

  369. 	<tt><b><a name="wm_classic_set_calibration_maxx">wm_classic_set_calibration_maxx and maxy(joystick, val)</a></b></tt> Sets the maximum joystick values for the x or y axis<br>

    370. 

  370. 	<tt><b><a name="wm_classic_set_calibration_midx">wm_classic_set_calibration_midx and midy(joystick, val)</a></b></tt> Sets the centered joystick values for the x or y axis<br>

    371. 

  371. 	<tt><b><a name="wm_classic_set_calibration_minx">wm_classic_set_calibration_minx and miny(joystick, val)</a></b></tt> Sets the minimum joystick values for the x or y axis<br>

    372. 

  372. 	<tt><b><a name="wm_bb_get_calibration_kg0">wm_bb_get_calibration_kg0, kg17, and kg34(sensor)</a></b></tt> Gets the calibration value for 0kg, 17kg, or 34kg for the given sensor<br>

    373. 

  373. 	<tt><b><a name="wm_bb_set_calibration_kg0">wm_bb_set_calibration_kg0, kg17, and kg34(sensor, val)</a></b></tt> Sets the calibration value for 0kg, 17kg, or 34kg for the given sensor<br>

    374. 

  374. </p>

    375. 

  375. </blockquote>

    376. 

  376. <p>NOTE: These functions are for advanced use only and can cause your Wii Remote to function poorly if used improperly.</p>

    377. 

  377. <p><!--END-->

    378. 

  378. </p>

    379. 

  379. </body>

    380. 

  380. </html>

    381. 

  381.