Skip to content

usage.md

Latest commit

 

History

History
161 lines (133 loc) · 4.08 KB

usage.md

File metadata and controls

161 lines (133 loc) · 4.08 KB

orion2GeoJSON プラグイン使用ガイド

設定パラメータ

パラメータ 必須 デフォルト値 説明
entity_type はい - 変換対象のエンティティタイプ（例：Room, Car など）。アルファベット、数字、ハイフン、アンダースコアのみ使用可能。
location_attr はい - 位置情報を含む属性名（例：location）。アルファベット、数字、ハイフン、アンダースコアのみ使用可能。
output_format はい FeatureCollection 出力形式。"FeatureCollection"（複数エンティティ）または"Feature"（単一エンティティ）。
conditional_transform いいえ true trueの場合、format=geojsonクエリパラメータがある場合のみ変換。falseの場合は常に変換。

GeoJSON変換の制御方法

クエリパラメータを使用する方法

# format=geojsonパラメータを使用
curl 'http://localhost:8000/orion/v2/entities/Room1?type=Room&format=geojson'

常に変換する方法

プラグインの設定でconditional_transform=falseを指定：

# プラグイン設定の更新
curl -X PATCH http://localhost:8001/services/orion/plugins/{plugin_id} \
  --data config.conditional_transform=false

この場合、すべてのリクエストでGeoJSON形式に変換されます。

使用例

1. 単一エンティティの変換

リクエスト

# クエリパラメータを使用
curl 'http://localhost:8000/orion/v2/entities/Room1?type=Room&format=geojson'

レスポンス（Feature形式）

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [13.3986112, 52.554699]
  },
  "properties": {
    "temperature": 23,
    "humidity": 45
  }
}

2. 複数エンティティの変換

リクエスト

# クエリパラメータを使用
curl 'http://localhost:8000/orion/v2/entities?type=Room&format=geojson'

レスポンス（FeatureCollection形式）

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [13.3986112, 52.554699]
      },
      "properties": {
        "temperature": 23
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [13.3986113, 52.554700]
      },
      "properties": {
        "temperature": 25
      }
    }
  ]
}

エラーケース

1. 無効なエンティティタイプ

指定されたentity_typeが見つからない場合：

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [0, 0]
  },
  "properties": {
    "error": "invalid_entity_type",
    "details": "Expected type 'Room', got 'Sensor'",
    "original_data": { ... }
  }
}

2. 位置情報属性が見つからない

location_attrで指定された属性が見つからない場合：

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [0, 0]
  },
  "properties": {
    "error": "location_attr_not_found",
    "details": "Attribute 'location' not found",
    "original_data": { ... }
  }
}

3. 無効な位置情報フォーマット

位置情報が正しいGeoJSON形式でない場合：

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [0, 0]
  },
  "properties": {
    "error": "invalid_location_format",
    "details": "Invalid format for location attribute 'location'",
    "original_data": { ... }
  }
}

注意事項

  1. 位置情報属性は必ずgeo:json型である必要があります
  2. エラー時も常に有効なGeoJSONが返されます
  3. エラーの場合、座標は[0, 0]にデフォルト設定されます
  4. propertiesには位置情報属性以外のすべての属性値が含まれます
  5. format=geojsonクエリパラメータを使用して変換を制御できます
  6. conditional_transform=falseに設定すると、すべてのレスポンスがGeoJSON形式になります