docs: update README hogeun

5FNSaaS · Oct 6, 2021 · f47961c · f47961c
1 parent 4719be3
commit f47961c
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -1,20 +1,20 @@
 # Motion Pose Node
 
-This module provides a set of nodes of a node-RED for recognizing body poses and hands poses.
+This module provides a set of nodes of node-RED for recognizing body poses and hands poses.
 
 Use MediaPipe's BlazePose and Hands to track and visualize body and hands poses.
 
-In this module, the type of camera device for recognizing poses is separated into webcam/external camera devices.
+In this module, the type of camera device for recognizing poses is separated into a webcam or external camera devices which support Samsung Smartthings.
 
 Certain poses can be saved through the 'Pose/Hand Register' node, and the 'Pose/Hand Find' node can determine similarity with other poses.
 
-Various devices are generally controlled by touch and voice, but the type of control may be limited in special circumstances. There are also users who cannot freely use this control method.
+Various devices are generally controlled by touch and voice, but the type of control may be limited in certain circumstances. There are also users who cannot freely use these control methods.
 
 This node was developed to solve the problems described above by presenting a new direction of "motion recognition" to Node-RED.
 
 Furthermore, by using the node of "5FNSaaS", you will be able to develop a flow of various services that utilize body information.
 
-Due to the nature of Node-RED, which is flow development for node-based visual programming, we wrote the code with the aim of freely customizing by developers.
+Due to the nature of Node-RED, which is a flow development for node-based visual programming, we wrote the code with the aim of freely customizing by developers.
 
 These nodes require Node.js version 14.17.0 and Node-RED 2.0.6.
 

diff --git a/body/pose-detection-iotcam/README.md b/body/pose-detection-iotcam/README.md
@@ -1,6 +1,10 @@
 # pose-detection-iotcam
 
-A simple node that recognizes and visualizes pose using a external camera device.
+A simple node that recognizes and visualizes pose using a external camera device which support Samsung Smartthings.
+
+## Pre-requisites
+
+The pose-detection-iotcam node requires [FFmpeg](https://ffmpeg.org/) to be installed. This node uses FFmpeg to receive rtsp streaming data and display it to the screen.
 
 ## Usage
 
@@ -16,19 +20,27 @@ Specify a pose to save and press the capture button to record the pose model at
 
 ### Server Url
 
-URL address of your websocket server. Server receives the user's pose recognition result in real time using a WebSocket. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments.
+URL address of your websocket server for monitoring and receiving streaming data from the camera. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments. (default: 'localhost')
+
+### Monitor Port
 
-### Mirror Port
+Port number to be used to monitor pose recognition results from other resources. To use properly, you need to match this value with `Monitor Port` attribute of [the monitor node](https://github.com/5FNSaaS/node-red-contrib-motion-pose/tree/master/monitor). (default: 1882)
 
-Port number to be used to monitor pose recognition results from other resources. (default: 1881)
+### Rtsp Port
+
+Port number to be used to receive streaming data from your Samsung Smartthings camera device. (default: 1886)
 
 ### Data Socket Url
 
-Specify the URI including the endpoint when communicating data using the WebSocket. (default: 'ws://localhost:1880/ws/data')
+Specify the URL including the endpoint to receive the user's pose recognition result data in real time using a WebSocket. (default: 'ws://localhost:1880/ws/data')
+
+### Smartthings MNID
+
+Your MNID to get access to your Samsung Smartthings camera device. You can check your MNID on [this page](https://smartthings.developer.samsung.com/partner/dashboard).
 
-### Camera Test
+### Smartthings PAT
 
-You can check the camera screen in advance in the node attribute.
+Your PAT to get access to your Samsung Smartthings camera device. You can generate a PAT on [this page](https://account.smartthings.com/login?redirect=https%3A%2F%2Faccount.smartthings.com%2Ftokens).
 
 ## Example
 
@@ -53,7 +65,7 @@ This is an example of a JSON string of data from a browser through a websocket.
       "z": -0.4486660063266754,
       "visibility": 0.9999632239341736
     },
-    // ...
+    // ... 33 landmarks
   ],
   "poseWorldLandmarks": [
     {
@@ -68,7 +80,7 @@ This is an example of a JSON string of data from a browser through a websocket.
       "z": -0.21838122606277466,
       "visibility": 0.9999632239341736
     },
-    // ...
+    // ... 33 landmarks
   ],
   "segmentationMask": {},
   "regist": true,

diff --git a/body/pose-detection-webcam/README.md b/body/pose-detection-webcam/README.md
@@ -16,11 +16,11 @@ Specify a pose to save and press the capture button to record the pose model at
 
 ### Server Url
 
-URL address of your websocket server. Server receives the user's pose recognition result in real time using a WebSocket. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments.
+URL address of your websocket server for monitoring. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments. (default: 'localhost')
 
-### Mirror Port
+### Monitor Port
 
-Port number to be used to monitor pose recognition results from other resources. (default: 1881)
+Port number to be used to monitor pose recognition results from other resources. To use properly, you need to match this value with `Monitor Port` attribute of [the monitor node](https://github.com/5FNSaaS/node-red-contrib-motion-pose/tree/master/monitor). (default: 1881)
 
 ### Data Socket Url
 

diff --git a/hand/hand-detection-iotcam/README.md b/hand/hand-detection-iotcam/README.md
@@ -1,6 +1,10 @@
-# hand-detection-webcam
+# hand-detection-iotcam
 
-A simple node that recognizes and visualizes hand using a webcam.
+A simple node that recognizes and visualizes hand using a external camera device which support Samsung Smartthings.
+
+## Pre-requisites
+
+The hand-detection-iotcam node requires [FFmpeg](https://ffmpeg.org/) to be installed. This node uses FFmpeg to receive rtsp streaming data and display it to the screen.
 
 ## Usage
 
@@ -16,19 +20,27 @@ Specify the hands pose to save and press the capture button to record the pose m
 
 ### Server Url
 
-URL address of your websocket server. Server receives the user's hands pose recognition result in real time using a WebSocket. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments.
+URL address of your websocket server for monitoring and receiving streaming data from the camera. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments. (default: 'localhost')
+
+### Monitor Port
 
-### Mirror Port
+Port number to be used to monitor pose recognition results from other resources. To use properly, you need to match this value with `Monitor Port` attribute of [the monitor node](https://github.com/5FNSaaS/node-red-contrib-motion-pose/tree/master/monitor). (default: 1884)
 
-Port number to be used to monitor hands pose recognition results from other resources. (default: 1881)
+### Rtsp Port
+
+Port number to be used to receive streaming data from your Samsung Smartthings camera device. (default: 1886)
 
 ### Data Socket Url
 
-Specify the URI including the endpoint when communicating data using the WebSocket. (default: 'ws://localhost:1880/ws/data')
+Specify the URL including the endpoint to receive the user's pose recognition result data in real time using a WebSocket. (default: 'ws://localhost:1880/ws/data')
+
+### Smartthings MNID
+
+Your MNID to get access to your Samsung Smartthings camera device. You can check your MNID on [this page](https://smartthings.developer.samsung.com/partner/dashboard).
 
-### Camera Test
+### Smartthings PAT
 
-You can check the webcam screen in advance in the node attribute.
+Your PAT to get access to your Samsung Smartthings camera device. You can generate a PAT on [this page](https://account.smartthings.com/login?redirect=https%3A%2F%2Faccount.smartthings.com%2Ftokens).
 
 ## Example
 

diff --git a/hand/hand-detection-webcam/README.md b/hand/hand-detection-webcam/README.md
@@ -16,11 +16,11 @@ Specify the hands pose to save and press the capture button to record the pose m
 
 ### Server Url
 
-URL address of your websocket server. Server receives the user's hands pose recognition result in real time using a WebSocket. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments.
+URL address of your websocket server for monitoring. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments. (default: 'localhost')
 
-### Mirror Port
+### Monitor Port
 
-Port number to be used to monitor hands pose recognition results from other resources. (default: 1881)
+Port number to be used to monitor pose recognition results from other resources. To use properly, you need to match this value with `Monitor Port` attribute of [the monitor node](https://github.com/5FNSaaS/node-red-contrib-motion-pose/tree/master/monitor). (default: 1883)
 
 ### Data Socket Url
 

diff --git a/monitor/README.md b/monitor/README.md
@@ -6,14 +6,15 @@ A node for monitoring the pose/hand recognition screen in an external browser.
 
 You can check the screen being detected in the external environment through the pose/hand detection node.
 
-Apply the `Server Url` and `Mirror Port` of the server set by the detection node to the properties of this node.
+Apply the `Server Url` and `Monitor Port` of the detection node to the properties of this node.
 
 ## Properties
 
 ### Server Url
 
-URL address of your websocket server. Server receives the user's pose recognition result in real time using a WebSocket. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments.
+URL address of your websocket server for monitoring. Do not include a prefix such as 'http://'. This is an attribute input item to facilitate both local and deployment environments. (default: 'localhost')
 
-### Mirror Port
+### Monitor Port
+
+Port number to be used to monitor pose recognition results from other resources. (default: 1881)
 
-Port number to be used to monitor pose recognition results from other resources. (default: 1881)