Skip to content

Commit a7b55cc

Browse files
committed
Add notes
1 parent 0d6d1ef commit a7b55cc

2 files changed

Lines changed: 34 additions & 32 deletions

File tree

README.ja.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ STH-Comet が実行されると、公開されている `STH_PORT` ポートへ
393393
行うことで状態を確認できます。レスポンスがブランクの場合は、通常、**STH-Comet**
394394
が実行されていないか、別のポートでリッスンしているためです。
395395

396-
#### :one: リクエスト :
396+
#### 1️⃣ リクエスト :
397397

398398
```console
399399
curl -X GET \
@@ -463,7 +463,7 @@ curl -X GET \
463463
- **STH-Comet** は、現在、古い NGSI v1 形式の通知のみを受け付けるため
464464
、`attrsFormat=legacy` が必要です
465465

466-
#### :two: リクエスト :
466+
#### 2️⃣ リクエスト :
467467

468468
```console
469469
curl -iX POST \
@@ -522,7 +522,7 @@ curl -iX POST \
522522
> れます。`t` の最初の変更に対して通知が送られますが、エンティティがサンプリング
523523
> 期間内に最近更新されたので、`l`の第 2 の変更は無視されます。
524524

525-
#### :three: リクエスト :
525+
#### 3️⃣ リクエスト :
526526

527527
```console
528528
curl -iX POST \
@@ -581,7 +581,7 @@ curl -iX POST \
581581
`fiware-service` および `fiware-servicepath` ヘッダはクエリに設定し、サブスクリ
582582
プションを設定するときに使用する値と一致する必要があることに注意してください。
583583

584-
#### :four: リクエスト :
584+
#### 4️⃣ リクエスト :
585585

586586
```console
587587
curl -X GET \
@@ -663,7 +663,7 @@ curl -X GET \
663663
`hLimit` パラメータは、N 値に結果を制限します。`hOffset=0` は、最初の値から開始
664664
します。
665665

666-
#### :five: リクエスト :
666+
#### 5️⃣ リクエスト :
667667

668668
```console
669669
curl -X GET \
@@ -728,7 +728,7 @@ curl -X GET \
728728
`hLimit` パラメータは、N 値に結果を制限します。`hOffset` は、ゼロ以外の値に設定
729729
すると N 番目の測定から開始します。
730730

731-
#### :six: リクエスト :
731+
#### 6️⃣ リクエスト :
732732

733733
```console
734734
curl -X GET \
@@ -793,7 +793,7 @@ curl -X GET \
793793
`lastN` パラメータが設定された場合は、その結果は、N 個の最新の測定結果のみを返し
794794
ます。
795795

796-
#### :seven: リクエスト :
796+
#### 7️⃣ リクエスト :
797797

798798
```console
799799
curl -X GET \
@@ -864,7 +864,7 @@ curl -X GET \
864864
常にデータ収集の頻度に基づいて最も適切な期間を選択してください。 `Motion:001` は
865865
、1 分ごとに数回変化しているので、`minute` が選択されます。
866866

867-
#### :eight: リクエスト :
867+
#### 8️⃣ リクエスト :
868868

869869
```console
870870
curl -X GET \
@@ -937,7 +937,7 @@ curl -X GET \
937937
`aggrMethod` パラメータは、時系列上に実行する集計のタイプを決定します
938938
。`aggrPeriod` は、`second`, `minute`, `hour` または `day` のいずれかです。
939939

940-
#### :nine: リクエスト :
940+
#### 9️⃣ リクエスト :
941941

942942
```console
943943
curl -X GET \
@@ -1015,7 +1015,7 @@ curl -X GET \
10151015
なっています。**モーション・センサ**は、バイナリ値のみを提供するため、これには適
10161016
していません。
10171017

1018-
#### :one::zero: リクエスト :
1018+
#### 1️⃣0️⃣ リクエスト :
10191019

10201020
```console
10211021
curl -X GET \
@@ -1089,7 +1089,7 @@ curl -X GET \
10891089
`aggrMethod` パラメータは、時系列上に実行する集計のタイプを決定します
10901090
。`aggrPeriod` は、`second`, `minute`, `hour` または `day` のいずれかです。
10911091

1092-
#### :one::one: リクエスト :
1092+
#### 1️⃣1️⃣ リクエスト :
10931093

10941094
```console
10951095
curl -X GET \
@@ -1280,7 +1280,7 @@ cygnus:
12801280
行うことで、状態を確認できます。レスポンスがブランクの場合は、通常
12811281
、**STH-Comet** が実行されていないか、別のポートでリッスンしているためです。
12821282

1283-
#### :one::two: リクエスト :
1283+
#### 1️⃣2️⃣ リクエスト :
12841284

12851285
```console
12861286
curl -X GET \
@@ -1305,7 +1305,7 @@ curl -X GET \
13051305
トを行うことで、状況を確認できます。レスポンスがブランクの場合、これは通常
13061306
、**Cygnus** が実行されていないか、別のポートでリッスンしているためです。
13071307

1308-
#### :one::three: リクエスト :
1308+
#### 1️⃣3️⃣ リクエスト :
13091309

13101310
```console
13111311
curl -X GET \
@@ -1376,7 +1376,7 @@ The response will look similar to the following:
13761376
- **Cygnus** は、現在、古い NGSI v1 形式の通知のみを受け付けるため
13771377
、`attrsFormat=legacy` が必要です
13781378

1379-
#### :one::four: リクエスト :
1379+
#### 1️⃣4️⃣ リクエスト :
13801380

13811381
```console
13821382
curl -iX POST \
@@ -1430,7 +1430,7 @@ curl -iX POST \
14301430
、`attrsFormat=legacy` が必要です
14311431
- `throttling` 値は、変更がサンプリングされる割合を定義します
14321432

1433-
#### :one::five: リクエスト :
1433+
#### 1️⃣5️⃣ リクエスト :
14341434

14351435
```console
14361436
curl -iX POST \

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,8 @@ repository:
242242
Where `<command>` will vary depending upon the mode we wish to activate. This command will also import seed data from
243243
the previous tutorials and provision the dummy IoT sensors on startup.
244244

245-
> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command:
245+
> [!NOTE]
246+
> If you want to clean up and start over again you can do so with the following command:
246247
>
247248
> ```console
248249
> ./services stop
@@ -319,7 +320,7 @@ To start the system using the _minimal_ configuration using **STH-Comet** only,
319320
Once STH-Comet is running, you can check the status by making an HTTP request to the exposed `STH_PORT` port. If the
320321
response is blank, this is usually because **STH-Comet** is not running or is listening on another port.
321322

322-
#### :one: Request:
323+
#### 1️⃣ Request:
323324

324325
```console
325326
curl -X GET \
@@ -378,7 +379,7 @@ This is done by making a POST request to the `/v2/subscription` endpoint of the
378379
- The `attrsFormat=legacy` is required since **STH-Comet** currently only accepts notifications in the older NGSI v1
379380
format.
380381

381-
#### :two: Request:
382+
#### 2️⃣ Request:
382383

383384
```console
384385
curl -iX POST \
@@ -425,15 +426,16 @@ the `throttling` attribute in the request body.
425426
format.
426427
- The `throttling` value defines the rate that changes are sampled.
427428

428-
> :information_source: **Note:** Be careful when throttling subscriptions as sequential updates will not be persisted as
429+
> [!NOTE]
430+
> Be careful when throttling subscriptions as sequential updates will not be persisted as
429431
> expected.
430432
>
431433
> For example if an UltraLight device sends the measurement `t|20|l|1200` it will be a single atomic commit and both
432434
> attributes will be included the notification to **STH-Comet** however is a device sends `t|20#l|1200` this will be
433435
> treated as two atomic commits - a notification will be sent for the first change in `t`, but the second change in `l`
434436
> will be ignored as the entity has been recently updated within the sampling period.
435437

436-
#### :three: Request:
438+
#### 3️⃣ Request:
437439

438440
```console
439441
curl -iX POST \
@@ -483,7 +485,7 @@ and the subscriptions have been registered. Data should be collected for at leas
483485
You can note that the `fiware-service` and `fiware-servicepath` headers must be set in the query and match the values
484486
used when setting up the subscription
485487

486-
#### :four: Request:
488+
#### 4️⃣ Request:
487489

488490
```console
489491
curl -X GET \
@@ -554,7 +556,7 @@ To obtain the short term history of a context entity attribute, send a GET reque
554556

555557
the `hLimit` parameter restricts the result to N values. `hOffset=0` will start with the first value.
556558

557-
#### :five: Request:
559+
#### 5️⃣ Request:
558560

559561
```console
560562
curl -X GET \
@@ -615,7 +617,7 @@ To obtain the short term history of a context entity attribute, send a GET reque
615617
the `hLimit` parameter restricts the result to N values. Setting `hOffset` to a non-zero value will start from the Nth
616618
measurement
617619

618-
#### :six: Request:
620+
#### 6️⃣ Request:
619621

620622
```console
621623
curl -X GET \
@@ -675,7 +677,7 @@ To obtain the short term history of a context entity attribute, send a GET reque
675677

676678
If the `lastN` parameter is set, the result will return the N latest measurements only.
677679

678-
#### :seven: Request:
680+
#### 7️⃣ Request:
679681

680682
```console
681683
curl -X GET \
@@ -741,7 +743,7 @@ of `second`, `minute`, `hour` or `day`.
741743
Always select the most appropriate time period based on the frequency of your data collection. `minute` has been
742744
selected because the `Motion:001` is firing a few times within each minute.
743745

744-
#### :eight: Request:
746+
#### 8️⃣ Request:
745747

746748
```console
747749
curl -X GET \
@@ -813,7 +815,7 @@ To obtain the short term history of a context entity attribute, send a GET reque
813815
The `aggrMethod` parameter determines the type of aggregation to perform over the time series, the `aggrPeriod` is one
814816
of `second`, `minute`, `hour` or `day`.
815817

816-
#### :nine: Request:
818+
#### 9️⃣ Request:
817819

818820
```console
819821
curl -X GET \
@@ -887,7 +889,7 @@ of `second`, `minute`, `hour` or `day`.
887889
The luminocity of the **Smart Lamp** is continually changing and therefore tracking the minimum value makes sense. The
888890
**Motion Sensor** is not suitable for this as it only offers binary values.
889891

890-
#### :one::zero: Request:
892+
#### 1️⃣0️⃣ Request:
891893

892894
```console
893895
curl -X GET \
@@ -957,7 +959,7 @@ To obtain the short term history of a context entity attribute, send a GET reque
957959
The `aggrMethod` parameter determines the type of aggregation to perform over the time series, the `aggrPeriod` is one
958960
of `second`, `minute`, `hour` or `day`.
959961

960-
#### :one::one: Request:
962+
#### 1️⃣1️⃣ Request:
961963

962964
```console
963965
curl -X GET \
@@ -1129,7 +1131,7 @@ To start the system using the _formal_ configuration using **Cygnus** and **STH-
11291131
Once **STH-Comet** is running, you can check the status by making an HTTP request to the exposed `STH_PORT` port. If the
11301132
response is blank, this is usually because **STH-Comet** is not running or is listening on another port.
11311133

1132-
#### :one::two: Request:
1134+
#### 1️⃣2️⃣ Request:
11331135

11341136
```console
11351137
curl -X GET \
@@ -1151,7 +1153,7 @@ The response will look similar to the following:
11511153
Once **Cygnus** is running, you can check the status by making an HTTP request to the exposed `CYGNUS_API_PORT` port. If
11521154
the response is blank, this is usually because **Cygnus** is not running or is listening on another port.
11531155

1154-
#### :one::three: Request:
1156+
#### 1️⃣3️⃣ Request:
11551157

11561158
```console
11571159
curl -X GET \
@@ -1208,7 +1210,7 @@ This is done by making a POST request to the `/v2/subscription` endpoint of the
12081210
- The `idPattern` in the request body ensures that **Cygnus** will be informed of all **Motion Sensor** data changes.
12091211
- The notification `url` must match the configured `CYGNUS_API_PORT`
12101212

1211-
#### :one::four: Request:
1213+
#### 1️⃣4️⃣ Request:
12121214

12131215
```console
12141216
curl -iX POST \
@@ -1255,7 +1257,7 @@ the `throttling` attribute in the request body.
12551257
- The notification `url` must match the configured `CYGNUS_API_PORT`
12561258
- The `throttling` value defines the rate that changes are sampled.
12571259

1258-
#### :one::five: Request:
1260+
#### 1️⃣5️⃣ Request:
12591261

12601262
```console
12611263
curl -iX POST \

0 commit comments

Comments
 (0)