iosignal-cli 1.0.0 → 1.1.0

package/README.md

@@ -13,7 +13,9 @@ $ npm install -g iosignal-cli
 
 # If NO Permissioin error, use sudo prefix.
 $ sudo npm install -g iosignal-cli
+
 ```
+
 windows as admin permission
 ```sh
 # global install.
@@ -28,10 +30,40 @@ $ io-server
 # start server with default option.
 # default. open port 7777 with WebSocket. 
 
+   ┌─────────────────────────────────────────┐
+                                            
+      WebSocket: Browser or nodejs client   
+                                            
+      - Local:    ws://localhost:7777       
+      - Network:  ws://192.168.0.204:7777   
+                                            
+   └─────────────────────────────────────────┘
+
 
 $ io-server -l 5555 
 # you can specify listen port number
 
+   ┌───────────────────────────────────────────┐
+                                              
+      WebSocket: Browser or nodejs client     
+                                              
+      - Local:    ws://localhost:5555         
+      - Network:  ws://192.168.0.204:5555     
+                                              
+      CongSocket: nodejs client or CLI        
+                                              
+      - Local:    cong://localhost:8888       
+      - Network:  cong://192.168.0.204:8888   
+                                              
+      CongSocket: Arduino client              
+                                              
+      - host: 192.168.0.204                   
+      - port: 8888                            
+                                              
+   └───────────────────────────────────────────┘
+
+
+
 $ io-server -l 0 -L 5555
 # use number 0 to disable WebSocket service.
 
@@ -41,7 +73,8 @@ $ io-server -l 0 -L 5555
 
 
 ```sh
-$ io # or io alias
+$ io 
+# io is an alias name of io-clinet
 # connect to localhost:7777 with websocket.
 
 # use -c to define websocket url and port number.

package/bin/io-server.js

@@ -1,12 +1,15 @@
 #!/usr/bin/env node
 
+import { createClient } from 'redis';
+import { program } from 'commander'
+import { version } from './getVersion.js'
+import { serverInfo } from './serverInfo.js';
 import {
   Server, serverOption, Auth_File, Auth_Env, Auth_Redis,
   api_reply, api_sudo, RedisAPI
 } from 'iosignal'
-import { createClient } from 'redis';
-import { program } from 'commander'
-import { version } from './getVersion.js'
+
+
 
 program
   .version(version)
@@ -95,5 +98,4 @@ if (options.showOptions) {
   console.log('server api list', server.apiNames)
 }
 
-
-
+console.log( serverInfo( serverOption.port , serverOption.congPort ))

package/bin/serverInfo.js

@@ -0,0 +1,48 @@
+import { networkInterfaces as getNetworkInterfaces } from 'node:os';
+const networkInterfaces = getNetworkInterfaces();
+import chalk from 'chalk';
+import boxen from 'boxen';
+
+
+function getNetworkAddress (){
+    for (const interfaceDetails of Object.values(networkInterfaces)) {
+      if (!interfaceDetails) continue;
+  
+      for (const details of interfaceDetails) {
+        const { address, family, internal } = details;
+  
+        if (family === 'IPv4' && !internal) return address;
+      }
+    }
+  };
+
+
+export function serverInfo ( wsPort, congPort ){
+    let ip = getNetworkAddress();
+    let message = chalk.green('WebSocket: Browser or nodejs client');
+
+    const prefix = '- '
+    const space = '    '
+
+    message += `\n\n${chalk.bold(`${prefix}Local:`)}${space}ws://localhost:${wsPort}`;
+    message += `\n${chalk.bold('- Network:')}  ws://${ip}:${wsPort}`;
+
+    if(congPort){
+        message += `\n\n`;
+        message += chalk.green('CongSocket: nodejs client or CLI');
+        message += `\n\n${chalk.bold(`${prefix}Local:`)}${space}cong://localhost:${congPort}`;
+        message += `\n${chalk.bold('- Network:')}  cong://${ip}:${congPort}`;
+
+        message += `\n\n`;
+        message += chalk.green('CongSocket: Arduino client');
+        message += `\n\n${chalk.bold(`${prefix}host:`)} ${ip}`;
+        message += `\n${chalk.bold('- port:')} ${congPort }`;
+
+    }
+
+    return boxen(message, { padding: 1, borderColor: 'green', margin: 1, })
+
+}
+
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iosignal-cli",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "IOSignal server and client CLI program.",
   "type": "module",
   "bin": {
@@ -16,18 +16,26 @@
   },
   "license": "MIT",
   "dependencies": {
+    "boxen": "^7.1.1",
+    "chalk": "^5.3.0",
     "commander": "^11.1.0",
     "iosignal": "^1.0.0",
     "meta-buffer-pack": "^1.3.1",
     "redis": "^4.6.12"
-  }
-  ,
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/remocons/iosignal-cli.git"
   },
   "homepage": "https://iosignal.net",
   "keywords": [
-    "io","pubsub","arduino","iot","auth","signal","CLI","remocon"
+    "io",
+    "pubsub",
+    "arduino",
+    "iot",
+    "auth",
+    "signal",
+    "CLI",
+    "remocon"
   ]
 }