node-red-contrib-3dm-space 0.0.7 → 1.0.0

package/README.md

@@ -1,126 +1,53 @@
 # node-red-contrib-3dm-space
 
-Node-RED nodes for sending telemetry data to **3DM.space SCADA Cloud** and receiving cloud attribute commands.
+Node-RED nodes for connecting Smithtek PassPort gateways to **3DM.space SCADA Cloud**.
 
-This package is designed for Smithtek PassPort gateways and provides simple 3DM Cloud communication without exposing MQTT details to the user.
+This package is designed to make 3DM.space cloud communication simple for users. The cloud connection, formatting, timing, storage and recovery handling are managed inside the nodes.
 
-## Nodes Included
+Users only need to copy the device credentials from 3DM.space into Node-RED.
 
-### 3DM Cloud Login
+---
 
-Shared configuration node used by the 3DM input and output nodes.
+## What This Package Does
 
-The user only needs to enter:
+This package allows a PassPort gateway to:
 
-* Name
-* Username
-* Password
-* Optional Client ID
+- Send telemetry values to 3DM.space
+- Receive cloud commands or control updates from 3DM.space
+- Store telemetry locally if the cloud connection is unavailable
+- Automatically send stored telemetry when the connection returns
 
-Connection details are handled internally.
+---
 
-### 3DM Out
+## Nodes Included
 
-Sends JSON telemetry data to 3DM.space SCADA Cloud.
+### 3DM Cloud Login
 
-The node automatically:
+The shared login node used by the 3DM input and output nodes.
 
-* Adds a timestamp
-* Formats the payload for 3DM Cloud time-series data
-* Publishes to the correct cloud endpoint
-* Applies a publish rate limit
-* Stores messages locally if the cloud connection is offline
-* Replays stored messages when the connection returns
+The settings match the credential order shown in 3DM.space:
 
-Example input:
+1. **Client ID**
+2. **User Name***
+3. **Password**
+4. **Node Name**
 
-```json
-{
-  "pump_run": true,
-  "flow_lpm": 125.5,
-  "tank_level_percent": 64,
-  "dc_voltage": 24.1
-}
-```
+The **Node Name** is only used inside Node-RED to make the login easier to identify.
 
-### 3DM In
+---
 
-Receives cloud attribute updates from 3DM.space.
+### 3DM Out
 
-The node can:
+Sends telemetry data from Node-RED to 3DM.space.
 
-* Allow all incoming attributes through
-* Filter by a single key
-* Output the selected value only
-* Output an object containing the selected key and value
+The input must be a JSON object.
 
-Example cloud attribute:
+Example:
 
 ```json
 {
-  "pump_cmd": 1
+  "pump_run": true,
+  "flow_lpm": 125.5,
+  "tank_level_percent": 64,
+  "dc_voltage": 24.1
 }
-```
-
-## Store and Forward
-
-The 3DM Out node includes built-in store and forward.
-
-If the cloud connection is lost, valid telemetry messages are stored locally using a persistent queue. Each message is timestamped when it arrives at the node, not when it is replayed.
-
-When the cloud connection returns, stored messages are replayed automatically.
-
-Default replay speed:
-
-```text
-250 ms per packet
-```
-
-This equals approximately:
-
-```text
-4 packets per second
-```
-
-## Rate Limiting
-
-The 3DM Out node includes a live publish throttle to prevent users from publishing too quickly.
-
-Default live publish limit:
-
-```text
-1 message every 10 seconds
-```
-
-If valid telemetry arrives faster than the live publish limit, it is queued rather than discarded.
-
-
-## Installation
-
-From the Node-RED user directory:
-
-```bash
-cd ~/.node-red
-npm install ./node-red-contrib-3dm-space
-```
-
-Or from inside the development folder:
-
-```bash
-cd ~/.node-red/node-red-contrib-3dm-space
-npm install
-```
-
-Restart Node-RED after installation:
-
-```bash
-node-red-restart
-```
-
-## License
-
-GPL-3.0-or-later
-
-## Author
-
-Smithtek

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "node-red-contrib-3dm-space",
-  "version": "0.0.7",
+  "version": "1.0.0",
   "description": "Node-RED nodes for 3DM.space SCADA Cloud telemetry and attributes",
   "main": "3dm-cloud-config.js",
   "license": "GPL-3.0-or-later",
   "keywords": [
     "node-red",
+    "node-red-contrib",
     "3dm",
     "3dm.space",
+    "smithtek",
     "scada",
     "telemetry",
     "store-and-forward"
@@ -20,7 +22,9 @@
     }
   },
   "dependencies": {
-    "mqtt": "~4.3.7",
+    "mqtt": "~4.3.7"
+  },
+  "optionalDependencies": {
     "node-persistent-queue": "^0.3.1"
   }
 }