https://github.com/afcms/devpet

https://github.com/afcms/devpet

cpp esp32 esp32-arduino platformio

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/afcms/devpet
• Owner: AFCMS
• License: gpl-3.0
• Created: 2024-04-02T09:45:43.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-06-28T13:45:36.000Z (5 months ago)
• Last Synced: 2024-10-10T22:16:37.332Z (about 1 month ago)
• Topics: cpp, esp32, esp32-arduino, platformio
• Language: C++
• Homepage:
• Size: 312 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        


# DevPet

[![PlatformIO CI](https://github.com/AFCMS/devpet/actions/workflows/platformio.yml/badge.svg)](https://github.com/AFCMS/devpet/actions/workflows/platformio.yml)

## Design

```mermaid

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

```

## Run the project

### Install PlatformIO

The project depends on the [PlatformIO](https://platformio.org) toolkit.

You can either install the [VSCode extension](https://platformio.org/install/ide?install=vscode) or the [CLI](https://platformio.org/install/cli)

### Build

```shell

platformio run

```

### Upload on the ESP32

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

```shell

platformio run --target upload

```