CLUATRON

repository for the CLUATRON - Made by JALECKO project registred on github since 17/3/24

The CLUATRON is a RP2040 based general purpose micro computer inspired by the maximite line of micro computers and the PICO-8 fantasy console. The goal with this project is to have a functional microcomputer that has an operating system with a terminal and a text editor. Programs for the CLUATRON will be written in a modified version of LUA 5.4.6 with a couple of additional commands that allow for easier program development.

Code build instructions

This will create the desired excecutable, this instalation does require the use of CMake and the PI PICO SDK with a compiled pico-extras library.

cd CLUATRON/Core
mkdir build
cd build
cmake ..
make

Hardware (currently)

• MCU: RP2040

  • 264 kb SRAM
  • 250 MHz (overclocked)
  • Dual core ARM M0+
  • USB host/device capabilities
  • Programmable I/O capabilities

• Storage: QSPI Flash memory

  • 2 MB of storage

• Resistor array

  • Digital analog converter voor VGA output
  • 15 bit signaal

Schematic

This is the schematic used for connecting the pi pico the VGA screen.

Here is an example of a development board for the Cluatron.

Usage

Programs and commands are written in LUA 5.4.6. Programs can be edited in the Cluatron Editing tool which is accesed with F2. Commands can be written and executed in the Cluashell which is accesed with F1.

F1 Using the CluaShell

The Cluashell is a shell like most shells but also contains a couple shortcuts for optimal usage.

Key combination	Function
Esc	Stops program loop.
Enter	Executes a Cluashell command.
Ctrl-L	Clears the Cluashell.
Ctrl-E	Executes a program from the Cluatron editing tool.

The Cluashell also has a command history wich can be navigated with the up and down arrows. Cluashell commands have a limit of 77 characters each.

F2 Using the Cluatron editing tool

The Cluatron editing tool as of now is quite a limited text editor. The character limit is 32768 characters. Navigation through a script is done using the left and right arrow keys.

In order to run a program press F1 and then Ctrl-E.

Programming

As mentioned before programs and commands are written in LUA 5.4.6. The Cluatron also provides extra functions baked into the system for more functionality, these functions can be sorted into different groups.

System control functions

Function Name	Return type	Description
reset()	void	Resets the Cluatron.
bootsel()	void	Puts the Cluatron in bootsel mode.
millis()	int	Returns the amount of milliseconds the Cluatron has been active.

Terminal control functions

Function Name	Return type	Description
pcol( c)	void	Sets the text color of the terminal, "c" is the color index within a range of 0 - 15.
bcol( c)	void	Sets the background color of the terminal, "c" is the color index within a range of 0 - 15.

Graphics functions

Function Name	Return type	Description
rgb( r, g, b)	int	Returns a 15 bit color value, "r" "g" "b" are within range of 0 - 255.
pal( c, setcol)	void	Sets color value for index "c" to "setcol", "c" is within range of 0 - 15 and "setcol" is within range of 0 - 32767. Use the rgb() function to accurately determine the "setcol".
dot( x, y, c)	void	Puts a pixel on the screen at position "x" , "y", "c" is the color index within a range of 0 - 15.
cls( c)	void	Fills the screen with color "c", "c" is the color index within a range of 0 - 15.
line( x1, y1, x2, y2, c)	void	Draws a line from position "x1" , "y1" to position "x2" , "y2" in color "c", "c" is the color index within a range of 0 - 15.
rect( x, y, w, h, c)	void	Draws a rectangle with upper left position "x" , "y" with a width of "w" and a height of "h" in color "c", "c" is the color index within a range of 0 - 15.
rectfill( x, y, w, h, c)	void	Draws a filled rectangle with upper left position "x" , "y" with a width of "w" and a height of "h" in color "c", "c" is the color index within a range of 0 - 15.
tri( x1, y1, x2, y2, x3, y3, c)	void	Draws a triangle on position "x1" , "y1" to position "x2" , "y2" to position "x3" , "y3" in color "c", "c" is the color index within a range of 0 - 15.
circ( x, y, r, c)	void	Draws a circle with center position "x" , "y" with a radius of "r" in color "c", "c" is the color index within a range of 0 - 15.
circfill( x, y, r, c)	void	Draws a filled circle with center position "x" , "y" with a radius of "r" in color "c", "c" is the color index within a range of 0 - 15.
oval( x, y, w, h, c)	void	Draws a oval with upper left position "x" , "y" with a width of "w" and a height of "h" in color "c", "c" is the color index within a range of 0 - 15.
ovalfill( x, y, w, h, c)	void	Draws a filled oval with upper left position "x" , "y" with a width of "w" and a height of "h" in color "c", "c" is the color index within a range of 0 - 15.
text( str, x, y, c)	void	Draws a string of text "str" with upper left position "x" , "y" in color "c", "c" is the color index within a range of 0 - 15.
textfill( str, x, y, c0, c1)	void	Draws a string of text "str" with upper left position "x" , "y" in color "c" with a background color "c1", "c0" and "c1" are color indexes within a range of 0 - 15.

*As of now all parameters must be entered as integers so to draw a rectangle to a variable position on the screen one must enter:

rect(math.floor(x), math.floor(y), 16, 32, 8)

USB input functions

Function Name	Return type	Description
init_input()	int	Initialises usb input. (done automatically)
read_input()	int	Updates all input buffers. (done automatically)
keyp( keycode)	int	Returns the rising edge value for if "keycode" has been pressed on the keboard. Returns 1 if true and 0 if false.
keyh( keycode)	int	Returns the value for if "keycode" has been pressed on the keyboard. Returns 1 if true and 0 if false.
keyr( keycode)	int	Returns the falling edge value for if "keycode" has been released on the keyboard. Returns 1 if true and 0 if false.
mdx()	int	Returns the horizontal mouse speed. The speed value is clamped between -128 and 127.
mdy()	int	Returns the vertical mouse speed. The speed value is clamped between -128 and 127.
mscr()	int	Returns the scrolling speed on the mouse. The speed value is clamped between -1 and 1.
mbp( mbuttoncode)	int	Returns the rising edge value for if "mbuttoncode" has been pressed on the mouse. Returns 1 if true and 0 if false.
mbh( mbuttoncode)	int	Returns the value for if "mbuttoncode" has been pressed on the mouse. Returns 1 if true and 0 if false.
mbr( mbuttoncode)	int	Returns the falling edge value for if "mbuttoncode" has been released on the mouse. Returns 1 if true and 0 if false.

For the "keycode" on the keyboard refer to the USB keyboard input constants. For the "mbuttoncode" on the mouse refer to the USB mouse input constants.

*As of now all of these functions return integers and reading them out must be treated so. This is how one must read out the value of a keyboard button pressed.

if (keyp(80) == 1) then
	moveleft()
end

USB keyboard input constants

USB mouse input constants

0. Left button
1. Middle button
2. Right button

For extra programming references look into the /Programs/-folder.

Roadmap

Planned Hardware features.

• DVI video output.
• I2S audio with headphone jack.
• SD card support.
• 4 USB device support.

Planned software features

• Improved graphics LUA API.
• Improved USB input LUA API.
• Game controller input LUA API.
• Audio output LUA API.
• SD card file navigation.
• SD card fileIO.
• Integrated Sprite editor.
• sprite support in LUA API.
• Integrated Color palette editor.
• Sound editor.
• Music tracker software.
• IO signal LUA API.
• UART communication LUA API.
• I2C communication LUA API.
• SPI communication LUA API.
• WAV audio output.
• BMP image drawing.