Lisp for microcontrollers
Lisp for Arduino, Adafruit M0/M4, Micro:bit, ESP8266/32, RISC-V, and Teensy 4.x boards.
uLisp Release 4.4
Release 4.4 has been restructured to make it easier to extend uLisp with your own functions. You can now include extra user functions in a separate file; the advantage of this is that you can extend uLisp without needing to edit the original uLisp source file, and you can update uLisp to a new release while keeping your same extensions file unaltered. For details see Adding your own functions.
In addition, Release 4.4 has the following new features:
- The equal function compares strings and lists, in addition to the objects handled by eq.
- The subseq function can now be used to create subsequences of lists as well as strings.
- The search function lets you search for a pattern in string or list.
- The apropos function lets you search for built-in and user-defined functions and symbols matching a specified substring.
- The unwind-protect, ignore-errors, and error functions provide advanced error handling.
- Improved support for several platforms.
uLisp® is a version of the Lisp programming language specifically designed to run on microcontrollers with a limited amount of RAM, from the Arduino Uno based on the ATmega328 up to the Teensy 4.0/4.1. You can use exactly the same uLisp program, irrespective of the platform. For the performance of each platform see Performance.
Because uLisp is an interpreter you can type commands in, and see the effect immediately, without having to compile and upload your program. This makes it an ideal environment for learning to program, or for setting up simple electronic devices.
Lisp is also an ideal language for learning about fundamental programming concepts. It incorporates string handling, list processing, and garbage collection, and so is also an excellent language for expressing complex ideas, such as teaching a robot to solve mazes or finding the shortest route on a map. As well as supporting a core set of Lisp functions uLisp includes Arduino extensions, making it ideal as a control language for the Arduino.
You can download the current version of uLisp free from the Download uLisp page.
There are five versions of uLisp to cater for different platforms. The following table describes the capabilities of each version:
The AVR-Nano version of uLisp supports boards with as little as 2 Kbytes of RAM and 32 Kbytes of program memory. All the Simple examples will run on these platforms:
Arduino Uno and Nano or other ATmega328-based cards. These will give you enough memory for a simple uLisp application.
ATmega4809 boards. The Arduino Nano Every and Microchip Curiosity Nano evaluation board are low-cost platforms based on the ATmega4809.
The AVR version of uLisp supports the following boards:
Arduino Mega 2560 or other ATmega2560-based boards. These will give you enough memory for a fairly complex application; for examples see Animals, Tweetmaze, Route finder, and Infinite precision arithmetic.
ATmega1284. Although there isn't an official Arduino board based on it, the ATmega1284 is easy to wire up on a prototyping board, and provides a generous 16 Kbytes RAM.
The ARM version of uLisp supports the following boards:
Arduino M0 boards. The Arduino Zero and Arduino MKRZero are based on the SAMD21 ARM Cortex-M0+ core and provide 256 Kbytes of flash and 32 Kbytes of RAM. They save images to the program flash. The Arduino MKRZero incorporates an SD-card socket which allows you to use an SD card for saving and loading uLisp images and files.
Adafruit M0 boards. The Adafruit Feather M0 Express, Adafruit Feather M0, Adafruit ItsyBitsy M0, Adafruit Gemma M0, and Adafruit QT-Py SAMD21 are each based on the ATSAMD21 48 MHz ARM Cortex M0+ microcontroller. They have similar features and performance. The Adafruit Feather M0 Express uses the on-board DataFlash to save Lisp images; the other boards save images to the program flash.
QT Py SAMD21 and XIAO SAMD21. The Adafruit QT-Py SAMD21 and Seeduino XIAO SAMD21 are each based on the ATSAMD21 48 MHz ARM Cortex M0+ microcontroller, with 256 Kbytes of flash and 32 Kbytes of RAM. They save images to the program flash.
Adafruit Neo Trinkey. This is a USB-key sized board containing an ATSAMD21 ARM M0+ chip running at 48MHz, with 256KB Flash and 32 KB RAM, and four NeoPixel WS2812 serial addressable RGB displays.
Adafruit M4 boards. The Adafruit Metro M4 Grand Central, Adafruit Metro M4, Adafruit Feather M4, and Adafruit ItsyBitsy M4 are each based on the ATSAMD51 120 MHz ARM Cortex M4 microcontroller. They all include on-board DataFlash which is used to save Lisp images.
Adafruit PyGamer and PyBadge. The Adafruit PyGamer and Adafruit PyBadge are handheld game platforms based on the ATSAMD51 120 MHz ARM Cortex M4 microcontroller and incorporating a 160x128 colour TFT display. They include on-board DataFlash which is used to save Lisp images.
Adafruit nRF52840 boards. The Adafruit CLUE and Adafruit ItsyBitsy nRF52840 are each based on the Nordic Semiconductor nRF52840 64 MHz ARM Cortex-M4 microcontroller, with 1 Mbyte of flash program memory and 256 Kbytes of RAM. They include on-board DataFlash which is used to save Lisp images.
BBC Micro:bit and Calliope Mini. The BBC Micro:bit is based on a Nordic Semiconductor nRF51822 ARM Cortex-M0 microcontroller. It runs at 16 MHz and provides 256 Kbytes of flash program memory and 16 Kbytes of RAM. The BBC Micro:bit V2 is based on a Nordic Semiconductor nRF52833 ARM Cortex-M4 microcontroller, running at 64 MHz, and provides 512 Kbytes of flash program memory, and 128 Kbytes of RAM. They don't support save-image.
Maxim MAX32620FTHR. This is based on a Maxim MAX32620 ARM Cortex-M4F microcontroller running at 96 MHz, with 2048 Kbytes of flash memory and 256 Kbytes of RAM. It doesn't support save-image.
Teensy 4.0 and 4.1. These are based on the NXP iMXRT1062 ARM M7 processor running at 600 MHz, and with 1 Mbytes of RAM.
RP2040 boards. These are based on the Raspberry Pi RP2040 microcontroller, which is a dual-core ARM Cortex M0+ running at 125 MHz which provides up to 16 MB of off-chip flash and 246 KB on-chip RAM.
The ESP version of uLisp supports the following ESP8266 and ESP32 boards:
ESP8266 boards. These boards are based on the 32-bit Tensilica Xtensa L106 microprocessor running at 80 MHz, with 4 Mbytes of flash and 80 Kbytes of RAM. They include integrated Wi-Fi.
ESP32 boards. These boards are based on the 32-bit Tensilica Xtensa LX6 microprocessor running at 160 or 240 MHz, with 4 Mbytes of flash and 520 Kbytes of RAM. They include integrated Wi-Fi and dual-mode Bluetooth.
ESP32-S2, ESP-S3, and ESP-C3 boards. These boards are based on Tensilica LX7 and RISC-V microprocessors running at 240 MHz or 160 MHz respectively. They include integrated Wi-Fi and native USB, and some include Bluetooth.
ESP32 boards with a TFT display. These ESP32 and ESP32-S2 boards include an integrated colour TFT display that can take advantage of uLisp's Graphics extensions.
The RISC-V version of uLisp supports the following boards:
Sipeed MAiX RISC-V boards. These boards are based on the Kendryte K210 RISC-V Dual Core 64 bit 400 MHz processor and provide 8 Mbytes RAM and 16 Mbytes flash. They are similar in performance.
For additional platforms supported by earlier versions of uLisp see: Older versions.
The language is generally a subset of Common Lisp, and uLisp programs should also run under Common Lisp. But note that there is one namespace for functions and variables; in other words, you cannot use the same name for a function and a variable.
All platforms provide lists, symbols, integers, characters, strings, streams, and arrays, including bit-arrays (not available in the AVR-Nano version). In addition the 32-bit platforms provide floating-point numbers.
All platforms provide Arduino extensions for accessing ports, running timers, and serial I/O.
Some platforms provide additional Wi-Fi extensions, graphics extensions, and an assembler.
An integer is a sequence of digits, optionally prefixed with "+" or "-".
- On the 8/16-bit platforms integers can be between -32768 and 32767.
- On the 32-bit platforms integers can be between 2147483647 and -2147483648.
You can enter integers in hexadecimal, octal, or binary with the notations #x2A, #o52, or #b101010, all of which represent 42.
The 32-bit platforms (ARM, ESP, and RISC-V) also support floating-point numbers with full 32-bit precision.
All platforms support long user-defined symbol names. Almost any sequence of characters that doesn't represent a number can be used as a symbol; so, for example, 12a and *2 are valid symbols.
Symbols consisting of up to three of the characters 0-9, a-z, -, *, and $ are represented more efficiently, and occupy less workspace.
Strings can consist of an arbitrary sequence of ASCII characters. Strings can be unlimited length, and are automatically garbage-collected.
uLisp includes a mark and sweep garbage collector. Garbage collection takes under 1 msec on an Arduino Uno or under 3 msec on an Arduino Mega 2560 (see Performance).
uLisp provides tail-call optimization, so applications written using recursive functions can be as efficient as using iteration.
uLisp includes a simple program editor (see Using the program editor), a trace facility, a pretty printer (see Debugging in uLisp), and built-in documentation (not available in the AVR-Nano version) (see Integral documentation).
Saving the workspace
On most platforms you can save the workspace, containing the functions and variables you have defined, using the save-image function, and then reload it with load-image. These functions take advantage of whatever non-volatile storage is available on each platform:
- On platforms with a DataFlash chip, such as Adafruit's ATSAMD21, ATSAMD51, and nRF52840 Express boards, you can save the entire workspace to DataFlash.
- On the ATmega1284P, AVR128DA48, AVR128DB48, the Raspberry Pi Pico, the ESP8266 and ESP32, and platforms based on the ATSAMD21 such as the Arduino Zero and Seeeduino XIAO, you can save the workspace to the flash program memory.
- On older AVR-based platforms, such as the Arduino Uno and Arduino Mega 2560, you can save the workspace to EEPROM.
- On any platform you can add an SD-card interface, and then save the workspace to an SD card.
Loading Lisp functions
On any platform you can also extend uLisp with your own library of function or variable definitions written in Lisp. They are stored as text in flash memory along with the uLisp code, and get loaded when you run uLisp. For more information see Lisp Library.
The following example illustrates how you might use uLisp.
After uploading uLisp to your microcontroller board you can communicate it via by typing or pasting commands into the Serial Monitor, or using a serial terminal. For more information see Using uLisp.
Suppose you have a red LED connected to the analogue output pin 9 on an Arduino Uno. Then you can type in the Lisp command:
(analogwrite 9 128)
to set the LED to 128, which corresponds to half brightness.
To save having to write this command every time you want to set the red LED you can define a function called red:
(defun red (x) (analogwrite 9 x))
Now you can achieve the same effect simply by writing:
In each case the LED changes immediately, as soon as you type in the command.
Suppose you've got a potentiometer connected to vary the voltage on the analogue input A0. You could define a function dim to make the potentiometer adjust the brightness of the LED with:
(defun dim () (loop (red (/ (analogread 0) 4)))
and run it by typing:
Finally, you could save the uLisp image to EEPROM, and specify that dim should be run on load, by entering:
When you reset the Arduino dim will now load and run automatically.
This is a simple example showing how uLisp allows you to build up complex programs from simpler components, testing each of the components as you go along.