@mcesystems/usb-device-listener 1.0.62 → 1.0.63

package/README.md

@@ -32,8 +32,20 @@ npm install
 
 ## Quick Start
 
+Examples below use `@mcesystems/tool-debug` for formatted logs.
+
 ```javascript
-import usbListener from 'usb-device-listener';
+import usbListener from "usb-device-listener";
+import {
+	logDataObject,
+	logErrorObject,
+	logHeader,
+	logNamespace,
+	setLogLevel
+} from "@mcesystems/tool-debug";
+
+logNamespace("usb");
+setLogLevel("debug");
 
 // Define configuration
 const config = {
@@ -50,31 +62,57 @@ const config = {
 	listenOnlyHubs: []
 };
 
-// Register event handlers
-usbListener.onDeviceAdd((device) => {
-	console.log('Device connected:', device.locationInfo);
-	console.log('VID:PID:', `${device.vid.toString(16)}:${device.pid.toString(16)}`);
-	console.log('Logical Port:', device.logicalPort);
-});
+function handleDeviceAdd(device) {
+	logDataObject("Device connected", {
+		locationInfo: device.locationInfo,
+		vid: device.vid.toString(16).toUpperCase().padStart(4, "0"),
+		pid: device.pid.toString(16).toUpperCase().padStart(4, "0"),
+		logicalPort: device.logicalPort ?? "<unmapped>"
+	});
+}
 
-usbListener.onDeviceRemove((device) => {
-	console.log('Device disconnected:', device.locationInfo);
-});
+function handleDeviceRemove(device) {
+	logDataObject("Device disconnected", {
+		locationInfo: device.locationInfo,
+		logicalPort: device.logicalPort ?? "<unmapped>"
+	});
+}
+
+// Register event handlers
+usbListener.onDeviceAdd(handleDeviceAdd);
+usbListener.onDeviceRemove(handleDeviceRemove);
 
 // Start listening
 try {
 	usbListener.startListening(config);
-	console.log('Listening for USB events...');
+	logHeader("Listening for USB events");
 } catch (error) {
-	console.error('Failed to start:', error.message);
+	logErrorObject(error, "Failed to start");
 }
 
 // Graceful shutdown
 process.on('SIGINT', () => {
+	logHeader("Stopping USB listener");
 	usbListener.stopListening();
 	process.exit(0);
 });
 ```
+Example output:
+```
+usb:info   ================================================================================
+usb:info                         Listening for USB events
+usb:info   ================================================================================
+usb:detail ================================================================================
+usb:detail                   *Device connected* handleDeviceAdd
+usb:detail ================================================================================
+usb:detail 
+usb:detail #  locationInfo: Port_#0005.Hub_#0002
+usb:detail #  vid: 04E8
+usb:detail #  pid: 6860
+usb:detail #  logicalPort: 1
+usb:detail 
+usb:detail ================================================================================
+```
 
 ## API Reference
 
@@ -134,10 +172,15 @@ Register callback for device connection events.
 
 **Example:**
 ```javascript
+import { logDataObject } from "@mcesystems/tool-debug";
+
 usbListener.onDeviceAdd((device) => {
-	const vidHex = device.vid.toString(16).toUpperCase().padStart(4, '0');
-	const pidHex = device.pid.toString(16).toUpperCase().padStart(4, '0');
-	console.log(`Device ${vidHex}:${pidHex} on port ${device.logicalPort || 'unmapped'}`);
+	const vidHex = device.vid.toString(16).toUpperCase().padStart(4, "0");
+	const pidHex = device.pid.toString(16).toUpperCase().padStart(4, "0");
+	logDataObject("Device connected", {
+		device: `${vidHex}:${pidHex}`,
+		port: device.logicalPort ?? "<unmapped>"
+	});
 });
 ```
 
@@ -147,8 +190,12 @@ Register callback for device disconnection events. Device info format same as `o
 
 **Example:**
 ```javascript
+import { logDataObject } from "@mcesystems/tool-debug";
+
 usbListener.onDeviceRemove((device) => {
-	console.log(`Port ${device.logicalPort} disconnected`);
+	logDataObject("Device disconnected", {
+		port: device.logicalPort ?? "<unmapped>"
+	});
 });
 ```
 
@@ -160,9 +207,15 @@ Get list of all currently connected USB devices.
 
 **Example:**
 ```javascript
+import { logDataObject } from "@mcesystems/tool-debug";
+
 const devices = usbListener.listDevices();
-devices.forEach(device => {
-	console.log(`${device.locationInfo}: VID=${device.vid.toString(16)}`);
+devices.forEach((device) => {
+	logDataObject("Device", {
+		locationInfo: device.locationInfo,
+		vid: device.vid.toString(16).toUpperCase().padStart(4, "0"),
+		pid: device.pid.toString(16).toUpperCase().padStart(4, "0")
+	});
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcesystems/usb-device-listener",
-  "version": "1.0.62",
+  "version": "1.0.63",
   "description": "Native cross-platform USB device listener for Windows and macOS",
   "main": "dist/index.js",
   "module": "dist/index.mjs",