afcms/devpet

DevPet

Design

flowchart TD
    subgraph graphical_elements[Graphical Elements]
    Node2D -.-> Rect
    Node2D -.-> ProgressBar
    Node2D -.-> SpriteAnimated
    Node2D -.-> SpriteBar
    Node2D -.-> SpriteStatic
    Node2D -.-> TextScrolling
    Node2D -.-> Text
    end

    graphical_elements --> DisplaySystem
    graphical_elements --> DevPetGraphics

    subgraph manager_classes[Manager Classes]
    DevPet --> DevPetGraphics
    DevPetGraphics --> DisplaySystem
    end

    subgraph input[Input]
    Button
    CommSystem
    end

    subgraph body[Body]
    loop
    end

    loop --> DevPet
    Button --> loop
    CommSystem <--> loop

    subgraph hardware[Hardware]
    SSD1306
    serial_port[Serial Port]
    end

    serial_port <--> CommSystem
    DisplaySystem --> SSD1306

Loading

Run the project

Install PlatformIO

The project depends on the PlatformIO toolkit.

You can either install the VSCode extension or the CLI

Build

platformio run

Upload on the ESP32

Make sure the ESP32 is connected to the computer and the USB port is accessible.

platformio run --target upload

devpet's Issues

Minigame

Add a cool minigame (I think based on Chrome's dino game)

• Dino icon
• Bug icon (enemy)
• Jump system
• Collisions
• Enemy spawning system
• Score at top

Remove the need for `-fpermissive` build flag

Doesn't sound like a good idea, currently doesn't build without the flag.

Basic Graphical primitives

• Text
• Static Image
• Animated Sprite (multiple animations)
• Scrolling Text
• Progress Bar

Bluetooth Serial command handler

• https://github.com/5cript/bluez-rfcomm-example
• https://serialport.io/docs/api-serialport
• https://medium.com/@18218004/devlog-6-bluetooth-and-esp32-ba076a8e207d

Fix `cpplint` issues

There are multiple warnings raised by cpplint in PlatformIO's project inspection.

These do not seem to cause any problems in the first place, but I guess it still makes sense to fix them.

"Notification" system

On the top 16px yellow bar there should be some kind of notification feed:

Usually empty, displays playing music if any. Push notification can replace it for a few seconds.

Composed of an icon at left, and two text zones, the first static the second scrolling.

`DisplaySystem` cleanup

• Display should be initialized in the class constructor
• Many methods can be removed now that the Node2D API is done
• Add some documentation for methods

Save data between restarts

https://randomnerdtutorials.com/esp32-save-data-permanently-preferences/

Screens system (maps of `Node2D`)

• typedef the Node2D map
• Create a screen for serial connection

Sprite bar widget (for health display)

Minecraft like health bar, rely on SpriteAnimated to get 3 states (animations).

• Base heart image
• Manager class

Dinosaur Sprites

@Klhmt

• 48x48 pixels, with at least 1px margins on each side
• Black on white background, black will light up on screen (inverted)
• Base design
• Anims (2-3 frames each)
  • IDLE (potentially different ones for health? not priority)
  • IDLE listening (maybe a headset or just music notes around?)
  • Dead
  • Wake up (when starting up the tamagotchi)
  • Drink coffee
  • Party (on notifications)
• License infos
• Credits to @Klhmt

Determine the stats of the pet

• Mood (music)
• Energy (coffee)
• Productivity (GitHub contributions)
• ?

Initial/Periodical serial ping

To make sure the backend is connected to the ESP32

Do not start pet automatically

Ask for a button press on startup

Non working input system

The first button pin is fired no matter the pressed button

Command handler have wrong payload sometimes

When there is no payload the payload is equal to the command name