Build Instructions

Arduino SDK, pin layout of board is identical to a Adafruit Feather M0.

Linux Arduino SDK and Dependency Setup

tools/linux/sdk-setup.sh

tools/linux/build.sh

Windows Arduino SDK and Dependency Setup

tools/win/sdk-setup.ps1

tools/win/build.ps1

Mac Arduino SDK and Dependency Setup

tools/osx/sdk-setup.ps1

tools/osx/build.ps1

Bootloader Instructions

flash adafruit bootloader https://github.com/adafruit/uf2-samdx1
set boot brotection fuses to 8kb (bootprot fuse value 0x2)
(optional) flash pawos_setup.hex
disable BOD33 fuse via pawos_setup.hex or preffered programmer device

Flash Instructions

connect device via usb
double click reset button to enter bootloader
flash pawos via arduino-cli (tools/<plat>/flash.sh)

Update Instructions

wake PawPet from sleep
connect via USB
flash pawos via arduino-cli (tools/<plat>/flash.sh)

TODO: update instructions that use UF2 instead, should be possible to use a script to put the device into bootloader mode, and then copy the file over via system file browser, or dynamically detect the device attach via usb id and drive name.

TODO: consider a self packaged C# exe or python script?

TODO: look into using openocd for flashing bootloader TODO: fork adafruit bootloader to have low power operation enabled by default, bootloader blocks startup below 2.2v right now. in theory device can operate to 1.9v before display cuts out

Simulator

A tool to simulate the pawpad on the computer.
Currently only supports Windows.

Requirements:

Visual Studio Community/MSVC
cmake
SDL2
ninja
emsdk (Optional for webSimulator)

Visual Studio Community

When setting up visual studio community, make sure to select these features: "Desktop Development with C++" as we require MSVC
If you are using VSCode, see the following notes on launching VSCode from the Developer command prompt:
(https://code.visualstudio.com/docs/cpp/config-msvc#_check-your-microsoft-visual-c-installation)

TODO: Could this possibly be switched to MinCG instead of using MSVC to remove the dependency of Visual Studio Community? See here

cmake

Install cmake to C:\Program Files\CMake

SDL2

Download SDL2-devel-[VERSION]-VC.zip and place SDL2 in .\simulator\SDL2

Ninja

Extract Ninja to %userprofile%\dev\ninja.exe

emsdk

TODO

Build the simulator

SDL2 and Webasm wrappers.

tools/win/build.ps1 -simulator

builds a SDL2 exe version of the pawpet, can be run from .\build\win32\pawpet.exe

tools/win/build.ps1 -webSimulator

builds a webasm version of the pawpet

Controls

The Simulator uses the following controls:

 - Arrow Keys: dpad operation
 - Z - A Button: Open menu
 - X - B Button
 - C - C Button
 - V - P Button: Select

Additional Information in simulator notes

Licensing

Code

All code is licensed under the MIT license.

Assets

Graphics, art, and models found in sprites and paw-case are licensed under the Creative Commons Attribution-NonCommercial 4.0 International Public License.

Coolfeather2/pawpet