כלים OpenWeave

צפה במקור ב- GitHub

OpenWeave כולל קבוצה של כלי שורת פקודה להגדרת תצורה, ניהול ובדיקה של פריסות OpenWeave.

בנה כלי אריגה

weave-tools היעד בונה ארכיון TAR של כלי שורת הפקודה Weave בחר להפצה. הוא כולל את הכלים הבאים:

כְּלִי תיאור לבנות עצמאי מיקום
gen-qr-code צור קוד QR /src/tools/misc
mock-device סימולטור מכשיר Weave גנרי /src/test-apps
weave צור ונהל אישורי Weave /src/tools/weave
weave-device-descriptor קידוד ופענוח מחרוזות מתאר מכשיר לארוג לזיווג קודי QR /src/test-apps
weave-device-mgr נהל את תהליך זיווג המכשירים /src/device-manager/python
weave-heartbeat שליחה וקבלה של Heartbeat הודעות לפרופיל /src/test-apps
weave-key-export שלח בקשות ייצוא מפתח /src/test-apps
weave-ping שליחה וקבלה של אקו הודעות לפרופיל /src/test-apps

לבניית היעד:

  1. התקן את כל התנאים המוקדמים לבנות .
  2. Configure OpenWeave ללא תמיכה BlueZ:
    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

ואז הפעל את מכשיר ה- Weave mock:

./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 מקודד כלי או מפענח מחרוזת מתאר התקן. מחרוזות אלה מכילות מידע מזהה עבור מכשיר המקודד לקוד ה- QR של זיווג Weave. השתמש --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 כתובת MAC (חוט, BLE) -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 לשלוח ולקבל 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 instantiates mock-device עבור שניהם שרת ולקוח. את אותה פונקציונליות Heartbeat ניתן להדגים באמצעות mock-device במקום הראשון weave-heartbeat לשרת 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 instantiates mock-device עבור שניהם שרת ולקוח. הפונקציונאליות אקו אותה ניתן להדגים באמצעות mock-device במקום הראשון weave-ping לשרת אקו:

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