Timagotchi Docs

sudo raspi-config

git clone https://github.com/broseph9972/Timagotchi && cd Timagotchi/Code

chmod +x install.sh start.sh
    ./install.sh

python3 Timagotchi/Code/configure_schedule.py

sudo raspi-config

sudo apt-get update
    sudo apt-get install python3-pip python3-pil python3-numpy
    pip3 install -r requirements.txt

sudo usermod -aG gpio [Your username]

python3 configure_schedule.py

{
    "base_url": "https://yourschool.instructure.com",
    "api_token": "your_canvas_api_token_here"
    }

PiOS 32bit Trixie

1. Download and open Pi Imager.
2. Select device as "Pi Zero" (not Pi Zero 2), then choose PiOS 32bit Trixie.
3. Enable SSH, set WiFi, and set a hostname, username, and password you will remember. Most likely, you won't need them after installation.
4. Flash the card, insert it into the Pi, and power on. then wait around 5 minutes.
5. Open Terminal and run ssh [Your username]@[Your hostname].local. Recommended is Timagotchi.local.

I recommend Termius, but anything else is fine.

Automated Installation

sudo raspi-config

Navigate to: Interfacing Options -> SPI -> Yes, then reboot. This is for the screen to work.

git clone https://github.com/broseph9972/Timagotchi && cd Timagotchi/Code

chmod +x install.sh start.sh
    ./install.sh

Reboot with sudo reboot

To customize your schedule run

python3 Timagotchi/Code/configure_schedule.py

If install.sh and start.sh wont run, try dos2unix install.sh start.sh this happens when i sftp it over. If using git ignore this

Important: Reboot after install.

Manual Installation

1. Enable SPI Interface

sudo raspi-config

Navigate to: Interfacing Options -> SPI -> Yes, then reboot. This is for the screen to work.

2. Install Dependencies

sudo apt-get update
    sudo apt-get install python3-pip python3-pil python3-numpy
    pip3 install -r requirements.txt

3. Do gpio stuff

sudo usermod -aG gpio [Your username]

4. Configure Your Schedule & Canvas (Optional)

Run the interactive configuration script:

python3 configure_schedule.py

For Canvas integration, you'll be prompted during install.sh or you can manually create Code/canvas_config.json:

{
    "base_url": "https://yourschool.instructure.com",
    "api_token": "your_canvas_api_token_here"
    }

How to create the Canvas API token:

1. Log into Canvas in a browser.
2. Open Account then Settings.
3. Scroll to Approved Integrations and click New Access Token.
4. Name it "Timagotchi" and set an expiration if you want.
5. Click Generate Token and copy the token right away.

Paste the token into api_token and set base_url to your Canvas domain.

PiOS 32bit Trixie

1. Install Pi Imager using the commands below.
2. Debian based:

sudo apt-get update
    sudo apt-get install rpi-imager

3. Arch:

sudo pacman -S rpi-imager

4. Red Hat or Fedora:

sudo dnf install rpi-imager

5. Select device as "Pi Zero" (not Pi Zero 2), then choose PiOS 32bit Trixie.
6. Enable SSH, set WiFi, and set a hostname, username, and password you will remember. Most likely, you won't need them after installation.
7. Flash the card, insert it into the Pi, and power on. then wait around 5 minutes.
8. Open your terminal and run ssh [Your username]@[Your hostname].local. Recommended is Timagotchi.local.

I recommend Termiusfor easy sshing, but anything else is fine.

Automated Installation

sudo raspi-config

Navigate to: Interfacing Options -> SPI -> Yes, then reboot. This is for the screen to work.

git clone https://github.com/broseph9972/Timagotchi && cd Timagotchi/Code

chmod +x install.sh start.sh
    ./install.sh

Reboot with sudo reboot

To customize your schedule run

python3 Timagotchi/Code/configure_schedule.py

If install.sh and start.sh wont run, try dos2unix install.sh start.sh this happens when i sftp it over. If using git ignore this

Important: Reboot after install.

Manual Installation

1. Enable SPI Interface

sudo raspi-config

Navigate to: Interfacing Options -> SPI -> Yes, then reboot. This is for the screen to work.

2. Install Dependencies

Debian based:

sudo apt-get update
    sudo apt-get install python3-pip python3-pil python3-numpy
    pip3 install -r requirements.txt

Arch:

sudo pacman -S python-pip python-pillow python-numpy
    pip install -r requirements.txt

Red Hat or Fedora:

sudo dnf install python3-pip python3-pillow python3-numpy
    pip3 install -r requirements.txt

3. Do gpio stuff

sudo usermod -aG gpio [Your username]

4. Configure Your Schedule & Canvas (Optional)

Run the interactive configuration script:

python3 configure_schedule.py

For Canvas integration, you'll be prompted during install.sh or you can manually create Code/canvas_config.json:

{
    "base_url": "https://yourschool.instructure.com",
    "api_token": "your_canvas_api_token_here"
    }

How to create the Canvas API token:

1. Log into Canvas in a browser.
2. Open Account then Settings.
3. Scroll to Approved Integrations and click New Access Token.
4. Name it "Timagotchi" and set an expiration if you want.
5. Click Generate Token and copy the token right away.

Paste the token into api_token and set base_url to your Canvas domain.