各種ダウンロード方法の解説 - renesas/amazon-freertos GitHub Wiki

はじめに

  • FreeRTOSというと、従来はリアルタイムOS処理のみを持っていたが、2018年以降Amazon Web Servicesが管理するようになって以降、IoT Librariesと呼ばれるAWS接続用のコードもディストリビューションに含まれるようになった
  • ここでは、便宜上IoT Libraries込みのFreeRTOSを "FreeRTOS(with IoT Libraries)"、従来のリアルタイムOS部分のみのものを"FreeRTOS(Kernel Only)"と呼称する
  • 当初、"FreeRTOS(with IoT Libraries)"は公式で"Amazon FreeRTOS"と呼称されていたが、"FreeRTOS"というブランド名に集約された
    • "Amazon FreeRTOS"という表記があった場合、それは"FreeRTOS(with IoT Libraries)"と読み替えて差し支えない

大枠

ダウンロード方法のリスト: インポート⇒ビルド⇒動作確認

  1. FreeRTOSコンソール からWebブラウザを用いてダウンロードする
  2. AWS FreeRTOS(with IoT Libraries) GitHub からgitクライアントを用いてダウンロードする
  3. ルネサス FreeRTOS(with IoT Libraries) GitHub からgitクライアントを用いてダウンロードする
  4. ルネサス FreeRTOS(with IoT Libraries) GitHubリリースタグ からe2 studioを用いてダウンロードする
  5. AWS FreeRTOS(Kernel Only) GitHub からgitクライアントを用いてダウンロードする
  6. ルネサス FreeRTOS(Kernel Only) GitHub からgitクライアントを用いてダウンロードする
  7. ルネサス FreeRTOS(Kernel Only) GitHubリリースタグ からe2 studioを用いてダウンロードする ★開発中★

それぞれのメリット・デメリット

No メリット デメリット
1 AWS認証取得済の状態、かつ、使用したいマイコンボードに関係のないファイルが削除されたクリーンな状態 特になし
2 最新状態である gitクライアントを使える必要がある
3 最新状態であり、AWS認証取得前のマイコンボード用プロジェクトも入手可能 gitクライアントを使える必要がある
4 リリース要件を満たす評価が完了しており、AWS認証取得前のマイコンボード用プロジェクトも入手可能 特になし
5 最新状態である gitクライアントを使える必要がある
6 最新状態であり、AWS認証取得前のマイコンボード用プロジェクトも入手可能 gitクライアントを使える必要がある
7 リリース要件を満たす評価が完了しており、AWS認証取得前のマイコンボード用プロジェクトも入手可能 特になし

推奨

上級者向けのオプション

  • 上記ダウンロード方法は、「AWSまたは、ルネサスが作成したプロジェクト」を「ユーザがインポートしてそのまま使う」ことを想定している
  • 一方で認証取得済のボードは例えばRX65N RSKでは、搭載されたチップの型名が「RTK50565N2S10010BE」であり、ユーザは別のチップを使った製品を開発することもある
  • その場合、しばしば、既存プロジェクトをインポートしてそれをベースラインとすることは好まれず、新規プロジェクトから作成することが好まれるケースがある
  • このため、e2 studio の新規プロジェクト生成時に、FreeRTOS(with IoT Libraries)、FreeRTOS(Kernel Only)を選択可能とした
  • こうすることで、任意のチップ、任意の初期設定でもってユーザは任意の新規プロジェクトを立ち上げることが可能となる
    • 上記スクリーンショットでは、Target Board にRX72N Envision Kitし、FreeRTOS(with IoT Libraries)プロジェクトを新規生成させる例である
    • ユーザ設計ボードを使用する際は、Target BoardにCustomを選択するとよい
    • 使用不可能な組み合わせは選べないようになっている
      • 例: FreeRTOS(with IoT Libraries)はRAM>64KBが推奨条件であるため、FreeRTOS(with IoT Libraries)が使用できないMCUが選択できないようになっている

ダウンロード方法のリスト: プロジェクト新規作成⇒ビルド⇒動作確認

  1. ルネサス FreeRTOS(with IoT Libraries) GitHub からe2 studioを用いてダウンロードする
  2. ルネサス FreeRTOS(Kernel Only) GitHub からe2 studioを用いてダウンロードする ★開発中★
    • 現状、ルネサスウェブサイトに配置したアプリケーションノートをe2 studioが読み取っているが、方式をルネサス FreeRTOS(with IoT Libraries)と合わせる方針

git クライアントを使ってダウンロードする

  • Amazon FreeRTOSはgit submoduleを活用しているので、clone時に再帰的ににgit submoduleをダウンロードする設定"--recursive"が必要
  • mainブランチは単に本家の鏡写しである
  • 特定ブランチ(rx_development_202012.00等)は特定のAmazon FreeRTOSバージョンを対象に、本家には登録されていないボード用のコードが含まれる場合がある
  • 本家には登録されていないボード用のコードリストは以下参照

mainブランチをダウンロードする

git clone --progress --recursive -v https://github.com/renesas/amazon-freertos.git

特定ブランチをダウンロードする

  • ブランチ rx_development_202012.00 のコミット番号 6d049513729c742b05b28f5a42ba7b3e201fd17e をダウンロードする例
git clone --progress --recursive --branch rx_development_202012.00 -v https://github.com/renesas/amazon-freertos.git
cd amazon-freertos
git checkout 6d049513729c742b05b28f5a42ba7b3e201fd17e