https://github.com/404background/node-red-contrib-mcu-m5units
Node to use M5Stack Units with Node-RED MCU
https://github.com/404background/node-red-contrib-mcu-m5units
Last synced: 5 months ago
JSON representation
Node to use M5Stack Units with Node-RED MCU
- Host: GitHub
- URL: https://github.com/404background/node-red-contrib-mcu-m5units
- Owner: 404background
- License: mit
- Created: 2025-05-05T07:49:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-25T09:55:33.000Z (about 1 year ago)
- Last Synced: 2025-12-14T00:49:13.583Z (7 months ago)
- Language: HTML
- Size: 1020 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-red-contrib-mcu-m5units
Node-RED nodes to use M5Stack Units with Node-RED MCU.
## About
This package provides Node-RED nodes for integrating M5Stack Units with Node-RED MCU. It allows you to easily use various M5Stack sensors and modules within your Node-RED flows when using the MCU feature.
## Installation
Install via npm:
```bash
npm install node-red-contrib-mcu-m5units
```
Or install directly from the Node-RED palette manager.
## Features
- Simple integration of M5Stack Units with Node-RED
- Support for various M5Stack sensors and modules
- Easy-to-use node interface
- Full localization support
## Supported Units
- Joystick - Read analog joystick input (X, Y axes and button press)
## Usage
1. Install the package
2. Add the desired M5Stack unit node to your flow
3. Configure the node settings
4. Connect to other nodes in your flow
## Examples
Example flows are provided in the `examples/` directory.
## Project Structure
The project follows the structure recommended in the node creation guidelines:
```
node-red-contrib-mcu-m5units/
├── README.md # This document
├── package.json # Package settings
├── node/ # Node implementation directory
│ ├── / # Each M5Stack unit has its own folder
│ │ ├── .js # Runtime implementation
│ │ ├── .html # Editor UI definition
│ │ └── locales/ # i18n dictionaries
│ └── index.js # Entry point for registering all nodes
├── manifest.json # Required configuration for MCU nodes
└── examples/ # Sample flows (JSON)
```