iosignal-cli 1.1.0 → 1.3.0

package/README.md

@@ -1,96 +1,264 @@
 # IOSignal CLI
 
+iosignal supports real-time communication between web browsers, node.js, and arduino. It also provides secure authentication and encrypted communication. The signaling protocol is built-in, so the server can be used without programming.
+
 iosignal-cli program that makes it simple to run a iosignal server and client. It uses the [iosignal](https://www.npmjs.com/package/iosignal)  library and uses Redis for authentication database functionality.
 
+[Kr] iosignal 은 웹브라우저, node.js , arduino 간의 실시간 통신을 지원합니다. 또한 보안 인증과 암호통신 기능도 제공됩니다. 시그널링 프로토콜이 내장되어 있어서 서버는 프로그래밍 없이 사용 가능합니다.
+
 ## supports 
+
 Windows, Mac, and Linux.
 
 ## install
+
 Linux, Mac and shell
+
 ```sh
 # global install.
 $ npm install -g iosignal-cli
 
-# If NO Permissioin error, use sudo prefix.
+# If you encounter a permissions error, use sudo.
 $ sudo npm install -g iosignal-cli
-
 ```
-
 windows as admin permission
 ```sh
 # global install.
 $ npm install -g iosignal-cli
 ```
 
-
 ## IOSignal server
 
+- use `io-server` command.
+- `ios` is a shortened name for io-server.
+
+```
+% io-server -h
+Usage: io-server [options] (--listen <port> )
+
+Options:
+  -V, --version                      output the version number
+  -l, --listen <port>                listen on port (start WebSocket Server)
+  -L, --listen-congport <port>       listen on cong port (start CongSocket
+                                     Server)
+  -d, --auth-file <path>             auth data file path
+  -e, --auth-param <id.key.level>    auth data from argument:
+                                     id.key.level,id2.key2.level2
+  -E, --auth-env                     auth data from shell env BOHO_AUTH
+  -r, --auth-redis                   connect to redis. if exist use env
+                                     REDIS_HOST, REDIS_PORT or localhost:6379
+  -t, --timeout <milliseconds>       ping period & timeout
+  -m, --metric <type>                show metric <number> 1:traffic, 2:echo
+  -s, --show-message <none|message>  show receive message.
+  -f, --file-logger                  write log files.
+  -a, --api-list [list...]           one or multiple api names:  -a api_1 api_2
+  -o, --show-options                 show server init options.
+  -h, --help                         display help for command
+
+```
+
+### IOSignal over WebSocket
+
+- Use the -l option to specify the port number for websocket connections.
+
+- Supports web browser and node.js client access.
+
+```sh
+ % io-server -l 7777
+```
+
+### IOSignal Over CongSocket
+
+- Use the -L option to specify the port number for CongSocket connections.
+- CongSocket is IOSignal's own protocol that is lighter than WebSocket. 
+- It was developed specifically for low-end devices like Arduino.
+- Supports Arduino and node.js client access.
+
 ```sh
-$ io-server
-# start server with default option.
-# default. open port 7777 with WebSocket. 
+ % io-server -L 8888
+```
+
+### WebSocket and CongSocket can be supported together.
 
-   ┌─────────────────────────────────────────┐
-                                            
-      WebSocket: Browser or nodejs client   
-                                            
-      - Local:    ws://localhost:7777       
-      - Network:  ws://192.168.0.204:7777   
-                                            
-   └─────────────────────────────────────────┘
+- This allows the Arduino and web browser to communicate with each other.
 
 
-$ io-server -l 5555 
-# you can specify listen port number
+```sh
+% io-server -l 7777 -L 8888
+opening WebSocket Server: 7777
+opening CongSocket Server: 8888
 
    ┌───────────────────────────────────────────┐
-                                              
-      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                            
-                                              
+   │                                           │
+   │   Serving                                 │
+   │                                           │
+   │   IOSignal Over WebSocket                 │
+   │                                           │
+   │    Web Browser & Node.js                  │
+   │    - Local:    ws://localhost:7777        │
+   │    - Network:  ws://192.168.0.72:7777     │
+   │                                           │
+   │   IOSignal Over CongSocket                │
+   │                                           │
+   │    Node.js                                │
+   │    - Local:    cong://localhost:8888      │
+   │    - Network:  cong://192.168.0.72:8888   │
+   │                                           │
+   │    Arduino                                │
+   │    - host: 192.168.0.72                   │
+   │    - port: 8888                           │
+   │                                           │
    └───────────────────────────────────────────┘
 
 
 
-$ io-server -l 0 -L 5555
-# use number 0 to disable WebSocket service.
+```
+
+## Monitor Server
+
+### Viewing incoming messages
+
+- To view server incoming signal messages, use the -s option.
+- `ios` is a shortened name for `io-server`.
 
+```
+% ios -l 7777 -s message 
+... 
+
+#1(undefined) [ CID_REQ ] <Buffer c1>
+#1(?ayTp) [ SIGNAL ] <Buffer d0 02 68 69 00>
+#1(?ayTp) [ PING ] <Buffer cd>
+
+```
+
+### Viewing metrics
+
+- `-m 1` : channels, clients, traffic
+- `-m 2` : clients
+- `-m 3` : channels
+
+```sh
+
+$ ios -l 7777 -m 1
+...
+
+monitor metric type: 1
+┌─────────┬───────────┬───────────┬──────────┬──────────┬──────────────┐
+│ (index) │    rss    │ heapTotal │ heapUsed │ external │ arrayBuffers │
+├─────────┼───────────┼───────────┼──────────┼──────────┼──────────────┤
+│    0    │ 108232704 │ 57294848  │ 24523112 │ 1389925  │    59260     │
+└─────────┴───────────┴───────────┴──────────┴──────────┴──────────────┘
+┌─────────┬──────────┬─────────┬──────────┬─────────┬─────────┐
+│ (index) │ lastSSID │ remotes │ channels │ txBytes │ rxBytes │
+├─────────┼──────────┼─────────┼──────────┼─────────┼─────────┤
+│    0    │    2     │    2    │    1     │   57    │   18    │
+└─────────┴──────────┴─────────┴──────────┴─────────┴─────────┘
+
+
+$ ios -l 7777 -m 2
+...
+monitor metric type: 2
+┌─────────┬───────────────┐
+│ (index) │    Values     │
+├─────────┼───────────────┤
+│    0    │ '#1:?9P-i(7)' │
+│    1    │ '#2:?zNuW(7)' │
+└─────────┴───────────────┘
+
+
+$ ios -l 7777 -m 3
+...
+monitor metric type: 3
+┌─────────┬───────────────────────┐
+│ (index) │        Values         │
+├─────────┼───────────────────────┤
+│    0    │ 'PRIVATE:#homeButton' │
+└─────────┴───────────────────────┘
 ```
 
 ## iosignal client
 
+- use `io-client` command.
+- `io` is a shortened name for io-client.
+
+### usage
+
+```
+ % io -h
+Usage: io [options] (--connect <url> )
+
+Options:
+  -V, --version                     output the version number
+  -t, --timeout <milliseconds>      ping period & timeout
+  -c, --connect <url>               connect to a server
+  -i, --id <id>                     userId
+  -k, --key <key>                   userKey
+  -a, --auth-idKey <idkey>          auth id.key
+  -j, --join-channel <channelName>  join to channel
+  -h, --help                        display help for command
+
+```
+
+### connection
+- To connect to a server, specify the server address and port number with the -c option.
+
+- The server address specifies one of the following protocols:  ws, wss, or cong.
+- `ws`://url:port (WebSocket)
+- In the case of localhost, ws can be omitted. 
+- `wss`://url:port (WebSocket TLS)
+- `cong`://url:port ( CongSocket) 
 
 ```sh
-$ io 
-# io is an alias name of io-clinet
-# connect to localhost:7777 with websocket.
+% io -c ws://localhost:7777
+{ connect: 'ws://localhost:7777' }
+Connecting to ws://localhost:7777
+ready:  cid: ?cybL
+> 
 
-# use -c to define websocket url and port number.
-$ io -c wss://websocket_server_url:port
-$ io -c ws://localhost:7777
+```
 
-# support ws or wss(TLS).
+```sh
+% io -c cong://localhost:8888
+{ connect: 'cong://localhost:8888' }
+Connecting to cong://localhost:8888
+ready:  cid: ?yVAQ
+> 
 
 ```
 
-## iosignal commands
+- On successful client connection, the `cid` is displayed with a `ready` indication.
+- The CID is a unique communication ID issued by the server.
+- The CID of an unauthenticated client changes with each connection.
+- Authenticated clients use a fixed, predefined CID.
+- You can use CIDs for one-to-one communication or CID subscriptions.
+
+
+### io-client cli command list
+
+- When connected to the server with the io-client CLI program, you can communicate, subscribe, and issue signals with the commands below.
+- The CLI program can also communicate with browsers and Arduino connected to the server.
+
+```
+io-client cli commands: 
+ .sig
+ .signal .publish .pub is the same as .sig.
+ .sub 
+ .subscribe is the same as .sub. 
+ .listen : subscirbe and print the received messages to the screen.
+ .unsub 
+ .ping 
+ .pong 
+ .id 
+ .iam 
+ .open 
+ .connect 
+ .close 
+ .login 
+ .auth 
+ .quit 
+ .exit
+```
 
-- subscribe('tag')
-- publish('tag', message ) 
-- signal('tag', message )  // same with publish
-- not ready whole document.
 
 ## tutorial 
 
@@ -101,18 +269,16 @@ $ io -c ws://localhost:7777
 
 1. start server
 ```sh
-$ io-server  # alias ios
+$ io-server -l 7777
 
 ```
 
 2. start client A.
 
 ```sh
-$ io
+$ io -c localhost:7777
 Connecting to ws://localhost:7777
 ready:  cid: ?c3Nr 
-# connected and receive client cid.
-# CID(Communicaion Id of the io client.)
 
 > .subscribe channel_name  
 # subscribe some channel
@@ -120,12 +286,10 @@ ready:  cid: ?c3Nr
 
 3. start client B.
 ```sh
-$ io
+$ io -c localhost:7777
 Connecting to ws://localhost:7777
 ready:  cid: ?rr75
 > 
-# connected and received cid.
-
 # multicast.
 > .signal channel_name some_message   
 
@@ -144,9 +308,9 @@ ready:  cid: ?rr75
 - each device have 4 values: `deviceId`, `deviceKey`, `deviceCId`, `level`
 - you can find sample auth_file.mjs and auth_file.json in root folder.
 ```sh
-$ io-server -d auth_file.json
+$ io-server -l 7777 -d auth_file.json
    or
-$ io-server -d auth_file.mjs
+$ io-server -l 7777 -d auth_file.mjs
 ```
 
 auth_file.json structure
@@ -188,7 +352,7 @@ Before running the server, you need to make sure that your Redis server is up an
 
 start server with local redis-auth-system
 ```sh
-$ io-server -r   //  redis://localhost:6379
+$ io-server -l 7777 -r   # redis://localhost:6379
 ```
 
 
@@ -197,7 +361,7 @@ $ io-server -r   //  redis://localhost:6379
 2. connect and login
 
 ```sh
-$ io
+$ io -c localhost:7777
 ready:  cid: ?YXDr
 > .login uno3 uno3-key
 try manual login:  uno3

package/bin/io-client.js

@@ -95,7 +95,6 @@ program
   .version(version)
   .usage('[options] (--connect <url> )')
   .option('-t, --timeout <milliseconds>', 'ping period & timeout')
-  .option('-s, --show-message <none|message|frame>', 'show receive message. ')
   .option('-c, --connect <url>', 'connect to a server')
   .option('-i, --id <id>', 'userId')
   .option('-k, --key <key>', 'userKey')
@@ -104,12 +103,12 @@ program
   .parse(process.argv)
 
 const options = program.opts()
+const defaultWebSocketPort = 7777;
 
 console.log(options)
 
-
 if (!options.connect) {
-  options.connect = 'localhost:' + serverOption.port;
+  options.connect = 'localhost:' + defaultWebSocketPort;
 }
 
 
@@ -389,6 +388,7 @@ wsConsole.on('line', (data) => {
         )
     }
   } else {
+    io.send( data )
   }
   wsConsole.prompt()
 })

package/bin/io-server.js

@@ -22,7 +22,7 @@ program
   .option('-r, --auth-redis', 'connect to redis. if exist use env REDIS_HOST, REDIS_PORT or localhost:6379')
   .option('-t, --timeout <milliseconds>', 'ping period & timeout')
   .option('-m, --metric <type>', 'show metric <number> 1:traffic, 2:echo')
-  .option('-s, --show-message <none|message|frame>', 'show receive message. ')
+  .option('-s, --show-message <none|message>', 'show receive message. ')
   .option('-f, --file-logger', 'write log files.')
   .option('-a, --api-list [list...]', 'one or multiple api names:  -a api_1 api_2 ')
   .option('-o, --show-options', 'show server init options.')
@@ -30,7 +30,6 @@ program
 
 const options = program.opts()
 
-
 if (options.fileLogger) {
   serverOption.fileLogger.connection.use = true;
   serverOption.fileLogger.auth.use = true;
@@ -38,7 +37,7 @@ if (options.fileLogger) {
 }
 
 if (options.listen) {
-  serverOption.port = options.listen
+  serverOption.port = parseInt(options.listen)
 }
 
 if (options.listenCongport) {
@@ -77,7 +76,7 @@ if (options.authFile) {
   redisClient.connect();
   authManager = new Auth_Redis(redisClient)
 } else {
-  console.log("No authentication support.")
+  // console.log("No authentication support.")
 
 }
 

package/bin/serverInfo.js

@@ -18,25 +18,48 @@ function getNetworkAddress (){
 
 
 export function serverInfo ( wsPort, congPort ){
+  // console.log('wsPort', wsPort, 'congPort', congPort)
     let ip = getNetworkAddress();
-    let message = chalk.green('WebSocket: Browser or nodejs client');
+    let message
+    
+    if( wsPort || congPort ){
+      message = chalk.green('Serving');
+    }else{
+      message = chalk.green('please use -l and -L option to select port number.');
+      message += chalk.yellow('\n\n $ io-server -l 7777');
+      message += chalk.green('  // iosignal over websocket.');
+      message += chalk.yellow('\n\n $ io-server -L 8888');
+      message += chalk.green('  // iosignal over congsocket.');
+      message += chalk.yellow('\n\n $ io-server -l 7777 -L 8888');
+      message += chalk.green('  // suppport both.');
+      message += chalk.yellow('\n\n $ io-server -h');
+      message += chalk.green('  // display help');
+    }
 
     const prefix = '- '
     const space = '    '
 
-    message += `\n\n${chalk.bold(`${prefix}Local:`)}${space}ws://localhost:${wsPort}`;
-    message += `\n${chalk.bold('- Network:')}  ws://${ip}:${wsPort}`;
+    if(wsPort){
+      message += `\n\n`;
+      message += chalk.green('IOSignal Over WebSocket');
+      message += chalk.yellow('\n\n Web Browser & Node.js');
+      message += `\n ${chalk.bold(`${prefix}Local:`)}${space}ws://localhost:${wsPort}`;
+      message += `\n ${chalk.bold('- Network:')}  ws://${ip}:${wsPort}`;
+    }else{
+
+    }
 
     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 += chalk.green('IOSignal Over CongSocket');
+        message += chalk.yellow('\n\n Node.js');
 
-        message += `\n\n`;
-        message += chalk.green('CongSocket: Arduino client');
-        message += `\n\n${chalk.bold(`${prefix}host:`)} ${ip}`;
-        message += `\n${chalk.bold('- port:')} ${congPort }`;
+        message += `\n ${chalk.bold(`${prefix}Local:`)}${space}cong://localhost:${congPort}`;
+        message += `\n ${chalk.bold('- Network:')}  cong://${ip}:${congPort}`;
+        
+        message += chalk.yellow('\n\n Arduino');
+        message += `\n ${chalk.bold(`${prefix}host:`)} ${ip}`;
+        message += `\n ${chalk.bold('- port:')} ${congPort }`;
 
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iosignal-cli",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "IOSignal server and client CLI program.",
   "type": "module",
   "bin": {
@@ -19,7 +19,7 @@
     "boxen": "^7.1.1",
     "chalk": "^5.3.0",
     "commander": "^11.1.0",
-    "iosignal": "^1.0.0",
+    "iosignal": "^1.3.1",
     "meta-buffer-pack": "^1.3.1",
     "redis": "^4.6.12"
   },