Improve Node-RED scorecard

Author: Bre77

.changeset/stale-taxes-begin.md

@@ -0,0 +1,5 @@
+---
+"@teslemetry/node-red-contrib-teslemetry": patch
+---
+
+Improve Node-RED scorecard

packages/node-red-contrib-teslemetry/examples/all-features.json

@@ -0,0 +1,148 @@
+[
+  {
+    "id": "config1",
+    "type": "teslemetry-config",
+    "name": "My Teslemetry",
+    "token": ""
+  },
+  {
+    "id": "inject_vehicle",
+    "type": "inject",
+    "z": "tab1",
+    "name": "Wake Up",
+    "props": [
+      { "p": "payload" }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 100,
+    "y": 100,
+    "wires": [["vehicle_cmd"]]
+  },
+  {
+    "id": "vehicle_cmd",
+    "type": "teslemetry-vehicle-command",
+    "z": "tab1",
+    "name": "",
+    "teslemetryConfig": "config1",
+    "vin": "VIN1234567890",
+    "command": "wakeUp",
+    "x": 300,
+    "y": 100,
+    "wires": [["debug_vehicle"]]
+  },
+  {
+    "id": "debug_vehicle",
+    "type": "debug",
+    "z": "tab1",
+    "name": "Vehicle Result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "x": 500,
+    "y": 100,
+    "wires": []
+  },
+  {
+    "id": "inject_energy",
+    "type": "inject",
+    "z": "tab1",
+    "name": "Get Site Info",
+    "props": [
+      { "p": "payload" }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 100,
+    "y": 200,
+    "wires": [["energy_cmd"]]
+  },
+  {
+    "id": "energy_cmd",
+    "type": "teslemetry-energy-command",
+    "z": "tab1",
+    "name": "",
+    "teslemetryConfig": "config1",
+    "siteId": "12345",
+    "command": "getSiteInfo",
+    "x": 300,
+    "y": 200,
+    "wires": [["debug_energy"]]
+  },
+  {
+    "id": "debug_energy",
+    "type": "debug",
+    "z": "tab1",
+    "name": "Energy Result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "x": 500,
+    "y": 200,
+    "wires": []
+  },
+  {
+    "id": "event_node",
+    "type": "teslemetry-event",
+    "z": "tab1",
+    "name": "",
+    "teslemetryConfig": "config1",
+    "vin": "VIN1234567890",
+    "event": "all",
+    "x": 300,
+    "y": 300,
+    "wires": [["debug_event"]]
+  },
+  {
+    "id": "debug_event",
+    "type": "debug",
+    "z": "tab1",
+    "name": "Event Data",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "x": 500,
+    "y": 300,
+    "wires": []
+  },
+  {
+    "id": "signal_node",
+    "type": "teslemetry-signal",
+    "z": "tab1",
+    "name": "",
+    "teslemetryConfig": "config1",
+    "vin": "VIN1234567890",
+    "field": "Odometer",
+    "x": 300,
+    "y": 400,
+    "wires": [["debug_signal"]]
+  },
+  {
+    "id": "debug_signal",
+    "type": "debug",
+    "z": "tab1",
+    "name": "Signal Data",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "x": 500,
+    "y": 400,
+    "wires": []
+  }
+]

packages/node-red-contrib-teslemetry/package.json

@@ -3,6 +3,9 @@
   "version": "0.1.0",
   "description": "Node-RED integration for Teslemetry",
   "main": "dist/index.cjs",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsdown src/nodes/*.ts --out-dir dist/nodes --format cjs --clean --bundle && cp src/nodes/*.html dist/nodes/",
@@ -21,10 +24,18 @@
     "url": "https://teslemetry.com"
   },
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Teslemetry/node-red-contrib-teslemetry"
+  },
+  "bugs": {
+    "url": "https://github.com/Teslemetry/node-red-contrib-teslemetry/issues"
+  },
   "files": [
     "dist"
   ],
   "node-red": {
+    "version": ">=3.0.0",
     "nodes": {
       "teslemetry-config": "dist/nodes/teslemetry-config.cjs",
       "teslemetry-vehicle-command": "dist/nodes/teslemetry-vehicle-command.cjs",
@@ -38,8 +49,5 @@
     "@types/node-red": "^1.3.5",
     "node-red": "^4.1.1",
     "tsdown": "^0.16.7"
-  },
-  "dependencies": {
-    "packages": "link:.."
   }
 }

packages/node-red-contrib-teslemetry/src/nodes/teslemetry-energy-command.ts

@@ -1,5 +1,5 @@
 import { Node, NodeAPI, NodeDef, NodeMessageInFlow } from "node-red";
-import { Teslemetry } from "packages/api/dist/index.cjs";
+import { Teslemetry } from "@teslemetry/api";
 import { instances } from "../shared";
 import { validateParameters, ValidationRules } from "../validation";
 

packages/node-red-contrib-teslemetry/src/nodes/teslemetry-event.ts

@@ -1,5 +1,5 @@
 import { Node, NodeAPI, NodeDef } from "node-red";
-import { SseEvent, Teslemetry } from "packages/api/dist/index.cjs";
+import { SseEvent, Teslemetry } from "@teslemetry/api";
 import { instances } from "../shared";
 
 export interface TeslemetryEventNodeDef extends NodeDef {

packages/node-red-contrib-teslemetry/src/nodes/teslemetry-signal.ts

@@ -1,7 +1,7 @@
 import { Node, NodeAPI, NodeDef } from "node-red";
 import { TeslemetryConfigNode } from "./teslemetry-config";
 import { instances } from "../shared";
-import { Teslemetry } from "packages/api/dist/index.cjs";
+import { Teslemetry } from "@teslemetry/api";
 
 export interface TeslemetrySignalNodeDef extends NodeDef {
   teslemetryConfig: string;

packages/node-red-contrib-teslemetry/src/shared.ts

@@ -1,4 +1,4 @@
-import { Products, Teslemetry } from "packages/api/dist/index.cjs";
+import { Products, Teslemetry } from "@teslemetry/api";
 
 export type Instance = {
   teslemetry: Teslemetry;