XIAOGYAN ソフトウェア開発マニュアル

1. はじめに

XIAOGYANのサンプルのソフトウェアはPlatformIOで開発しています。 PlatformIO開発環境はみんな大好きVisual Studio Codeの拡張機能でも提供されていて、これを使うと簡単に開発環境を用意できます。

• Visual Studio Code
• PlatformIO IDE for VSCode

また、XIAOGYANのサンプルのソフトウェアはGitHubで管理しています。GitとVisual Studio Code拡張機能のGit Graphも使えるようになりましょう。

• Git
• Git Graph extension for Visual Studio Code

2. 開発ツールのインストール

2.1. Visual Studio Code

1. ブラウザでDownload Visual Studio Codeページを開いてください。
2. Windowsをクリックしてください。インストールファイルがダウンロードされます。
3. インストールファイルを実行してください。Visual Studio Codeのセットアップ画面が表示されます。
4. 画面の指示にしたがってセットアップを完了してください。
   • 使用許諾契約書の同意 - 同意するを選択
   • 追加タスクの選択 - PATHへの追加(再起動後に使用可能)を選択

画面ショット

2.2. Git

1. ブラウザでDownload Gitページを開いてください。
2. Windowsをクリックしてください。Download for Windowsページが表示されます。
3. 64-bit Git for Windows Setupをクリックしてください。インストールファイルがダウンロードされます。
4. インストールファイルを実行してください。Gitのセットアップ画面が表示されます。
5. 画面の指示にしたがってセットアップを完了してください。
   • Select Components - Git LFSとScalarを選択
   • Choosing the default editor used by Git - Use Visual Studio Code as Git's default editorを選択
   • Adjusting your PATH environment - Git from the command line and also from 3rd-party softwareを選択

画面ショット

2.3. Visual Studio Code拡張

1. Visual Studio Codeを起動してください。
2. EXTENSIONS画面でMS-CEINTL.vscode-language-pack-ja（Japanese Language Pack for Visual Studio Code）を検索してインストールしてください。
3. Visual Studio Codeを再起動してください。
4. 拡張機能画面でmhutchie.git-graph（Git Graph）を検索してインストールしてください。
5. 拡張機能画面でplatformio.platformio-ide（PlatformIO IDE）を検索してインストールしてください。
6. Visual Studio Codeを再起動してください。

画面ショット

3. サンプルのソフトウェアをビルド、書き込み

1. ソース管理画面でリポジトリのクローンをクリックして実行してください。
   • リポジトリのURL - https://github.com/algyan/xiaogyan_examples
   • 複製するフォルダー -- デスクトップを指定
2. 「クローンしたリポジトリを開きますか？画面で開くをクリックしてください。
3. ファイルの作成者を信頼する確認画面が表示されたときははい、作成者を信頼しますをクリックしてください。
4. ソース管理画面にあるView Git Graphボタンをクリックして、コミット一覧が表示されることを確認してください。
5. PLATFORMIO画面でPick a folderをクリックして、platformio/HardwareTestフォルダーを選択してください。
6. XIAOGYANをUSB接続しておき、PLATFORMIO画面でseeed_xiao_esp32c3/General/Uploadをクリックしてください。

画面ショット