Difference between revisions of "AIMLinux/AddOn/DeviceOn"

From ESS-WIKI
Jump to: navigation, search
 
(58 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
= Getting Started =
+
= <span style="color:#0070c0">DeviceOn</span> =
  
−
This section describes the information about DeviceOn on RISC platform.
+
This section describes the information about How to install the DeviceOn on RISC platform.
  
−
== <span style="color:#0070c0">DeviceOn</span> ==
+
== <span style="color:#0070c0">Get the following required files from PM or AE members&nbsp;</span> ==
  
−
=== <span style="color:#0070c0">Requirements for Build Environment</span> ===
+
*'''WISE-Agent'''
 +
**EX:&nbsp;wise-agent-Poky_3.0.4-imx8-1.4.31.0.run
 +
*'''CreateAccount'''
 +
**EX:&nbsp;createaccount_2020_04_10_a59cbe72.tar.gz
 +
*'''Service-SD'''K
 +
**EX:&nbsp;Service-SDK_Release_20200421_fsl_imx8_yocto_3f5ea785.tar.gz
 +
*'''SUSI-IoT'''
 +
**EX: SusiIoT_Release_2021_08_31_Poky_3.0.4-imx8_x64_16490.tar.gz
 +
*'''SUSI 4.0'''
 +
**EX:&nbsp;SUSI4.0_Release_2021_10_29_Poky_3.0.4-imx8_x64_16557.tar.gz
  
−
To cross-compile DeviceOn agent, you have to install dependencies into SDK toolchain.
+
== <span style="color:#0070c0">Bundle Mechanism</span> ==
  
−
Please refer to '''[https://github.com/ADVANTECH-Corp/meta-advantech2/blob/aim20-rocko-sumo/meta-WISE-PaaS/recipes-core/packagegroups/packagegroup-wise-paas.bb packagegroup-wise-paas.bb]''' and '''[https://github.com/ADVANTECH-Corp/meta-advantech2/blob/aim20-rocko-sumo/meta-WISE-PaaS/recipes-core/images/sdk.inc sdk.inc]''' for details. These two files are used on Yocto to generate suitable image & toolchain for DeviceOn.
+
Install the DeviceOn function on a specific BSP official release with related DeviceOn packages enabled.
  
−
=== <span style="color:#0070c0">Build Instruction</span> ===
+
== <span style="color:#0070c0">DeviceOn Installation</span> ==
  
−
=== <span style="color:#0070c0">Bundle Mechanism</span> ===
+
=== '''1. Install&nbsp;WISE-Agent''' ===
  
−
=== <span style="color:#0070c0">Connect to Server</span> ===
+
./wise-agent-Poky_xxx.run
  
−
== <span style="color:#0070c0">Additional Modules</span> ==
+
During the installation, do not configure at this moment.
  
−
=== <span style="color:#0070c0">OTA Handler</span> ===
+
* Setup Agent [y/n](default:n): '''<span style="color:#DD0000">y</span>'''
 +
* Do you want to configure RMM Agent now? [y/n](default: y) '''<span style="color:#DD0000">n</span>'''
 +
* Do you want to start RMM Agent now? [y/n](default: y) '''<span style="color:#DD0000">n</span>'''
  
−
=== <span style="color:#0070c0">Service-SDK</span> ===
+
=== '''2. Install CreateAccount''' ===
  
−
=== <span style="color:#0070c0">SUSI 4.0 & SUSI-IoT</span> ===
+
Get CreateAccount program and install with npm.
  
−
=== <span style="color:#0070c0">OPC-UA</span> ===
+
​tar -zxvf createaccount_xxx.tar.gz
 +
cd createaccount
 +
cp -a * /usr/local/AgentService/
  
−
=== <span style="color:#0070c0">Modbus Handler</span> ===
+
=== '''3. Set up Zero-Config service''' ===
−
[[Category:Editor]]
+
 
 +
==== '''[System V]''' ====
 +
 
 +
Create the "zero-config" file, and the&nbsp;content of zero-config:
 +
 
 +
#!/bin/sh
 +
 +
SERVICE_PATH="/usr/local/AgentService/"
 +
SERVICE_PROGRAM="node index.js"
 +
 +
# Source function library.
 +
. /etc/init.d/functions
 +
 +
case "$1" in
 +
    start)
 +
        echo -n "Starting CreateAccount: "
 +
        cd $SERVICE_PATH
 +
        $SERVICE_PROGRAM > /dev/null 2>&1
 +
        RETVAL=$?
 +
        if [ $RETVAL -eq 0 ]; then
 +
            echo "OK"
 +
        else
 +
            echo "Failure"
 +
        fi
 +
        &nbsp;;;
 +
    *)
 +
        echo "Usage: $0 {start}"
 +
        exit 1
 +
        &nbsp;;;
 +
esac
 +
 +
exit 0
 +
 
 +
Set up the zero-config file:
 +
 
 +
cp zero-config /etc/init.d
 +
chown root:root /etc/init.d/zero-config
 +
chmod 0750 /etc/init.d/zero-config
 +
update-rc.d -f zero-config remove
 +
update-rc.d zero-config defaults 99 20
 +
 
 +
==== '''[System D]''' ====
 +
 
 +
Create the "zero-config.service" file, and the&nbsp;content of zero-config.service:
 +
 
 +
[Unit]
 +
Description=CreatAccount
 +
After=saagent.service
 +
 +
[Service]
 +
User=root
 +
Group=root
 +
 +
Type=idle
 +
WorkingDirectory=/usr/local/AgentService/
 +
ExecStartPre=/bin/sleep 10
 +
ExecStart=/usr/bin/node /usr/local/AgentService/index.js
 +
 +
[Install]
 +
WantedBy=multi-user.target
 +
 
 +
Set up the zero-config.service file:
 +
 
 +
cp zero-config.service /etc/systemd/system
 +
chown root:root /etc/systemd/system/zero-config.service
 +
chmod 750 /etc/systemd/system/zero-config.service
 +
systemctl enable zero-config.service
 +
 
 +
=== '''4.&nbsp;Install Service-SDK''' ===
 +
 
 +
tar -zxvf Service-SDK_Release_xxx.tar.gz
 +
cp -a Service-SDK/.libs/libEIServiceSDK.so* /usr/lib/
 +
 
 +
=== '''5.&nbsp;Install&nbsp;SUSI-IoT''' ===
 +
 
 +
tar -zxvf SusiIoT_Release_xxx.tar.gz
 +
cd release/library
 +
sudo ./install.sh
 +
 
 +
=== '''6. Install&nbsp;SUSI 4.0''' ===
 +
 
 +
tar -zxvf SUSI4.0_Release_xxx.tar.gz
 +
cd SUSI4.x.x/Driver
 +
sudo ./install.sh
 +
 
 +
''PS. Please make sure the owner of files above are ''''root:root''''.''
 +
 
 +
== <span style="color:#0070c0">First Boot</span> ==
 +
 
 +
Connect the internet and during the first boot procedure, the /usr/local/AgentService/agent_config.xml will be updated by saagent service firstly. The MAC address is used as an unique device id for DeviceOn.
 +
 
 +
<DeviceName>imx6dlubc220a1</DeviceName>
 +
<DevID>00000001-0000-0000-0000-00049F0130E0</DevID>
 +
<SN>00049F0130E0</SN>
 +
<UserName>00049F0130E0@advtrial.net</UserName>
 +
 
 +
Then, zero-config service will register this account to the server. Once successful, the agent_config.xml will be updated again with corresponding credentials.
 +
 
 +
<CredentialURL>[https://deviceonapp.wise-paas.com/rmm/v1/iothub/credential https://deviceonapp.wise-paas.com/rmm/v1/iothub/credential]</CredentialURL>
 +
<IoTKey>10da34e72025c137618bb4d4aefff18d</IoTKey>
 +
 
 +
These procedures are automatically complete during first booting up. Users only need to power up device and connect with network.
 +
 
 +
== <span style="color:#0070c0">Connect to Server</span> ==
 +
 
 +
On PC or cellular phone, connect to '''[https://deviceonapp.wise-paas.com/#/DeviceQRCode DeviceQRCode]''' website and input the MAC address of your target device.
 +
 
 +
If your target device has multiple Ethernet interfaces, use the following command to confirm the associated MAC.
 +
 
 +
$ cat /usr/local/AgentService/agent_config.xml | grep SN
 +
    <SN>00049F0130E0</SN>
 +
 
 +
Follow the steps to connect to DeviceOn server
 +
 
 +
1. Click the button to generate QR code
 +
 
 +
2. Click the QR code or scan it with camera
 +
 
 +
[[File:Deviceon qrcode.png|800px|deviceon_qrcode]]
 +
 
 +
The QR code will re-direct to DeviceOn home page. Enjoy it!
 +
 
 +
[[File:Deviceon home.png|800px|deviceon_home]]
 +
 
 +
 
 +
 
 +
If the '''[https://deviceonapp.wise-paas.com/#/DeviceQRCode DeviceQRCode]''' website appear the mac address does not exist, the&nbsp;mac account may have expired (six month trial period) or&nbsp;'''you&nbsp;can check the &lt;IoTKey&gt; exist or not in the /usr/local/AgentService/agent_config.xml'''.
 +
 
 +
'''''If the&nbsp;&lt;IoTKey&gt; is empty, please connect the internet and reboot the device agai''n'''.
 +
 
 +
[[File:Deviceon mac.png|800px|Deviceon_mac]]
 +
 
 +
== <span style="color:#0070c0">DeviceOn logs and check the connection</span> ==
 +
You can go to the /usr/local/AgentService/logs and check the log file:
 +
 
 +
04-01 07:35:11.306 1687 [WiseAgent] Agent Credential: mqtt,efcc749121b5ecd182f58aa1649457eb_created,2265409aaecb11bf79a7c16473af5c47,deviceonapp.wise-paas.com,1883,false
 +
04-01 07:35:11.306 1687 [WiseAgent] Connecting to broker: deviceonapp.wise-paas.com
 +
04-01 07:35:11.389 1740 [WiseAgent] Broker connected!

Latest revision as of 10:21, 1 April 2022

DeviceOn

This section describes the information about How to install the DeviceOn on RISC platform.

Get the following required files from PM or AE members 

  • WISE-Agent
    • EX: wise-agent-Poky_3.0.4-imx8-1.4.31.0.run
  • CreateAccount
    • EX: createaccount_2020_04_10_a59cbe72.tar.gz
  • Service-SDK
    • EX: Service-SDK_Release_20200421_fsl_imx8_yocto_3f5ea785.tar.gz
  • SUSI-IoT
    • EX: SusiIoT_Release_2021_08_31_Poky_3.0.4-imx8_x64_16490.tar.gz
  • SUSI 4.0
    • EX: SUSI4.0_Release_2021_10_29_Poky_3.0.4-imx8_x64_16557.tar.gz

Bundle Mechanism

Install the DeviceOn function on a specific BSP official release with related DeviceOn packages enabled.

DeviceOn Installation

1. Install WISE-Agent

./wise-agent-Poky_xxx.run

During the installation, do not configure at this moment. 

* Setup Agent [y/n](default:n): y
* Do you want to configure RMM Agent now? [y/n](default: y) n
* Do you want to start RMM Agent now? [y/n](default: y) n

2. Install CreateAccount

Get CreateAccount program and install with npm. 

​tar -zxvf createaccount_xxx.tar.gz
cd createaccount
cp -a * /usr/local/AgentService/

3. Set up Zero-Config service

[System V]

Create the "zero-config" file, and the content of zero-config: 

#!/bin/sh

SERVICE_PATH="/usr/local/AgentService/"
SERVICE_PROGRAM="node index.js"

# Source function library.
. /etc/init.d/functions 

case "$1" in
    start)
        echo -n "Starting CreateAccount: "
        cd $SERVICE_PATH
        $SERVICE_PROGRAM > /dev/null 2>&1
        RETVAL=$?
        if [ $RETVAL -eq 0 ]; then
            echo "OK"
        else
            echo "Failure"
        fi
        ;;
    *)
        echo "Usage: $0 {start}"
        exit 1
        ;;
esac

exit 0

Set up the zero-config file: 

cp zero-config /etc/init.d
chown root:root /etc/init.d/zero-config
chmod 0750 /etc/init.d/zero-config
update-rc.d -f zero-config remove
update-rc.d zero-config defaults 99 20

[System D]

Create the "zero-config.service" file, and the content of zero-config.service: 

[Unit]
Description=CreatAccount
After=saagent.service

[Service]
User=root
Group=root

Type=idle
WorkingDirectory=/usr/local/AgentService/
ExecStartPre=/bin/sleep 10
ExecStart=/usr/bin/node /usr/local/AgentService/index.js

[Install]
WantedBy=multi-user.target

Set up the zero-config.service file: 

cp zero-config.service /etc/systemd/system
chown root:root /etc/systemd/system/zero-config.service
chmod 750 /etc/systemd/system/zero-config.service
systemctl enable zero-config.service

4. Install Service-SDK

tar -zxvf Service-SDK_Release_xxx.tar.gz
cp -a Service-SDK/.libs/libEIServiceSDK.so* /usr/lib/

5. Install SUSI-IoT

tar -zxvf SusiIoT_Release_xxx.tar.gz
cd release/library
sudo ./install.sh

6. Install SUSI 4.0

tar -zxvf SUSI4.0_Release_xxx.tar.gz
cd SUSI4.x.x/Driver
sudo ./install.sh

PS. Please make sure the owner of files above are 'root:root'.

First Boot

Connect the internet and during the first boot procedure, the /usr/local/AgentService/agent_config.xml will be updated by saagent service firstly. The MAC address is used as an unique device id for DeviceOn. 

<DeviceName>imx6dlubc220a1</DeviceName>
<DevID>00000001-0000-0000-0000-00049F0130E0</DevID>
<SN>00049F0130E0</SN>
<UserName>00049F0130E0@advtrial.net</UserName>

Then, zero-config service will register this account to the server. Once successful, the agent_config.xml will be updated again with corresponding credentials. 

<CredentialURL>https://deviceonapp.wise-paas.com/rmm/v1/iothub/credential</CredentialURL>
<IoTKey>10da34e72025c137618bb4d4aefff18d</IoTKey>

These procedures are automatically complete during first booting up. Users only need to power up device and connect with network.

Connect to Server

On PC or cellular phone, connect to DeviceQRCode website and input the MAC address of your target device.

If your target device has multiple Ethernet interfaces, use the following command to confirm the associated MAC. 

$ cat /usr/local/AgentService/agent_config.xml | grep SN
   <SN>00049F0130E0</SN>

Follow the steps to connect to DeviceOn server

1. Click the button to generate QR code

2. Click the QR code or scan it with camera

deviceon_qrcode

The QR code will re-direct to DeviceOn home page. Enjoy it!

deviceon_home


If the DeviceQRCode website appear the mac address does not exist, the mac account may have expired (six month trial period) or you can check the <IoTKey> exist or not in the /usr/local/AgentService/agent_config.xml.

If the <IoTKey> is empty, please connect the internet and reboot the device again.

Deviceon_mac

DeviceOn logs and check the connection

You can go to the /usr/local/AgentService/logs and check the log file: 

04-01 07:35:11.306 1687 [WiseAgent] Agent Credential: mqtt,efcc749121b5ecd182f58aa1649457eb_created,2265409aaecb11bf79a7c16473af5c47,deviceonapp.wise-paas.com,1883,false
04-01 07:35:11.306 1687 [WiseAgent] Connecting to broker: deviceonapp.wise-paas.com
04-01 07:35:11.389 1740 [WiseAgent] Broker connected!
Retrieved from "https://ess-wiki.advantech.com.tw/wiki/index.php?title=AIMLinux/AddOn/DeviceOn&oldid=23398"