プロジェクトディレクトリの構成 #

actdk initによって作成されるディレクトリについて説明します。

• app
• model
• include
• manifesto
• .actdk
• .actdk/cache
• .actdk/long_descriptions

app #

appディレクトリは Actcast アプリケーション内で動作させるスクリプト・実行ファイルを配置するディレクトリです。 appディレクトリに含まれるファイルはすべてアプリケーションイメージの中に転送されます。

model #

modelディレクトリは nnoir ファイルを置くためのディレクトリです。 このディレクトリに置かれた nnoir ファイルは深層学習モデルからスタブ C ランタイムを生成するactdk compile において変換の対象になります。

include #

上記のactdk compileにおいて生成されるスタブ C ランタイムを利用するためのヘッダーファイルが置かれるディレクトリです。

manifesto #

実行時に必要となるリソースを記述するためのマニフェストが置かれるディレクトリです。 初期化時には以下のファイルが含まれます。

• default.json
• pi4_or_later.json

ファイル名は任意で、複数のファイルを置けます。 サポートするボードとそのボード上で動作する際に必要なデバイスを記述します。

.actdk #

Actcast アプリケーションのプロジェクトの設定を記述するためのディレクトリです。 次のファイルが含まれます。

• dependencies.json
• files.json
• setting.json

dependencies.json #

dependencies.jsonは作成する Actcast アプリケーションが利用するパッケージを記述します。

詳細については依存パッケージの追加を参照してください。

files.json #

files.jsonはプロジェクトの構成についての設定を記述します。 エントリポイントやイメージの死活監視のためのファイル名などの設定を変更することができますが、通常変更する必要はありません。

{
  "main": "main",
  "healthchecker": "healthchecker",
  "act_setting": "act_settings.json"
}

setting.json #

setting.jsonはプロジェクトの基本設定が記述されるファイルです。 actdk initコマンドにより自動生成されますが、必要に応じて手動で編集もできます。 ただし編集後にactdk init --deriveを実行すると上書きされてしまうので、注意してください。

{
  "app_id": "example",
  "app_server_id": 48,
  "short_description": "A test application",
  "short_descriptions": {
    "ja": "テストアプリケーション",
    "eo": "Una testa aplikaĵo"
  },
  "target_types": [
    "raspberrypi-buster"
  ],
  "apt_repository": "http://one.of/raspbian/mirror"
}

• "app_id"
  • アプリケーション名
• "app_server_id"
  • アプリケーション ID
• "short_description"
  • 1 行説明
• "short_descriptions"
  • 英語以外の言語向けの 1 行説明。プロパティ名にISO 639-1 で指定された言語コードを、値にその言語での説明を書きます。
• "target_types"
  • "raspberrypi-buster", "raspberrypi" のいずれかのリストです。ここの記述は dependencies.json と manifesto/*.json と一致している必要があります。 "raspberrypi" は古いターゲットタイプなので非推奨であり、 Manifesto V2 では利用できません。
• "apt_repository"
  • ビルド時に特定の apt ミラーを利用したい場合に指定。デフォルトではmirror redirection systemが利用されます。

.actdk/cache #

actdk がプロジェクトに関するキャッシュの情報を保存しておくディレクトリです。ユーザが直接編集してはいけません。 プロジェクトを git で管理している場合、このディレクトリを .gitignore に記述することを推奨します。

actdk の version 1.7.0 より前では代わりに .actdklastremote や .actdkbuildid が用いられていましたが、 version 1.7.0 でこれらの古い形式は廃止されました。 .actdk/cache/project_state.json が存在せずかつこれらのファイルが存在するとき、actdk のいくつかのコマンドはこれらを新しい形式に自動的に変換します。

.actdk/long_descriptions #

アプリケーションの説明を英語以外の言語でも用意する場合、このディレクトリに説明を書いたファイルを置きます。ファイル名はISO 639-1 で指定された言語コードにします。拡張子として.mdが使用できます

アプリケーション開発 トップへ