YAMLプロジェクト形式

YAML（YAML Ain't Markup Language）は構造化データを表現するテキスト形式です。 インデント（スペース）で階層を表現するため、特別なツールなしで読み書きできます。

キーと値のペア

基本的なデータはキー: 値のペアで記述します:

name: "My Project"
rotation_type: 1
enabled: true

インデント = ネスト（入れ子）

ネスト構造はスペースによるインデントで表現します（1レベルにつき2スペース）:

plc:
  provider: KEYENCE
  config:
    ip_or_hostname: "192.168.0.10"
    port_no: 8501

リスト（配列）

リストの各要素は-（ハイフン + スペース）で始めます:

pages:
  - uuid: "page-001"
    page_no: 1
    title: Main
  - uuid: "page-002"
    page_no: 2
    title: Settings

データ型

コメント

#で始まる行はコメントとして無視されます:

# これはコメントです
name: "My Project"   # インラインコメントも可能

YAMLプロジェクトはproject.yamlファイルとオプションのimages/サブフォルダーを含むフォルダーです:

ProjectName/
  project.yaml       # プロジェクト設定（必須）
  images/             # 画像ファイル（オプション）
    {uuid}.png        # UUIDで参照される背景画像

project.yamlファイルにはすべてのプロジェクト設定、ページ、アイテム、各種設定が含まれます。 プロジェクト、ページ、アイテムの背景画像はimages/フォルダーにUUIDで命名されたPNGファイルとして格納されます。

ラベルとボタンを1つずつ含む1ページの最小構成プロジェクトです:

uuid: "00000000-0000-0000-0000-000000000001"
name: "My Project"
screen_size_string: "768x1024"
rotation_type: 1

plc:
  model: KV-8000
  provider: KEYENCE
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 8501

pages:
  - uuid: "00000000-0000-0000-0000-100000000001"
    page_no: 1
    title: Main
    items:
      - uuid: "00000000-0000-0000-0000-200000000001"
        class: Label
        frame_string: "{{50, 50}, {200, 40}}"
        title: Temperature
        text_color_name: "RGBA,0.0,0.0,0.0,1.0"
      - uuid: "00000000-0000-0000-0000-200000000002"
        class: Button
        frame_string: "{{50, 120}, {120, 50}}"
        title: Start
        switch_device_name: MR100
        switch_mode: momentary

必須フィールド: plcとpagesは必須です。 plcセクションがないとインポート時にエラーになります。 uuid、nameは省略可能で、省略時は自動生成されます。 各ページのuuidとpage_noも省略時は自動補完されます。 各アイテムのuuidとframe_stringも省略可能（デフォルト値が適用されます）。 classは必須ですが、小文字や別名（例: gauge, slider, alarm, grid等）も使用できます。

プロジェクト全体を構成するトップレベルのプロパティ:

grid:
  style: 1
  enabled: 1
  pixel: 10.0

plcセクションでPLC接続を設定します。このセクションは必須です。省略するとインポートエラーになります。 対応PLCプロバイダーとモデルについては PLC接続 のドキュメントを参照してください。

KEYENCE の例

plc:
  model: KV-8000
  provider: KEYENCE
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 8501

三菱電機（MCプロトコル）の例

plc:
  model: iQ-R
  provider: MITSUBISHI
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 5000

オムロン（FINS）の例

plc:
  model: NJ
  provider: OMRON
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 9600
      self_node: 0
      destination_node: 0

MODBUS/TCPの例

plc:
  model: MODBUS
  provider: MODBUS
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 502
      unit_id: 1

PLCプロバイダー / モデル / チャンネル一覧

設定オプション

pages:
  - uuid: "page-uuid-1"
    page_no: 1
    title: Main
    background_color_name: "RGBA,0.95,0.95,0.95,1.0"
    items:
      - ...

ページナビゲーション（スワイプ）

ページ間のスワイプナビゲーションをUUID参照で設定できます:

各アイテムにはclassフィールドでタイプを指定します:

すべてのアイテムに共通するプロパティ:

静的テキストまたはデバイス値に基づくテキストを表示します。

- uuid: "label-uuid"
  class: Label
  frame_string: "{{50, 50}, {200, 40}}"
  title: Temperature
  text_color_name: "RGBA,0.0,0.0,0.0,1.0"
  background_color_name: "RGBA,0.9,0.9,0.9,1.0"
  alignment: 1
  font_size: 18.0

PLCデバイスをON/OFFでき、ランプ状態を表示する対話型ボタンです。 スイッチデバイスを指定しない場合はランプインジケーターとして動作します。

- uuid: "button-uuid"
  class: Button
  frame_string: "{{50, 100}, {120, 50}}"
  title: Start
  alternate_title: Stop
  switch_device_name: MR100
  switch_mode: momentary
  lamp_device_name: MR100
  lamp_color_name: "RGBA,0.0,0.8,0.0,1.0"
  style: irPanel

スイッチプロパティ

ランププロパティ

ページナビゲーション

ボタンスタイル

PLCデバイスの数値やテキストを表示・編集するフィールドです。

- uuid: "value-uuid"
  class: ValueField
  frame_string: "{{300, 100}, {150, 40}}"
  title: Temperature
  device_name: DM100
  editable: 0
  decimal_place: 1
  unit: "\u00B0C"
  number_type: 2
  min_value: 0.0
  max_value: 999.0
  text_color_name: "RGBA,0.0,0.0,0.0,1.0"
  field_background_color_name: "RGBA,1.0,1.0,1.0,1.0"

+/-ボタン付きの値フィールド、またはスライダーやプログレスバーとして表示されます。

- uuid: "slider-uuid"
  class: SteppedValueField
  frame_string: "{{50, 200}, {300, 40}}"
  title: Speed
  device_name: DM200
  step_value: 1.0
  min_value: 0.0
  max_value: 100.0
  style: slider

値フィールドのすべてのプロパティ（device_name、min_value、max_value、number_typeなど）を継承します。

PLCデバイスの値をアナログゲージで表示します。

- uuid: "meter-uuid"
  class: Meter
  frame_string: "{{50, 300}, {200, 200}}"
  title: Pressure
  device_name: DM300
  min_value: 0.0
  max_value: 100.0
  figures: 5
  major: 20
  minor: 10
  unit: MPa
  decimal_place: 1

メーターゾーン

meter_zones:
  - color_name: "RGBA,0.0,0.8,0.0,1.0"
    from_value: 0.0
    to_value: 60.0
  - color_name: "RGBA,1.0,0.8,0.0,1.0"
    from_value: 60.0
    to_value: 80.0
  - color_name: "RGBA,1.0,0.0,0.0,1.0"
    from_value: 80.0
    to_value: 100.0

スタンドアロンの状態表示インジケーター。ボタンと同じクラス（Button）で、スイッチデバイスを指定しないことでランプとして動作します。

- uuid: "lamp-uuid"
  class: Button
  frame_string: "{{300, 50}, {60, 60}}"
  title: Running
  lamp_device_name: MR200
  lamp_color_name: "RGBA,0.0,0.8,0.0,1.0"
  alternate_lamp_color_name: "RGBA,0.5,0.5,0.5,1.0"
  style: Circle

ボタンと同じランププロパティ（lamp_device_name、lamp_color_name、lamp_negativeなど）を使用します。 switch_device_nameを省略すると、ランプインジケーターになります。

メッセージセットからのメッセージリストを表示します。メッセージはPLCデバイス値に基づいてアクティブになります。

- uuid: "message-uuid"
  class: Message
  frame_string: "{{50, 400}, {400, 200}}"
  message_set_uuid: "msgset-uuid-1"
  active_color_name: "RGBA,1.0,0.0,0.0,1.0"
  inactive_color_name: "RGBA,0.9,0.9,0.9,1.0"
  active_only: true

テンプレートアイテムを行列で繰り返し、デバイスアドレスオフセットで展開する表/グリッドレイアウトです。 詳細は マトリックス のドキュメントを参照してください。

- uuid: "matrix-uuid"
  class: Matrix
  frame_string: "{{50, 50}, {600, 400}}"
  matrix_rows: 5
  matrix_columns: 3
  matrix_device_offset: 10
  matrix_add_borders: true
  matrix_border_color_name: "RGBA,0.7,0.7,0.7,1.0"
  matrix_has_column_header: true
  matrix_has_row_header: true

マトリックステンプレート

マトリックスはセルテンプレートを定義でき、インポート時に全行列にわたって自動展開されます。 テンプレートは各セルに表示するアイテムを定義し、デバイスオフセットルールがグリッド全体のデバイスアドレスの増分を制御します。

テンプレートはmatrix_template_jsonで定義します。 YAML形式でアイテム定義の配列として直接記述できます（JSON文字列でも可）。 座標はセル原点(0, 0)からの相対位置です。 テンプレートがあるが未展開のマトリックスは、YAMLインポート時に自動的に展開されます。

- uuid: "matrix-uuid"
  class: Matrix
  frame_string: "{{50, 50}, {600, 300}}"
  matrix_rows: 3
  matrix_columns: 4
  matrix_add_borders: true
  matrix_border_color_name: "RGBA,0.7,0.7,0.7,1.0"
  matrix_template_cell_width: 140.0
  matrix_template_cell_height: 60.0
  matrix_template_json:
    - class: Label
      uuid: "tpl-001"
      frame_string: "{{2, 2}, {60, 26}}"
      title: CH1
      font_size: 12.0
      text_color_name: "RGBA,0.3,0.3,0.3,1.0"
    - class: ValueField
      uuid: "tpl-002"
      frame_string: "{{2, 30}, {136, 28}}"
      device_name: DM100
      number_type: 2
      decimal_place: 1
      unit: "\u00B0C"
      text_color_name: "RGBA,0.0,0.0,0.0,1.0"
      field_background_color_name: "RGBA,1.0,1.0,1.0,1.0"
      border_style: 3
  matrix_device_offset_rules:
    - id: "rule-1"
      itemUUID: "*"
      property: device_name
      rowOffset: 10
      colOffset: 1

デバイスオフセットルール

matrix_device_offset_rulesは行・列間でデバイスアドレスをどのように変化させるかを制御するルールの配列です。

各セルのデバイスアドレスは以下の式で計算されます:
offset = row * rowOffset + col * colOffset

テンプレート例の説明

上記の例は3x4の温度監視グリッドを作成します:

• 各セルにはラベル（"CH1"）とDM100を読み取る値フィールドが含まれます
• タイトルテキストは自動的にインクリメント: CH1, CH2, CH3, ...
• デバイスオフセットルール: rowOffset: 10, colOffset: 1
  セル(0,0)はDM100、セル(0,1)はDM101、セル(1,0)はDM110を読み取ります。

ページ内にWebブラウザビューを埋め込みます。

- uuid: "web-uuid"
  class: WebPage
  frame_string: "{{50, 50}, {600, 400}}"
  url: "https://example.com"

アイテムテキストの翻訳はプロジェクトレベルのlocalizedStrings配列で定義します。 各エントリはアイテムUUIDとフィールドキーを特定のロケールの翻訳文字列にマッピングします。

localizedStrings:
  - localeIdentifier: ja
    key: "item-uuid-1.title"
    text: "\u30B9\u30BF\u30FC\u30C8"
  - localeIdentifier: ja
    key: "item-uuid-1.alternate_title"
    text: "\u30B9\u30C8\u30C3\u30D7"
  - localeIdentifier: fr
    key: "item-uuid-1.title"
    text: "D\u00E9marrer"

ローカライズ可能なフィールド

• title — アイテムタイトル
• alternate_title — 代替タイトル（ボタンのトグル状態）
• unit — 単位テキスト（ValueField、Meter）
• message_ — メッセージテキスト（MessageItem）
• detail_message — 詳細メッセージテキスト（MessageItem）
• title_ — メッセージセットタイトル

メッセージセットはメッセージアイテムで表示されるメッセージのグループを定義します。 各メッセージはPLCデバイス値によってトリガーされます。

messageSets:
  - uuid: "msgset-uuid-1"
    no: 1
    title_: Alarms
    order_style: 0
    messageItems:
      - device_name: DM500
        value: 1.0
        number_type: 0
        message_: "Motor overload"
        detail_message: "Motor overload detected. Check motor wiring."
        disabled: false
        order_style: 0
      - device_name: DM500
        value: 2.0
        number_type: 0
        message_: "Temperature high"
        detail_message: "Temperature exceeds the limit."
        disabled: false
        order_style: 1

メッセージアイテムのプロパティ

色はRGBA形式の文字列で指定します:

"RGBA,R,G,B,A"

R、G、B、Aは0.0から1.0の浮動小数点値です。

例

アイテムの位置とサイズはCGRect文字列形式で指定します:

"{{x, y}, {width, height}}"

値はポイント単位です。原点(0, 0)はページの左上隅です。 座標系はscreen_size_stringの寸法に対応します。

例

"{{0, 0}, {768, 1024}}"      # フルページ（縦向き）
"{{50, 50}, {200, 40}}"       # 左上付近の小さなアイテム
"{{384, 512}, {100, 50}}"     # 中央付近のアイテム（概算）

screen_size_string: "768x1024"、rotation_type: 1（横向き）のプロジェクトでは、 座標空間は幅1024ポイント、高さ768ポイントになります。

プロジェクト、ページ、アイテムの背景画像を使用するには:

1. images/フォルダーにUUIDで命名されたPNG画像ファイルを配置します（例: abc-123.png）。
2. YAMLでbackground_imageオブジェクトを使って画像を参照します:

background_image:
  uuid: "abc-123"
  kind: page_background

画像の種類

デバイス名はPLCプロバイダーによって異なります。各プロバイダーの一般的なデバイス名は以下の通りです:

キーエンス（KVシリーズ）

三菱電機（MCプロトコル）

オムロン（FINS）

MODBUS/TCP

注意: ビットデバイス（MR、M、COなど）はswitch_device_name、lamp_device_name、visible_device_nameに使用します。 ワードデバイス（DM、D、HRなど）はdevice_name（値の読み書き）に使用します。

KEYENCE KV-8000 PLCを使用した、2ページ、各種アイテム、メッセージセット、日本語ローカライズを含む完全なプロジェクトの例:

uuid: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
name: "Factory Monitor"
screen_size_string: "768x1024"
rotation_type: 1
style: default
background_color_name: "RGBA,0.95,0.95,0.95,1.0"

grid:
  style: 1
  enabled: 1
  pixel: 10.0

plc:
  model: KV-8000
  provider: KEYENCE
  plc_channel:
    config:
      ip_or_hostname: "192.168.0.10"
      port_no: 8501

pages:
  - uuid: "page-0001"
    page_no: 1
    title: Main
    right_page_uuid: "page-0002"
    items:
      - uuid: "item-0001"
        class: Label
        frame_string: "{{20, 20}, {300, 40}}"
        title: Factory Monitor
        text_color_name: "RGBA,0.0,0.0,0.0,1.0"
        font_size: 24.0
        alignment: 0
      - uuid: "item-0002"
        class: Button
        frame_string: "{{20, 80}, {150, 60}}"
        title: Start
        alternate_title: Stop
        switch_device_name: MR100
        switch_mode: alternate
        lamp_device_name: MR100
        lamp_color_name: "RGBA,0.0,0.8,0.0,1.0"
        style: irPanel
      - uuid: "item-0003"
        class: Button
        frame_string: "{{200, 80}, {60, 60}}"
        title: Run
        lamp_device_name: MR200
        lamp_color_name: "RGBA,0.0,0.8,0.0,1.0"
        alternate_lamp_color_name: "RGBA,0.5,0.5,0.5,1.0"
        style: Circle
      - uuid: "item-0004"
        class: Label
        frame_string: "{{20, 170}, {120, 30}}"
        title: Temperature
        text_color_name: "RGBA,0.3,0.3,0.3,1.0"
      - uuid: "item-0005"
        class: ValueField
        frame_string: "{{150, 160}, {150, 50}}"
        device_name: DM100
        number_type: 2
        decimal_place: 1
        unit: "\u00B0C"
        min_value: 0.0
        max_value: 999.0
        text_color_name: "RGBA,0.0,0.0,0.0,1.0"
        field_background_color_name: "RGBA,1.0,1.0,1.0,1.0"
        border_style: 3
      - uuid: "item-0006"
        class: Meter
        frame_string: "{{20, 230}, {280, 280}}"
        title: Pressure
        device_name: DM200
        number_type: 2
        min_value: 0.0
        max_value: 100.0
        figures: 6
        major: 20
        minor: 10
        unit: MPa
        decimal_place: 1
        meter_zones:
          - color_name: "RGBA,0.0,0.8,0.0,1.0"
            from_value: 0.0
            to_value: 60.0
          - color_name: "RGBA,1.0,0.8,0.0,1.0"
            from_value: 60.0
            to_value: 80.0
          - color_name: "RGBA,1.0,0.0,0.0,1.0"
            from_value: 80.0
            to_value: 100.0
      - uuid: "item-0007"
        class: SteppedValueField
        frame_string: "{{350, 160}, {300, 50}}"
        title: Speed
        device_name: DM300
        step_value: 5.0
        min_value: 0.0
        max_value: 100.0
        number_type: 2
        unit: "%"
        style: slider
      - uuid: "item-0008"
        class: Button
        frame_string: "{{850, 20}, {120, 40}}"
        title: "Alarms >>"
        page_uuid: "page-0002"

  - uuid: "page-0002"
    page_no: 2
    title: Alarms
    left_page_uuid: "page-0001"
    items:
      - uuid: "item-0009"
        class: Label
        frame_string: "{{20, 20}, {200, 40}}"
        title: Alarm List
        text_color_name: "RGBA,0.0,0.0,0.0,1.0"
        font_size: 24.0
      - uuid: "item-0010"
        class: Message
        frame_string: "{{20, 80}, {600, 400}}"
        message_set_uuid: "msgset-0001"
        active_color_name: "RGBA,1.0,0.9,0.9,1.0"
        inactive_color_name: "RGBA,0.95,0.95,0.95,1.0"
        active_text_color_name: "RGBA,0.8,0.0,0.0,1.0"
        inactive_text_color_name: "RGBA,0.3,0.3,0.3,1.0"
        show_detail: true
        show_title: true
      - uuid: "item-0011"
        class: Button
        frame_string: "{{850, 20}, {120, 40}}"
        title: "<< Main"
        page_uuid: "page-0001"

messageSets:
  - uuid: "msgset-0001"
    no: 1
    title_: Alarms
    order_style: 0
    messageItems:
      - device_name: DM500
        value: 1.0
        number_type: 0
        message_: "Motor overload"
        detail_message: "Motor overload detected. Check wiring."
        disabled: false
        order_style: 0
      - device_name: DM500
        value: 2.0
        number_type: 0
        message_: "Temperature high"
        detail_message: "Temperature exceeds limit."
        disabled: false
        order_style: 1
      - device_name: DM500
        value: 3.0
        number_type: 0
        message_: "Emergency stop"
        detail_message: "Emergency stop activated."
        disabled: false
        order_style: 2

localizedStrings:
  - localeIdentifier: ja
    key: "item-0001.title"
    text: "\u5DE5\u5834\u30E2\u30CB\u30BF\u30FC"
  - localeIdentifier: ja
    key: "item-0002.title"
    text: "\u30B9\u30BF\u30FC\u30C8"
  - localeIdentifier: ja
    key: "item-0002.alternate_title"
    text: "\u30B9\u30C8\u30C3\u30D7"
  - localeIdentifier: ja
    key: "item-0003.title"
    text: "\u904B\u8EE2\u4E2D"
  - localeIdentifier: ja
    key: "item-0004.title"
    text: "\u6E29\u5EA6"
  - localeIdentifier: ja
    key: "item-0006.title"
    text: "\u5727\u529B"
  - localeIdentifier: ja
    key: "item-0007.title"
    text: "\u901F\u5EA6"
  - localeIdentifier: ja
    key: "item-0009.title"
    text: "\u30A2\u30E9\u30FC\u30E0\u4E00\u89A7"

• 自動補完: プロジェクト・ページ・アイテムのuuidは省略可能で、インポート時に自動生成されます。 name、page_no、frame_stringも省略時にデフォルト値が自動補完されます。
• PLC設定は必須: plcセクションは必ず指定してください。省略するとインポートエラーになります。 providerとmodelを指定すれば、PLC内部のclass_nameは自動解決されます。
• クラス名の別名: classは大文字小文字を問いません。また以下の別名が使えます: gauge→Meter、alarm→Message、grid→Matrix、slider→Slider、progress_bar→Progress、value_field→ValueField、web_page→WebPage。
• frame_stringの代替形式: "{{x, y}, {width, height}}" の他に "x, y, width, height" 形式も使用できます。
• 座標系: 横向きプロジェクト（rotation_type: 1）でscreen_size_string "768x1024"の場合、使用可能な領域は幅1024 x 高さ768です。 この範囲を超えてアイテムを配置しないでください。
• デバイス名の一貫性: デバイス名がPLCプロバイダーの構文に合っていることを確認してください。スイッチ/ランプにはビットデバイス、値にはワードデバイスを使用します。
• 最小間隔: 読みやすさのため、アイテム間に少なくとも5〜10ポイントの間隔を空けてください。
• フォントサイズ: 推奨サイズ: タイトル18〜24pt、ラベル14〜16pt、値16〜20pt。
• メッセージセット: メッセージアイテムのmessage_set_uuidはmessageSets配列のUUIDと一致する必要があります。
• ローカライズ: localizedStringsのkeyは"{item_uuid}.{field_name}"形式です。 一般的なフィールド: "title"、"alternate_title"、"unit"。
• インポート動作: インポート時に同じUUIDのプロジェクトが存在する場合は上書きされます。 新しいコピーを作成するにはUUIDを変更してください。
• Lite版の制限: irBoard Liteでは、インポート時にプロジェクトが最大2ページ、1ページあたり最大10アイテムに切り詰められます。 超過分のページやアイテムはインポート時に自動的に削除されます。切り詰めが行われた場合はインポート後に通知が表示されます。