unirpi-io 0.0.0-stage → 0.0.2

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,12 @@
+## Code of Conduct
+
+As a contributor to this project, you are expected to adhere to the following code of conduct:
+
+- Be respectful, kind, and patient
+- Welcome feedback constructively
+- Avoid offensive or discriminatory language
+- Focus on collaboration
+- Properly credit contributors
+- Report concerns privately
+
+Failure to adhere to this code of conduct may result in removal from the project and reporting to GitHub if necessary.

package/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+Anyone is welcome to contribute to this project.
+Please make sure to follow these steps thoroughly to contribute :
+
+1. **Fork the repository:** Click the Fork button on GitHub to create your copy.
+
+2. **Clone your fork:**
+   ```bash
+   git clone https://github.com/your-username/your-fork.git
+   ```
+
+3. **Create a branch for your feature:**
+   ```bash
+   git checkout -b feat/your-feature
+   ```
+
+4. **Set up the environment:** Follow the setup instructions in the README.
+
+5. **Use clear commit messages:**
+   - `feat:` – New feature
+   - `fix:` – Bug fix
+   - `docs:` – Documentation update
+   - `refactor:` – Code restructuring
+
+6. **Submit a Pull Request (PR):**
+
+   Include:
+   - Description of the changes
+   - References to issues (e.g., Closes #12)
+   - Screenshots or examples (if applicable)
+
+7. **Participate in the code review:** Be collaborative and responsive.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Noah Bleau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,63 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# UniRPI-IO (Universal Raspberry Pi I/O)
+
+![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=191A1B)
+![Node.js](https://img.shields.io/badge/Node.js-6DA55F?logo=node.js&logoColor=white)
+
+A mock implementation of [RPI-IO](https://github.com/gdorbes/rpi-io) to use a fake instance of Raspberry Pi GPIO's on any platform for Node.js
+
+## Installation
+
+Before installing, make sure you have [Node.js](https://nodejs.org/) installed on your system.
+
+Install the package using npm:
+```bash
+npm install unirpi-io --save-optional
+npm install rpi-io --save-optional
+```
+*The `--save-optional` flag ensures that the packages are listed under `optionalDependencies` in your `package.json` file.*
+
+Make sure both **UniRPI-IO** and **RPI-IO** are listed in `optionalDependencies` in your `package.json` file to prevent installation issues :
+```json
+"dependencies": {
+    "dotenv": "^18.0.5",
+    ...
+},
+"optionalDependencies": {
+    "unirio": "^1.0.0",
+    "unirpi-io": "^1.0.0"
+}
+```
+
+In your project, you can now use a basic `if/else` statement to conditionally require **UniRPI-IO** or **RPI-IO** based on the platform:
+```javascript
+let GPIO; // Variable for the GPIO module
+if (process.platform === 'linux') {
+    // Using RPI-IO for Linux platforms
+    GPIO = require('rpi-io').RIO;
+} else {
+    // Using UniRPI-IO on others platforms
+    GPIO = require('unirpi-io').URIO;
+}
+```
+
+> [!Note]
+> **RPI-IO has it's own system to detect if the system is running on a Raspberry Pi on Linux**, this package won't perform any such detection for other platforms.
+
+## Contributing
+
+Please make sure to follow the contribution guidelines before submitting any changes.
+
+See the [CONTRIBUTING.md](https://github.com/noahbleau/UniRPI-IO/blob/main/CONTRIBUTING.md) file for contribution instructions.
+
+## Code of Conduct
+
+Please make sure to read and follow the code of conduct before contributing to the project.
+
+See the [CODE_OF_CONDUCT.md](https://github.com/noahbleau/UniRPI-IO/blob/main/CODE_OF_CONDUCT.md) file for the code of conduct.
+
+## License
+
+This project is licensed under the MIT license, please make sure to read and understand the terms before reusing the code.
+Read more about Licensing in Open Source projects : [What are Open Source Licenses?](https://www.blackduck.com/glossary/what-are-open-source-licenses.html)
+
+See the [LICENSE](https://github.com/noahbleau/UniRPI-IO/blob/main/LICENSE) file for more details.

package/index.js

@@ -0,0 +1,22 @@
+// UniRPI-IO library for handling GPIO pins in a mock environment
+class URIO {
+    // Initialize the instance with the specified pin, mode, and options
+    constructor(pin, mode, options = {}) {
+        console.log('\x1b[36m%s\x1b[0m', `[UniRPI-IO] Using UniRPI-IO on pin ${pin}`);
+        this.pin = pin;
+        this.mode = mode;
+        this.isMock = true;
+    }
+
+    // Write a value to the specified pin
+    write(value) {
+        console.log('\x1b[36m%s\x1b[0m', `[UniRPI-IO] Writing value ${value} on pin ${this.pin}`);
+    }
+
+    // Close the specified pin
+    close() {
+        console.log('\x1b[36m%s\x1b[0m', `[UniRPI-IO] Closing pin ${this.pin}`);
+    }
+}
+
+module.exports = { URIO };

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "unirpi-io",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.2",
+  "description": "A mock implementation of RPI-IO (by gdorbes) to use a fake instance of Raspberry Pi GPIO's on any platform for Node.js",
+  "keywords": [
+    "unirpi-io",
+    "rpi-io",
+    "mock",
+    "gpio",
+    "rpi",
+    "raspberry-pi"
+  ],
+  "homepage": "https://github.com/noahbleau/UniRPI-IO#readme",
+  "bugs": {
+    "url": "https://github.com/noahbleau/UniRPI-IO/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/noahbleau/UniRPI-IO.git"
+  },
+  "license": "MIT",
+  "author": "Noah Bleau <noah@hexoraw.com>",
+  "type": "commonjs",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}