> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/opc-ua-server.md).

# OPC UA サーバー

デバイスデータを OPC UA タグとして公開し、PLC、SCADA システム、その他の産業用クライアントが読み書きできるようにします。

OPC UA（Open Platform Communications Unified Architecture）は、デバイス、PLC、SCADA システム間でデータを交換するための産業用通信プロトコルです。OPC UA Server はエッジコンテナサービスで、デバイス上のタグを公開するため、産業用クライアントは推論結果を読み取り、値を書き戻せます。

タグ、フォルダ、サーバー設定を Deployment Manager の Configuration タブで定義し、その後 OPC UA クライアントをデバイスに向けます。

{% hint style="info" %}
OPC UA Server は Enterprise 顧客専用です。 [Roboflow の営業チームにお問い合わせください](https://roboflow.com/sales) 詳細をご確認ください。
{% endhint %}

## 接続詳細

置き換えてください `<device-ip>` Deployment Manager のデバイスページに表示される IP アドレスに。

<table data-search="false"><thead><tr><th>用途</th><th>アドレス</th></tr></thead><tbody><tr><td>OPC UA エンドポイント</td><td><code>opc.tcp://&#x3C;device-ip>:4840/opcua/server</code></td></tr><tr><td>Web UI と REST API</td><td><code>http://&#x3C;device-ip>:8092</code></td></tr></tbody></table>

<table data-search="false"><thead><tr><th>ポート</th><th>プロトコル</th><th>用途</th></tr></thead><tbody><tr><td>4840</td><td>OPC UA バイナリ</td><td>産業用クライアント接続（PLC、SCADA）</td></tr><tr><td>8092</td><td>HTTP</td><td>Web UI、REST API、ドキュメント</td></tr></tbody></table>

## 設定ソース

Configure モーダル上部の「Configuration Source」トグルは、タグとフォルダの設定元を制御します。デバイス上で一度に有効になるソースは常に 1 つだけです。

<table data-search="false"><thead><tr><th>ソース</th><th>保存先</th><th>次の場合に使用します</th></tr></thead><tbody><tr><td>「Web UI」</td><td><code>OPCUA_CONFIG</code></td><td>モーダル内でタグ、フォルダ、サーバー設定を直接定義したい場合に使用します。これがデフォルトです。</td></tr><tr><td>「File」</td><td><code>OPCUA_CONFIG_FILE</code></td><td>設定が環境変数には大きすぎる場合、たとえば数千個のタグを含むデプロイメントなどです。サーバーをデバイス上のパスに向けます（例: <code>/data/opcua-config.json</code>).</td></tr></tbody></table>

「File」モードでは、サーバーは起動時にファイルが存在し、読み取り可能で、空でないことを検証し、どれか 1 つでも満たさない場合は明示的なログを出して起動に失敗します。 `OPCUA_CONFIG_FILE` より優先されます `OPCUA_CONFIG`.

ソースを切り替えると、モーダルを開いている間はインライン値とファイルパスの両方が保持されます。保存すると選択しなかったソースは消去されるため、2 つの変数のうちどちらか一方だけが設定されます。「File」モードでは、サービスカードにインラインのタグ一覧の代わりに設定済みのファイルパスが表示されます。

## サーバー設定

<table data-search="false"><thead><tr><th>設定項目</th><th>説明</th></tr></thead><tbody><tr><td>「Server Name」</td><td>ネットワークを閲覧するクライアントに表示される、人間が読めるサーバーインスタンス名。</td></tr><tr><td>「Namespace URI」</td><td>タグが登録されるサーバーの名前空間を識別する一意の URI。デフォルトは <code>http://opcua.roboflow.run</code>.</td></tr><tr><td>「Max Sessions」</td><td>同時に接続できる OPC UA クライアント数。デフォルトは <code>200</code>.</td></tr></tbody></table>

各クライアントは 1 つのセッションを保持します。これには、タグを書き込む各推論ポッドと各 SCADA 接続も含まれます。クラッシュしたクライアントに属するセッションは、サーバーがタイムアウトさせるまで解放されないため、稼働中クライアント数より多くのセッションがサイトで保持されることがあります。上限に達すると、それ以降のクライアントは `BadTooManySessions` で拒否され、タグの更新が止まります。サイトでデフォルトより多くの同時クライアントが動作する場合は値を上げてください。モーダルで設定するとサーバー設定に書き込まれ、 `OPCUA_MAX_SESSIONS` を手動管理のデプロイメントではデバイスごとに上書きできます。

## フォルダとタグ

フォルダはタグを階層構造に整理します。各フォルダには名前と任意の説明があり、OPC UA アドレス空間ではノードとして表示されるため、クライアントはタグを参照して見つけられます。タグはフォルダに属することも、ルートレベルに置くこともできます。

タグはサーバーが公開するデータポイントを定義します。各タグには次のフィールドがあります。

<table data-search="false"><thead><tr><th>フィールド</th><th>説明</th></tr></thead><tbody><tr><td>「Display Name」</td><td>OPC UA クライアントに表示される、人間が読める名前。</td></tr><tr><td>「Browse Name」</td><td>アドレス空間で使用されるプログラム上の識別子。表示名から生成されます。</td></tr><tr><td>「Data Type」</td><td>タグが保持する値の型。</td></tr><tr><td>「Access Level」</td><td>タグが <code>ReadWrite</code> または <code>ReadOnly</code>.</td></tr><tr><td>「Folder」</td><td>タグが属するフォルダ。未割り当ての場合は Root。</td></tr><tr><td>「Initial Value」</td><td>サーバー起動時の初期値。データ型に対して検証されます。</td></tr><tr><td>「Description」</td><td>タグの用途を説明する任意のラベル。</td></tr></tbody></table>

### データ型

<table data-search="false"><thead><tr><th>型</th><th>説明</th><th>例</th></tr></thead><tbody><tr><td><code>Boolean</code></td><td>真または偽</td><td><code>true</code></td></tr><tr><td><code>Int32</code></td><td>32ビット符号付き整数</td><td><code>42</code></td></tr><tr><td><code>Float</code></td><td>32ビット浮動小数点</td><td><code>3.14</code></td></tr><tr><td><code>Double</code></td><td>64ビット浮動小数点</td><td><code>3.14159265359</code></td></tr><tr><td><code>String</code></td><td>UTF-8 テキスト</td><td><code>実行中</code></td></tr><tr><td><code>DateTime</code></td><td>ISO 8601 タイムスタンプ</td><td><code>2024-01-15T10:30:00Z</code></td></tr></tbody></table>

これらは Configure モーダルで選択できる型です。手書きの設定ファイルでは `Int16`, `UInt16`、および `UInt32`も使用でき、サーバーはそれらを受け入れます。

### アクセスレベル

`ReadWrite` タグは OPC UA クライアントだけでなく、REST API、CLI、Web UI からも読み書きできます。制御出力、設定値、ユーザーが調整可能な値に使用してください。

`ReadOnly` タグは OPC UA クライアントからの書き込みを `BadNotWritable`で拒否します。REST API、CLI、Web UI はアクセスレベルに関係なく値を更新できるため、 `ReadOnly` を、デバイスだけが生成すべきセンサー値、計算済み出力、システム状態に使用してください。

### 任意の制約

数値型は「Min Value」と「Max Value」による許容範囲の制限に対応しており、さらに説明用の単位ラベル（例: °C、PSI、RPM）として「Engineering Units」も使えます。文字列型は「Max Length」で文字数を制限できます。

## 認証

サーバーはデフォルトで SecurityPolicy None を使用した匿名接続を許可します。すべてのクライアントにユーザー名とパスワードを要求するには、Configure モーダルで「Require authentication」をオンにします。

トグルがオンのときはユーザー名とパスワードの両方を指定する必要があります。パスワードは保存前に bcrypt でハッシュ化されるため、元の値は保存されず、後から取得することもできません。既存サーバーのパスワードを変更するには、Configure モーダルで新しいパスワードを入力するか、フィールドを空のままにして現在のパスワードを保持してください。トグルをオフにすると匿名アクセスが復元されます。

認証情報は 2 つの環境変数として保存され、両方を同時に設定するか、両方とも未設定のままにする必要があります。

<table data-search="false"><thead><tr><th>変数</th><th>説明</th></tr></thead><tbody><tr><td><code>OPCUA_USERNAME</code></td><td>クライアント認証用の平文ユーザー名。</td></tr><tr><td><code>OPCUA_PASSWORD_HASH</code></td><td>ソルトラウンド 10 の bcrypt ハッシュ。先頭は <code>$2b$10$</code>.</td></tr></tbody></table>

{% hint style="warning" %}
環境変数を編集するのではなく、Configure モーダルで認証情報を設定してください。モーダルが bcrypt ハッシュを生成してくれますが、 `OPCUA_PASSWORD_HASH` を手動で設定するには、外部で有効なハッシュを生成する必要があります。
{% endhint %}

## タグレポート

サーバーはスケジュールに従ってタグを Roboflow にレポートできるため、現地に行かなくても何を提供しているか確認できます。これは Configure モーダルの「Tag Reporting」セクションで設定します。

<table data-search="false"><thead><tr><th>設定項目</th><th>説明</th></tr></thead><tbody><tr><td>「Send periodic tag reports」</td><td>レポートの送信をオン/オフします。デフォルトではオンです。</td></tr><tr><td>「Include tag values」</td><td>各タグの現在値を送信します。オフにするとタグ数のみを送信します。デフォルトではオンです。</td></tr><tr><td>「Reporting Interval」</td><td>レポート間隔（秒）。デフォルトは 60 です。</td></tr></tbody></table>

設定は環境変数として保存され、サーバーは起動時にそれを読み込みます。

<table data-search="false"><thead><tr><th>変数</th><th>デフォルト</th><th>説明</th></tr></thead><tbody><tr><td><code>OPCUA_SNAPSHOT_INTERVAL_SECONDS</code></td><td><code>60</code></td><td>レポート間の秒数。 <code>0</code> レポート送信をオフにします。</td></tr><tr><td><code>OPCUA_SNAPSHOT_INCLUDE_VALUES</code></td><td><code>true</code></td><td><code>false</code> タグ数のみを送信します。</td></tr><tr><td><code>OPCUA_SNAPSHOT_TTL_SECONDS</code></td><td>派生値</td><td>レポートがどのくらいの間最新の状態であるか。モーダルはこれを間隔から算出し、保存するたびに書き換えます。</td></tr></tbody></table>

サーバーが受け入れない値は、デフォルトに戻るのではなくレポート送信をオフにします。そのため টাইポがあるとレポートが止まります。デバイスページでは、そのようなデバイスはレポートしていないものとして表示されます。

これらの変数のいずれかが参照で設定されている場合（`{$ref}`）、モーダルではレポートを編集できず、保存時もそのままにされます。フォームからレポートを管理するには、参照をリテラル値に置き換えてください。

{% hint style="warning" %}
「Include tag values」は定期レポートのみに適用されます。サーバーはタグ値の変更を引き続きコンテナログに書き込み、Roboflow がそれを別途収集します。
{% endhint %}

## 監視

デバイスページには、接続中クライアント数、「Max Sessions」に対する使用中セッション数、最新のタグレポートを表示するライブの OPC UA ステータスカードが表示されます。タグレポートより古いイメージ上のデバイスには、レポートの代わりにその旨が表示されます。

サーバーがセッション上限に達して新しいクライアントを拒否すると、カードにはセッション数、上限、拒否されたクライアント数を示すバナーが表示されます。これについてメールを受け取るには、デバイスの「Device Alerts」タブから「OPC UA Refusing Clients」アラートを追加し、最初にどれだけの拒否分数を許可するかを設定してください。参照: [デバイスアラートを設定](/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/set-up-device-alerts.md).

## Web インターフェース

サーバーは次の場所に Web インターフェースをホストしています: `http://<device-ip>:8092`.

<table data-search="false"><thead><tr><th>ページ</th><th>パス</th><th>内容</th></tr></thead><tbody><tr><td>ダッシュボード</td><td><code>/</code></td><td>設定済みのすべてのタグの現在値を 2 秒ごとに更新して表示します。アクセスレベルに関係なく、どのタグの値も編集ダイアログから変更できます。</td></tr><tr><td>ドキュメント</td><td><code>/docs.html</code></td><td>サーバーガイド、設定フォーマットのリファレンス、トラブルシューティングノート。</td></tr><tr><td>API エクスプローラ</td><td><code>/api/docs</code></td><td>エンドポイントのテストやリクエスト／レスポンススキーマの確認に使える対話型 Swagger UI。</td></tr></tbody></table>

## HTTP API

REST API は、タグ値とサーバー情報へのプログラムからのアクセスを提供します。すべてのエンドポイントは JSON を返します。ベース URL は `http://<device-ip>:8092/api`です。参照: [サービス](/deployment/ja/self-hosted/enterprise/deployment-manager/services.md#using-the-apis) すべてのオンデバイスサービス API に共通するルール。

{% hint style="warning" %}
HTTP API には認証がありません。 `OPCUA_USERNAME` および `OPCUA_PASSWORD_HASH` は、4840 ポート上の OPC UA バイナリエンドポイントを保護するものであり、8092 ポートではありません。8092 ポートに到達できるものはどのタグにも書き込めます。
{% endhint %}

タグ構造は実行時に不変です。タグとフォルダは `OPCUA_CONFIG` 環境変数、または `OPCUA_CONFIG_FILE` で指定されたファイルから取得され、API  аркылуу 作成・変更・削除はできません。書き込めるのは値だけです。

### タグ値の読み取りと書き込み

`accessLevel` はこの API ではなく OPC UA プロトコルを制御します。タグに `ReadOnly` が付いている場合、OPC UA クライアントからの書き込みは `BadNotWritable` で拒否されますが、ここでは引き続き書き込み可能です。これは、産業用クライアントが受け取るだけにすべきセンサー値をパイプラインが公開する方法です。

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/tags" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/tags/{id}" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/tags/{id}/value" method="put" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

### 設定エンドポイント

実行中の設定を読み取り専用で確認できるビューです。書き込む前にタグ ID とその制約を見つけるのに役立ちます。

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/config" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/config/folders" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

### セッションとヘルス

一度 `maxSessions` に達すると、それ以降のクライアントは `BadTooManySessions`で拒否されるため、 `sessionCount` と `maxSessions` を比較して、余裕を確認します。

ある `200` からの `/subscriptions` で、セッションリストがゼロ化され、 `maxSessions` が省略されている場合、OPC UA サーバーは実行されていません。ウォームアップではなく障害として扱ってください。エンドポイントが少しでも応答するなら、起動はすでに完了しているか失敗しています。次で確認します。 `/health`には `status: "unhealthy"` および `opcuaServer: "stopped"`.

`maxSessions` はこの場合ゼロではなく省略されるため、 `maxSessions - sessionCount` を計算する利用側が、未知の上限を満杯と読み違えません。

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/subscriptions" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

{% hint style="info" %}
`/subscriptions` が仕様から欠落している場合、デバイスは次の場所で提供します `/api/openapi.json`。このルートは常に有効で、ここで文書化されています。
{% endhint %}

`/health` 返します `200` OPC UA サーバーが稼働しているかどうかに関係なく `status` および `opcuaServer` ではなくステータスコードを確認してください。

{% openapi src="/files/a9718340faace7402aaf905281c791254fa8fddb" path="/health" method="get" %}
[edge-opcua-server.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-21a215712d389ded373872b7a4e970e80be2c5fa%2Fedge-opcua-server.yaml?alt=media)
{% endopenapi %}

## CLI

この `opcua-cli` ツールは、デバッグ、スクリプト実行、Web UI にアクセスできないときの簡単なタグ操作のために、サーバーへのターミナルアクセスを提供します。

```bash
docker exec -it opcua-server opcua-cli
```

```bash
docker exec opcua-server opcua-cli <command>
```

<table data-search="false"><thead><tr><th>コマンド</th><th>説明</th></tr></thead><tbody><tr><td><code>list</code>, <code>ls</code></td><td>現在値付きで全タグを一覧表示</td></tr><tr><td><code>read &#x3C;tag></code></td><td>特定のタグ値を読み取る</td></tr><tr><td><code>write &#x3C;tag> &#x3C;value></code></td><td>タグに値を書き込む</td></tr><tr><td><code>status</code></td><td>サーバーのヘルスと稼働時間を表示</td></tr><tr><td><code>clients</code></td><td>接続中の OPC UA クライアントを一覧表示</td></tr><tr><td><code>clients --detailed</code></td><td>サブスクリプションの詳細付きでクライアントを一覧表示</td></tr><tr><td><code>export</code></td><td>設定を JSON としてエクスポート</td></tr></tbody></table>

```bash
docker exec opcua-server opcua-cli read Temperature
docker exec opcua-server opcua-cli write Temperature 25.5
docker exec opcua-server opcua-cli clients --detailed
```

## ログ

設定する `LOG_LEVEL` をサービスに設定して、冗長性を制御します。参照: [デバイス設定を更新](/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/update-device-configuration.md) でサービスの環境変数を編集する場所を確認し、 [デバイスログを表示](/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-device-logs.md) で出力を確認してください。

<table data-search="false"><thead><tr><th>レベル</th><th>説明</th></tr></thead><tbody><tr><td><code>DEBUG</code></td><td>詳細な診断情報</td></tr><tr><td><code>INFO</code></td><td>一般的な運用メッセージ（デフォルト）</td></tr><tr><td><code>WARN</code></td><td>動作を停止しない可能性のある問題</td></tr><tr><td><code>ERROR</code></td><td>機能に影響するエラー</td></tr></tbody></table>

値は大文字小文字を区別せず、認識されない値は既定値にフォールバックします `INFO`.
