# TeensyEyes

**Repository Path**: joy_ai/TeensyEyes

## Basic Information

- **Project Name**: TeensyEyes
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-05
- **Last Updated**: 2026-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TeensyEyes

### Introduction

This project is my take on "[Uncanny Eyes](https://github.com/adafruit/Uncanny_Eyes)", adapted for [Teensy 4.x](https://www.pjrc.com/store/teensy40.html)
microcontrollers. It renders animated eyes on round GC9A01 LCD screens. See the video below for an example of the eyes in action.

This is all still very much a work in progress. The aim is to turn this into a library that is fully configurable and
easily integrated with your own Teensy projects.

This codebase is based on code and ideas from the following projects:
  - https://github.com/adafruit/Uncanny_Eyes
  - https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/main/M4_Eyes
  - https://github.com/mjs513/GC9A01A_t3n

### Building and Running

This project is developed with PlatformIO and (optionally) CLion.

Running the "PlatformIO Upload | eyes" target from CLion, or alternatively running
```platformio run --target upload -e eyes```
will compile the firmware and upload it to your Teensy 4.x.

### What does it Look Like?
Here's a video of the eyes in action:
<br/>

[![Teensy Eyes](http://img.youtube.com/vi/Ke1SJ8-6zJw/0.jpg)](https://www.youtube.com/watch?v=Ke1SJ8-6zJw "Teensy Eyes")

### 3D Printed Enclosure for the GC9A01 Screens

I've made some cases for the GC9A01 screens that you can print. More details and the links to the models are available [here](https://forum.pjrc.com/index.php?threads/uncanny-eyes-is-getting-expensive.71068/page-5#post-333711).

### Creating Your Own Animated Eyes
Each type of eye is defined with a config.eye JSON file specifying various parameters of the eye, pupil, iris and
sclera, plus (optional) bitmaps that define the extents of the upper and lower eyelids, along with any textures for the
iris and sclera.

Detailed documentation for config.eye is coming, but in the meantime, if you want to try creating your own eyes
then copying and editing existing eyes in the `resources/eyes/240x240` directory is a good
starting point. Note that colors are currently only able to be specified as 5:6:5 RGB decimal
or hex values. Try [this](http://greekgeeks.net/#maker-tools_convertColor) for help in creating
your own 5:6:5 color codes.

Once you have an eye definition that you want to try, you need to generate code from it for
use in your firmware. For this you will need a recent version of [Python](https://www.python.org/) installed, as well as [numpy](https://numpy.org/)
and the imaging library [Pillow](https://python-pillow.org/). You can install these two libraries with:
```shell
pip install numpy
pip install Pillow
```

To generate the data files for a single eye, run the following from the `resources/eyes/240x240` directory:
```shell
python tablegen.py ../../../src/eyes/graphics/240x240 path/to/your/config.eye
```
To generate _all_ eyes, run the `genall.py` command shown below. Note that you may want to make sure the output directory is empty first, so you don't end
up with redundant data files in there if your eye's configurations have changed.
```shell
python genall.py ../../../src/eyes/graphics/240x240
```

To use your newly created eye, include it with `#include "path/to/eyename.h"` and access it in your
code using `eyename::eye`, or with `eyename::left` and `eyename::right` if your eye has different parameters
for the left and right eyes.