利用 Embedded Swift 实现轻量级开发

Embedded Swift 让你在受限环境中仍能充分利用 Swift 的安全性和表现力。我们将使用现成的 Matter 设备进行展示，带你探索 Embedded Swift 在各种微控制器上的运行效果。了解 Embedded Swift 这个不含运行时且占用空间极小的子集如何为你带来 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 来构建许多不同类型的软件你可以针对移动设备、台式电脑和服务器进行构建

在本讲座中我们将讨论 Swift 在新领域的应用也就是嵌入式设备嵌入式设备在日常生活中无处不在智能灯、恒温器、闹钟、智能风扇、音乐设备、灯带还有许多常见的小玩意都内置了可编程微控制器无论你是业余爱好者还是真正的开发者今天我将向各位介绍如何使用 Swift 为嵌入式设备编程为此我们推出了 Embedded Swift 这是一种新的编译模式专门用于受限的嵌入式设备过去 C 和 C++ 是这个领域的常用语言但现在我们支持在这些地方使用 Swift 嵌入式开发者将能够享受 Swift 的种种好处比如它的人体工程学设计、安全功能和易用性

Embedded Swift 当然很适合对嵌入式设备中的微控制器进行编程但它也适用于内核级代码和其他低级资料库代码这类代码可能对不能获得新的依赖项很敏感 Apple 设备中的安全隔区处理器就使用了 Embedded Swift Swift 的内存安全性为平台带来了巨大的益处 Embedded Swift 是 Swift 的子集涵盖你所熟知和喜爱的大部分语言并且它是一个功能完备的子集支持值和引用类型、闭包、可选类型、错误处理、泛型等现在让我们通过现场演示来了解 Embedded Swift

在开始之前请注意 Embedded Swift 目前处于实验阶段它的源代码还不稳定还在持续开发中它的最佳使用方法是搭配 swift.org 中的预览版工具链

在这个演示中我将构建一个非常简单的 HomeKit 配件的原型彩色 LED 灯首先我需要一个有效的 HomeKit 设置也就是一个 Wi-Fi 网络以及连接到这个网络的一些现有 Apple 设备我将使用一个可编程的嵌入式设备具体来说就是一块 ESP32C6 开发板搭载一个 RISC-V 微控制器它还将连接一个彩色 LED 灯我将通过 USB 数据线把 Mac 连接到设备在 Embedded Swift 中写一个程序它会实现 HomeKit 配件然后我会将它刷入设备然后设备将加入我的 Wi-Fi 和 HomeKit 网络可以通过任何 Apple 设备上的 “家庭”App 来控制这个设备

让我们开始吧我使用的是 Neovim 和 CMake 现在这只是一个模板项目展示了最基本的结构并让我们的 Embedded Swift 代码正常运行这个项目使用的是我从设备供应商获取的第三方 SDK 它是一个用 C 语言编写的 SDK 因为我不想修改这个 SDK 我可以只使用桥接标头将 SDK 的所有 API 导入 Swift

我需要一些简单的 CMake 逻辑来构建我的 Swift 代码代码将构建在供应商的 SDK 和他们的构建系统之上

这还需要几个样板文件：比如 YAML 文件

CSV 文件

和“sdkconfig”文件

任何基于这个 SDK 构建的项目都需要这些文件我已经根据供应商提供的现有示例进行了设置并在上面添加了 Swift

现在回到我的 Swift 源代码我的编辑器集成了 LSP 因此可以显示我正在使用的函数和类型的定义和文档

它可以提供丰富的语义自动补全

如果我输入错误的代码

立刻就会看到错误和警告告诉我哪里出了问题现在我插入设备

我将通过 USB 对这个设备编程我的试验板有单独的电池编程完成之后我们可以将设备拔下并继续使用它但首先我们要让最基本的 Swift 应用程序在设备上运行起来我使用的 SDK 提供了相应的工具

我将运行这个便捷的 Python 脚本它是由供应商提供的我只需要一条命令就可以构建、刷入和监控设备

运行之后可以看到固件正在构建然后上传到设备接着我们收到设备发回的日志现在我们在嵌入式设备上运行的第一个 Embedded Swift 应用程序有了生命迹象现在我们将添加代码来实现一些更有用的功能 Swift 的互操作性使我们能够访问供应商 SDK 中的所有 API 如果我想控制设备上的 LED 我可以使用 SDK 中现有的 C API

我们将调用这些 API 并设置以下含义的值 “蓝色”、“100% 饱和度” “80% 亮度”

让我们保存这个版本的代码并上传到设备

我将运行与上次相同的命令

只需几秒钟当固件上传完成并且设备重新启动后我们就能控制 LED 的颜色和亮度

仅使用 Swift 调用 C API 来完成一切会破坏原本的目的我们可以这样做但更好的做法是在这些之上构建封装层和抽象以便为应用程序编写清晰、直观且符合人体工程学的 Swift 代码在这个版本中我准备了一个 LED 对象我们直接查看它的定义

这是我之前编写的一些帮助代码它将 C API 封装为一个 Swift 层它提供了实用的属性和一些符合人体工程学的类型例如 enabled 属性是布尔值 brightness 属性是整数让我们回到包含主应用程序逻辑的文件使用 LED 对象现在我们可以编写非常简单直观的代码

开始时我们将颜色设为红色

将亮度设为 80%

像这样的代码非常清晰且易于阅读

让我们再添加一些代码

在一个循环中我们将等待 1 秒改变 LED 的状态如果是打开 LED 则请求一个新的颜色这通过色相和饱和度值来表达色相为随机饱和度为 100% 这些 Embedded Swift 代码感觉就像是用普通 Swift 写的大多数语言都是现成的我将再次上传固件

我们来看看结果如何程序启动并运行后设备的 LED 应该会闪烁随机变化的颜色

太棒了！这正是我们想要的结果构建 LED 对象层使我们能够利用 Swift 的强大能力即借助高级 API 编写清晰且易于阅读的代码

现在我们已经了解 Embedded Swift 如何巧妙整合到你的工作流程中你可以将它与供应商提供的 SDK 搭配使用你可以使你的 IDE 或文本编辑器提供完整的自动补全显示定义和文档借助 Swift 的互操作性你可以在 Swift 代码中直接从 SDK 调用现有的 C API 但将 C API 封装为一个层通常更有价值这可以提供直观且符合人体工程学的 API 来实现核心应用程序逻辑

现在我们的基本原型已经能够正常运行我们来继续构建实际的 HomeKit 配件为此我们将使用“Matter”协议 Matter 是用于构建智能家居配件的开放标准 2021 年的一个 WWDC 讲座深入介绍了这个协议如果你想进一步了解建议观看这个讲座

在我使用的 SDK 中 Matter 以 C++ API 的形式提供我们可以再次借助 Swift 的互操作性来使用这个功能它将免费提供所有的基础架构组件如设备发现和调试

一旦我们有了实现 Matter 协议的设备它将自动在 HomeKit 中运行因为它原生支持 Matter 配件我们重新开始创建一个不实现任何功能的空应用程序要使用 Matter 我们需要稍微了解一下它的数据模型和术语这是一个粗略的任务列表它们是为实现 Matter 设备而必须完成的任务我们需要创建一个根节点它代表整个 Matter 配件然后我们需要一个端点在本例中是彩色 LED 灯它也将是有状态的对象例如颜色和亮度并且可以接收命令例如打开或关闭指示灯

然后我们将端点连接到节点并将节点连接到“应用程序”对象我已经围绕 C++ Matter API 编写了一个简单的封装层它位于这个“Matter”子目录中

我们也用这种同样的方法来编写好用的 API 来与 LED 搭配使用利用它我们可以轻松地填充顶层逻辑

首先我们创建根节点

然后创建并配置端点

这是我们的彩色 LED 灯注意它有一个 eventHandler 闭包每当 HomeKit 事件发送到这个端点就会触发这个闭包闭包是一种非常自然的回调机制我们不必处理不安全的函数指针或无类型的上下文变量即 C 语言中常见的回调解决方案接下来我们注册端点最后设置并启动 Matter 应用程序

目前逻辑只是输出所有事件但我们现在已经构建了有效的 Matter 应用程序让我们把这个应用程序刷入设备

启动需要一些时间正常来说你需要完成新配件的设置流程我之前已完成这个流程并在我的 HomeKit 网络中注册了这个设备所以它已经知道要加入哪个 Wi-Fi 网络加入 Wi-Fi 网络后它将出现在我的 Mac 以及其他设备上的“家庭”App 中并显示为“Matter 配件”

它显示为智能灯我可以在 Mac 上的 “家庭”App 中控制它我可以打开和关闭智能灯这个时候我们会在设备日志中收到与这些命令相关的事件

到目前为止我们只是记录了传入的事件现在来让它们做点什么将它们连接到我们之前使用的 LED 对象在事件处理程序内我们需要针对设置的不同属性做出反应由于属性是 Swift 枚举我们可以使用 switch 语句

自动补全会告诉我们必须处理哪些情况

让我们为不同的属性填充代码根据收到的事件如果我们想要打开或关闭智能灯将需要设置 enabled 属性或者将设置 brightness 属性并需要适当调整属性值我们可以通过同样的方式处理颜色变化设置新的色相新的饱和度或新的色温我们需要的就是这些让我们将这个程序刷入设备并进行测试

在程序正在启动时我想指出 Swift 枚举十分有用且符合人体工程学

在最简单的情况下枚举只代表一组选项中的一个例如属性的 .onOff case 或 .levelControl case

但它们也可能有关联值例如 .colorControl case 具有有效负载多亏 Swift 的模式匹配我不需要第二个嵌套的 switch 语句我只需要将枚举 case 与有效负载进行匹配

我还使用枚举来表示 color 属性

可以是色相加饱和度或是色温

这些 case 甚至有不同的有效负载类型前者需要两个整数作为有效负载

后者只需要一个整数这一切使得 Swift 枚举具有强大的功能和表达能力使我们能够编写简单、简洁、易读的逻辑

现在设备已经启动我可以拔掉 USB 连接线通过电池来供电

我们可以从“家庭”App 无线控制这个设备将智能灯打开

然后关闭

我们来看看能否更改亮度

或者选择其他色温

或者完全自定义颜色我们来试试不同的颜色

太棒了我们的智能灯原型表现得很好我们成功地使用 Embedded Swift 构建了一个支持 HomeKit 的智能灯如有需要你可以在 GitHub 上获取这个演示项目和设置说明

我们已经了解如何利用 Swift 的互操作性能力来快速设置和运行支持 HomeKit 的设备的基本原型不需要在 Swift 中重新实现整个 Matter 协议我们可以仅使用 Swift 中现有的实现 Swift 鼓励简洁直观的代码设计和实现并且可读性和安全性优于 C 和 C++ 例如使用闭包作为符合人体工程学的回调解决方案在演示中我们看到 Embedded Swift 与普通 Swift 很相似它确实具有 Swift 的大部分语言特性但也有一些不同

嵌入式环境通常非常受限需要体积小且内容简单的程序二进制文件内存、存储和 CPU 性能通常非常有限因此 Embedded Swift 禁用某些功能以满足这些要求例如让我们考虑运行时反射的工作原理要检查某个类型的子项它需要访问类型的元数据记录这包括字段的名称、偏移和类型它们又会引用其他元数据记录以此类推这些记录会累积导致代码大小超出嵌入式设备的承受能力

为避免这个问题运行时反射使用 Mirror API 这在 Embedded Swift 中是禁用的仅在完整版 Swift 中提供出于相同的原因为避免在运行时需要元数据也不允许使用元类型和“any”类型不过不用担心绝大部分 Swift 语言特性在 Embedded Swift 中都支持

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 -- 用户手册” 它介绍了入门操作、你应该和不应期待的结果以及在与供应商的 SDK 和构建系统交互时可能需要了解的细节例如要使用的编译器标志以及需要满足的依赖项

我们在 GitHub 上发布了一组示例项目它们以 Embedded Swift 语言编写涵盖了一系列具有 ARM 或 RISC-V 微控制器的嵌入式设备其中包括热门的嵌入式开发板以及 Playdate 游戏机等其他设备这些示例还展示了如何使用各种构建系统和集成选项它们可让你大致了解 Embedded Swift 的功能还可以用作你自己想法的模板当编写嵌入式设备所运行的代码时你经常需要与底层硬件寄存器交互为了帮助你我们发布了“Swift MMIO” 这是一个提供 API 的资料库可在内存映射寄存器上实现安全、结构化且符合人体工程学的操作最后 Swift 论坛新增了 “Embedded”子类别你可以在这里发布试验、提问和进行讨论

我们了解了如何使用新的编译模式 Embedded Swift 对嵌入式设备进行编程它目前为预览版最好与 swift.org 上的工具链搭配使用目前支持 32 位和 64 位的 ARM 和 RISC-V 芯片但 Embedded Swift 并非特定于硬件并且很容易与新的指令集集成赶快尝试使用 Embedded Swift 构建有趣的电子产品项目并在 Swift 论坛上分享你的经验和反馈吧感谢观看祝你在 WWDC 度过美妙的时光

3:50 - Empty Embedded Swift application

@_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)
}

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。