Skip to content

Latest commit

 

History

History
463 lines (313 loc) · 27.9 KB

Moddable SDK - Getting Started.md

File metadata and controls

463 lines (313 loc) · 27.9 KB

Moddable SDK – 入門

Moddable SDKのインストールとツールのビルド方法

Copyright 2016-2023 Moddable Tech, Inc.
改訂： 2023年10月12日

このドキュメントは、開発用のコンピュータにModdable SDKをインストールし、そのツールをビルドするための手順を提供します。

目次

概要

Moddable SDKを始めるには、以下のステップを踏んでください：

ステップ 1: Moddable SDKツールをビルドする

以下のセクションにあるインストールの指示に従って、使用しているOSに該当する手順を実行してください。これらの手順には、mcconfigというコマンドラインツールを使用してデスクトップシミュレーター上でhelloworldサンプルを実行し、セットアップを確認する手順が含まれています。

デスクトップシミュレーターについての詳細は、ツールドキュメントのシミュレーターセクションを参照してください。

また、Moddable SDKツールの一部としてビルドされるJavaScriptソースレベルデバッガーであるxsbugを実行する方法も学びます。xsbugは、XSプラットフォームのモジュールやアプリケーションのデバッグをサポートするフル機能のデバッガーです。

他のデバッガーと同様に、xsbugはブレークポイントの設定、ソースコードの閲覧、コールスタックと変数の閲覧をサポートします。さらに、xsbugデバッガーはリアルタイムの計測を提供し、メモリ使用量を追跡し、アプリケーションとリソース消費をプロファイルします。

xsbugについての詳細は、xsbugのドキュメントを参照してください。

ステップ2：対象プラットフォームのツールをインストールする

デバイス上でアプリケーションを実行するには、対象プラットフォームの必要なSDK、ドライバ、および開発ツールをインストールする必要があります。devicesフォルダには、Moddable SDKがサポートするすべてのMCUの手順が含まれています。このドキュメントの次のステップ：開発ボードとMCUでのアプリのビルドと実行セクションを参照して、対象プラットフォームの手順への詳細とリンクを確認してください。

ステップ3：いくつかのサンプルを試す

このリポジトリには、Moddable SDKの多くの機能の使用方法を示す150以上のサンプルアプリが含まれています。多くのサンプルは、特定の機能の使用方法を示すために、ソースコードが1ページ未満です。

ステップ4：独自のアプリを構築する

サンプルのアプリをカスタマイズする準備ができたら、または最初から自分のアプリを構築する準備ができたら、すべてのJavaScript APIのドキュメントとソースコードが利用可能です。すべてのドキュメントはマークダウン形式で提供されています。Moddable SDKのランタイムを構成するソフトウェアモジュールは、modulesディレクトリにあります。

documentation、examples、およびmodulesディレクトリは、情報を簡単に見つけられるように共通の構造を共有しています。

  • base: time、timer、debug、instrumentation、UUIDを含む基本的なランタイム機能
  • commodetto: ビットマップグラフィックスライブラリ
  • crypt: 暗号プリミティブとTLS
  • data: Base64およびhexエンコーディング
  • drivers: ディスプレイ、タッチ入力、センサー、拡張用のデバイスドライバ
  • files: ファイル、フラッシュ、設定、リソース、zipを含むストレージ機能
  • network: ソケットとソケットに基づくプロトコル（HTTP、WebSockets、DNS、SNTP、telnet、TLS）; また、Wi-FiとBLE API。
  • pins: ハードウェアプロトコル（デジタル（GPIO）、アナログ、PWM、I2Cを含む）
  • piu: ユーザーインターフェースフレームワーク

macOS

システム要件

Moddable SDKは、macOS Sierra（バージョン10.12）以降およびXcodeのフルインストール（バージョン9以降）が必要です。

インストール

  1. Xcodeをダウンロードしてインストールします。プロンプトが表示されたらXcodeを起動して追加のコマンドラインコンポーネントをインストールします。

  2. ホームディレクトリに~/ProjectsでProjectsディレクトリを作成し、Moddable SDKリポジトリを配置します。

    注意: Moddable SDKリポジトリは任意のディレクトリにダウンロードできます。これらの手順では、Moddable SDKが~/Projectsディレクトリにダウンロードされることを前提としています。

  3. Moddableリポジトリをダウンロードするか、次のようにgitコマンドラインツールを使用します：

    cd ~/Projects
git clone https://github.com/Moddable-OpenSource/moddable

  4. シェルのスタートアップ/初期化ファイルを開きます。

    macOS Mojave以前ではデフォルトのシェルはbashなので、~/.profileを開く必要があります。

    open ~/.profile

    macOS Catalinaからは、デフォルトのシェルはzshなので、~/.zshrcを開くべきです。

open ~/.zshrc

注: 上記のコマンドを実行してエラーが表示される場合（シェルの起動/初期化ファイルが存在しないというエラー）、touch コマンドを使用して適切なファイルを作成できます。例えば、touch ~/.zshrc。

  1. 開いたファイルに以下の行を追加して保存します。これにより、MODDABLE 環境変数がローカルのModdable SDKリポジトリディレクトリを指すように設定され、PATH 環境変数がModdableのビルドツールディレクトリを含むように編集されます。
export MODDABLE="/Users/<user>/Projects/moddable"
export PATH="${MODDABLE}/build/bin/mac/release:$PATH"

  1. ~/.profile や ~/.zshrc にexport文を追加しても、アクティブなシェルインスタンスの環境変数は更新されないため、新しいシェルインスタンスを開く（新しいタブ/ウィンドウを開く）か、シェルでexport文を手動で実行してから進めてください。

  2. コマンドラインからModdableコマンドラインツール、シミュレータ、デバッガをビルドします：

cd ${MODDABLE}/build/makefiles/mac
make
  1. コマンドラインから xsbug デバッガを起動します：
open ${MODDABLE}/build/bin/mac/release/xsbug.app
  1. デスクトップシミュレータターゲット用のスターター helloworld アプリケーションをビルドして、ホスト環境のセットアップを確認します：
cd ${MODDABLE}/examples/helloworld
mcconfig -d -m -p mac
  1. 重要： これでデスクトップシミュレータ用のアプリケーションをビルドして実行できます。開発ボードやMCUでアプリケーションをビルドして実行するには、対象プラットフォーム用の追加のSDK、ドライバ、および開発ツールをインストールする必要があります。詳細と手順へのリンクについては、このドキュメントの 次のステップ（開発ボードとMCUでのアプリケーションのビルドと実行）セクションを参照してください。

トラブルシューティング

  • Moddable SDKのビルドが "xcode-select: error: tool 'ibtool' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance." のようなエラーで失敗する場合、3つの潜在的な問題と修正があります：
    1. コマンドラインツールのみのXcodeインストールを実行している可能性があります。Moddable SDKのビルドにはXcodeの完全なインストールが必要です。
    2. Xcodeのライセンス契約を受け入れ、コマンドラインコンポーネントをインストールするためにXcodeアプリケーションを起動する必要があるかもしれません。
    3. 完全なXcodeインストールを実行しているが、このエラーでビルドが失敗する場合は、xcode-select ユーティリティを使用して完全なXcodeインストールを選択する必要があります。これは、環境に応じて必要に応じてパスを調整して、このコマンドで行うことができます： sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

更新

Moddable SDKツールは頻繁に改善され、機能が追加されます。以下の手順に従って、定期的にホスト環境を更新する必要があります：

  1. Moddableリポジトリのローカルクローンを更新します：

    cd $MODDABLE
git pull

    Moddableリポジトリのファイルにローカル変更がある場合は、変更をスタッシュしてから、プルした後に再適用する必要があるかもしれません：

    cd $MODDABLE
git stash push
git pull
git stash pop

  2. 既存のModdable SDKビルド出力を削除します：

    cd $MODDABLE
rm -rf build/bin
rm -rf build/tmp

  3. Moddableコマンドラインツール、シミュレータ、デバッガをビルドします：

    cd ${MODDABLE}/build/makefiles/mac
make

  4. デスクトップシミュレータターゲット用のスターターhelloworldアプリケーションをビルドすることで、ホスト環境のセットアップを確認します：

    cd ${MODDABLE}/examples/helloworld
mcconfig -d -m -p mac

Windows

システム要件

Moddable SDKは、Windows 8.1以降およびMicrosoft Visual Studio Community 2017以降が必要です。Windows 10またはWindows 11とMicrosoft Visual Studio Community 2022を推奨します。

インストール方法

  1. Microsoft Visual Studio 2022 Communityインストーラーをダウンロードします。

  2. インストーラーを起動します。「Workloads」タブで「Desktop development for C++」オプションを選択します。「Individual Components」タブで「Windows 10 SDK (10.0.19041.0)」を選択します（これはWindows 10システムでは事前に選択されていますが、Windows 11システムでは手動で含める必要があります）。設定された通りにインストールを進めます。

  3. %USERPROFILE%ディレクトリ、例えばC:\Users\<your-user-name>にProjectsディレクトリを作成し、Moddable SDKリポジトリを配置します。

    注意: Moddable SDKリポジトリは任意のディレクトリにダウンロードできます。これらの指示は、Moddable SDKが%USERPROFILE%ディレクトリにダウンロードされることを前提としています。

  4. Moddableリポジトリをダウンロードするか、以下のようにgitコマンドラインツールを使用します：

    cd %USERPROFILE%\Projects
git clone https://github.com/Moddable-OpenSource/moddable

  5. リンク先の手順に従ってコントロールパネルアプリの「環境変数」ダイアログを開きます。そのダイアログから：

  • ユーザー変数としてMODDABLEを作成し、ローカルのModdable SDKリポジトリディレクトリを指すように設定します。システムに合わせてパスを更新し、「ディレクトリを参照」ボタンを使用してModdable SDKフォルダに移動します。

    • 変数名：MODDABLE
    • 変数値：%USERPROFILE%\Projects\moddable

  • ユーザー変数Pathを編集して、Moddable SDKツールディレクトリを含むようにします。システムに合わせてパスを更新し、「参照」ボタンを使用して正しいフォルダに移動します。

    • 変数名：Path
    • 変数値（既存のリストに追加）：%USERPROFILE%\Projects\moddable\build\bin\win\release

注意: %USERPROFILE%\Projects\moddable\build\bin\win\release ディレクトリは次のステップで作成されます。環境変数を今設定しても安全ですし、ステップ6の後で Path に追加しても構いません。

注意: 環境変数を設定した後は、新しいコマンドプロンプトを開いてください。新しい環境設定は既存のコマンドプロンプトインスタンスでは有効になりません。

  1. "x86 Native Tools Command Prompt for VS 2022" コマンドラインコンソールを起動します。コマンドラインからModdableコマンドラインツール、シミュレータ、およびデバッガをビルドします：

    cd %MODDABLE%\build\makefiles\win
build

    注意: parallel_build.bat という代替のビルドバッチファイルがあり、マルチコアシステムで使用すると Moddable SDK のビルド速度を大幅に向上させることができます。ただし、このバッチファイルを使用すると診断エラーメッセージが見にくくなることがあります。システムで build.bat が正しく動作する場合は、将来の Moddable SDK ビルドに parallel_build.bat の使用を検討してください。

  2. コマンドラインから xsbug デバッガを起動します：

    xsbug

  3. デスクトップシミュレータターゲット用のスターター helloworld アプリケーションをビルドして、ホスト環境のセットアップを確認します：

    cd %MODDABLE%\examples\helloworld
mcconfig -d -m -p win

  4. 重要： これでデスクトップシミュレータでアプリケーションをビルドして実行できるようになりました。開発ボードやMCUでアプリケーションをビルドして実行するには、対象プラットフォーム用の追加のSDK、ドライバ、および開発ツールをインストールする必要があります。詳細と指示へのリンクについては、このドキュメントの次のステップ（開発ボードとMCUでのアプリケーションのビルドと実行）セクションを参照してください。

トラブルシューティング

  • Moddable SDKのビルドが "LINK : fatal error LNK1104: cannot open file '<Moddable path>\build\bin\win\release\<tool name>.exe'" のようなエラーで失敗する場合、それはMicrosoftのドキュメントで説明されているように、アンチウイルスソフトウェアとの競合を示している可能性が高いです。ビルドプロセス中に %MODDABLE% ディレクトリをアンチウイルスソフトウェアのライブスキャン機能から除外してみてください。

  • Moddable SDKのビルドが"'nmake' is not recognized as an internal or external command, operable program or batch file."のエラーで失敗した場合、3つの潜在的な問題と修正方法があります：

    1. Visual Studioがインストールされていない可能性があります。Microsoft Visual Studio 2022 Community Edition installerの使用をお勧めします。
    2. Visual Studioをインストールした際に、「Desktop development for C++」ワークロードオプションを選択していない可能性があります。インストーラーを再実行し、そのワークロードをインストールするオプションを選択してください。
    3. 「VS 2022用x86ネイティブツールコマンドプロンプト」を使わずにデフォルトのコマンドプロンプトでビルドを試みた可能性があります。「VS 2022用x86ネイティブツールコマンドプロンプト」はビルドに重要な環境変数を設定します。これはスタートメニューで「x86 Native Tools」と検索することで見つけることができます。

  • Moddable SDKのビルドが"fatal error LNK1112: module machine type 'x64' conflicts with target machine type 'x86'"のようなエラーで失敗した場合、おそらく「VS 2022用x64ネイティブツールコマンドプロンプト」ではなく、正しい「VS 2022用x86ネイティブツールコマンドプロンプト」でビルドを試みたことが原因です。このコマンドプロンプトはビルドに重要な環境変数を設定し、スタートメニューで「x86 Native Tools」と検索することで見つけることができます。

更新

Moddable SDKツールは頻繁に改善や機能追加のために更新されます。以下の手順に従って定期的にホスト環境を更新する必要があります。

> 注: 以下のコマンドはすべて「VS 2022用 x86 ネイティブツール コマンドプロンプト」コンソールで実行してください。

  1. Moddable リポジトリのローカルクローンを更新します：

    cd %MODDABLE%
git pull

    Moddable リポジトリのファイルにローカル変更がある場合は、変更をスタッシュしてからプルした後に再適用する必要があるかもしれません：

    cd %MODDABLE%
git stash push
git pull
git stash pop

  2. 既存のModdable SDKビルド出力を削除します：

    cd %MODDABLE%\build\makefiles\win
build clean

  3. Moddableコマンドラインツール、シミュレータ、デバッガをビルドします：

    cd %MODDABLE%\build\makefiles\win
build

    注: マルチコアシステムで Moddable SDK のビルドを大幅に高速化できる parallel_build.bat という代替ビルドバッチファイルがあります。ただし、このバッチファイルを使用すると診断エラーメッセージが見にくくなることがあります。build.bat がシステムで正しく動作する場合は、将来の Moddable SDK ビルドに parallel_build.bat を検討してください。

  4. デスクトップシミュレータターゲット用のスターター helloworld アプリケーションをビルドして、ホスト環境のセットアップを確認します：

    cd %MODDABLE%\examples\helloworld
mcconfig -d -m -p win

Linux

システム要件

Moddable SDKは、Ubuntu 16.04-22.04 LTS（64ビット）およびRaspberry Pi Desktop（32ビット）オペレーティングシステムでテストされています。これらの指示は、GCCツールチェーンがすでにインストールされていることを前提としています。

インストール方法

  1. コンパイルに必要なパッケージをインストールまたは更新します：

    sudo apt-get install gcc git wget make libncurses-dev flex bison gperf

  2. GTK+ 3ライブラリの開発バージョンをインストールします：

    sudo apt-get install libgtk-3-dev

    注：WSL2をWindowsで使用している場合は、以下のアイコンパックをインストールしてください：

    sudo apt-get install adwaita-icon-theme-full

  3. ~/Projects に Projects ディレクトリを作成し、そこにModdable SDKリポジトリを配置します。

注意: Moddable SDK リポジトリは任意のディレクトリにダウンロードできます。これらの指示では、Moddable SDK が ~/Projects ディレクトリにダウンロードされていると仮定しています。

  1. Moddable リポジトリをダウンロードするか、以下のように git コマンドラインツールを使用します：

    cd ~/Projects
git clone https://github.com/Moddable-OpenSource/moddable

  2. ~/.bashrc ファイルに MODDABLE 環境変数を設定し、ローカルのModdable SDKリポジトリディレクトリを指すようにします。Moddableビルドツールディレクトリを PATH に追加します：

    export MODDABLE=~/Projects/moddable
export PATH=$PATH:$MODDABLE/build/bin/lin/release

    注意: 進む前に新しいシェルインスタンスを開くか、手動でシェルにエクスポート文を実行する必要があります。~/.profile にエクスポート文を追加しても、アクティブなシェルインスタンスの環境変数は更新されません。

  3. コマンドラインからModdableコマンドラインツール、シミュレータ、およびデバッガをビルドします：

cd $MODDABLE/build/makefiles/lin
make

  1. デスクトップシミュレータと xsbug デバッガーアプリケーションをインストールします：

    cd $MODDABLE/build/makefiles/lin
make install

    プロンプトが表示されたら、アプリケーションのデスクトップ、実行可能ファイル、アイコンファイルを標準の /usr/share/applications, /usr/bin, /usr/share/icon/hicolor ディレクトリにコピーするために、sudo パスワードを入力してください。

  2. コマンドラインから xsbug デバッガーを起動します：

    xsbug

  3. デスクトップシミュレータターゲット用のスターター helloworld アプリケーションをビルドして、ホスト環境のセットアップを確認します：

    cd $MODDABLE/examples/helloworld
mcconfig -d -m -p lin

    何を期待すべきかの説明のためにこのdiscussionを見てください。

  4. 重要： これでデスクトップシミュレータでアプリケーションをビルドして実行できるようになりました。開発ボードやMCUでアプリケーションをビルドして実行するには、ターゲットプラットフォーム用の追加のSDK、ドライバ、開発ツールをインストールする必要があります。詳細と指示へのリンクについては、このドキュメントの 次のステップ（開発ボードとMCUでのアプリケーションのビルドと実行）セクションを参照してください。

更新

Moddable SDKツールは頻繁に改善され、機能が追加されます。定期的に以下の手順に従ってホスト環境を更新する必要があります：

  1. GTK+ 3ライブラリの開発バージョンがインストールされ、最新の状態であることを確認してください：

    sudo apt-get update
sudo apt-get install libgtk-3-dev
sudo apt-get upgrade libgtk-3-dev

  2. Moddableリポジトリのローカルクローンを更新します：

    cd $MODDABLE
git pull

    Moddableリポジトリのファイルにローカル変更がある場合は、変更をスタッシュしてから、プルした後に再適用する必要があるかもしれません：

    cd $MODDABLE
git stash push
git pull
git stash pop

  3. 既存のModdable SDKビルド出力を削除します：

    cd $MODDABLE
rm -rf build/tmp
rm -rf build/bin

  4. Moddableのコマンドラインツール、シミュレータ、デバッガーをビルドします：

cd $MODDABLE/build/makefiles/lin
make

  1. デスクトップシミュレータと xsbug デバッガアプリケーションをインストールします：

    cd $MODDABLE/build/makefiles/lin
make install

    プロンプトが表示されたら、アプリケーションのデスクトップ、実行可能ファイル、アイコンファイルを標準の /usr/share/applications, /usr/bin, /usr/share/icon/hicolor ディレクトリにコピーするために sudo パスワードを入力します。

  2. デスクトップシミュレータターゲット用のスターター helloworld アプリケーションをビルドして、ホスト環境のセットアップを確認します：

    cd $MODDABLE/examples/helloworld
mcconfig -d -m -p lin

次のステップ：開発ボードとMCUでアプリをビルドして実行する

開発ボードまたはMCUでアプリケーションをビルドして実行するには、ターゲットプラットフォーム用の追加のSDK、ドライバ、開発ツールをインストールする必要があります。これらのツールはMCUの製造元によって提供され、Moddable SDKの一部ではありませんが、devices フォルダにはインストールプロセスをガイドするために私たちが書いた手順が含まれています。

以下の表は、ターゲットプラットフォームの指示をすばやく見つけるために、devices フォルダ内のいくつかのドキュメントへのリンクを提供します：

デバイス ドキュメント
ESP32またはESP32ベースの製品
Moddable Two、NodeMCU ESP32、
およびM5Stack開発ボードを含む		 ESP32でのModdable SDKの使用
ESP8266またはESP8266ベースの製品
Moddable One、Moddable Three、
およびNodeMCU ESP8266を含む		 ESP8266でのModdable SDKの使用
Giant Gecko、Mighty Gecko、
Thunderboard Sense 2、またはBlue Gecko		 GeckoでのModdable SDKの使用
QCA4020 QCA4020でのModdable SDKの使用
Raspberry Pi Pico PicoでのModdable SDKの使用
Nordic nRF52 nRF52でのModdable SDKの使用