This repository contains several templates to be used as a base to create devices that can be controlled over the network the Puara Framework.
-
Install VSCode and PlatformIO: We recommend using Visual Studio Code as code editor with the PlatformIO IDE extension.
-
Clone the
puara-module-templatesrepository locally:git clone https://github.com/Puara/puara-module-templates.git -
Open a puara template in VS Code: Open VS Code, and select the platformIO extension on the left side. This will open the
PLATFORMIOpanel. From there select "Pick a folder", and navigate to one of thepuara-module-templatessubfolders, e.g.,puara-module-templates/basic/(see below for a list of available templates). Click the "Select Folder" button. Wait for a bit while PlatformIO configures your project.
-
Configure the board: Ensure the
boardvariable in theplatformio.inifile matches your board's name. If needed you can find valid board IDs in Boards catalog, Boards Explorer or by using the pio boards terminal command. -
Edit the template: You are now ready to edit the template according to your board/needs.
-
Build and upload the file system and firmware: Once ready, you can use PlatformIO to build and upload the file system and firmware to your board. You can access the
PLATFORMIOProject Tasks by clicking on the extension button on the left. Make sure you upload both the filesystem (Build/Upload Filesystem Imageunder thePlatformicon) and the firmware (Build/Uploadunder theGeneralicon).
Use this as a bare-minimum template to just make puara-module available in you microcontroller.
Use this as a base if you want to send and receive osc messages.
Use this as a base if you want to expose sensor data as BLE advertisements.
Use this as a base if you want to use libmapper or raw OSC messages.
More Info on the research related with Puara
The code in this project is licensed under the MIT license, unless otherwise specified within the file.