ओपनवेव टूल्स

GitHub पर स्रोत देखें

OpenWeave में OpenWeave परिनियोजन को कॉन्फ़िगर करने, प्रबंधित करने और परीक्षण करने के लिए कमांड लाइन टूल का एक सेट शामिल है।

बुनाई-उपकरण बनाएं

weave-tools लक्ष्य वितरण के लिए चयन Weave कमांड लाइन उपकरणों की एक tar संग्रह बनाता है। इसमें निम्नलिखित उपकरण शामिल हैं:

साधन विवरण स्टैंडअलोन निर्माण स्थान
gen-qr-code एक क्यूआर कोड जनरेट करें /src/tools/misc
mock-device जेनेरिक वीव डिवाइस सिम्युलेटर /src/test-apps
weave बुनाई प्रमाणपत्र बनाएं और प्रबंधित करें /src/tools/weave
weave-device-descriptor क्यूआर कोड पेयरिंग के लिए वीव डिवाइस डिस्क्रिप्टर स्ट्रिंग्स को एनकोड और डिकोड करें /src/test-apps
weave-device-mgr डिवाइस पेयरिंग प्रक्रिया को प्रबंधित करें /src/device-manager/python
weave-heartbeat ई-गोल्ड और हार्टबीट प्रोफ़ाइल संदेशों /src/test-apps
weave-key-export प्रमुख निर्यात अनुरोध भेजें /src/test-apps
weave-ping ई-गोल्ड और इको प्रोफ़ाइल संदेशों /src/test-apps

लक्ष्य बनाने के लिए:

  1. सभी स्थापित निर्माण आवश्यक शर्तें ।
  2. BlueZ समर्थन के बिना कॉन्फ़िगर OpenWeave:
    cd <path-to-openweave-core>
./configure --without-bluez
  3. Make the weave-tools target: 
    make weave-tools
  4. Check the root openweave-core directory for the tar archive: 
    ls weave*
    weave-tools-x86_64-unknown-linux-gnu-4.0d.tar.gz

gen-qr-code

The gen-qr-code tool requires the Python qrcode module. Use pip to install it:

pip install --user qrcode

उपयोग gen-qr-code डिवाइस युग्मन प्रयोजनों के लिए एक QR कोड उत्पन्न करने के लिए। उपकरण के लिए इनपुट स्थानीय फ़ाइल में होना चाहिए। उदाहरण के लिए, एक QR कोड को उपयोगकर्ता द्वारा भेजे जाने वाले उत्पन्न करने के लिए https://www.google.com :

  1. : QR कोड के लिए तार के साथ एक फ़ाइल बनाएँ
    echo "https://www.google.com" >> ~/ow_qrcode
  2. Generate a 64x64 QR code of that string: 
    ./gen-qr-code -v 1 -s 64 < ~/ow_qrcode
  3. To save the QR code as an image, specify an output file: 
    ./gen-qr-code -v 1 -s 64 < ~/ow_qrcode > ~/ow_qrcode.png
Use the weave-device-descriptor tool to generate the device descriptor string
for use in a Weave device's pairing QR code.

mock-device

The mock-device tool simulates a generic Weave node. Other tools and test case scripts use this tool to encapsulate Weave functionality. Instantiate mock devices on individual Happy nodes to test Weave functionality in a simulated topology.

For example, to start a Weave mock device listening on an IPv6 address of fd00:0:1:1::1, first add that IPv6 address to the lo (loopback) interface:

sudo ifconfig lo add fd00:0:1:1::1/64

फिर वीव मॉक डिवाइस शुरू करें:

./mock-device -a fd00:0:1:1::1
WEAVE:ML: Binding IPv6 TCP listen endpoint to [fd00:0:1:1::1]:11095
WEAVE:ML: Listening on IPv6 TCP endpoint
WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
WEAVE:IN: IPV6_PKTINFO: 92
WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [fd00:0:1:1::1]:11095 (lo)
WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
WEAVE:ML: Binding IPv6 multicast receive endpoint to [ff02::1]:11095 (lo)
WEAVE:ML: Listening on IPv6 multicast receive endpoint
WEAVE:EM: Cannot listen for BLE connections, null BleLayer
Weave Node Configuration:
  Fabric Id: 1
  Subnet Number: 1
  Node Id: 1
WEAVE:SD: init()
Weave Node Configuration:
  Fabric Id: 1
  Subnet Number: 1
  Node Id: 1
  Listening Addresses:
      fd00:0:1:1::1 (ipv6)
  Pairing Server: fd00:0:1:1::1
Mock Time Sync is disabled and not initialized
Mock System Time Offset initialized to: 3.213773 sec
Listening for requests...
Weave Node ready to service events; PID: 256904; PPID: 251571

का प्रयोग करें --help सभी उपलब्ध विन्यास विकल्प देखने के लिए झंडा।

बुनाई-उपकरण-विवरणकर्ता

weave-device-descriptor उपकरण encodes या डीकोड एक युक्ति वर्णनकर्ता स्ट्रिंग। इन स्ट्रिंग्स में एक डिवाइस के लिए पहचान की जानकारी होती है जो इसके वेव पेयरिंग क्यूआर कोड में एन्कोडेड होती है। का प्रयोग करें --help साथ झंडा encode या decode अधिक जानकारी के लिए विकल्प।

./weave-device-descriptor encode --help
./weave-device-descriptor decode --help

एन्कोड

उदाहरण के लिए, डिवाइस डिस्क्रिप्टर स्ट्रिंग को निम्नलिखित पहचान वाली जानकारी के साथ एन्कोड करने के लिए, उपयुक्त फ़्लैग और मानों का उपयोग करें:

मैदान झंडा मूल्य
विक्रेता पहचान -V 1
उत्पाद आइ डि -p 1
उत्पाद संशोधन संख्या -r 2
क्रमिक संख्या -s 18B4300000000004
निर्माण की तारीख -m 2018/05/02
802.15.4 मैक पता (थ्रेड, बीएलई) -8 000D6F000DA80466
पेयरिंग कोड -P AB713H
./weave-device-descriptor encode -V 1 -p 1 -r 2 -s 18B4300000000004 -m 2018/05/02 \
                                   -8 000D6F000DA80466 -w 5CF370800E77 -P AB713H
1V:1$P:1$R:2$D:180502$S:18B4300000000004$L:000D6F000DA80466$W:5CF370800E77$C:AB713H$

के साथ इस उत्पादन स्ट्रिंग का उपयोग gen-qr-code उपकरण QR कोड उत्पन्न करने के लिए।

व्याख्या करना

का प्रयोग करें decode एक युक्ति वर्णनकर्ता स्ट्रिंग का एक तत्व को डिकोड करने के विकल्प। डिकोड करने वाले तत्व में निम्नलिखित सिंटैक्स है:

1 + <device-descriptor-element> + $

उदाहरण के लिए, को डिकोड करने के W:5CF370800E77 डिवाइस वर्णनकर्ता तत्व:

./weave-device-descriptor decode 1W:5CF370800E77$
Primary WiFi MAC: 5C:F3:70:80:0E:77

बुनाई-दिल की धड़कन

उपयोग weave-heartbeat भेजने और प्राप्त करने हार्टबीट दो Weave नोड्स के बीच प्रोफ़ाइल संदेशों। हार्टबीट नेटवर्क में एक नोड की अन्य नोड्स के लिए जीवंतता को इंगित करने के लिए, या यह जांचने के लिए एक साधन प्रदान करता है कि कोई नोड कपड़े से जुड़ा रहता है या नहीं।

एक सफल हार्टबीट को सर्वर के रूप में कार्य करने के लिए एक नोड की आवश्यकता होती है (दिल की धड़कन को सुनना और प्रतिक्रिया देना) और क्लाइंट के रूप में कार्य करने के लिए एक नोड (दिल की धड़कन भेजना)।

टेस्ट weave-heartbeat की नकल दो नोड्स के लिए लूपबैक इंटरफ़ेस का उपयोग कर उपकरण:

  1. IPv6 पतों के लिए प्रत्येक हार्टबीट नोड के लिए इस्तेमाल किया जा में जोड़े lo : (लूपबैक) इंटरफेस
    sudo ifconfig lo add fd00:0:1:1::1/64
sudo ifconfig lo add fd00:0:1:1::2/64

  2. Start the Heartbeat server on the fd00:0:1:1::1 address and assign it a node-id of 1: 

    ./weave-heartbeat --node-addr fd00:0:1:1::1 --node-id 1 --listen
    WEAVE:ML: Binding IPv6 TCP listen endpoint to [fd00:0:1:1::1]:11095
    WEAVE:ML: Listening on IPv6 TCP endpoint
    WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
    WEAVE:IN: IPV6_PKTINFO: 92
    WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [fd00:0:1:1::1]:11095 (lo)
    WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
    WEAVE:ML: Binding IPv6 multicast receive endpoint to [ff02::1]:11095 (lo)
    WEAVE:ML: Listening on IPv6 multicast receive endpoint
    WEAVE:EM: Cannot listen for BLE connections, null BleLayer
    Weave Node Configuration:
      Fabric Id: 1
      Subnet Number: 1
      Node Id: 1
      Listening Addresses:
          fd00:0:1:1::1 (ipv6)
    Listening for Heartbeats...
    Weave Node ready to service events; PID: 170883; PPID: 170418

  3. Open a second terminal window and start the Heartbeat client on the fd00:0:1:1::2 IPv6 address with a node-id of 2 and the first node's IPv6 address as the destination for the Heartbeat: 

    ./weave-heartbeat --node-addr fd00:0:1:1::2 --node-id 2 --dest-addr fd00:0:1:1::1 1
    WEAVE:ML: Binding IPv6 TCP listen endpoint to [fd00:0:1:1::2]:11095
    WEAVE:ML: Listening on IPv6 TCP endpoint
    WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
    WEAVE:IN: IPV6_PKTINFO: 92
    WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [fd00:0:1:1::2]:11095 (lo)
    WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
    WEAVE:ML: Binding IPv6 multicast receive endpoint to [ff02::1]:11095 (lo)
    WEAVE:ML: Listening on IPv6 multicast receive endpoint
    WEAVE:EM: Cannot listen for BLE connections, null BleLayer
    WEAVE:EM: Binding0: Allocated
    Weave Node Configuration:
      Fabric Id: 1
      Subnet Number: 1
      Node Id: 2
      Listening Addresses:
          fd00:0:1:1::2 (ipv6)
    Sending Heartbeats via UDP to node 1 (fd00:0:1:1::1) every 1000 ms
    Weave Node ready to service events; PID: 170932; PPID: 170608
    WEAVE:EM: Binding0: Configuring
    WEAVE:EM: Binding0: Preparing
    WEAVE:EM: Binding0: Ready, peer 1 ([fd00:0:1:1::1]:11095) via UDP

  4. After a successful connection, node 2 sends Heartbeats to node 1, and node 1 logs Heartbeats received from node 2:

    Node 1
<code></code>
WEAVE:EM: Msg rcvd 00000013:1 1 0000000000000002 0000 C993 0 MsgId:1380A259
WEAVE:EM: ec id: 1, AppState: 0xb8e89790
Heartbeat from node 2 (fd00:0:1:1::2): state=1, err=No Error
### Node 2
<code></code>
WEAVE:EM: ec id: 1, AppState: 0x0
WEAVE:EM: Msg sent 00000013:1 1 0000000000000001 0000 C993 0 MsgId:1380A259
Heartbeat sent to node 1: state=1

नकली डिवाइस के साथ दिल की धड़कन

weave-heartbeat एक को दर्शाता है mock-device दोनों सर्वर और ग्राहक के लिए। एक ही हार्टबीट कार्यक्षमता का उपयोग करके प्रदर्शन किया जा सकता mock-device पहले के स्थान पर weave-heartbeat हार्टबीट सर्वर:

./mock-device -a fd00:0:1:1::1

बुनाई-पिंग

उपयोग weave-ping भेजने और प्राप्त करने इको दो Weave नोड्स के बीच प्रोफ़ाइल संदेशों। एक इको पेलोड में अनुरोध करने वाले नोड द्वारा आपूर्ति किए गए मनमाने डेटा होते हैं और प्रतिक्रिया में वापस शब्दशः प्रतिध्वनित होने की उम्मीद है। इको नेटवर्क कनेक्टिविटी और विलंबता का परीक्षण करने का एक साधन प्रदान करता है।

एक सफल इको को सर्वर के रूप में कार्य करने के लिए एक नोड की आवश्यकता होती है (इको अनुरोध को सुनना और उसका जवाब देना) और क्लाइंट के रूप में कार्य करने के लिए एक नोड (इको अनुरोध भेजना)।

टेस्ट weave-ping नकल दो नोड्स के लिए लूपबैक इंटरफ़ेस का उपयोग कर उपकरण:

  1. IPv6 पतों के लिए प्रत्येक इको नोड के लिए इस्तेमाल किया जा में जोड़े lo : (लूपबैक) इंटरफेस
    sudo ifconfig lo add fd00:0:1:1::1/64
sudo ifconfig lo add fd00:0:1:1::2/64

  2. Start the Echo server on the fd00:0:1:1::1 address, assigning it a node-id of 1: 

    ./weave-ping --node-addr fd00:0:1:1::1 --node-id 1 --listen
    WEAVE:ML: Binding IPv6 TCP listen endpoint to [fd00:0:1:1::1]:11095
    WEAVE:ML: Listening on IPv6 TCP endpoint
    WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
    WEAVE:IN: IPV6_PKTINFO: 92
    WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [fd00:0:1:1::1]:11095 (lo)
    WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
    WEAVE:ML: Binding IPv6 multicast receive endpoint to [ff02::1]:11095 (lo)
    WEAVE:ML: Listening on IPv6 multicast receive endpoint
    WEAVE:EM: Cannot listen for BLE connections, null BleLayer
    WEAVE:SD: init()
    Weave Node Configuration:
      Fabric Id: 1
      Subnet Number: 1
      Node Id: 1
      Listening Addresses:
          fd00:0:1:1::1 (ipv6)
    Listening for Echo requests...
    Iteration 0
    Weave Node ready to service events; PID: 120927; PPID: 113768
    WEAVE:ECH: Listening...

  3. Open a second terminal window and start the Echo client on the fd00:0:1:1::2 IPv6 address with a node-id of 2 and the first node's IPv6 address as the destination for the Echo request: 

    ./weave-ping --node-addr fd00:0:1:1::2 --node-id 2 --dest-addr fd00:0:1:1::1 1
    WEAVE:ML: Binding general purpose IPv4 UDP endpoint to [::]:11095
    WEAVE:IN: IPV6_PKTINFO: 92
    WEAVE:ML: Binding general purpose IPv6 UDP endpoint to [fd00:0:1:1::2]:11095 (lo)
    WEAVE:ML: Listening on general purpose IPv6 UDP endpoint
    WEAVE:ML: Binding IPv6 multicast receive endpoint to [ff02::1]:11095 (lo)
    WEAVE:ML: Listening on IPv6 multicast receive endpoint
    WEAVE:EM: Cannot listen for BLE connections, null BleLayer
    WEAVE:SD: init()
    Weave Node Configuration:
      Fabric Id: 1
      Subnet Number: 1
      Node Id: 2
      Listening Addresses:
          fd00:0:1:1::2 (ipv6)
    Sending Echo requests to node 1 at fd00:0:1:1::1
    Iteration 0
    Weave Node ready to service events; PID: 121125; PPID: 121017
    WEAVE:ML: Con start 9A00 0000000000000001 0001
    WEAVE:ML: Con DNS complete 9A00 0
    WEAVE:ML: TCP con start 9A00 fd00:0:1:1::1 11095
    WEAVE:ML: TCP con complete 9A00 0
    WEAVE:ML: Con complete 9A00
    Connection established to node 1 (fd00:0:1:1::1)

  4. After a successful connection, node 1 logs Echo Requests from node 2, and node 2 logs Echo Responses from node 1:

    Node 1
<code></code>
WEAVE:ML: Con rcvd AA00 fd00:0:1:1::2 41675
Connection received from node 2 (fd00:0:1:1::2)
WEAVE:EM: Msg rcvd 00000001:1 15 0000000000000002 AA00 B8A5 0 MsgId:00000000
WEAVE:EM: ec id: 1, AppState: 0xfce0ca80
Echo Request from node 2 (fd00:0:1:1::2): len=15 ... sending response.
WEAVE:EM: Msg sent 00000001:2 15 0000000000000002 AA00 B8A5 0 MsgId:00000000
WEAVE:EM: Msg rcvd 00000001:1 15 0000000000000002 AA00 B8A6 0 MsgId:00000001
### Node 2
<code></code>
WEAVE:EM: ec id: 1, AppState: 0xd239baa0
WEAVE:EM: Msg sent 00000001:1 15 0000000000000001 9A00 B8A5 0 MsgId:00000000
WEAVE:EM: Msg rcvd 00000001:2 15 0000000000000001 9A00 B8A5 0 MsgId:00000000
Echo Response from node 1 (fd00:0:1:1::1): 1/1(100.00%) len=15 time=0.228ms

नकली डिवाइस के साथ गूंजें

weave-ping एक को दर्शाता है mock-device दोनों सर्वर और ग्राहक के लिए। एक ही इको कार्यक्षमता का उपयोग करके प्रदर्शन किया जा सकता mock-device पहले के स्थान पर weave-ping इको सर्वर:

./mock-device -a fd00:0:1:1::1