Skip to content

Commit

Permalink
Add notes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jason-fox
jason-fox committed Dec 18, 2023
1 parent 0d6d1ef commit a7b55cc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 32 deletions.
30 changes: 15 additions & 15 deletions README.ja.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ STH-Comet が実行されると、公開されている `STH_PORT` ポートへ
行うことで状態を確認できます。レスポンスがブランクの場合は、通常、**STH-Comet**
が実行されていないか、別のポートでリッスンしているためです。

#### :one: リクエスト :
#### 1️⃣ リクエスト :

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

#### :two: リクエスト :
#### 2️⃣ リクエスト :

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

#### :three: リクエスト :
#### 3️⃣ リクエスト :

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

#### :four: リクエスト :
#### 4️⃣ リクエスト :

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

#### :five: リクエスト :
#### 5️⃣ リクエスト :

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

#### :six: リクエスト :
#### 6️⃣ リクエスト :

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

#### :seven: リクエスト :
#### 7️⃣ リクエスト :

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

#### :eight: リクエスト :
#### 8️⃣ リクエスト :

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

#### :nine: リクエスト :
#### 9️⃣ リクエスト :

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

#### :one::zero: リクエスト :
#### 1️⃣0️⃣ リクエスト :

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

#### :one::one: リクエスト :
#### 1️⃣1️⃣ リクエスト :

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

#### :one::two: リクエスト :
#### 1️⃣2️⃣ リクエスト :

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

#### :one::three: リクエスト :
#### 1️⃣3️⃣ リクエスト :

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

#### :one::four: リクエスト :
#### 1️⃣4️⃣ リクエスト :

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

#### :one::five: リクエスト :
#### 1️⃣5️⃣ リクエスト :

```console
curl -iX POST \
Expand Down
36 changes: 19 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,8 @@ repository:
Where `<command>` will vary depending upon the mode we wish to activate. This command will also import seed data from
the previous tutorials and provision the dummy IoT sensors on startup.

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

#### :one: Request:
#### 1️⃣ Request:

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

#### :two: Request:
#### 2️⃣ Request:

```console
curl -iX POST \
Expand Down Expand Up @@ -425,15 +426,16 @@ the `throttling` attribute in the request body.
format.
- The `throttling` value defines the rate that changes are sampled.

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

#### :three: Request:
#### 3️⃣ Request:

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

#### :four: Request:
#### 4️⃣ Request:

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

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

#### :five: Request:
#### 5️⃣ Request:

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

#### :six: Request:
#### 6️⃣ Request:

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

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

#### :seven: Request:
#### 7️⃣ Request:

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

#### :eight: Request:
#### 8️⃣ Request:

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

#### :nine: Request:
#### 9️⃣ Request:

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

#### :one::zero: Request:
#### 1️⃣0️⃣ Request:

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

#### :one::one: Request:
#### 1️⃣1️⃣ Request:

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

#### :one::two: Request:
#### 1️⃣2️⃣ Request:

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

#### :one::three: Request:
#### 1️⃣3️⃣ Request:

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

#### :one::four: Request:
#### 1️⃣4️⃣ Request:

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

#### :one::five: Request:
#### 1️⃣5️⃣ Request:

```console
curl -iX POST \
Expand Down

0 comments on commit a7b55cc

Please sign in to comment.