Skip to content

Commit 0f1e369

Browse files
committed
Add notes
1 parent 8cbb03d commit 0f1e369

File tree

2 files changed

+42
-42
lines changed

2 files changed

+42
-42
lines changed

README.ja.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ IoT Agent は、[Mosquitto](https://mosquitto.org/) message broker を介して
3636
- [起動](#start-up)
3737
- [IoT Agent のプロビジョニング (Ultra Light over MQTT)](#provisioning-an-iot-agent-ultralight-over-mqtt)
3838
- [Mosquitto Health の確認](#checking-mosquitto-health)
39-
- [MQTT サブスクライバを開始 (:one:st ターミナル)](#start-an-mqtt-subscriber-onest-terminal)
40-
- [MQTT パブリッシャを開始 (:two:nd ターミナル)](#start-an-mqtt-publisher-twond-terminal)
41-
- [MQTT サブスクライバを停止 (:one:st ターミナル)](#stop-an-mqtt-subscriber-onest-terminal)
39+
- [MQTT サブスクライバを開始 (1️⃣st ターミナル)](#start-an-mqtt-subscriber-onest-terminal)
40+
- [MQTT パブリッシャを開始 (2️⃣nd ターミナル)](#start-an-mqtt-publisher-twond-terminal)
41+
- [MQTT サブスクライバを停止 (1️⃣st ターミナル)](#stop-an-mqtt-subscriber-onest-terminal)
4242
- [Mosquitto ログを表示](#show-mosquitto-log)
4343
- [IoT Agent Service Health の確認](#checking-the-iot-agent-service-health)
4444
- [IoT デバイスの接続](#connecting-iot-devices)
@@ -433,7 +433,7 @@ IoT デバイスのアレイの現在の状態が表示されます。
433433

434434
<a name="start-an-mqtt-subscriber-onest-terminal"></a>
435435

436-
### MQTT サブスクライバを開始 (:one:st ターミナル)
436+
### MQTT サブスクライバを開始 (1️⃣st ターミナル)
437437

438438
最終的にシステムによって正しく接続されると、IoT Agent は関連するすべてのイベント
439439
にサブスクライブし、センサの測定値の形式でノース・バウンドのトラフィックを待ち受
@@ -456,7 +456,7 @@ docker run -it --rm --name mqtt-subscriber \
456456

457457
<a name="start-an-mqtt-publisher-twond-terminal"></a>
458458

459-
### MQTT パブリッシャを開始 (:two:nd ターミナル)
459+
### MQTT パブリッシャを開始 (2️⃣nd ターミナル)
460460

461461
ノース・バウンドの測定値を送信するセンサは、**MQTT Broker** へ測定値を公開して、
462462
サブスクライバに送信することができます。センサはサブスクライバに直接接続する必要
@@ -470,7 +470,7 @@ docker run -it --rm --name mqtt-publisher \
470470
--network fiware_default efrecon/mqtt-client pub -h mosquitto -m "HELLO WORLD" -t "/test"
471471
```
472472

473-
#### :one:st ターミナル - 結果 :
473+
#### 1️⃣st ターミナル - 結果 :
474474

475475
MQTT Broker が正常に機能している場合は、メッセージを別のターミナルで受信する必要
476476
があります :
@@ -481,7 +481,7 @@ HELLO WORLD
481481

482482
<a name="stop-an-mqtt-subscriber-onest-terminal"></a>
483483

484-
### MQTT サブスクライバを停止 (:two:nd ターミナル)
484+
### MQTT サブスクライバを停止 (2️⃣nd ターミナル)
485485

486486
MQTT サブスクライバを終了するには、次の Docker コマンドを実行します :
487487

@@ -522,7 +522,7 @@ docker logs --tail 10 mosquitto
522522
IoT Agent が動作しているかどうかは、公開されているポートに対して HTTP リクエスト
523523
を行うことで確認できます :
524524
525-
#### :one: リクエスト :
525+
#### 1️⃣ リクエスト :
526526
527527
```console
528528
curl -X GET \
@@ -643,7 +643,7 @@ HTTP 通信が使用されていないため、`resource` 属性は空白のま
643643
合、 IoT Agent は設定ファイルで定義されているデフォルトの context broker URL を
644644
使用しますが、完全性のためにここに追加されています。
645645
646-
#### :two: リクエスト :
646+
#### 2️⃣ リクエスト :
647647
648648
```console
649649
curl -iX POST \
@@ -684,7 +684,7 @@ curl -iX POST \
684684
> **注 :** 個別 id が必要でないか、または集約されたデータが十分である場合は
685685
> `attributes` は個別にではなくプロビジョニング・サービス内で定義できます。
686686
687-
#### :three: リクエスト :
687+
#### 3️⃣ リクエスト :
688688

689689
```console
690690
curl -iX POST \
@@ -725,7 +725,7 @@ curl -iX POST \
725725
次の**トピック**に MQTT メッセージをポストすることで、**モーション・センサ**
726726
デバイス `motion001` からのダミー IoT デバイスの測定値をシミュレートできます。
727727

728-
#### :four: MQTT リクエスト :
728+
#### 4️⃣ MQTT リクエスト :
729729

730730
```console
731731
docker run -it --rm --name mqtt-publisher --network \
@@ -766,7 +766,7 @@ Context Broker からエンティティ・データを取得することで、
766766
確認できます。`fiware-service` ヘッダと `fiware-service-path` ヘッダを追加する
767767
ことを忘れないでください。
768768

769-
#### :five: リクエスト :
769+
#### 5️⃣ リクエスト :
770770

771771
```console
772772
curl -X GET \
@@ -821,7 +821,7 @@ curl -X GET \
821821

822822
以下の例では、`deviceId = bell001` のベルがプロビジョニングされています。
823823

824-
#### :six: リクエスト :
824+
#### 6️⃣ リクエスト :
825825

826826
```console
827827
curl -iX POST \
@@ -856,7 +856,7 @@ Agent のノース・ポートに直接 REST リクエストを行うことで
856856
に Context Broker によって呼び出されるのは、このエンドポイントです。設定をテスト
857857
するには、次のようにコマンドを直接実行します :
858858

859-
#### :seven: リクエスト :
859+
#### 7️⃣ リクエスト :
860860

861861
```console
862862
curl -iX POST \
@@ -886,7 +886,7 @@ curl -iX POST \
886886
ベルを鳴らすコマンドの結果は、Orion Context Broker 内のエンティティにクエリする
887887
ことによって読み取ることができます。
888888

889-
#### :eight: リクエスト :
889+
#### 8️⃣ リクエスト :
890890

891891
```console
892892
curl -X GET \
@@ -922,7 +922,7 @@ curl -X GET \
922922
します。デバイスがコマンドをリッスンする HTTP url がないため、`endpoint` 属性は
923923
必要ありません。
924924

925-
#### :nine: リクエスト :
925+
#### 9️⃣ リクエスト :
926926

927927
```console
928928
curl -iX POST \
@@ -964,7 +964,7 @@ curl -iX POST \
964964
同様に、2 つのコマンド (`on` および `off`) と 2 つの属性を持つ**スマート・ラン
965965
**は、次のようにプロビジョニングできます :
966966

967-
#### :one::zero: リクエスト :
967+
#### 1️⃣0️⃣ リクエスト :
968968

969969
```console
970970
curl -iX POST \
@@ -1001,7 +1001,7 @@ curl -iX POST \
10011001
プロビジョニングされたデバイスの完全なリストは、`/iot/devices` エンドポイントに
10021002
GET リクエストを行うことで取得できます。
10031003

1004-
#### :one::one: リクエスト :
1004+
#### 1️⃣1️⃣ リクエスト :
10051005

10061006
```console
10071007
curl -X GET \
@@ -1041,7 +1041,7 @@ IoT Agent のノース・ポートのすべての通信は、標準の NGSI 構
10411041
`ring` コマンドを呼び出すには、コンテキスト内で `ring` 属性を更新する必要があり
10421042
ます。
10431043

1044-
#### :one::two: リクエスト :
1044+
#### 1️⃣2️⃣ リクエスト :
10451045

10461046
```console
10471047
curl -iX PATCH \
@@ -1068,7 +1068,7 @@ curl -iX PATCH \
10681068
`open` コマンドを呼び出すには、コンテキスト内で `open` 属性を更新する必要があり
10691069
ます。
10701070

1071-
#### :one::three: リクエスト :
1071+
#### 1️⃣3️⃣ リクエスト :
10721072

10731073
```console
10741074
curl -iX PATCH \
@@ -1091,7 +1091,7 @@ curl -iX PATCH \
10911091
**スマート・ランプ**をオンにするには、`on` 属性をコンテキストで更新する必要があ
10921092
ります。
10931093

1094-
#### :one::four: リクエスト :
1094+
#### 1️⃣4️⃣ リクエスト :
10951095

10961096
```console
10971097
curl -iX PATCH \

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ The tutorial uses [cUrl](https://ec.haxx.se/) commands throughout, but is also a
3636
- [Start Up](#start-up)
3737
- [Provisioning an IoT Agent (UltraLight over MQTT)](#provisioning-an-iot-agent-ultralight-over-mqtt)
3838
- [Checking Mosquitto Health](#checking-mosquitto-health)
39-
- [Start an MQTT Subscriber (:one:st Terminal)](#start-an-mqtt-subscriber-onest-terminal)
40-
- [Start an MQTT Publisher (:two:nd Terminal)](#start-an-mqtt-publisher-twond-terminal)
41-
- [Stop an MQTT Subscriber (:one:st Terminal)](#stop-an-mqtt-subscriber-onest-terminal)
39+
- [Start an MQTT Subscriber (1️⃣st Terminal)](#start-an-mqtt-subscriber-onest-terminal)
40+
- [Start an MQTT Publisher (2️⃣nd Terminal)](#start-an-mqtt-publisher-twond-terminal)
41+
- [Stop an MQTT Subscriber (1️⃣st Terminal)](#stop-an-mqtt-subscriber-onest-terminal)
4242
- [Show Mosquitto Log](#show-mosquitto-log)
4343
- [Checking the IoT Agent Service Health](#checking-the-iot-agent-service-health)
4444
- [Connecting IoT Devices](#connecting-iot-devices)
@@ -363,7 +363,7 @@ The device monitor can be found at: `http://localhost:3000/device/monitor`
363363
We will start by mimicking the roles of both the IoT Agent and a dummy IoT device and send and receive some messages
364364
using MQTT. This section of the tutorial requires several open terminals.
365365

366-
### Start an MQTT Subscriber (:one:st Terminal)
366+
### Start an MQTT Subscriber (1️⃣st Terminal)
367367

368368
Eventually once we have wired by the system correctly, IoT Agent will subscribe to all relevant events to listen for
369369
northbound traffic in the form of sensor measurements. It therefore will need to make a subscription across all topics.
@@ -383,7 +383,7 @@ The terminal will then be ready to receive events
383383
> **Note:** There is no change on whilst running this command. The on screen output will only respond once you have
384384
> completed the next step.
385385

386-
### Start an MQTT Publisher (:two:nd Terminal)
386+
### Start an MQTT Publisher (2️⃣nd Terminal)
387387

388388
A sensor sending northbound measurements will publish to those measurements to the MQTT Broker to be passed on to any
389389
subscriber than wants them. The sensor will not need to make a connection to the subscriber directly.
@@ -395,15 +395,15 @@ docker run -it --rm --name mqtt-publisher \
395395
--network fiware_default efrecon/mqtt-client pub -h mosquitto -m "HELLO WORLD" -t "/test"
396396
```
397397

398-
#### :one:st terminal - Result:
398+
#### 1️⃣st terminal - Result:
399399

400400
If the MQTT Broker is functioning correctly, the message should be received in the other terminal
401401

402402
```
403403
HELLO WORLD
404404
```
405405
406-
### Stop an MQTT Subscriber (:two:nd Terminal)
406+
### Stop an MQTT Subscriber (2️⃣nd Terminal)
407407
408408
To terminate the MQTT subscriber, run the following Docker command:
409409
@@ -439,7 +439,7 @@ docker logs --tail 10 mosquitto
439439

440440
You can check if the IoT Agent is running by making an HTTP request to the exposed port:
441441

442-
#### :one: Request:
442+
#### 1️⃣ Request:
443443

444444
```console
445445
curl -X GET \
@@ -541,7 +541,7 @@ The `resource` attribute is left blank since HTTP communication is not being use
541541
optional attribute - if it is not provided, the IoT Agent uses the default context broker URL as defined in the
542542
configuration file, however it has been added here for completeness.
543543
544-
#### :two: Request:
544+
#### 2️⃣ Request:
545545
546546
```console
547547
curl -iX POST \
@@ -578,7 +578,7 @@ Three types of measurement attributes can be provisioned:
578578
> **Note**: in the case where individual `id`s are not required, or aggregated data is sufficient the `attributes` can
579579
> be defined within the provisioning service rather than individually.
580580
581-
#### :three: Request:
581+
#### 3️⃣ Request:
582582

583583
```console
584584
curl -iX POST \
@@ -617,7 +617,7 @@ should subscribe to the `/<api-key>/<device-id>` **topic** to receive measuremen
617617
You can simulate a dummy IoT device measurement coming from the **Motion Sensor** device `motion001`, by posting an MQTT
618618
message to the following **topic**
619619

620-
#### :four: MQTT Request:
620+
#### 4️⃣ MQTT Request:
621621

622622
```console
623623
docker run -it --rm --name mqtt-publisher --network \
@@ -652,7 +652,7 @@ raising a request with the Orion Context Broker.
652652
You can see that a measurement has been recorded by retrieving the entity data from the context broker. Don't forget to
653653
add the `fiware-service` and `fiware-service-path` headers.
654654

655-
#### :five: Request:
655+
#### 5️⃣ Request:
656656

657657
```console
658658
curl -X GET \
@@ -701,7 +701,7 @@ device is listening for commands. The array of commands is mapped to directly to
701701

702702
The example below provisions a bell with the `deviceId=bell001`.
703703

704-
#### :six: Request:
704+
#### 6️⃣ Request:
705705

706706
```console
707707
curl -iX POST \
@@ -735,7 +735,7 @@ REST request directly to the IoT Agent's North Port using the `/v2/op/update` en
735735
eventually be invoked by the context broker once we have connected it up. To test the configuration you can run the
736736
command directly as shown:
737737

738-
#### :seven: Request:
738+
#### 7️⃣ Request:
739739

740740
```console
741741
curl -iX POST \
@@ -764,7 +764,7 @@ If you are viewing the device monitor page, you can also see the state of the be
764764

765765
The result of the command to ring the bell can be read by querying the entity within the Orion Context Broker.
766766

767-
#### :eight: Request:
767+
#### 8️⃣ Request:
768768

769769
```console
770770
curl -X GET \
@@ -797,7 +797,7 @@ both `attributes` and `command` attributes in the body of the request. Once agai
797797
the communications protocol to be used, and no `endpoint` attribute is required as there is no HTTP URL where the device
798798
is listening for commands.
799799

800-
#### :nine: Request:
800+
#### 9️⃣ Request:
801801

802802
```console
803803
curl -iX POST \
@@ -836,7 +836,7 @@ curl -iX POST \
836836

837837
Similarly, a **Smart Lamp** with two commands (`on` and `off`) and two attributes can be provisioned as follows:
838838

839-
#### :one::zero: Request:
839+
#### 1️⃣0️⃣ Request:
840840

841841
```console
842842
curl -iX POST \
@@ -872,7 +872,7 @@ curl -iX POST \
872872

873873
The full list of provisioned devices can be obtained by making a GET request to the `/iot/devices` endpoint.
874874

875-
#### :one::one: Request:
875+
#### 1️⃣1️⃣ Request:
876876

877877
```console
878878
curl -X GET \
@@ -903,7 +903,7 @@ Therefore this section of registering and invoking commands **duplicates** the i
903903

904904
To invoke the `ring` command, the `ring` attribute must be updated in the context.
905905

906-
#### :one::two: Request:
906+
#### 1️⃣2️⃣ Request:
907907

908908
```console
909909
curl -iX PATCH \
@@ -927,7 +927,7 @@ If you are viewing the device monitor page, you can also see the state of the be
927927

928928
To invoke the `open` command, the `open` attribute must be updated in the context.
929929

930-
#### :one::three: Request:
930+
#### 1️⃣3️⃣ Request:
931931

932932
```console
933933
curl -iX PATCH \
@@ -947,7 +947,7 @@ curl -iX PATCH \
947947

948948
To switch on the **Smart Lamp**, the `on` attribute must be updated in the context.
949949

950-
#### :one::four: Request:
950+
#### 1️⃣4️⃣ Request:
951951

952952
```console
953953
curl -iX PATCH \

0 commit comments

Comments
 (0)