目次

はじめに

AdamApp は、定められた形式（AdamApp パッケージ形式）にパッケージングをして、インス トールする必要があります。このため、AdamAppSDK では、AdamApp のビルドと AdamApp パッケージ 作成を、容易に行える環境を提供します。

本章では、AdamApp のビルド、及び、AdamApp パッケージ形式の作成に必要な情報と手順について、 AdamAppSDK で提供するサンプルプログラム(SkeletonSampleApp)を用いて説明します。

また、このチュートリアルでは、SDKのインストールディレクトリを${SDK_DIR}として記載します。

開発環境のディレクトリ構成

AdamAppSDK のディレクトリ構成は、以下のようになります。

${SDK_DIR}/ 追加アプリ作成トップディレクトリ

bin/ Adam 実行プログラムのディレクトリ

build_config/ make 用ルールファイルのディレクトリ

conf/ 設定情報用ディレクトリ

external/ AdamApp で利用する Open Source ライブラリファイルのディレクトリ

include/ AdamApp 用ヘッダファイルディレクトリ

lib/ AdamApp 用ライブラリファイルディレクトリ

src/ AdamApp のソースコードを格納するディレクトリ

tool/ ツール類のディレクトリ

www/ Adam の操作用 HTML ページを格納するディレクトリ(未使用)

sdk_version.txt AdamSDK のバージョンを書いたファイル

setup_env.sh make 環境設定用ファイル

 これ以降の節で、各ディレクトリ/ファイルの詳細な説明を行います。

include: AdamApp のヘッダーファイルのディレクトリ

include ディレクトリは、AdamApp（追加アプリ）を作成する際に必要なヘッダファイルを置いています。提供するヘッダファイルは以下の通りです。

AdamType.h Adam の型定義がされているヘッダファイルです。

AdamApi.h 追加アプリ用 API ヘッダです。

lib: AdamApp のライブラリのディレクトリ

lib ディレクトリは、AdamApp（追加アプリ）を作成する際に必要なライブラリファイルを置いています。提供するライブラリファイルは、以下の通りです。

libadam_common.so / libadam_common.a

Adam 共通ライブラリ: Adam 関連プロセスの共通ライブラリです。

libadam.so / libadam.a
追加アプリ用 API ライブラリ: 追加アプリ向けの API を提供するライブラリです。

なお、ライブラリファイルは、実行環境毎に異なるものを使う必要があります。このため、実行環境毎のディレクトリを作り、その下に、それぞれの実行環境用のライブラリファイルを用意しています。

${SDK_DIR}/lib/aarch64-linux-gnu/

i-pro ambaCV2X model 用ライブラリ

src: AdamApp のソースファイルのディレクトリ

src ディレクトリは、AdamApp（追加アプリ）のソースファイルを格納するディレクトリです。この srcディレクトリの直下に、AdamApp 毎のディレクトリをさらに作成して、そこにソースファイルを置くことを想定しています。
AdamApp のソースファイルの配置方法を理解しやすくするため、AdamApp のサンプルとして、srcディレクトリ直下に、skelton_sample_appディレクトリを配置しています。ユーザは、このskelton_sample_app ディレクトリをコピーして、そのコピーしたディレクトリ内でソースファイルを作成することで、ビルド環境の構築が容易になります。なお、skelton_sample_app ディレクトリ以下には、実際にビルド＆可能な簡単なサンプルアプリケーションを格納していますので、AdamApp の API の使用方法の参考にすることができます。srcディレクトリ、及び、skelton_sample_app ディレクトリは、以下の構成になっています。

${SDK_DIR}/src/adamapp/

adamapp_setting.mk Make 用共通設定ファイル

adam_make_package.mk Make用共通ルールファイル

${SDK_DIR}/src/adamapp/skeleton_sample_app/

bin/ AdamApp 実行プログラムを格納するディレクトリ

conf/ コンフィギュレーション情報を格納するディレクトリ

data/ AdamApp 用外部データファイルを格納するディレクトリ

external/ AdamApp で使う外部ソフトウェアを配置するディレクトリ

setup/ セットアップスクリプトファイルを格納するディレクトリ

Makefile メイクファイル

configuration.txt コンフィギュレーションファイル

skeletonSampleApp.cpp サンプルアプリソースプログラム

bin: Adam 実行プログラムのディレクトリ

作成した AdamApp（追加アプリ）を実行させるために必要となる、Adam の実行プログラムを置いています。提供している実行プログラムは、下記のものになります。

adamCore : Adam の主制御を行うプログラムです。
adam.cgi : Adam の CGI プログラムです。HTTP サーバから呼び出されます。
sdkCam : sdkCAM のプログラムです。

なお、実行プログラムは、実行環境毎に異なるものを使う必要があります。このため、実行環境毎のディレクトリを作り、その下に、それぞれの実行環境用の実行プログラムを用意しています。

${SDK_DIR}/bin/

i686-linux-gnu/ PC(32bit 版)実行用バイナリ

X86_64-linux-gnu/ PC(64bit 版)実行用バイナリ

build_config: ビルド用基本設定ファイルのディレクトリ

build_config ディレクトリは、AdamApp アプリのビルドの際に必要となる make 用ルールファイルを格納しています。通常は、このディレクトリ以下のファイルを編集する必要はありません。もし、ユーザ独自で make ルールを変更したい場合には、このディレクトリ以下のファイルを編集してください。

tool: ツールのディレクトリ

tool ディレクトリは、コンフィギュレーション情報生成ツールなどの Adam 用のツールや、Adam 起動用スクリプトファイルなど、Adam 関連ファイルの作成や実行を行うツール類を格納したディレクトリです。
提供するツールは、下記のものになります。

adamapp_configurator コンフィギュレーションファイルからコンフィギュレーション情報を生成するスクリプト
httpdctl.sh httpd 起動、終了スクリプト (busybox httpd を使います)
startAdam.sh Adam 起動スクリプト
stopAdam.sh Adam 終了スクリプト

external: AdamApp に使用されるオープン ソース ライブラリのディレクトリ

external ディレクトリは、AdamApp のビルドに必要な Open Source のライブラリファイルを置いています。このディレクトリに格納されている Open Source の種類については、adamappsdk/external/license を参照してください。
なお、ライブラリファイルは、実行環境毎に異なるものを使う必要があります。このため、ターゲット毎のディレクトリを作り、その下に、それぞれの実行環境用のライブラリファイルを用意しています。

${SDK_DIR}/external/license/
external ディレクトリに格納されている Open Source のライセンスを置き場です。

 

${SDK_DIR}/external/lib/aarch64-linux-gnu/
i-pro ambaCV2X model 用ライブラリ

sdk_version.txt: SDK のバージョン ファイル

iPRO_CAMERA_SDK のバージョン情報が記載されています。

setup_env.sh: 設定ファイル

ビルドに必要な環境設定ファイルです。

AdamApp のパッケージ形式

AdamApp パッケージ形式とは、カメラにインストールする際のパッケージ形式です。 具体的には、下記に示すディレクトリ構成で、かつ、これらを zip 化 ＋ 暗号化したものです。※C/C++を例に記載します。

bin/

AdamApp 実行プログラムを格納するディレクトリ

conf/

コンフィギュレーション情報を格納するディレクトリ

data/data_CV2X/data_CV5X

AdamApp 用外部データファイルを格納するディレクトリ
※data_CV2X/data_CV5X はSDK1.80以降のみ

 

external/

AdamApp で使う外部ソフトウェアを配置するディレクトリ

setup/

セットアップスクリプトファイルを格納するディレクトリ

上記のディレクトリに、AdamApp の実行プログラムや、コンフィギュレーション情報などの関連ファイ ルを配置します。それぞれのディレクトリの詳しい説明は、下記の通りです。

⚫ bin ディレクトリ： AdamApp 実行プログラムを格納するディレクトリ

bin ディレクトリは、AdamApp の実行プログラムを格納するディレクトリです。実行プログラ ム名は、任意の名前で構いません。 なお、AdamAppSDKを用いて、AdamAppをビルド、パッケージ化した場合には、このディレ クトリに、実行プログラムが自動的に配置されます。その際、実行プログラム名は、Makefile の PROG_NAME マクロで指定した名前となります。

⚫ conf ディレクトリ： コンフィギュレーション情報を格納するディレクトリ

conf ディレクトリは、AdamApp 用のコンフィギュレーション情報を格納するディレクトリで す。コンフィギュレーション情報は、applicense.bin と profile.binの 2つのファイルが必須です。 applicense.bin と profile.bin の 2 つのファイルは、adamapp_configurator というツールを用い て、コンフィギュレーションファイル（AdamAppSDK のサンプルでは、configuration.txt とい う名前で配置しています）から生成します。コンフィギュレーションファイルの記載方法につい ては、コンフィギュレーションファイルのフォーマットを参照してください。 なお、 AdamAppSDK を用いて、 AdamApp をビルド、パッケージ化した場合には、 configuration.txt から applicense.bin と profile.bin を自動的に生成して、このディレクトリに配 置します。

⚫ data/data_CV2X/data_CV5X ディレクトリ： AdamApp 用外部データファイルを格納するディレクトリ

data ディレクトリは、AdamApp 用外部データファイルを配置できる唯一のディレクトリで す。 AdamApp 用外部データファイルを、インストール時に同時にコピーしたい場合には、そのフ ァイルをこの下に配置します。インストール時に、コピーしたい AdamApp 用外部データファイ ルがない場合は、このディレクトリは空にしておきます。
data_CV2Xディレクトリは、ambaCV2X用のAdamApp 用外部データファイルを配置できるディレクトリで す。
data_CV5Xディレクトリは、ambaCV5X用のAdamApp 用外部データファイルを配置できるディレクトリで す。
ambaCV2XおよびambaCV5Xで共用する場合はdataディレクトリにAdamApp 用外部データファイルを格納すれば、共用されます。ambaCV2XおよびambaCV5XでAdamApp 用外部データファイルを区別する場合はdata_CV2Xディレクトリおよびdata_CV5Xディレクトリの下に配置します。

AIアクセラレータを使用する場合は、変換したバイナリデータをcnn ディレクトリの下に配置します。

⚫ external ディレクトリ： AdamApp で使う外部ソフトウェアを配置するディレクトリ

AdamApp で利用する外部ソフトウェアのライブラリファイル(.a や.so ファイル)とヘッダファイル (.h .hpp .hxx ファイルなど)を、external ディレクトリ以下に配置してください。

⚫ setup ディレクトリ： セットアップスクリプトファイルを格納するディレクトリ

setup ディレクトリは、AdamApp のインストール時、アップデート時、アンインストール時に 実行させたいシェルスクリプトを格納します。記述できるシェルスクリプトは、Bourne Shell （実際には、Bourne Shell 互換シェルである ash を利用)スクリプトのみです。 シェルスクリプトは、下記の環境変数が渡されて実行されますので、シェルスクリプト内から これら環境変数を参照することができます。

ADAM_INSTALLID

AdamApp のインストール ID

 

ADAM_APP_DATA_DIR

AdamApp 用外部データファイルを格納するディレクトリのパス (= data ディレクトリのパス)

 

ADAM_APP_TMP_DIR

AdamApp の一時的なファイルを格納するディレクトリのパス

それぞれのシェルスクリプト名は、コンフィギュレーションファイルで指定します。 なお、シェルスクリプトを使うかどうかを、スクリプト毎に任意に設定可能です。使わない場 合は、コンフィギュレーションファイルに、シェルスクリプトのファイル名を記載しないでくだ さい。（その際、setup ディレクトリに、スクリプトファイルを配置しても問題は発生しません が、FlashROM の容量を無駄に消費することになりますので、配置しない方がよいです。）

➢ インストールスクリプト（任意）

AdamApp をインストールする際に実行されるシェルスクリプトです。AdamApp がインス トールされた直後に実行されます。

➢ アップデートスクリプト（任意）

AdamApp をアップデートする際に実行されるシェルスクリプトです。AdamApp がアップ デートされた直後に実行されます。

➢ アンインストールスクリプト（任意）

AdamApp をアンインストールする際に実行されるシェルスクリプトです。AdamApp がア ンインストールされる直前に実行されます。

Pythonの場合は下記の通りです。詳細な説明はC/C++と同様のため省略します。

bin/

AdamApp 実行プログラムを格納するディレクトリ

 

conf/

コンフィギュレーション情報を格納するディレクトリ

 

data/

AdamApp 用外部データファイルを格納するディレクトリ

 

python/

Python スクリプトファイルを格納するディレクトリ

 

setup/

セットアップスクリプトファイルを格納するディレクトリ

ターゲット依存マクロ

この節では、ターゲット依存マクロについて説明します。ターゲット依存マクロは、機種や OS などの違 いを示すもので、マクロ変数として定義され、ソースコード、ヘッダファイル、Makefileから利用すること ができます。開発者は、機種や OS などによって AdamApp の実装を変える必要がある場合、このマクロを 利用することで、作り分けることができます。

ソースファイルとヘッダーファイルのマクロ

ソースファイル、及び、ヘッダファイル用のターゲット依存マクロは、下記のマクロが定義されます。

Makefileのマクロ

Makefile 用のターゲット依存マクロは、下記のマクロが定義されます。

AdamApp パッケージの生成手順

この節では、AdamApp パッケージの具体的な作成手順について、AdamAppSDK のサンプルプログラム (SkeletonSampleApp)を用いて、説明します。 パッケージ作成手順は、大きく分けて、下記の 3 つのフェーズで構成されています。

1.ソースファイルの作成、Makefile の作成

　AdamApp のソースファイルを作成します。

2.関連ファイルの作成と配置

　AdamApp のビルド・動作に必要なファイルを作成し、適切なディレクトリに配置します。

3.ビルド & パッケージ作成

　AdamApp のビルド（コンパイル、リンク）と、パッケージ作成を行います。

それぞれの具体的な方法について、これ以降で説明していきます。

ソースファイルと Makefile を生成する

(1) ソースファイルの作成と配置

AdamAppSDK では、AdamApp のソースコードは、
<AdamAppSDK のインストールディレクトリ>/src/adamapp
以下に置くことを前提としています。

その前提に従って、AdamAppSDK 付属のサンプルプログラム(SkeletonSampleApp)のソースコードは、
<AdamAppSDK の イ ン ス ト ー ル デ ィ レ ク ト リ >/src/adamapp/skeleton_sample_app
に配置されています。
このため、新規に AdamApp を作りたい場合は、
<AdamAppSDK のインストールディレクトリ>/src/adamapp/<新規 AdamApp のディレクトリ名>

のディレクトリを作成し、その下にソースコード、及び、ヘッダファイル、Makefile を作成・配置する
ようにしてください。
なお、skeleton_sample_app ディレクトリをコピーして新規ディレクトリを作成することで、新規
AdamApp 作成に必要なファイル一式もコピーされますので、新規 AdamApp を作る場合は、
skeleton_sample_app ディレクトリをコピーして利用することをお薦めします。

(2) 外部ソフトウェアのライブラリとヘッダファイルの配置（必要であれば）

AdamApp で利用する外部ソフトウェアのライブラリファイル(.a や.so ファイル)とヘッダファイル
(.h .hpp .hxx ファイルなど)を、external ディレクトリ以下に配置してください。

(3) Makefile の編集

ソースファイル、ヘッダファイルの作成後、Makefile の編集を行います。Makefileは雛形が用意されて
いますので、その雛形に必要な情報を追記して完成させます。Makefile の雛形は、変数が並んでいて、
それらの変数に値を追記する形で構成されています。
下記は、サンプルプログラム(SkeletonSampleApp)のMakefile の雛形の中から、代表的な変数を抜き出し、説明したものになります。この説明を参考にして、Makefile の編集を行って下さい。

PROG_NAME= SkeletonSampleApp

PROG_NAME は、作成されるプログラム名を指定する変数です。 プログラム名には、英数字、ハイフン、アンダースコア、ピリオドを用いることが できます。また、プログラム名の長さは 32 文字までです。

SRC_FILES= skeletonSampleApp.cpp

SRC_FILES は、ビルド対象のソースファイルを指定する変数です。 ビルド対象のすべてのソースファイルを、この変数に指定してください。 なお、この変数は、C のソースファイル（.c の拡張子のファイル）、C++のソースフ ァイル（.cpp の拡張子のファイル）を混在して指定可能です。

ADD_LIB_PATH=$(ADAM_ADD_LIB_PATH)

ADD_LIB_PATH+=

ADD_LIB_PATH は、ライプラリパスを指定する変数です。 指定時には、パス名のみを記載してください。 Adam のライブラリ以外をリンクする場合に、追記して下さい。 なお、ADD_LIB_PATH に設定済みの値[$(ADAM_ADD_LIB_PATH)]は、消さない でください。

ADD_LIBS=$(ADAM_ADD_LIBS)

ADD_LIBS+=

ADD_LIBS は、リンクするライプラリ名を指定する変数です。 Adam のライブラリ以外をリンクする場合は、この変数に追記してください。 なお、ADD_LIBS に設定済みの値[$(ADAM_ADD_LIBS)]は、消さないでください。

ADD_INCLUDE_PATH=$(ADAM_ADD_INCLUDE_PATH)

ADD_INCLUDE_PATH+=

ADD_INCLUDE_PATH は、include パスを指定する変数です。 Adam の include ファイル以外を include する場合に、そのパスを追記して下さ い。 なお、ADD_INCLUDE_PATH に設定済みの値[$(ADAM_ADD_INCLUDE_PATH)]は、 消さないでください。

PROG_CPPFLAGS= $(ADAM_DFLAGS)

PROG_CPPFLAGS+=

PROG_CPPFLAGS は、プリプロセッサオプションを指定する変数です。 AdamApp 独自のプリプロセッサオプションがある場合は、この変数に追記して下さ い。 なお、PROG_CPPFLAGSに設定済みの値[$(ADAM_DFLAGS)]は、消さないでくださ い。

PROG_CFLAGS= $(ADAM_CFLAGS)

PROG_CFLAGS+=

PROG_CFLAGS は、C のコンパイルオプションを指定する変数です。 AdamApp 独自の C コンパイルオプションがある場合は、この変数に追記して下さ い。 なお、PROG_CFLAS に設定済みの値[$(ADAM_CFLAGS)]は、消さないでくださ い。

PROG_CXXFLAGS= $(ADAM_CXXFLAGS)

PROG_CXXFLAGS+= -fno-rtti

PROG_CXXFLAGS+=

PROG_CXXFLAGS は、C++のコンパイルオプションを指定する変数です。 AdamApp 独自の C++コンパイルオプションがある場合は、この変数に追記して下さ い。 なお、PROG_CXXFLAGS に設定済みの値[$(ADAM_CXXFLAGS)]は、消さないでく ださい。

ファイルの生成と配置

(1) AdamApp 用外部データファイルの作成と配置

AdamApp から Read/Write したいファイルがある場合は、skeleton_sample_app/data ディレクトリ
以下に、作成・配置してください。なお、data ディレクトリ以下に配置されたファイルは、AdamApp
パッケージ作成時に、AdamApp パッケージの中に一緒に含められます。このため、AdamApp が実行
時には、AdamApp から data ディレクトリに配置されたファイルにアクセスすることができます。

(2) スクリプトファイルの作成と配置

AdamApp は、インストール時（直後）、アップデート時（直後）、アンインストール時（直前） に、指定されたスクリプトを実行する機能を持っています。それぞれの時に、実行したいスクリプトがあれば、skeleton_sample_app/setup ディレクトリに配置してください。もし、実行したいスクリプトがなければ、配置する必要はありません。

(3) コンフィギュレーションファイルの作成

コンフィギュレーションファイルのフォーマットに示す記載方法に従って、コンフィギュレーションファイルを作成し、configuration.txt という ファイル名で、skeleton_sample_app/ディレクトリ直下に配置してください。

(4) 設定値ファイルの作成

AdamApp で、設定値管理機能を用いる場合は、こちらに従って、設定値管理ファイルを作成し、appPrefs.json というファイル名で、skeleton_sample_app/ディレクトリ直下に配置してください。

AdamApp のビルドとパッケージの生成

AdamApp に必要なファイルの作成と配置が完了したら、AdamApp のビルドとパッケージ作成を行いま
す。具体的には、(1)AdamApp の実行環境に対応する設定ファイルを読み込み、(2)make の実行、を実施し
ます。
詳しい手順について、SDK v1.71以前を利用される場合はこちらを参照ください。
SDK v1.80以降を利用される場合はこちらを参照ください。

ambaCV2XおよびambaCV5Xの拡張アプリを1ファイルにまとめてビルドする

ambaCV2XおよびambaCV5Xのアプリを1ファイルにまとめる方法を説明します。1ファイルにまとめる必要が無い場合は実施しなくても問題ありません。
事前にambaCV2XおよびambaCV5Xのアプリをビルドしておきます。例としてPythonのsqlite_appをビルドした場合は、下記のファイルが生成されることになります。

SQLiteSampleAppPy_V0_1_ambaCV2X.ext
SQLiteSampleAppPy_V0_1_ambaCV2X.zip
SQLiteSampleAppPy_V0_1_ambaCV5X.ext
SQLiteSampleAppPy_V0_1_ambaCV5X.zip

このまま、下記の通り対象のディレクトリに移動しmake packを実行します。

成功すると、ambaCV2XおよびambaCV5Xのアプリが1ファイルにまとめられます。

SQLiteSampleAppPy_V0_1_ambaCV2X5X.ext
SQLiteSampleAppPy_V0_1_ambaCV2X5X.zip

上記ファイルはambaCV2XカメラおよびambaCV5Xカメラに利用可能です。

コンフィギュレーションファイルのフォーマット

コンフィギュレーションファイルとは、AdamApp の動作に必要な情報を記述したファイルです。Adam
実行環境は、このファイルの内容を参照して、AdamApp の制御（インストール/開始など）を行います。このため、このファイルの内容が誤っている場合は、AdamApp のインストールや開始に失敗することがありますので、正確に記述してください。
なお、このファイルは、AdamApp パッケージの作成時に参照されますので、AdamApp 作成のための
make 実行前までに作成しておく必要があります。

具体的な記述例については、任意のサンプルアプリのconfiguration.txt を参照してください。

${SDK_DIR}/src/adamapp/[任意のサンプルアプリ]/configuration.txt

configuration.txt の各用語

コンフィギュレーションファイルの各項目は、タグと値で構成されており、下記のフォーマットで記述し ます。

# 行頭の「#」はコメントアウトを表わす

# head of line ‘#’ means comment out

TagName Value

TagName と Value の間の空白は、１文字以上のスペースか、タブで構成してください。行頭の「#」は、
コメントアウトを表わします。なお、行の途中に「#」が来ても、コメントアウトとは認識されませんの
で、ご注意ください。
具体的なタグの種類は、Table1.4.1-1 に示しています。また、Value に使える文字は、タグの種類によって異なりますので、こちらについても Table1.4.1-1 を参照してください。
記述の具体例を下記に示します。

# AdamApp 実行ファイル名の設定

# set of the name of execution file of AdamApp

APPLICATION SkeletonSampleApp

 

# AdamApp のバージョンの設定

# set of version of AdamApp

APPVERSION V0.01

また、項目によっては、複数設定することも可能です。複数設定する場合は、下記のように項目を複数の 項目を並べて記述してください。

# APPNAME(AdamApp の正式名称)の設定

# set of the official name of AdamApp

APPNAME0 Sample Application

APPNAME1 サンプルアプリケーション

APPNAME5 esempio di applicazione

コンフィギュレーションファイルに記載できるタグ名の種類は、下記の通りです。
なお、選択性に、「M（Mandatory）」と書かれている項目は、記述必須の項目です（何も書かれていてい
ない項目は、省略可能です）。

Table 1.4.1-1 コンフィギュレーションファイルに記載するタグの説明

*1: ROMSIZE
以下の合計：
実行可能なファイルと共有ライブラリ（Linux サイズコマンドで取得した”text”と”data”のフィールドの合計値）。
Data ディレクトリの容量
Conf ディレクトリの容量

*2: RAMSIZE, CPURATE
初めにサンプルアプリケーションと同じ値を設定してください。最後に、i-PRO カメラ上でアプリケーションを実行した際の値を設定してください。これらのパラメータについてはResource Monitorを参照ください。
*3: AIACCRATE,AIMEMSIZE

サンプルアプリケーションと同じ値を設定してください。内部処理で使用されることはありません。

Appendix

Appendix A: 製品のセキュリティについて

製品セキュリティを確保するため以下の事に注意して開発してください。
・静的解析を実施してください。
・脆弱性の検証を行ってください。
・OSS 使用時には、最新の OSS を使用する、或いは、既知の脆弱性を確認してからご使用ください。