BrowseBoardRepo

pico-pet

Public

@bytomancer

Download board files

Files for version 1. Pick what you came for.

KiCad projectAll 23 files, ready to open in KiCad914 KB
For fabricationGerbers, drill, pick-and-place and BOMGerbers and drill zip102 KBGerbers and drill zip: rtc+nvm30 KBGerbers and drill zip: usb49 KBPick and place (CSV)4.1 KBPick and place (CSV): rtc+nvm728 BPick and place (CSV): usb1.5 KBBOM CSV11 KB
Schematic PDFEvery sheet, to read or print207 KB
3D modelThe board with its parts, for an enclosure (GLB)3D model (GLB)2.6 MB3D model (GLB): rtc+nvm380 KB3D model (GLB): usb1020 KB
Browse all files

Share pico-pet

Check access before sharing the link.

Who can open this board

Anyone can open this board. No sign-in is required.

https://boardrepo.com/bytomancer/pico-pet

This link opens the latest version. Copying it does not grant additional access.

Loading 3D model… large boards can take a moment.

README

Pico Pet

A virtual pet that requires the user to complete pomodoros for the health of their pet.

Hardware

NVM Utilization

The NVM (Non-Volatile Memory) module included with the DS3231 provides 4KiB arranged in 512 pages of 8 bytes each.

Permanent storage must be serializable to a specified number of pages, and write to an assigned page address.

Pages are addressed from hexidecimal 0x000 to 0x1ff.

Page StartPage EndModule
000000Header
001002Settings
003003Inventory
004005Pet

note: If the NVM becomes corrupted, try changing the const NVM_SENTINEL to force a header guard check failure. This will factory reset the device, and all data will be lost.

Header
0if set to the NVM_SENTINEL value, then the EEPROM is assumed to contain a valid savefile
1
2
3
4
5
6
7
Settings Page 1minmax
0User brightness015
1User volume04
2nyi Vibration enabled01
3nyi 12hr clock enabled01
4nyi minutes before device sleeps190
5
6
7
Settings Page 2minmax
0Pomodoro length in minutes190
1Short break length in minutes190
2Long break length in minutes190
3Cycles, aka number of pomodoros before a long rest19
4Pet feeding deadline hr023
5Pet feeding deadline min059
6
7
Inventoryminmax
0Tomatoes099
1Raspberries09
2Lower byte of juice value
3Higher byte of juice value
4
5
6
7

Max juice is 9999ml as a u16

Pet Page 1
0Birth Day
1Birth Month
2Birth Year
3
4
5
6
7
Pet Page 2
0Current HP
1Sickness
2Daily Hunger
3Last Fed Day
4Last Fed Month
5Last Fed Year
6
7

Max HP = Daily Hunger + 4

Last Fed Year is probably excessive, but it'd be a weird bug if someone started the pet up after exactly 1 year, and their pet showed no signs of missed days of hunger...

Pin Out For Raspberry Pico

graph LR
    subgraph RP2040
        Pin1
        Pin2
        %%Pin3[GND]
        Pin4
        Pin5
        Pin6
        Pin7
        %%Pin8[GND]
        Pin9
        %%Pin10
        Pin11
        Pin12
        %%Pin13[GND]
        Pin14
        Pin15
        Pin16
        Pin17
        %%Pin18[GND]
        %%Pin19
        Pin20
        %%Pin21
        Pin22
        %%Pin23[GND]
        %%Pin24
        %%Pin25
        %%Pin26
        %%Pin27
        %%Pin28[GND]
        %%Pin29
        %%Pin30
        %%Pin31
        %%Pin32
        %%Pin33[GND]
        %%Pin34
        %%Pin35
        %%Pin36[3V3_OUT]
        %%Pin37[3V3_EN]
        %%Pin38[GND]
        %%Pin39[VSYS]
        %%Pin40[VBUS]
    end



    subgraph RTC_NVM
        RTC_SDA
        RTC_SCL
        RTC_SQW
    end
    Pin1[Pin1 I2C0_SDA] --> RTC_SDA
    Pin2[Pin2 I2C0_SCL] --> RTC_SCL
    Pin7[Pin7 GP5] --> RTC_SQW



    subgraph BUZZER
        SPEAKER
    end
    Pin6[Pin6 PWM_A2] --> SPEAKER



    subgraph VIBRATION
        MOTOR
    end
    Pin9[Pin9 GP6] --> MOTOR



    subgraph LCD
        LCD_KEY2
        LCD_KEY3
        LCD_DC
        LCD_CS
        LCD_CLK
        LCD_DIN
        LCD_RST
        LCD_BL
        LCD_KEY0
        LCD_KEY1
    end
    Pin4[Pin4 GP2] --> LCD_KEY2
    Pin5[Pin5 GP3] --> LCD_KEY3
    Pin11[Pin11 GP8] --> LCD_DC
    Pin12[Pin12 SPI1_CSn] --> LCD_CS
    Pin14[Pin14 SPI1_SCK] --> LCD_CLK
    Pin15[Pin15 SPI1_TX] --> LCD_DIN
    Pin16[Pin16 SPI1_RX] --> LCD_RST
    Pin17[Pin17 PWM_B6] --> LCD_BL
    Pin20[Pin20 GP15] --> LCD_KEY0
    Pin22[Pin22 GP17] --> LCD_KEY1

Pinout for Waveshare RP2040-Tiny

graph LR
    subgraph RP2040-Tiny
        TinyPin0
        TinyPin1
        TinyPin2
        TinyPin3
        TinyPin4
        TinyPin5
        TinyPin6
        %%TinyPin7
        TinyPin8
        TinyPin9
        TinyPin10
        TinyPin11
        TinyPin12
        TinyPin13
        %%TinyPin14
        TinyPin15
        %%TinyPin16
        %%TinyPin17
        %%TinyPin18
        TinyPin19
        %%TinyPin20
        %%TinyPin21[3V3]
        %%TinyPin22[GND]
        %%TinyPin23[5V]
    end



    subgraph RTC_NVM
        RTC_SDA
        RTC_SCL
        RTC_SQW
    end
    TinyPin0[TinyPin0 I2C0_SDA] --> RTC_SDA
    TinyPin1[TinyPin1 I2C0_SCL] --> RTC_SCL
    TinyPin5[TinyPin5 GP5] --> RTC_SQW



    subgraph BUZZER
        SPEAKER
    end
    TinyPin4[TinyPin4 PWM_A2] --> SPEAKER



    subgraph VIBRATION
        MOTOR
    end
    TinyPin6[TinyPin6 GP6] --> MOTOR



    subgraph LCD
        LCD_KEY2
        LCD_KEY3
        LCD_DC
        LCD_CS
        LCD_CLK
        LCD_DIN
        LCD_RST
        LCD_BL
        LCD_KEY0
        LCD_KEY1
    end
    TinyPin2[TinyPin2 GP2] --> LCD_KEY2
    TinyPin3[TinyPin3 GP3] --> LCD_KEY3
    TinyPin8[TinyPin8 GP8] --> LCD_DC
    TinyPin9[TinyPin9 SPI1_CSn] --> LCD_CS
    TinyPin10[TinyPin10 SPI1_SCK] --> LCD_CLK
    TinyPin11[TinyPin11 SPI1_TX] --> LCD_DIN
    TinyPin12[TinyPin12 SPI1_RX] --> LCD_RST
    TinyPin13[TinyPin13 PWM_B6] --> LCD_BL
    TinyPin15[TinyPin15 GP15] --> LCD_KEY0
    TinyPin19[TinyPin19 GP29] --> LCD_KEY1

Development Breakboard Build

Below are my recommendations for how to build the development board.

Shopping List

All amazon links are tracking free and affiliate free; feel free to source these where you wish, but compatability is not guaranteed for other similar products. The current iteration of the software is absolutely tied to the LCD module below, as well as the combination DS3231 & AT24C32 board. Theoretically any RTC and NVM module could replace the aformentioned, but the I2C addresses have been set to match the product below. Additionally, any ST7735S driven 128x128 display could be adapted. All four buttons provided on the waveshare LCD hat are used as well.

Assembly

  1. Socket the Raspberry Pico into center of the Expansion Board.
  2. Socket the LCD Module into the left slot of the Expansion Board.
  3. Using a command strip, attach the breadboard to the flat side of the breakout board.
    • The 1A point of the breadboard should be in the top left, near where the word VBUS is printed on the back of the breakout board.
    • While many breadboards do come with stickers, there is often no solid insulating layer for the conductive rails, and the breakout board has sharp solder points that can stab through this thin soft layer. Whatever you do, I recommend insulating these two boards or you will risk a short...
  4. Connect the breakout terminal VSYS and tie point 1A on the breadboard, preferably using a red wire.
    • I recommend running this wire over the top of the board rather than the side as it would be natural to do, because there will be essentially no space between the Raspberry Pico and this specific Breakout Board when they are eventually mated.
  5. Connect the breakout terminal GND (the one adjacent to VSYS) and tie point 2A on the breadboard, preferably using a black wire.
    • Again, I recommend running this wire over the top of the board.
  6. Connect the data lines to the breadboard, this time allowing the wires to wrap around the side of the board (recommended colors in parenthesis):
    • GP0 to J1 (green)
    • GP1 to J2 (white)
    • GP4 to J5 (yellow)
    • GP5 to J6 (blue)
    • GP6 to J7 (green)
  7. Connect new lines on the breadboard for the RTC module:
    • C2 to C3 (black)
    • D1 to D4 (red)
    • H1 to B5 (green)
    • H2 to B6 (white)
    • H6 to B7 (blue) (I recommend routing this cable up then following the other 2 data lines)
  8. Connect new lines on the breadboard for the piezo buzzer:
    • G5 to F17 (orange)
    • E2 to G13 (black) (I recommend routing this along the top side, then down the gap I left in the I column)
  9. Connect new lines on the breadboard for the vibration motor:
    • G7 to K16 (green)
    • F13 to F15 (black)
  10. Stick the vibration motor onto the bottom of the breadboard.
  11. Attach the vibration motor wires (letting the wires lay to the right):
    • red wire to G16
    • blue wire to G15
  12. Place the piezo buzzer onto pins J17 and J13 (placement will secure the vibration motor wires)
  13. Insert a CR2032 battery into the RTC module.
  14. Place the RTC module onto pins A3, A4, A5, A6, A7, and A8.
  15. Finally, socket the breakout board onto the right slot of the Expansion Board.

Development Environment Setup

NixOS

I recommend running the following to open the VSCodium development environment:

nix develop --command codium .

You can of course just use whatever text editor you like, and simply enter the flake in a terminal with:

nix develop

Other Linux Distros

You'll need Rust installed and set to nightly-2023-11-16. Other versions may not be supported. You will likely also need udev to detect the raspberry pico. To use the makefile, you'll also want gnu make. You can review the flake.nix and attempt to reproduce it in your own OS.

First Time Setup

Your first time opening this repo, you'll need to setup the dependencies and enable the thumbv6m-none-eabi target. This has been automated for you:

make init

Running The Code

The build process performs a number of actions. The sprites will be converted from PNG files to raw binary files containing RGB332 data. Fonts will be converted from PNG files to binary files containg black&white data. The custom PEAT audio files will be converted from plaintext files to the binary custom BEAT format. With all assets converted, the project will finally build and attempt to upload.

All of this is as simple as invoking:

make run

Attributions

Placeholder artwork (lofi.png) copyright belongs to Juan Pablo Machado.

Comments

No comments yet. Be the first to ask about this board.

Ask about this board

Sign in to BoardRepo

New here? Signing in creates your account; there is no separate sign-up.