Component: GameCode (Misc Circuit): Difference between revisions

Revision as of 14:23, 13 July 2026

Author	Jef De Bruyne
Version	1.0
Category	Misc Circuit

GameCode component

A small handheld device designed for creating embedded games. Complete with a 8 x 16 LED display, 4-Way DPAD with 4 additional push switches Buzzer, Vibration, MP3 Player, Potentiometer and Lithium battery management. Programmed via USB.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

BatteryRead

	BatteryRead
Read and return the voltage level of the battery in millivolt.
- UINT	Return

DisplayBrightness

	DisplayBrightness
Control the brightness of the display.
- BYTE	Value
Enter value from 0 to 15
- VOID	Return

DisplayClear

	DisplayClear
Clear the display.
- VOID	Return

DisplayWrite

	DisplayWrite
Write an array containing 16 bytes to the display to illuminate the corresponding dots. The index represents the line (Y-axis), starting from 0 for the uppermost line. The value of the byte represents the column (X-axis), with MSB the leftmost dot.
- BYTE	Array
Index = line, Content (byte) = column
- VOID	Return

DisplayWriteNumber

	DisplayWriteNumber
Show a number ranging from 000 to 999 on the display. Number is printed vertically.
- UINT	Value
Enter a number from 0 to 999.
- VOID	Return

EEReadValue

	EEReadValue
Retreives a value from none volitile memory
- BYTE	Address
Address to write to, Range: 0-255
- BYTE	Return

EEStoreValue

	EEStoreValue
Saves a value to none volitile memory
- BYTE	Address
Address to write to, Range: 0-255
- BYTE	Value
Value to store, Range: 0-255
- VOID	Return

Initialise

	Initialise
Initializes all present hardware and communication. Place this at the very start of your code.
- VOID	Return

LedsWrite

	LedsWrite
Set the button-leds. MSB = leftmost led LSB = rightmost led
- BYTE	Value
MSB = leftmost dot, LSB = rightmost dot
- VOID	Return

MP3GetStatus

	MP3GetStatus
Returns the status of the MP3 module. 0 = module in sleep 1 = track is playing 2 = track is pauzed 3 = track is stopped
- BYTE	Return

MP3PausePlayResetStop

	MP3PausePlayResetStop
Allows the current playing track to be paused, restarted or stopped.
- BYTE	Mode
0=Pause, 1=Play, 2=Reset, 3=Stop
- VOID	Return

MP3PlayTrack

	MP3PlayTrack
Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. "0001-anyname.mp3". Other folder track numbers should be 3 characters long e.g. "001-anyname.mp3".
- BYTE	Directory
0=Root, 01=Folder "01" - 99=Folder "99", 100=Folder "MP3", 101=Advert
- UINT	Track
Track number 1 = "001.mp3" / "0001.mp3"
- VOID	Return

MP3SendCommand

	MP3SendCommand
Send commands to MP3 module. Check datasheet for info.
- BYTE	Command

- BYTE	Para1

- BYTE	Para2

- VOID	Return

MP3SetVolume

	MP3SetVolume
Sets the volume level for the MP3 module
- BYTE	Volume
Range: 0 (min) - 30 (max)
- VOID	Return

PlayNote

	PlayNote
Output a single note on the buzzer. Specify the desired frequency (Hz) and duration (ms).
- UINT	Frequency
Sets the pitch for the note in Hz. Range 1-20000 Hz
- ULONG	Duration
Time period to play the note for in milliseconds. Range 0-65535 ms
- VOID	Return

PotRead

	PotRead
Read and return the value of the potentiometer. If desired, give the upper limit to scale the output value. Enter "MaxValue = 0" to skip scaling and get the byte value (0-255)
- UINT	MaxValue
Scale the return value. Enter 0 to skip.
- UINT	Return

PwrLedSet

	PwrLedSet
Control the PWR LED. 0 = red + green 1 = red 2 = green
- BYTE	Value
0 = red + green, 1 = red, 2 = green
- VOID	Return

Property reference

	Properties
	LED Colours
	LED On

	LED Off

	Display Colours
	On Colour

	Off Colour

	Background Colour

@@ Line 69: / Line 69: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BatteryRead'''
+| width="90%" class="mtx-class-macrohead" | '''BatteryRead'''
 |-
 | colspan="2" | Read and return the voltage level of the battery in millivolt. &nbsp;
@@ Line 83: / Line 83: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayBrightness'''
+| width="90%" class="mtx-class-macrohead" | '''DisplayBrightness'''
 |-
 | colspan="2" | Control the brightness of the display. &nbsp;
@@ Line 102: / Line 102: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayClear'''
+| width="90%" class="mtx-class-macrohead" | '''DisplayClear'''
 |-
 | colspan="2" | Clear the display.&nbsp;
@@ Line 116: / Line 116: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayWrite'''
+| width="90%" class="mtx-class-macrohead" | '''DisplayWrite'''
 |-
 | colspan="2" | Write an array containing 16 bytes to the display to illuminate the corresponding dots.  The index represents the line (Y-axis), starting from 0 for the uppermost line. The value of the byte represents the column (X-axis), with MSB the leftmost dot.&nbsp;
@@ Line 135: / Line 135: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayWriteNumber'''
+| width="90%" class="mtx-class-macrohead" | '''DisplayWriteNumber'''
 |-
 | colspan="2" | Show a number ranging from 000 to 999 on the display. Number is printed vertically. &nbsp;
@@ Line 154: / Line 154: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EEReadValue'''
+| width="90%" class="mtx-class-macrohead" | '''EEReadValue'''
 |-
 | colspan="2" | Retreives a value from none volitile memory&nbsp;
@@ Line 173: / Line 173: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EEStoreValue'''
+| width="90%" class="mtx-class-macrohead" | '''EEStoreValue'''
 |-
 | colspan="2" | Saves a value to none volitile memory&nbsp;
@@ Line 197: / Line 197: @@
 |-
 | 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" | Initializes all present hardware and communication. Place this at the very start of your code.&nbsp;
@@ Line 211: / Line 211: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LedsWrite'''
+| width="90%" class="mtx-class-macrohead" | '''LedsWrite'''
 |-
 | colspan="2" | Set the button-leds. MSB = leftmost led LSB = rightmost led&nbsp;
@@ Line 230: / Line 230: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MP3GetStatus'''
+| width="90%" class="mtx-class-macrohead" | '''MP3GetStatus'''
 |-
 | colspan="2" | Returns the status of the MP3 module. 0 = module in sleep 1 = track is playing 2 = track is pauzed 3 = track is stopped&nbsp;
@@ Line 244: / Line 244: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MP3PausePlayResetStop'''
+| width="90%" class="mtx-class-macrohead" | '''MP3PausePlayResetStop'''
 |-
 | colspan="2" | Allows the current playing track to be paused, restarted or stopped.&nbsp;
@@ Line 263: / Line 263: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MP3PlayTrack'''
+| width="90%" class="mtx-class-macrohead" | '''MP3PlayTrack'''
 |-
 | colspan="2" | Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. "0001-anyname.mp3". Other folder track numbers should be 3 characters long e.g. "001-anyname.mp3".&nbsp;
@@ Line 287: / Line 287: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MP3SendCommand'''
+| width="90%" class="mtx-class-macrohead" | '''MP3SendCommand'''
 |-
 | colspan="2" | Send commands to MP3 module. Check datasheet for info.&nbsp;
@@ Line 316: / Line 316: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MP3SetVolume'''
+| width="90%" class="mtx-class-macrohead" | '''MP3SetVolume'''
 |-
 | colspan="2" | Sets the volume level for the MP3 module&nbsp;
@@ Line 335: / Line 335: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PlayNote'''
+| width="90%" class="mtx-class-macrohead" | '''PlayNote'''
 |-
 | colspan="2" | Output a single note on the buzzer. Specify the desired frequency (Hz) and duration (ms).&nbsp;
@@ Line 359: / Line 359: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PotRead'''
+| width="90%" class="mtx-class-macrohead" | '''PotRead'''
 |-
 | colspan="2" | Read and return the value of the potentiometer. If desired, give the upper limit to scale the output value. Enter "MaxValue = 0" to skip scaling and get the byte value (0-255)&nbsp;
@@ Line 378: / Line 378: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PwrLedSet'''
+| width="90%" class="mtx-class-macrohead" | '''PwrLedSet'''
 |-
 | colspan="2" | Control the PWR LED. 0 = red + green 1 = red 2 = green&nbsp;
@@ Line 398: / Line 398: @@
 |-
 | 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'''
 |-
 |-

SteveT (talk | contribs)