From d7f7113a73f7255ad624875c4e42774be8b92980 Mon Sep 17 00:00:00 2001 From: Daniel BP Date: Thu, 15 Aug 2024 19:30:05 -0300 Subject: [PATCH] Node-RED messagens node --- docs/community/software/index.mdx | 1 + docs/community/software/node-red-messages.mdx | 37 +++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/community/software/node-red-messages.mdx diff --git a/docs/community/software/index.mdx b/docs/community/software/index.mdx index 0f5bdc1a..461bc405 100644 --- a/docs/community/software/index.mdx +++ b/docs/community/software/index.mdx @@ -12,6 +12,7 @@ Current community projects: - [Meshtasticator (Simulator)](/docs/community/software/community-meshtasticator) - Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software. - [Meshtastic Web API](/docs/community/software/meshtastic-web-api) - Meshtastic Web API provides a RESTful interface to interact with a Meshtastic node via a serial connection. - [Mesh-metrics](/docs/community/software/community-mesh-metrics) - Meshtastic repeater metrics scraper using meshtastic-cli to be ingested by node_exporter for use in Prometheus or Victoria Metrics Time series DB with a Grafana dashboard and sample alerting rules. +- [Node-RED Messages Node](/docs/community/software/community-node-red-messages) - Node-RED node to send and receive packets / text messages from a device connected via HTTP. Support for these projects should be sought from their respective authors. diff --git a/docs/community/software/node-red-messages.mdx b/docs/community/software/node-red-messages.mdx new file mode 100644 index 00000000..ded11af2 --- /dev/null +++ b/docs/community/software/node-red-messages.mdx @@ -0,0 +1,37 @@ +--- +id: community-node-red-messages +title: Node-RED Messages Node +sidebar_label: Node-RED Messages +sidebar_position: 4 +--- + +:::note + +This is a community project maintained by @danpeig. +Development can be followed on [GitHub](https://github.com/danpeig/node-red-meshtastic-msg). +Support should be sought from the respective authors. + +::: + +## Overview + +This [Node-RED](https://nodered.org) node allows sending and receiving packets to a Meshtastic mesh network thru a device connected via HTTP. +It is based on [Meshtastic.js](https://js.meshtastic.org/) library. + +## Features +- Send and receive text messages to/from any device in the mesh +- Supervise/monitor device status +- Subscribe and receive all types of events supported by [Meshtastic.js](https://js.meshtastic.org/) (examples: Atak, Position, Range Test, Map Report, Store and Forward, etc...) +- Send packets to any Meshtastic APP (port num) +- Plug and Play: no additional servers, no containers, no CLI, no binary files, super simple configuration +- Indirect support to MQTT via uplink/downlink channels + +## Limitations +- Connect directly to the MQTT server: this is not supported by [Meshtastic.js](https://js.meshtastic.org/) +- Connect to a device via Bluetooth or Serial (not implemented yet) + +## Instructions +For installation and usage instructions, please visit the project page at [GitHut](https://github.com/danpeig/node-red-meshtastic-msg). + +## Screenshot +![Node-RED Meshtastic Messages node](https://github.com/danpeig/node-red-meshtastic-msg/raw/main/resources/flow_example.png)