particle-commands 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+### 0.5.0 - 2023-10-10
+- Add the new Particle project template
+
+### 0.4.1-rc.0 - 2023-09-26
+- [tests] add project directory
+
 ### 0.4.0 - 2022-05-31
 - Move to `node@16` and `npm@8` for local development
 

package/dist/cmd/project_init.js

@@ -294,22 +294,29 @@ var ProjectInitCommand = exports.ProjectInitCommand = function (_Command) {
 			var _this6 = this;
 
 			var properties = { name: name };
-			var projectFile = _path2.default.join(directory, 'project.properties');
 			var project = new _project_properties2.default(directory, { fs: _project_properties2.default.buildFs(fs) });
 			return this.createNotifyDirectory(site, fs, directory).then(function () {
+				return _this6.createNotifyTemplateIfNeeded(site, fs, _path2.default.join(directory, '.gitignore'), '.gitignore', properties);
+			}).then(function () {
+				return _this6.createNotifyFileIfNeeded(site, fs, _path2.default.join(directory, 'project.properties'), '');
+			}).then(function () {
 				return _this6.createNotifyDirectory(site, fs, _path2.default.join(directory, 'src'));
 			}).then(function () {
-				return _this6.createNotifyFileIfNeeded(site, fs, projectFile, '');
+				return _this6.createNotifyDirectory(site, fs, _path2.default.join(directory, '.github', 'workflows'));
+			}).then(function () {
+				return _this6.createNotifyTemplateIfNeeded(site, fs, _path2.default.join(directory, '.github', 'workflows', 'main.yaml'), '.github/workflows/main.yaml', properties);
 			}).then(function () {
 				return _this6.createNotifyTemplateIfNeeded(site, fs, _path2.default.join(directory, 'README.md'), 'README.md', properties);
 			}).then(function () {
-				return _this6.createNotifyTemplateIfNeeded(site, fs, _path2.default.join(directory, 'src', name + '.ino'), 'project.ino', properties);
+				return _this6.createNotifyTemplateIfNeeded(site, fs, _path2.default.join(directory, 'src', name + '.cpp'), 'src/project.cpp', properties);
 			}).then(function () {
 				return project.load();
 			}).then(function () {
 				if (project.setField('name', name)) {
 					return project.save();
 				}
+			}).then(function () {
+				return project.writeAssetOtaDir();
 			});
 		}
 

package/dist/cmd/project_properties.js

@@ -33,7 +33,7 @@ function buildPromisefs() {
 	var fs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _fs2.default;
 
 	var promisefs = {};
-	['readFile', 'writeFile', 'stat'].forEach(function (fn) {
+	['readFile', 'writeFile', 'appendFile', 'stat'].forEach(function (fn) {
 		return promisefs[fn] = (0, _es6Promisify2.default)(fs[fn]);
 	});
 	return promisefs;
@@ -120,6 +120,13 @@ var ProjectProperties = function () {
 			var data = this.serialize();
 			return this.fs.writeFile(this.name(), data, 'utf8');
 		}
+	}, {
+		key: 'writeAssetOtaDir',
+		value: function writeAssetOtaDir() {
+			// Add a commented line for assetOtaDir
+			var data = '#assetOtaDir=assets\n';
+			return this.fs.appendFile(this.name(), data, 'utf8');
+		}
 	}, {
 		key: 'serialize',
 		value: function serialize() {

package/dist/cmd/templates/project/.github/workflows/main.yaml

@@ -0,0 +1,37 @@
+# Particle Compile Action Workflow
+# This workflow uses the Particle compile-action to compile Particle application firmware.
+# Make sure to set the particle-platform-name for your project.
+# For complete documentation, please refer to https://github.com/particle-iot/compile-action
+
+name: Particle Compile
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # Particle Compile Action
+      - name: Compile Firmware
+        id: compile
+        uses: particle-iot/compile-action@v1
+        with:
+          # Set the particle-platform-name to the platform you're targeting.
+          # Allowed values: core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom
+          particle-platform-name: 'p2'
+
+      # Optional: Upload compiled firmware as an artifact on GitHub.
+      - name: Upload Firmware as Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: firmware-artifact
+          path: |
+            ${{ steps.compile.outputs.firmware-path }}
+            ${{ steps.compile.outputs.target-path }}

package/dist/cmd/templates/project/README.md

@@ -1,35 +1,100 @@
 # <%=name%>
 
-A Particle project named <%=name%>
+This firmware project was created using [Particle Developer Tools](https://www.particle.io/developer-tools/) and is compatible with all [Particle Devices](https://www.particle.io/devices/).
 
-## Welcome to your project!
+Feel free to replace this README.md file with your own content, or keep it for reference.
 
-Every new Particle project is composed of 3 important elements that you'll see have been created in your project directory for <%=name%>.
+## Table of Contents
+- [Introduction](#introduction)
+- [Prerequisites To Use This Template](#prerequisites-to-use-this-repository)
+- [Getting Started](#getting-started)
+- [Particle Firmware At A Glance](#particle-firmware-at-a-glance)
+  - [Logging](#logging)
+  - [Setup and Loop](#setup-and-loop)
+  - [Delays and Timing](#delays-and-timing)
+  - [Testing and Debugging](#testing-and-debugging)
+  - [GitHub Actions (CI/CD)](#github-actions-cicd)
+  - [OTA](#ota)
+- [Support and Feedback](#support-and-feedback)
+- [Version](#version)
 
-#### ```/src``` folder:  
-This is the source folder that contains the firmware files for your project. It should *not* be renamed. 
-Anything that is in this folder when you compile your project will be sent to our compile service and compiled into a firmware binary for the Particle device that you have targeted.
+## Introduction
 
-If your application contains multiple files, they should all be included in the `src` folder. If your firmware depends on Particle libraries, those dependencies are specified in the `project.properties` file referenced below.
+For an in-depth understanding of this project template, please refer to our [documentation](https://docs.particle.io/firmware/best-practices/firmware-template/).
 
-#### ```.ino``` file:
-This file is the firmware that will run as the primary application on your Particle device. It contains a `setup()` and `loop()` function, and can be written in Wiring or C/C++. For more information about using the Particle firmware API to create firmware for your Particle device, refer to the [Firmware Reference](https://docs.particle.io/reference/firmware/) section of the Particle documentation.
+## Prerequisites To Use This Repository
 
-#### ```project.properties``` file:  
-This is the file that specifies the name and version number of the libraries that your project depends on. Dependencies are added automatically to your `project.properties` file when you add a library to a project using the `particle library add` command in the CLI or add a library in the Desktop IDE.
+To use this software/firmware on a device, you'll need:
 
-## Adding additional files to your project
+- A [Particle Device](https://www.particle.io/devices/).
+- Windows/Mac/Linux for building the software and flashing it to a device.
+- [Particle Development Tools](https://docs.particle.io/getting-started/developer-tools/developer-tools/) installed and set up on your computer.
+- Optionally, a nice cup of tea (and perhaps a biscuit).
 
-#### Projects with multiple sources
-If you would like add additional files to your application, they should be added to the `/src` folder. All files in the `/src` folder will be sent to the Particle Cloud to produce a compiled binary.
+## Getting Started
 
-#### Projects with external libraries
-If your project includes a library that has not been registered in the Particle libraries system, you should create a new folder named `/lib/<libraryname>/src` under `/<project dir>` and add the `.h`, `.cpp` & `library.properties` files for your library there. Read the [Firmware Libraries guide](https://docs.particle.io/guide/tools-and-features/libraries/) for more details on how to develop libraries. Note that all contents of the `/lib` folder and subfolders will also be sent to the Cloud for compilation.
+1. While not essential, we recommend running the [device setup process](https://setup.particle.io/) on your Particle device first. This ensures your device's firmware is up-to-date and you have a solid baseline to start from.
 
-## Compiling your project
+2. If you haven't already, open this project in Visual Studio Code (File -> Open Folder). Then [compile and flash](https://docs.particle.io/getting-started/developer-tools/workbench/#cloud-build-and-flash) your device. Ensure your device's USB port is connected to your computer.
 
-When you're ready to compile your project, make sure you have the correct Particle device target selected and run `particle compile <platform>` in the CLI or click the Compile button in the Desktop IDE. The following files in your project folder will be sent to the compile service:
+3. Verify the device's operation by monitoring its logging output:
+    - In Visual Studio Code with the Particle Plugin, open the [command palette](https://docs.particle.io/getting-started/developer-tools/workbench/#particle-commands) and choose "Particle: Serial Monitor".
+    - Or, using the Particle CLI, execute:
+    ```
+    particle serial monitor --follow
+    ```
 
-- Everything in the `/src` folder, including your `.ino` application file
-- The `project.properties` file for your project
-- Any libraries stored under `lib/<libraryname>/src`
+4. Uncomment the code at the bottom of the cpp file in your src directory to publish to the Particle Cloud! Login to console.particle.io to view your devices events in real time.
+
+5. Customize this project! For firmware details, see [Particle firmware](https://docs.particle.io/reference/device-os/api/introduction/getting-started/). For information on the project's directory structure, visit [this link](https://docs.particle.io/firmware/best-practices/firmware-template/#project-overview).
+
+## Particle Firmware At A Glance
+
+### Logging
+
+The firmware includes a [logging library](https://docs.particle.io/reference/device-os/api/logging/logger-class/). You can display messages at different levels and filter them:
+
+```
+Log.trace("This is trace message");
+Log.info("This is info message");
+Log.warn("This is warn message");
+Log.error("This is error message");
+```
+
+### Setup and Loop
+
+Particle projects originate from the Wiring/Processing framework, which is based on C++. Typically, one-time setup functions are placed in `setup()`, and the main application runs from the `loop()` function.
+
+For advanced scenarios, explore our [threading support](https://docs.particle.io/firmware/software-design/threading-explainer/).
+
+### Delays and Timing
+
+By default, the setup() and loop() functions are blocking whilst they run, meaning that if you put in a delay, your entire application will wait for that delay to finish before anything else can run. 
+
+For techniques that allow you to run multiple tasks in parallel without creating threads, checkout the code example [here](https://docs.particle.io/firmware/best-practices/firmware-template/).
+
+(Note: Although using `delay()` isn't recommended for best practices, it's acceptable for testing.)
+
+### Testing and Debugging
+
+For firmware testing and debugging guidance, check [this documentation](https://docs.particle.io/troubleshooting/guides/build-tools-troubleshooting/debugging-firmware-builds/).
+
+### GitHub Actions (CI/CD)
+
+This project provides a YAML file for GitHub, automating firmware compilation whenever changes are pushed. More details on [Particle GitHub Actions](https://docs.particle.io/firmware/best-practices/github-actions/) are available.
+
+### OTA
+
+To learn how to utilize Particle's OTA service for device updates, consult [this documentation](https://docs.particle.io/getting-started/cloud/ota-updates/).
+
+Test OTA with the 'Particle: Cloud Flash' command in Visual Studio Code or the CLI command 'particle flash'!
+
+This firmware supports binary assets in OTA packages, allowing the inclusion of audio, images, configurations, and external microcontroller firmware. More details are [here](https://docs.particle.io/reference/device-os/api/asset-ota/asset-ota/).
+
+## Support and Feedback
+
+For support or feedback on this template or any Particle products, please join our [community](https://community.particle.io)!
+
+## Version
+
+Template version 1.0.2

package/dist/cmd/templates/project/src/project.cpp

@@ -0,0 +1,35 @@
+/* 
+ * Project myProject
+ * Author: Your Name
+ * Date: 
+ * For comprehensive documentation and examples, please visit:
+ * https://docs.particle.io/firmware/best-practices/firmware-template/
+ */
+
+// Include Particle Device OS APIs
+#include "Particle.h"
+
+// Let Device OS manage the connection to the Particle Cloud
+SYSTEM_MODE(AUTOMATIC);
+
+// Run the application and system concurrently in separate threads
+SYSTEM_THREAD(ENABLED);
+
+// Show system, cloud connectivity, and application logs over USB
+// View logs with CLI using 'particle serial monitor --follow'
+SerialLogHandler logHandler(LOG_LEVEL_INFO);
+
+// setup() runs once, when the device is first turned on
+void setup() {
+  // Put initialization like pinMode and begin functions here
+}
+
+// loop() runs over and over again, as quickly as it can execute.
+void loop() {
+  // The core of your code will likely live here.
+
+  // Example: Publish event to cloud every 10 seconds. Uncomment the next 3 lines to try it!
+  // Logging.info("Sending Hello World to the cloud!");
+  // Particle.publish("Hello world!");
+  // delay( 10 * 1000 ); // milliseconds and blocking - see docs for more info!
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "particle-commands",
   "description": "Library of UX-neutral commands that provide key functionality for developer tools",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "author": "Matthew McGowan",
   "bugs": {
     "url": "https://github.com/particle-iot/particle-commands/issues"
@@ -35,6 +35,7 @@
     "babel-register": "^6.5.2",
     "chai": "^3.5.0",
     "chai-as-promised": "^5.3.0",
+    "copyfiles": "^2.4.1",
     "coveralls": "^2.11.4",
     "doctoc": "^0.15.0",
     "eslint": "~2.2.0",
@@ -73,7 +74,9 @@
     "prepublish": "npm run compile",
     "preversion": "npm run lint && npm run test && npm run prepublish",
     "version": "npm run update-changelog",
-    "compile": "babel src -d dist --copy-files",
+    "compile": "npm run compile:src && npm run copy:dotfiles",
+    "compile:src": "babel src -d dist --copy-files",
+    "copy:dotfiles": "copyfiles -u 4 src/cmd/templates/project/.github/**/* src/cmd/templates/project/.gitignore dist/cmd/templates/project/",
     "babel-watch": "babel src -d dist --watch --source-maps --copy-files",
     "doctoc": "doctoc --title '## Table of Contents' README.md",
     "list-folders": "node --require babel-register bin/list_folders.js",

package/src/cmd/project_init.js

@@ -208,19 +208,22 @@ export class ProjectInitCommand extends Command {
 
 	createProject(site, fs, directory, name) {
 		const properties = { name };
-		const projectFile = path.join(directory, 'project.properties');
 		const project = new ProjectProperties(directory, { fs:ProjectProperties.buildFs(fs) });
 		return this.createNotifyDirectory(site, fs, directory)
+			.then(() => this.createNotifyTemplateIfNeeded(site, fs, path.join(directory, '.gitignore'), '.gitignore', properties))
+			.then(() => this.createNotifyFileIfNeeded(site, fs, path.join(directory, 'project.properties'), ''))
 			.then(() => this.createNotifyDirectory(site, fs, path.join(directory, 'src')))
-			.then(() => this.createNotifyFileIfNeeded(site, fs, projectFile, ''))
+			.then(() => this.createNotifyDirectory(site, fs, path.join(directory, '.github', 'workflows')))
+			.then(() => this.createNotifyTemplateIfNeeded(site, fs, path.join(directory, '.github', 'workflows', 'main.yaml'), '.github/workflows/main.yaml', properties))
 			.then(() => this.createNotifyTemplateIfNeeded(site, fs, path.join(directory, 'README.md'), 'README.md', properties))
-			.then(() => this.createNotifyTemplateIfNeeded(site, fs, path.join(directory, 'src', name+'.ino'), 'project.ino', properties))
+			.then(() => this.createNotifyTemplateIfNeeded(site, fs, path.join(directory, 'src', name + '.cpp'), 'src/project.cpp', properties))
 			.then(() => project.load())
 			.then(() => {
 				if (project.setField('name', name)) {
 					return project.save();
 				}
-			});
+			})
+			.then(() => project.writeAssetOtaDir());
 	}
 
 	/**

package/src/cmd/project_properties.js

@@ -10,6 +10,7 @@ function buildPromisefs(fs=nodeFs) {
 	[
 		'readFile',
 		'writeFile',
+		'appendFile',
 		'stat'
 	].forEach(fn => promisefs[fn] = promisify(fs[fn]));
 	return promisefs;
@@ -71,6 +72,12 @@ export default class ProjectProperties {
 		return this.fs.writeFile(this.name(), data, 'utf8');
 	}
 
+	writeAssetOtaDir() {
+		// Add a commented line for assetOtaDir
+		const data = '#assetOtaDir=assets\n';
+		return this.fs.appendFile(this.name(), data, 'utf8');
+	}
+
 	serialize() {
 		return Object.keys(this.fields).map(field => {
 			return `${field}=${this.fields[field]}`;

package/src/cmd/templates/project/.github/workflows/main.yaml

@@ -0,0 +1,37 @@
+# Particle Compile Action Workflow
+# This workflow uses the Particle compile-action to compile Particle application firmware.
+# Make sure to set the particle-platform-name for your project.
+# For complete documentation, please refer to https://github.com/particle-iot/compile-action
+
+name: Particle Compile
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # Particle Compile Action
+      - name: Compile Firmware
+        id: compile
+        uses: particle-iot/compile-action@v1
+        with:
+          # Set the particle-platform-name to the platform you're targeting.
+          # Allowed values: core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom
+          particle-platform-name: 'p2'
+
+      # Optional: Upload compiled firmware as an artifact on GitHub.
+      - name: Upload Firmware as Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: firmware-artifact
+          path: |
+            ${{ steps.compile.outputs.firmware-path }}
+            ${{ steps.compile.outputs.target-path }}

package/src/cmd/templates/project/README.md

@@ -1,35 +1,100 @@
 # <%=name%>
 
-A Particle project named <%=name%>
+This firmware project was created using [Particle Developer Tools](https://www.particle.io/developer-tools/) and is compatible with all [Particle Devices](https://www.particle.io/devices/).
 
-## Welcome to your project!
+Feel free to replace this README.md file with your own content, or keep it for reference.
 
-Every new Particle project is composed of 3 important elements that you'll see have been created in your project directory for <%=name%>.
+## Table of Contents
+- [Introduction](#introduction)
+- [Prerequisites To Use This Template](#prerequisites-to-use-this-repository)
+- [Getting Started](#getting-started)
+- [Particle Firmware At A Glance](#particle-firmware-at-a-glance)
+  - [Logging](#logging)
+  - [Setup and Loop](#setup-and-loop)
+  - [Delays and Timing](#delays-and-timing)
+  - [Testing and Debugging](#testing-and-debugging)
+  - [GitHub Actions (CI/CD)](#github-actions-cicd)
+  - [OTA](#ota)
+- [Support and Feedback](#support-and-feedback)
+- [Version](#version)
 
-#### ```/src``` folder:  
-This is the source folder that contains the firmware files for your project. It should *not* be renamed. 
-Anything that is in this folder when you compile your project will be sent to our compile service and compiled into a firmware binary for the Particle device that you have targeted.
+## Introduction
 
-If your application contains multiple files, they should all be included in the `src` folder. If your firmware depends on Particle libraries, those dependencies are specified in the `project.properties` file referenced below.
+For an in-depth understanding of this project template, please refer to our [documentation](https://docs.particle.io/firmware/best-practices/firmware-template/).
 
-#### ```.ino``` file:
-This file is the firmware that will run as the primary application on your Particle device. It contains a `setup()` and `loop()` function, and can be written in Wiring or C/C++. For more information about using the Particle firmware API to create firmware for your Particle device, refer to the [Firmware Reference](https://docs.particle.io/reference/firmware/) section of the Particle documentation.
+## Prerequisites To Use This Repository
 
-#### ```project.properties``` file:  
-This is the file that specifies the name and version number of the libraries that your project depends on. Dependencies are added automatically to your `project.properties` file when you add a library to a project using the `particle library add` command in the CLI or add a library in the Desktop IDE.
+To use this software/firmware on a device, you'll need:
 
-## Adding additional files to your project
+- A [Particle Device](https://www.particle.io/devices/).
+- Windows/Mac/Linux for building the software and flashing it to a device.
+- [Particle Development Tools](https://docs.particle.io/getting-started/developer-tools/developer-tools/) installed and set up on your computer.
+- Optionally, a nice cup of tea (and perhaps a biscuit).
 
-#### Projects with multiple sources
-If you would like add additional files to your application, they should be added to the `/src` folder. All files in the `/src` folder will be sent to the Particle Cloud to produce a compiled binary.
+## Getting Started
 
-#### Projects with external libraries
-If your project includes a library that has not been registered in the Particle libraries system, you should create a new folder named `/lib/<libraryname>/src` under `/<project dir>` and add the `.h`, `.cpp` & `library.properties` files for your library there. Read the [Firmware Libraries guide](https://docs.particle.io/guide/tools-and-features/libraries/) for more details on how to develop libraries. Note that all contents of the `/lib` folder and subfolders will also be sent to the Cloud for compilation.
+1. While not essential, we recommend running the [device setup process](https://setup.particle.io/) on your Particle device first. This ensures your device's firmware is up-to-date and you have a solid baseline to start from.
 
-## Compiling your project
+2. If you haven't already, open this project in Visual Studio Code (File -> Open Folder). Then [compile and flash](https://docs.particle.io/getting-started/developer-tools/workbench/#cloud-build-and-flash) your device. Ensure your device's USB port is connected to your computer.
 
-When you're ready to compile your project, make sure you have the correct Particle device target selected and run `particle compile <platform>` in the CLI or click the Compile button in the Desktop IDE. The following files in your project folder will be sent to the compile service:
+3. Verify the device's operation by monitoring its logging output:
+    - In Visual Studio Code with the Particle Plugin, open the [command palette](https://docs.particle.io/getting-started/developer-tools/workbench/#particle-commands) and choose "Particle: Serial Monitor".
+    - Or, using the Particle CLI, execute:
+    ```
+    particle serial monitor --follow
+    ```
 
-- Everything in the `/src` folder, including your `.ino` application file
-- The `project.properties` file for your project
-- Any libraries stored under `lib/<libraryname>/src`
+4. Uncomment the code at the bottom of the cpp file in your src directory to publish to the Particle Cloud! Login to console.particle.io to view your devices events in real time.
+
+5. Customize this project! For firmware details, see [Particle firmware](https://docs.particle.io/reference/device-os/api/introduction/getting-started/). For information on the project's directory structure, visit [this link](https://docs.particle.io/firmware/best-practices/firmware-template/#project-overview).
+
+## Particle Firmware At A Glance
+
+### Logging
+
+The firmware includes a [logging library](https://docs.particle.io/reference/device-os/api/logging/logger-class/). You can display messages at different levels and filter them:
+
+```
+Log.trace("This is trace message");
+Log.info("This is info message");
+Log.warn("This is warn message");
+Log.error("This is error message");
+```
+
+### Setup and Loop
+
+Particle projects originate from the Wiring/Processing framework, which is based on C++. Typically, one-time setup functions are placed in `setup()`, and the main application runs from the `loop()` function.
+
+For advanced scenarios, explore our [threading support](https://docs.particle.io/firmware/software-design/threading-explainer/).
+
+### Delays and Timing
+
+By default, the setup() and loop() functions are blocking whilst they run, meaning that if you put in a delay, your entire application will wait for that delay to finish before anything else can run. 
+
+For techniques that allow you to run multiple tasks in parallel without creating threads, checkout the code example [here](https://docs.particle.io/firmware/best-practices/firmware-template/).
+
+(Note: Although using `delay()` isn't recommended for best practices, it's acceptable for testing.)
+
+### Testing and Debugging
+
+For firmware testing and debugging guidance, check [this documentation](https://docs.particle.io/troubleshooting/guides/build-tools-troubleshooting/debugging-firmware-builds/).
+
+### GitHub Actions (CI/CD)
+
+This project provides a YAML file for GitHub, automating firmware compilation whenever changes are pushed. More details on [Particle GitHub Actions](https://docs.particle.io/firmware/best-practices/github-actions/) are available.
+
+### OTA
+
+To learn how to utilize Particle's OTA service for device updates, consult [this documentation](https://docs.particle.io/getting-started/cloud/ota-updates/).
+
+Test OTA with the 'Particle: Cloud Flash' command in Visual Studio Code or the CLI command 'particle flash'!
+
+This firmware supports binary assets in OTA packages, allowing the inclusion of audio, images, configurations, and external microcontroller firmware. More details are [here](https://docs.particle.io/reference/device-os/api/asset-ota/asset-ota/).
+
+## Support and Feedback
+
+For support or feedback on this template or any Particle products, please join our [community](https://community.particle.io)!
+
+## Version
+
+Template version 1.0.2

package/src/cmd/templates/project/src/project.cpp

@@ -0,0 +1,35 @@
+/* 
+ * Project myProject
+ * Author: Your Name
+ * Date: 
+ * For comprehensive documentation and examples, please visit:
+ * https://docs.particle.io/firmware/best-practices/firmware-template/
+ */
+
+// Include Particle Device OS APIs
+#include "Particle.h"
+
+// Let Device OS manage the connection to the Particle Cloud
+SYSTEM_MODE(AUTOMATIC);
+
+// Run the application and system concurrently in separate threads
+SYSTEM_THREAD(ENABLED);
+
+// Show system, cloud connectivity, and application logs over USB
+// View logs with CLI using 'particle serial monitor --follow'
+SerialLogHandler logHandler(LOG_LEVEL_INFO);
+
+// setup() runs once, when the device is first turned on
+void setup() {
+  // Put initialization like pinMode and begin functions here
+}
+
+// loop() runs over and over again, as quickly as it can execute.
+void loop() {
+  // The core of your code will likely live here.
+
+  // Example: Publish event to cloud every 10 seconds. Uncomment the next 3 lines to try it!
+  // Logging.info("Sending Hello World to the cloud!");
+  // Particle.publish("Hello world!");
+  // delay( 10 * 1000 ); // milliseconds and blocking - see docs for more info!
+}

package/test/cmd/library_publish.spec.js

@@ -28,7 +28,7 @@ describe('LibraryPublishCommand', () => {
 			}
 		};
 
-		const execute = () => sut.run({user: {id: 'foo'}, api: {key: 'bar'}}, site);
+		const execute = () => sut.run({ user: { id: 'foo' }, api: { key: 'bar' } }, site);
 
 		const verify = () => {
 			throw new Error('expected rejection');

package/test/cmd/project_init.spec.js

@@ -16,8 +16,10 @@ describe('project_init', () => {
 
 	beforeEach(() => {
 		const fs = {};
+		addFile(fs, ProjectInitCommand.templateFile('.gitignore'));
 		addFile(fs, ProjectInitCommand.templateFile('README.md'));
-		addFile(fs, ProjectInitCommand.templateFile('project.ino'));
+		addFile(fs, ProjectInitCommand.templateFile('src/project.cpp'));
+		addFile(fs, ProjectInitCommand.templateFile('.github/workflows/main.yaml'));
 		mockfs(fs);
 	});
 
@@ -49,8 +51,10 @@ describe('project_init', () => {
 			expect(fs.existsSync(directory), 'expected project directory to exist').to.be.true;
 			expect(fs.existsSync(path.join(directory, 'src')), 'expected src directory to exist').to.be.true;
 			expect(fs.existsSync(path.join(directory, 'project.properties')), 'expected project.properties to exist').to.be.true;
+			expectTemplate(path.join(directory, '.gitignore'), '.gitignore', properties);
+			expectTemplate(path.join(directory, '.github', 'workflows', 'main.yaml'), '.github/workflows/main.yaml', properties);
 			expectTemplate(path.join(directory, 'README.md'), 'README.md', properties);
-			expectTemplate(path.join(directory, 'src', properties.name+'.ino'), 'project.ino', properties);
+			expectTemplate(path.join(directory, 'src', properties.name+'.cpp'), 'src/project.cpp', properties);
 
 			const project = new ProjectProperties(directory, { fs:ProjectProperties.buildFs(fs) });
 			return project.load()

package/test/fixtures/projects/basic/README.md

@@ -0,0 +1 @@
+TBD

package/test/fixtures/projects/basic/project.properties

@@ -0,0 +1 @@
+name=basic

package/test/fixtures/projects/myProject/.github/workflows/main.yaml

@@ -0,0 +1,37 @@
+# Particle Compile Action Workflow
+# This workflow uses the Particle compile-action to compile Particle application firmware.
+# Make sure to set the particle-platform-name for your project.
+# For complete documentation, please refer to https://github.com/particle-iot/compile-action
+
+name: Particle Compile
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # Particle Compile Action
+      - name: Compile Firmware
+        id: compile
+        uses: particle-iot/compile-action@v1
+        with:
+          # Set the particle-platform-name to the platform you're targeting.
+          # Allowed values: core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom
+          particle-platform-name: 'p2'
+
+      # Optional: Upload compiled firmware as an artifact on GitHub.
+      - name: Upload Firmware as Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: firmware-artifact
+          path: |
+            ${{ steps.compile.outputs.firmware-path }}
+            ${{ steps.compile.outputs.target-path }}

package/test/fixtures/projects/myProject/README.md

@@ -0,0 +1,100 @@
+# myProject
+
+This firmware project was created using [Particle Developer Tools](https://www.particle.io/developer-tools/) and is compatible with all [Particle Devices](https://www.particle.io/devices/).
+
+Feel free to replace this README.md file with your own content, or keep it for reference.
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Prerequisites To Use This Template](#prerequisites-to-use-this-repository)
+- [Getting Started](#getting-started)
+- [Particle Firmware At A Glance](#particle-firmware-at-a-glance)
+  - [Logging](#logging)
+  - [Setup and Loop](#setup-and-loop)
+  - [Delays and Timing](#delays-and-timing)
+  - [Testing and Debugging](#testing-and-debugging)
+  - [GitHub Actions (CI/CD)](#github-actions-cicd)
+  - [OTA](#ota)
+- [Support and Feedback](#support-and-feedback)
+- [Version](#version)
+
+## Introduction
+
+For an in-depth understanding of this project template, please refer to our [documentation](https://docs.particle.io/firmware/best-practices/firmware-template/).
+
+## Prerequisites To Use This Repository
+
+To use this software/firmware on a device, you'll need:
+
+- A [Particle Device](https://www.particle.io/devices/).
+- Windows/Mac/Linux for building the software and flashing it to a device.
+- [Particle Development Tools](https://docs.particle.io/getting-started/developer-tools/developer-tools/) installed and set up on your computer.
+- Optionally, a nice cup of tea (and perhaps a biscuit).
+
+## Getting Started
+
+1. While not essential, we recommend running the [device setup process](https://setup.particle.io/) on your Particle device first. This ensures your device's firmware is up-to-date and you have a solid baseline to start from.
+
+2. If you haven't already, open this project in Visual Studio Code (File -> Open Folder). Then [compile and flash](https://docs.particle.io/getting-started/developer-tools/workbench/#cloud-build-and-flash) your device. Ensure your device's USB port is connected to your computer.
+
+3. Verify the device's operation by monitoring its logging output:
+    - In Visual Studio Code with the Particle Plugin, open the [command palette](https://docs.particle.io/getting-started/developer-tools/workbench/#particle-commands) and choose "Particle: Serial Monitor".
+    - Or, using the Particle CLI, execute:
+    ```
+    particle serial monitor --follow
+    ```
+
+4. Uncomment the code at the bottom of the cpp file in your src directory to publish to the Particle Cloud! Login to console.particle.io to view your devices events in real time.
+
+5. Customize this project! For firmware details, see [Particle firmware](https://docs.particle.io/reference/device-os/api/introduction/getting-started/). For information on the project's directory structure, visit [this link](https://docs.particle.io/firmware/best-practices/firmware-template/#project-overview).
+
+## Particle Firmware At A Glance
+
+### Logging
+
+The firmware includes a [logging library](https://docs.particle.io/reference/device-os/api/logging/logger-class/). You can display messages at different levels and filter them:
+
+```
+Log.trace("This is trace message");
+Log.info("This is info message");
+Log.warn("This is warn message");
+Log.error("This is error message");
+```
+
+### Setup and Loop
+
+Particle projects originate from the Wiring/Processing framework, which is based on C++. Typically, one-time setup functions are placed in `setup()`, and the main application runs from the `loop()` function.
+
+For advanced scenarios, explore our [threading support](https://docs.particle.io/firmware/software-design/threading-explainer/).
+
+### Delays and Timing
+
+By default, the setup() and loop() functions are blocking whilst they run, meaning that if you put in a delay, your entire application will wait for that delay to finish before anything else can run. 
+
+For techniques that allow you to run multiple tasks in parallel without creating threads, checkout the code example [here](https://docs.particle.io/firmware/best-practices/firmware-template/).
+
+(Note: Although using `delay()` isn't recommended for best practices, it's acceptable for testing.)
+
+### Testing and Debugging
+
+For firmware testing and debugging guidance, check [this documentation](https://docs.particle.io/troubleshooting/guides/build-tools-troubleshooting/debugging-firmware-builds/).
+
+### GitHub Actions (CI/CD)
+
+This project provides a YAML file for GitHub, automating firmware compilation whenever changes are pushed. More details on [Particle GitHub Actions](https://docs.particle.io/firmware/best-practices/github-actions/) are available.
+
+### OTA
+
+To learn how to utilize Particle's OTA service for device updates, consult [this documentation](https://docs.particle.io/getting-started/cloud/ota-updates/).
+
+Test OTA with the 'Particle: Cloud Flash' command in Visual Studio Code or the CLI command 'particle flash'!
+
+This firmware supports binary assets in OTA packages, allowing the inclusion of audio, images, configurations, and external microcontroller firmware. More details are [here](https://docs.particle.io/reference/device-os/api/asset-ota/asset-ota/).
+
+## Support and Feedback
+
+For support or feedback on this template or any Particle products, please join our [community](https://community.particle.io)!
+
+## Version
+
+Template version 1.0.2

package/test/fixtures/projects/myProject/project.properties

@@ -0,0 +1,2 @@
+name=myProject
+#assetOtaDir=assets

package/test/fixtures/projects/myProject/src/myProject.cpp

@@ -0,0 +1,35 @@
+/* 
+ * Project myProject
+ * Author: Your Name
+ * Date: 
+ * For comprehensive documentation and examples, please visit:
+ * https://docs.particle.io/firmware/best-practices/firmware-template/
+ */
+
+// Include Particle Device OS APIs
+#include "Particle.h"
+
+// Let Device OS manage the connection to the Particle Cloud
+SYSTEM_MODE(AUTOMATIC);
+
+// Run the application and system concurrently in separate threads
+SYSTEM_THREAD(ENABLED);
+
+// Show system, cloud connectivity, and application logs over USB
+// View logs with CLI using 'particle serial monitor --follow'
+SerialLogHandler logHandler(LOG_LEVEL_INFO);
+
+// setup() runs once, when the device is first turned on
+void setup() {
+  // Put initialization like pinMode and begin functions here
+}
+
+// loop() runs over and over again, as quickly as it can execute.
+void loop() {
+  // The core of your code will likely live here.
+
+  // Example: Publish event to cloud every 10 seconds. Uncomment the next 3 lines to try it!
+  // Logging.info("Sending Hello World to the cloud!");
+  // Particle.publish("Hello world!");
+  // delay( 10 * 1000 ); // milliseconds and blocking - see docs for more info! 
+}

package/src/cmd/templates/project/project.ino

@@ -1,18 +0,0 @@
-/*
- * Project <%=name%>
- * Description:
- * Author:
- * Date:
- */
-
-// setup() runs once, when the device is first turned on.
-void setup() {
-  // Put initialization like pinMode and begin functions here.
-
-}
-
-// loop() runs over and over again, as quickly as it can execute.
-void loop() {
-  // The core of your code will likely live here.
-
-}