Installation via Node-RED
Requirements
- Industrial IoT Gateway: An NCD Enterprise-series gateway.
- Node-RED Access: Access to the Node-RED flow editor.
- Network Connectivity: Active internet access for the gateway (required for library installation).
Procedure
Step 1. Go to ‘update ncd library‘ github repo and click on the copy raw file button:
Step 2. Access the Node-RED editor on your NCD Gateway. Navigate to the Menu (the three horizontal lines in the top-right corner) and select the ‘Import’ option:
Step 3. Paste the JSON code into the text input field within the Import dialog, then click the ‘Import’ button to proceed:
Step 4. Go to the new ‘Update library’ tab on your Node-RED workspace:
Step 5. Click on the ‘Deploy’ button located at the top right side:
Step 6. Trigger the first flow by clicking the embedded left button, as shown in the following image:
Step 7. A few seconds after enabling the flow, you should see the ‘pid’ process and then the “Completed” message under the debug node, as shown in the following image:
Step 8. Enable the second flow by clicking the embedded left button, as shown in the following image:
This flow enables a command to restart Node-RED on the Gateway.
Step 9. Finally refresh the web browser page. It will take a few minutes to restart Node-RED.
After completing these steps, your NCD Library has been updated from the temp-dev branch.
Offline Installation via SCP (For Isolated Environments or Restricted Networks)
Must-have
- Enable SSH: SSH into your IoT Enterprise Gateway
Steps
Step 1: Using a PC with internet access that is also on the same network as the NCD Gateway (or connected via Ethernet), navigate to the NCD GitHub Library repository and switch to the temp-dev branch. Click the green ‘Code‘ button and select ‘Download ZIP‘ from the dropdown menu to save the library locally.
Step 2: Extract the contents of the ZIP file.
Step 3: Rename the extracted folder to exactly: node-red-enterprise-sensors
Step 4: Type cmd into the Windows Explorer Address Bar and press Enter to open a Command Prompt window within the current directory.
Step 5: Enter the following command to copy and replace the node-red-enterprise-sensors folder in the Gateway’s Node-RED directory. Replace xxxx with the last four digits of your Gateway’s MAC address (found on the nameplate located on the bottom of the unit):
scp -r node-red-enterprise-sensors ncdio@ncd-xxxx.local:/home/ncdio/
Step 6: You will be prompted for the Gateway password. The default password is:
ncdB3ast
Step 7: SSH to the Gateway:
ssh ncdio@ncd-xxxx.local
Step 8: Use these commands to install the library:
cd ~/.node-red
npm install /home/ncdio/node-red-enterprise-sensors
Step 9: Once the process is complete, you may reboot Node-RED process, use this command:
pm2 restart all