機種 (DeviceModel)

説明

2023-04-15/2024-09-21

　　設備の機種などの設備の共通情報を登録するためのデータモデルです。このデータモデルの名称はDeviceModelですが、説明文などで用いる呼称は「機種」です。

データモデル

2023-04-15/2024-09-21

　下表の「呼称」の列は、説明文やケーススタディで用いる項目の名称です。仕様としては意味を持たない情報ですが、本来の項目名であるAttribute nameは日本語話者にとっては感覚的に理解しにくいため、便宜上定義してあります。説明の①の列は、公共施設の施設管理において登録が想定されるAttributeです。

Data Model				説明
Attribute name	呼称	回数	type	補足	①
id	機種ID	1::1	Text	NGSI-LDの仕様に合わせ、次の形式の識別子とする。”urn:ngsi-ld:DeviceModel:”<一意となる文字列>。一意となる文字列は、例えば国名コードとメーカの法人番号の後にハイフンを挟んで型番を並べたもの。	必須
type		1::1	Text	必ず”DeviceModel”の文字列でなくてはならない	必須
alternateName	通称	0::1	Text	通称を入れる (もしあれば)
annotations	注釈	0::n	Array	設備に関する注釈
brandName	ブランド名	1::1	Text	機器のブランド名を設定する。例えば”しろくまくん”。	必須
category	設備種別	1::n	Text	設備の種別。列挙型項目。定義はBuildingComponentを参照	必須
color	色	0::1	Text	機器の色を設定する。例えば”白”
controlledProperty	制御対象	0::n	Text	検知・制御・計測する対象。列挙型項目。定義はControlledProperty。例えば”水位”、”温度”など。
dataProvider	プロバイダ	0::1	Text	このEntityに対するプロバイダを特定する文字列。今回のユースケースではプロバイダは存在しません。
description	説明	0::1	Text	機種情報として公開可能な詳細情報
deviceClass	クラス	0::1	Text	制約条件付きデバイス(constrained device)のクラスです。RFC7228で規定。制約条件付きデバイスではない場合、意味を持ちません
documentation	ドキュメント	0::1	URI	デバイスのドキュメントに対するリンク
energyLimitationClass	エネルギークラス	0::1	Text	これも、デバイスのクラスです。RFC7228で規定されています
function	機能	0::n	Array	デバイスの機能です。SAREFで規定されており、levelControl, sensing, onOff, openClose, metering, eventNotificationなどがある
image	写真	0::1	URL	デバイスの写真等のurlです。
manufacturerName	メーカ名	1::1	Text	メーカ名を設定する。例えば”日立製作所”	必須
modelName	モデル名	1::1	Text	機器のモデル名を設定する。例えば”RAS-DM28KE8″	必須
name	機種名	0::1	Text	機種に個別に名称が付いているときに、その名称を設定する
owner	所有者	0::n	Array	所有者のidです
seeAlso	追加情報	0::n	Array	追加情報のURIを格納します。つまり、idやurlが入ります。
serviceLife	耐用年数	0::1	Number	耐用年数です。会計上、税務上の耐用年数ではなく、実際に利用可能な年数です	〇
source	データー提供者	0::1	URL	データ提供者のurlです
supportedProtocol	プロトコル	0::n	Array	サポートしているプロトコルです
supportedUnits	精度	0::n	Array	サポートしている測定値の精度です

技術情報

2023-04-15

定義名	DeviceModel
継承元データモデル	Smart Data Models/DeviceModel
参照データモデル	なし
URI	https://ppp-database/spec/datamodel/DeviceModel
JSON Schema	このJSON SchemaはNormalized形式に対応しています。必要に応じて、形式チェックの項目を追加するなどして利用する事ができます。本JSON Schemaはデータ仕様の変更や、JSON schemaに対する要望により、予告なく更新されます
補足	設備の機種などの機種間の共通情報です。Smart Data Modelとの相違点は次の通りです。controlledPropertyの列挙型メンバの定義が日本語になっている点、controlledPropertyが省略可能となっている点、deviceCategoryとmacAddressを削除した点です