mesh-tools 1.0.0 → 1.0.1

package/README.md

@@ -1,35 +1,39 @@
 # Mesh-Tools
 
-This is a packer made for the Meshtastic Project. I am not affiliated with Meshtastic or sponsored. This project is just for fun. [Meshtastic](https://meshtastic.org)
+This is a package made for use with the Meshtastic Project. I am not affiliated with or sponsored by Meshtastic. This project is just for fun. [Meshtastic](https://meshtastic.org)
 
-## Documentation
+This package is currently deployed to npm! 
+
+### Download: [Mesh Tools NPM](https://www.npmjs.com/package/mesh-tools)
 
-Here is the table of contents to the documentation;
+Use `npm i mesh-tools` to use in your project!
+
+## Documentation
 
-[Table Of Contents](/docs/table-of-contents.md)
+[Documentation](https://github.com/JStudios6118/Mesh-Tools/blob/main/docs/table-of-contents.md)
 
 ## What this package does #
 This package is meant to abstract the functions of the meshtastic node.js cli package. It is meant to make the developement of programs that interact with the mesh network easier and more efficient.
 
-This is a side project so don't expect this to always be up to date but I'll do my best.
+This is a side project so don't expect this to always be up to date but I'll try my best.
 
-It can easily handle connecting to nodes, detecting when someone has dmed you, sending dms, sending on channels, receiving on channels and more. All of the stuff you would ever want.
+It can easily handle connecting to nodes, detect when someone has dmed you, sending dms, sending on channels, receiving on channels and more. All of the stuff you would ever want. It can even manage an optional Database of Nodes and store custom data for each node.
 
 ## How it works
 
-I tried my best to abstract all of the features that are unnecessary to the average user. The package has been designed around making bots for Meshtastic.
+I tried my best to abstract many of the Meshtastic CLI's functions.
 
 Here is all of the code needed to connect to your node. It is much shorter than what would be needed if you were not using my package.
 ```js
-// Import the package (not on npm yet)
-const MeshTools = require('mesh-tools')
+// Import the package. Install with npm i mesh-tools
+const MeshTools = require('mesh-tools');
 // Define the port your node is on over serial
 const node = new MeshTools.SerialNode('/dev/ttyACM1');
 // Connect the node to your computer
 node.connect()
 ```
 
-If for instance you wanted to listen for direct messages to your node, it is as easy as this chunk of code.
+If you wanted to listen for a direct messages to your node, it is as easy as this chunk of code.
 
 ```js
 // Connect to the receiveDm event
@@ -47,4 +51,4 @@ I made this because I was annoyed at how difficult it was to work with the nodej
 
 Thanks for checking this out! Please give it a star :)
 
--JStudios6118
+-JStudios6118

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mesh-tools",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A helpful package for automating the Meshtastic node api",
   "license": "ISC",
   "author": "Josh Carlson",
@@ -9,7 +9,9 @@
   "scripts": {
     "test": "node test.js"
   },
-  "engines": { "node": ">=18.0.0" },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
     "@meshtastic/core": "^2.6.7",
     "@meshtastic/transport-http": "^0.2.5",
@@ -27,10 +29,11 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/JStudios6118/Mesh-Tools"
+    "url": "git+https://github.com/JStudios6118/Mesh-Tools.git"
   },
   "homepage": "https://github.com/JStudios6118/Mesh-Tools#readme",
   "bugs": "https://github.com/JStudios6118/Mesh-Tools/issues",
-  "files": ["src"]
-  
-}
+  "files": [
+    "src"
+  ]
+}

package/src/index.js

@@ -16,15 +16,16 @@ const path = require('path');
 
 TODO:
 -ADD MESSAGE ACKNOWLEDGEMENT HANDLING
--ADD TCP AND HTTP CONNECTION TYPES
 -MAKE EVERYTHING ASYNCHRONOUS
 -ADD LOG LEVELS
--ADD SUPPORT FOR DIFFERENT PACKET TYPES LIKE TELEMETRY AND ETC
+-ADD SUPPORT FOR MORE PACKET TYPES LIKE TELEMETRY AND ETC
 -ADD PROPER JSDOC DOCUMENTATION FOR AUTOFILL AND SUCH
+-ADD PROPER ERROR HANDLING FOR ALL FUNCTIONS
 
 DONE:
 -ADD BROADCAST MESSAGING
 -ADD A NODE DATABASE BUILDER
+-ADD TCP AND HTTP CONNECTION TYPES
 
 */
 
@@ -177,6 +178,18 @@ class NodeDB {
         return true;
     }
 
+    async updateLastHeard(identifier){
+        if (this.#db === null) { this.#logger.log("Database has not been initialized yet!"); return false }
+        
+        const index = this.#checkId(identifier);
+        if (index === -1) { this.#logger.log("Node not found!"); return false }
+
+        this.#dbData.nodes[index].lastHeard = Math.floor(Date.now() / 1000);
+
+        await this.#db.write;
+        return true;
+    }
+
 }
 
 // Node class for NodeDB