Embedded Swiftでサイズを縮小

Embedded Swiftでサイズを縮小

Embedded Swiftを使用すると、制限の厳しい環境において、より安全かつ表現力に富む方法でSwiftによる開発を行えます。このセッションでは、既製のMatterデバイスでのデモを交えて、さまざまなマイクロコントローラ上でEmbedded Swiftを実行する方法を解説します。Swiftのさまざまなメリットをランタイムなしの小さなフットプリントで提供するEmbedded Swiftのサブセットの仕組みと、Embedded Swiftの利用を始めるうえで役立つ幅広いリソースもご紹介します。

関連する章
- 0:00 - Introduction
- 0:25 - Agenda
- 0:46 - Why Embedded Swift
- 2:30 - Showcase
- 2:47 - The plan
- 3:39 - Getting started
- 6:19 - Using Swift's interoperability to control the LED
- 7:12 - Using an ergonomic LED struct
- 10:07 - Adding the Matter protocol
- 13:43 - Using a Swift enum in the event handler
- 16:52 - Demo summary
- 17:34 - How Embedded Swift differs
- 19:48 - Explore more
- 21:32 - Wrap up
リソース
関連ビデオ

WWDC21
- スマートホームAppへのMatterのサポートの追加
ようこそ Kuba Mracekですご存じのとおり Swiftは Appleプラットフォームと他の環境のアプリ開発に効果を発揮する強力な言語です今日はそんなSwiftを新しくエキサイティングでコンパクトな組み込みデバイスで活用する話をします最初に Embedded Swiftを紹介しその後にデモをお見せして実用的なアプリの作り方を説明します Embedded Swiftを使ったアプリ開発のやり方とデスクトップやモバイルの Swiftとの違いを説明し最後に詳しい情報を得たい方のためにリソースを紹介しますでは始めましょう皆さんが現在お使いのSwiftはさまざまなソフト開発に対応しモバイルデバイスデスクトップやサーバを対象にできます
このセッションでは Swiftが新たに進出したエリアである組み込みデバイスについてお話しします誰もが日常的に使っているスマートライトサーモスタットアラームスマートファン音楽デバイス LEDテープライトその他多くの身近なガジェットにはプログラマブルなマイクロコントローラが組み込まれています今日は趣味のプログラマーと本格的なデベロッパの両方に向けて Swiftによる組み込みデバイス向け開発のやり方を説明しますその手段として新たに登場した Embedded Swiftは制約が大きい組み込みデバイスに特化した新しいコンパイルモードです従来この世界ではCとC++が標準的な開発言語として使われてきました今後はそこにSwiftが加わります組み込み開発に携わる皆さんに Swiftの長所である人間工学的なデザインや安全機能使いやすさをもたらします
Embedded Swiftは組み込みデバイスのマイクロコントローラ向けプログラミングだけでなくカーネルレベルやその他の低レベルライブラリコードなど新たな依存関係を持ち込むことが難しい用途にも適しています Appleデバイス上の動作環境は Secure Enclaveプロセッサであり Swiftのメモリが備える安全性は大きなメリットです Embedded Swiftはサブセットですが愛用されているSwiftの言語仕様をほぼ網羅したフル機能のサブセットです値型と参照型をはじめクロージャやオプショナル型エラー処理ジェネリックスなどもサポートされていますでは Embedded Swiftのライブデモに移りましょう
ところで Embedded Swiftの機能は今はまだ実験段階ですソースの安定段階には至っていません活発な開発作業の最中ですから現時点では swift.orgの previewツールチェーンでの利用をおすすめします
このデモでは HomeKitアクセサリの非常にシンプルなプロトタイプとしてカラーLEDライトを作りますまず HomeKitの動作環境をセットアップしますつまり WiFiネットワークや既にあるAppleデバイスの接続を確立しておきますここではプログラマブルな組み込みデバイスとして ESP32C6開発ボードを使うことにします RISC-Vマイクロコントローラ搭載のボードにカラーLEDが1個装備されていますこのデバイスを USBケーブルでMacに接続して HomeKitアクセサリを実装するプログラムを Embedded Swiftで作成してからデバイスに書き込みますするとこのデバイスが WiFi環境と HomeKitネットワークに接続されどのAppleデバイスからもホームアプリを使って制御できるようになります
始めましょうこれはNeovimとCMakeですいま見ているテンプレートプロジェクトは非常に基本的な内容で Embedded Swiftコードを実行するだけのものですプロジェクトで使っているSDKはデバイスベンダーから提供されたもので C言語で書かれていますそのベンダー製SDKを無変更で使えるようブリッジヘッダーを利用し SDKのすべてのAPIを Swiftにインポートしています
ベンダー製のSDKとビルドシステムの上で Swiftのコードをビルドするには簡単なCMakeロジックが必要です
そのために追加のファイルとして定型的なYAMLファイルや
CSVファイル
sdkconfigファイルを用意します
このSDKをプロジェクトで使うために必要なファイルだったのでベンダーから提供されたサンプルを参考にしてセットアップしその上にSwiftを追加しました
Swiftのソースコードに戻りましょうこのエディタにはLSP連携機能があり使おうとしている関数や型の定義とドキュメントを見ることができます
セマンティック自動補完機能も充実しています
意味をなさないコードを書こうとすると
すぐにエラーメッセージと問題点を示す警告文が表示されますデバイスをケーブルで接続しましょう
USB経由でデバイスにプログラムを書き込みますブレッドボードにバッテリーを付けてあるので書き込みが完了した後は USBを抜いてもデバイスを動かし続けることができますしかしまずはこのデバイス上で最も簡単なSwiftアプリが動くことを確かめましょうこのSDKには確認用ツールが用意されています
ベンダーから提供された便利な Pythonスクリプトを実行してみましょうデバイスのビルド書き込み監視をすべて1つのコマンドで行えるものです
実行するとファームウェアのビルド進行状況とデバイスへのアップロード状況デバイスから受信したログが表示されました続いて初めて作った Embedded Swiftアプリが組み込みデバイス上で動いていることを示すサインが表示されました次はもっと有用なコードを追加してみます Swiftには優れた相互運用性がありベンダーSDKのすべてのAPIにアクセス可能ですデバイス上のLEDを制御するときは Cで書かれた SDKの従来のAPIが使えます
それらのAPIを呼び出して制御してみましょう "青色" "彩度100%" "明るさ80%" の値を送ることにします
このバージョンのコードを保存しデバイスにアップロードします
先ほどと同じコマンドを実行します
ファームウェアのアップロードが数秒で完了しデバイスが再起動すると LEDの色や明るさを制御できるようになりました
しかし何か操作をするたびに SwiftからC APIを呼び出すのは面倒ですそれができること自体は有意義ですがラッパーを作り C APIを抽象化して扱えるようにすればアプリ開発時にクリーンかつ直感的で人間工学的なSwiftコードを書けますそのバージョンのために作った LEDオブジェクトの定義を見てみましょう
これは私が作っておいたヘルパーコードですわかりやすいSwiftレイヤーで C APIをラップしており有用かつ人間工学的な型のプロパティを持っていますたとえば enabledプロパティはブール型 brightnessプロパティは整数型ですメインのアプリロジックを含んだファイルに戻りましょう LEDオブジェクトを使うととても明快で直感的なコードを書けます
起動時は赤色で光らせるようにしましょう
明るさは80%にします
非常に読みやすく明快なコードでしょう
コーディングを続けます
ループを追加して 1秒経つごとに LEDの状態を反転させますまたオンにするときはどういう新しい色で光らせるか色相と彩度の値が変化できるようにします色相はランダムに決めて彩度は100%にしましょうこのように Embedded Swiftのコードは普通のSwiftに近い感覚で作成できほとんどの言語要素を同じように使えますもう一度ファームウェアをアップロードします
うまく動くか見てみましょう起動して実行が始まるとデバイスのLEDの色がランダムに切り替わります
すばらしい！まさに期待どおりの結果です LEDオブジェクトのレイヤーを作ったことで Swiftの本領が発揮され高レベルのAPIによりクリーンで読みやすいコードになりました
ご覧のとおり Embedded Swiftは皆さんのワークフローによく馴染みますベンダーから提供されたSDKを使えますしお使いのIDEやテキストエディタで完全な自動補完機能を利用でき定義やドキュメントも参照できます Swiftの優れた相互運用機能によって従来のSDKに含まれるC APIも Swiftコードから直接呼び出せますとはいえ多くの場合 C APIはコアアプリロジックから切り離し人間工学的で直感的なAPIレイヤー内にラップして利用するのがおすすめです
基本的な動きを確認できたので実際のHomeKitアクセサリを作っていきましょうこれには Matterプロトコルを使います Matterはスマートホームアクセサリ向けのオープンな標準です 2021年のWWDCセッションで詳しく取り上げられたので詳細を知りたい方はぜひそちらをご覧ください
私が使っているSDKでは C++ API の形でMatterを利用できるため Swiftの相互運用機能を使って呼び出すことでインフラストラクチャのデバイス検出やコミッショニングなどの機能をすべて無料で活用できます
また Matterプロトコル対応デバイスは新しく入手したときから Matterアクセサリにネイティブ対応しているため自動的にHomeKitの中で機能を発揮しますもう一度何もしない空のアプリを作るところから始めましょう Matterを扱うにはデータモデルと用語を少し知っておく必要があります Matterデバイスを実装する際に必要となる作業の大まかなリストをご覧くださいまずルートノードというものを作りますこれはそのMatterアクセサリ自体を表します次にエンドポイントを作る必要がありますエンドポイントは状態を持ったオブジェクトでこの例ではカラーLEDライトが該当し状態は色や明るさなどを表しますまたライトのオン/オフなどコマンドを受け付けることができます
そのエンドポイントをノードに接続しさらにノードを applicationオブジェクトに接続します私があらかじめ作っておいたシンプルな C++ Matter APIラッパーレイヤーが Matterサブディレクトリに入っています
これは使いやすいAPIと同じ考え方で作った Matter API用のレイヤーで LEDライトを制御できますそれがあると最上位ロジックを組むのが簡単になります
最初はルートノードの作成
次はエンドポイントの作成と構成
エンドポイントはカラーLEDライトで eventHandlerのクロージャは HomeKitからエンドポイントにイベントが届くたびにトリガーされますコールバックの実装にはクロージャが適しています Cのコールバックでよく使われるような安全でない関数ポインタや型指定なしのコンテキスト引数は扱いませんその次はエンドポイントの登録最後に Matterアプリのセットアップと起動です
まだ全イベントの文字出力しかロジックはありませんが有効なMatterアプリを 1つ作ることができましたこのアプリをデバイスに書き込みましょう
起動までは少し時間がかかります普通この後は新しいアクセサリのセットアップを実行しますが今日の環境では実行済みですまた HomeKitネットワークへのデバイス登録も済ませたので参加先のWiFiネットワークも設定済みですネットワークに接続すると Macやその他デバイスのホームアプリにすぐに"Matter Accessory" として表示されます
スマートライトとして認識され Macのホームアプリから制御できるようになりましたここでライトのオン/オフ操作をするとデバイスがイベントを受信して制御コマンドを受け取りデバイスログを出力します
今は届いたイベントをログに出力しているだけですが次は意味があるコードを実装し LEDオブジェクトを使って先ほど見たような制御を実行させましょうイベントハンドラでは場合によって異なる属性を設定できる必要があります属性はSwiftの列挙型なので switchステートメントが使えます
どのようなケースを含めるべきかは自動補完でわかります
各種の属性に対応するコードを記述しましょう受信したイベントに基づいて enabledプロパティを設定することでライトのオン/オフを切り替えることができますまた明るさのプロパティを設定するときは値の範囲を適切に調整します同じように色の変化を処理する場合も色相や彩度色温度の新しい値を設定しますコーディングが済んだのでデバイスにこのプログラムを書き込んでテストしましょう
起動するまでお話を Swiftの列挙型は人間工学的に優れた便利なしくみです
列挙型は非常に単純なケースでは集合に含まれる1つの選択肢を表しますこの例では属性.onOffや .levelControlが該当します
関連する値が付随することもありますたとえば .colorControlはペイロードを伴っています Swiftのパターンマッチ機能のおかげで switchステートメントをネストさせる必要はありませんこのようにペイロードを添えたケースを書けば済みます
同じく colorプロパティも列挙型で表現されていて
色相+彩度または色温度の 2とおりの形式を使用できます
これらのケースではペイロードの型も違っています一方のケースではペイロードは2つの整数
もう一方のケースは整数1つだけですこの使い方ができる Swiftの列挙型はとても強力で表現力がありシンプルに簡潔に読みやすくロジックを記述できます
さてデバイスが起動しましたバッテリーの電力で動くので USBケーブルは抜くことができます
デバイスの制御はホームアプリからワイヤレスで行えますライトをつけてみます
消します
明るさを調整してみます
色温度を切り替えてみます
自由に色を指定することもできますいくつかの色を試してみましょう
いいですねスマートライトの試作品がうまく動いていますこうして Embedded Swiftを使い HomeKit対応スマートライトを開発できました実際にやってみたい方は GitHubにデモプロジェクトとセットアップ手順があります
このように Swiftでは相互運用機能を生かし HomeKit対応デバイスの基本的なプロトタイプをごく短時間で作り動作させることができます Matterプロトコル全体を Swiftで実装し直す必要はなく既にある実装を Swiftから利用できます Swiftはコードの設計と実装をクリーンで直感的なものにし読みやすさと安全性を CやC++よりも向上させることができます先ほどもクロージャを使ってコールバックを書き人間工学的なコードで実装できました Embedded Swiftは普通のSwiftに近い感覚で使うことができデモで見たとおりほぼ同じ言語機能を備えていますが異なる点もあります
組み込み環境にはいずれも非常に厳しい制約があり小さくてシンプルなプログラムのバイナリしか搭載できませんメモリとストレージのサイズや CPUの性能も非常に限られていますその要件に合わせるため一部の機能は Embedded Swiftでは無効になっていますたとえば実行時リフレクションについて考えてみましょうある型の子について検査するには型のメタデータレコードを参照する必要がありますそれにはフィールドの名前やオフセットと型情報が含まれさらに他のメタデータレコードへの参照なども発生しますそうしたレコードの扱いは組み込みデバイスの規模を超えたコードサイズコストになります
このため Mirror APIによる実行時リフレクションは完全なSwift環境でしか利用できません Embedded Swiftでは無効です同じ理由でメタデータの参照を実行時に発生させないようメタタイプと"any"型も無効になっていますしかし心配は無用ごくわずかな範囲を除きそのままの言語機能が備わっています
Embedded Swiftは Swiftのフル仕様を厳守したサブセットで変種や方言のようなクセはありません Embedded Swiftの挙動は完全なSwiftと同じですそこに違いはありません Embedded Swiftで使えるすべてのコードは完全なSwiftでも動作します
使おうとした機能が Embedded Swiftにない場合はコンパイラが教えてくれますたとえば any型を使おうとするとこのようになります
このエラーは any Countableをジェネリクスに置き換えれば回避することができますこのコードスニペットは any Countableを some Countableに書き換えたものですこの変更で関数はジェネリック関数になりましたジェネリック関数はコンパイラによって特定されるので Embedded Swiftでも完全にサポートされていますこのコーディングにするとコストが大きい実行時サポートや型メタデータは必要ありません Embedded Swiftには他にも興味深い点が山ほどあります Swift Evolutionプロセスにおいても Embedded Swiftのビジョンドキュメントが公開/承認されましたそのドキュメントでは Embedded Swiftの概要設計要件アプローチが説明されておりコンパイルモードや言語サブセットの知識を得る資料として最適です Embedded Swiftを試してみたい方は「Embedded Swift -- User Manual」をぜひ読みください使い始める方法やできることできないことがわかりますしベンダー製の SDKやビルドシステムの扱いに関して知っておく必要がある情報も得られますたとえばコンパイラに指定するフラグや満たす必要がある依存関係などがわかります
GitHubには私たちがEmbedded Swiftで作ったサンプルプロジェクト群があります ARMまたはRISC-Vマイクロコントローラ搭載の組み込みデバイス各種を扱った内容で広く使われている人気の組み込み開発ボードやゲーム端末Playdateなどいろいろなデバイスが含まれますサンプルは各種ビルドシステムや統合オプションの使い方を理解し Embedded Swiftの利用価値を知る情報源になるだけでなくアイデアを練るためのテンプレートとしても役立ちます埋め込みデバイス上で実行するコードでは低レベルのハードウェアレジスタ操作がよく行われるのでそうした用途向けの Swift MMIOライブラリを公開しましたこれはメモリマップドレジスタの操作を安全に体系的に人間工学的に行える APIを提供するものです最後に Swift Forumsに新たなサブカテゴリ "Embedded"が設けられました皆さんが新しい試みや質問議論のやり取りなどを行う場として最適です
以上組み込みデバイス用の新しいコンパイルモード Embedded Swiftの使い方を紹介してきました今はプレビュー公開の段階であり swift.org nightlyツールチェーンでの利用が前提になります 32ビットと64ビットの ARMチップ RISC-Vチップが現時点で両方サポートされていますなお Embedded Swift自体は特定のハードウェアに依存しないため新しい命令セットへの対応は簡単です Embedded Swiftでぜひ魅力的なプロジェクトを作ってみてください体験談やご意見を Swift Forumsでお待ちしていますありがとうございました WWDCをお楽しみください

@_cdecl("app_main")
func app_main() {
  print("🏎️   Hello, Embedded Swift!")
}

6:48 - Turning on LED to blue color

@_cdecl("app_main")
func app_main() {
  print("🏎️   Hello, Embedded Swift!")
  var config = led_driver_get_config()
  let handle = led_driver_init(&config)
  led_driver_set_hue(handle, 240) // blue
  led_driver_set_saturation(handle, 100) // 100%
  led_driver_set_brightness(handle, 80) // 80%
  led_driver_set_power(handle, true)  
}

8:32 - Using an LED object

let led = LED()

@_cdecl("app_main")
func app_main() {
  print("🏎️   Hello, Embedded Swift!")

  led.color = .red
  led.brightness = 80

  while true {
    sleep(1)
    led.enabled = !led.enabled
    if led.enabled {
      led.color = .hueSaturation(Int.random(in: 0 ..< 360), 100)
    }
  }
}

12:44 - Matter application controlling an LED light

let led = LED()

@_cdecl("app_main")
func app_main() {
  print("🏎️   Hello, Embedded Swift!")
  
  // (1) create a Matter root node
  let rootNode = Matter.Node()
  rootNode.identifyHandler = {
    print("identify")
  }
  
  // (2) create a "light" endpoint, configure it
  let lightEndpoint = Matter.ExtendedColorLight(node: rootNode)
  lightEndpoint.configuration = .default
  lightEndpoint.eventHandler = { event in
    print("lightEndpoint.eventHandler:")
    print(event.attribute)
    print(event.value)

    switch event.attribute {
    case .onOff:
      led.enabled = (event.value == 1)
    
    case .levelControl:
      led.brightness = Int(Float(event.value) / 255.0 * 100.0)
    
    case .colorControl(.currentHue):
      let newHue = Int(Float(event.value) / 255.0 * 360.0)
      led.color = .hueSaturation(newHue, led.color.saturation)
    
    case .colorControl(.currentSaturation):
      let newSaturation = Int(Float(event.value) / 255.0 * 100.0)
      led.color = .hueSaturation(led.color.hue, newSaturation)
    
    case .colorControl(.colorTemperatureMireds):
      let kelvins = 1_000_000 / event.value
      led.color = .temperature(kelvins)
    
    default:
      break
    }
  }
  
  // (3) add the endpoint to the node
  rootNode.addEndpoint(lightEndpoint)
  
  // (4) provide the node to a Matter application, start the application
  let app = Matter.Application()
  app.eventHandler = { event in
    print(event.type)
  }
  app.rootNode = rootNode
  app.start()
  
}

18:03 - Reflection example

// Reflection needs metadata records

let mirror = Mirror(reflecting: s)
mirror.children.forEach { … }

struct MyStruct {
  var count: Int
  var name: String
}

18:57 - Unavailable features will produce errors

// Unavailable features will produce errors

protocol Countable {
  var count: Int { get }
}

func count(countable: any Countable) {
  print(countable.count)
}

19:24 - Prefer generics over “any” types

// Prefer generics over “any” types

protocol Countable {
  var count: Int { get }
}

func count(countable: some Countable) {
  print(countable.count)
}

関連する章

リソース

関連ビデオ

WWDC21