Component: Wii Nunchuk (Movement Orientation): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	2.0
Category	Movement Orientation

Wii Nunchuk component

A component to interface the Wii Nunchuck which features a 3-axis 10-bit Accelerometer A 2-axis 8-bit joystick and two digital button inputs. Interfaced using a standard I2C bus at 100KHz. Nunchuk must be powered at 3V3 to avoid damage.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WiiNunchuck.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_WiiNunchuck.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Initialise

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 1 for success and 0 for fail.
- BYTE	Return

ReadAccelerometer

	ReadAccelerometer
Reads a single Accelerometer axis
- BYTE	Axis
0=X, 1=Y, 2=Z
- INT	Return

ReadJoystick

	ReadJoystick
Reads a single joystick axis
- BYTE	Axis
0=X, 1=Y
- INT	Return

ReadSwitch

	ReadSwitch
Reads one of the nunchuck switches
- BYTE	Switch
0=Z, 1=C
- BOOL	Return

Sample

	Sample
Reads from the nunchuck and updates the local variables.
- VOID	Return

SimReset1G

	SimReset1G
Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.
- VOID	Return

Property reference

	Properties
	Bit Depth
The number of binary bits used to store the sensor's X,Y,Z readings.
	Encryption
Decides if encryption should be active or disabled
	Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Simulation
	Simulate Comms
Yes: Accelerometer data will come from the simulation component sliders. No: Accelerometer data will come from the CAL component - I2C or SPI - API etc

@@ Line 91: / Line 91: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Sets up up the communication bus and initialises the accelerometer module.  Returns 1 for success and 0 for fail.&nbsp;
@@ Line 105: / Line 105: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAccelerometer'''
+| width="90%" class="mtx-class-macrohead" | '''ReadAccelerometer'''
 |-
 | colspan="2" | Reads a single Accelerometer axis&nbsp;
@@ Line 124: / Line 124: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadJoystick'''
+| width="90%" class="mtx-class-macrohead" | '''ReadJoystick'''
 |-
 | colspan="2" | Reads a single joystick axis&nbsp;
@@ Line 143: / Line 143: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadSwitch'''
+| width="90%" class="mtx-class-macrohead" | '''ReadSwitch'''
 |-
 | colspan="2" | Reads one of the nunchuck switches&nbsp;
@@ Line 162: / Line 162: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Sample'''
+| width="90%" class="mtx-class-macrohead" | '''Sample'''
 |-
 | colspan="2" | Reads from the nunchuck and updates the local variables. &nbsp;
@@ Line 176: / Line 176: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SimReset1G'''
+| width="90%" class="mtx-class-macrohead" | '''SimReset1G'''
 |-
 | colspan="2" | Resets the simulation to 0.0 on X and Y and 1.0 on Z as if the accelerometer was sitting completely horizontal.&nbsp;
@@ Line 191: / Line 191: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 204: / Line 204: @@
 | colspan="2" | Decides if encryption should be active or disabled&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 238: / Line 238: @@
 | colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  a 10ms delay between an I2C stop event and the next I2C start event.  Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  I2C communications. &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)