diff --git a/Documentation/README.md b/Documentation/README.md index 9926a2ff..ab6c1899 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -2,5 +2,5 @@ Documentation for Embedded Swift ================================ Documentation for Embedded Swift can be found at these locations: -- [in rendered form](https://swiftpackageindex.com/apple/swift-embedded-examples/documentation/embeddedswift) +- [in rendered form](https://swiftpackageindex.com/swiftlang/swift-embedded-examples/documentation/embeddedswift) - [DocC source code](/Sources/EmbeddedSwift/Documentation.docc) diff --git a/README.md b/README.md index ce750827..4683642c 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ This repository is a set of demonstration projects of **Embedded Swift**. Embedd - [Blog post introducing this repository](https://www.swift.org/blog/embedded-swift-examples/) - [Swift forums thread about this repository](https://forums.swift.org/t/embedded-swift-example-projects-for-arm-and-risc-v-microcontrollers/71066) - [Discussions about Embedded Swift on the Swift forums](https://forums.swift.org/t/embedded-swift/67057) -- [Embedded Swift Vision Document](https://github.com/apple/swift-evolution/blob/main/visions/embedded-swift.md) -- [Documentation for Embedded Swift](https://github.com/apple/swift/tree/main/docs/EmbeddedSwift) +- [Embedded Swift Vision Document](https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md) +- [Documentation for Embedded Swift](https://github.com/swiftlang/swift/tree/main/docs/EmbeddedSwift) ## Building the examples Each example in this repository contains build and deployment instructions, however there are a couple common steps needed for many of the examples included below: -1. Install [`swift`](https://swift.org) using the [instructions here](https://swiftpackageindex.com/apple/swift-embedded-examples/main/documentation/embeddedswift/installembeddedswift). +1. Install [`swift`](https://swift.org) using the [instructions here](https://swiftpackageindex.com/swiftlang/swift-embedded-examples/main/documentation/embeddedswift/installembeddedswift). 2. Install [`uv`](https://github.com/astral-sh/uv), "an extremely fast Python package and project manager", using the [instructions here](https://docs.astral.sh/uv/getting-started/installation/). @@ -21,21 +21,21 @@ Each example in this repository contains build and deployment instructions, howe | Name | Platform | SDK | Description | Photo | | ---- | -------- | --- | ----------- | ----- | | [esp32-led-blink-sdk](./esp32-led-blink-sdk) | ESP32-C6-Bug | ESP-IDF SDK | Blink an LED repeatedly with Swift & the ESP-IDF. | | -| [esp32-led-strip-sdk](./esp32-led-strip-sdk) | ESP32-C6-DevKitC-1 | ESP-IDF SDK | Control NeoPixel LEDs with Swift & the ESP-IDF. | | +| [esp32-led-strip-sdk](./esp32-led-strip-sdk) | ESP32-C6-DevKitC-1 | ESP-IDF SDK | Control NeoPixel LEDs with Swift & the ESP-IDF. | | | [harmony](./harmony) | Raspberry Pi Pico W | Pico SDK | A bluetooth speaker and ferrofluidic music visualizer. Firmware, Electrical, and Mechanical designs fully available. | | -| [nrfx-blink-sdk](./nrfx-blink-sdk) | nRF52840-DK | Zephyr SDK | Blink an LED repeatedly with Swift & Zephyr. | | +| [nrfx-blink-sdk](./nrfx-blink-sdk) | nRF52840-DK | Zephyr SDK | Blink an LED repeatedly with Swift & Zephyr. | | | [nuttx-riscv-blink](./nuttx-riscv-blink) | QEMU | NuttX | Blink a virualized led in QEMU using the Apache NuttX RTOS | | | [rpi-4b-blink](./rpi-4b-blink) | Raspberry Pi 4B | None | Blink the Pi's status green LED repeatedly using Swift MMIO. | | | [rpi-5-blink](./rpi-5-blink) | Raspberry Pi 5 | None | Blink the Pi's status green LED repeatedly with Swift MMIO. | | -| [rpi-pico-blink-sdk](./rpi-pico-blink-sdk) | Raspberry Pi Pico, Pico 2 | Pico SDK | Blink an LED repeatedly with Swift & the Pico SDK. | | -| [rpi-pico-blink](./rpi-pico-blink) | Raspberry Pi Pico | None | Blink an LED repeatedly. | | +| [rpi-pico-blink-sdk](./rpi-pico-blink-sdk) | Raspberry Pi Pico, Pico 2 | Pico SDK | Blink an LED repeatedly with Swift & the Pico SDK. | | +| [rpi-pico-blink](./rpi-pico-blink) | Raspberry Pi Pico | None | Blink an LED repeatedly. | | | [rpi-pico2-neopixel](./rpi-pico2-neopixel) | Raspberry Pi Pico 2 | None | Control Neopixel LEDs using the RP2350 PIO. | | -| [rpi-picow-blink-sdk](./rpi-picow-blink-sdk) | Raspberry Pi Pico W | Pico SDK | Blink an LED to signal 'SOS' in Morse code repeatedly with Swift & the Pico SDK. | | -| [stm32-blink](./stm32-blink) | STM32F746G-DISCO | None | Blink an LED repeatedly. | | -| [stm32-lcd-logo](./stm32-lcd-logo) | STM32F746G-DISCO | None | Animate the Swift Logo on the built-in LCD. | | +| [rpi-picow-blink-sdk](./rpi-picow-blink-sdk) | Raspberry Pi Pico W | Pico SDK | Blink an LED to signal 'SOS' in Morse code repeatedly with Swift & the Pico SDK. | | +| [stm32-blink](./stm32-blink) | STM32F746G-DISCO | None | Blink an LED repeatedly. | | +| [stm32-lcd-logo](./stm32-lcd-logo) | STM32F746G-DISCO | None | Animate the Swift Logo on the built-in LCD. | | | [stm32-lvgl](./stm32-lvgl) | STM32F746G-DISCO | – | Baremetal setup of LCD, touch panel, DRAM, using the LLVM Embedded toolchain for ARM. Renders graphics, animations, and reacts to user input via LVGL. Includes a macOS/Linux SDL based host simulation app. | | -| [stm32-neopixel](./stm32-neopixel) | STM32F746G-DISCO | None | Control NeoPixel LEDs using SPI. | | -| [stm32-uart-echo](./stm32-uart-echo) | STM32F746G-DISCO | None | Echo user input using UART. | | +| [stm32-neopixel](./stm32-neopixel) | STM32F746G-DISCO | None | Control NeoPixel LEDs using SPI. | | +| [stm32-uart-echo](./stm32-uart-echo) | STM32F746G-DISCO | None | Echo user input using UART. | | Note that the SDK integration examples (Pico SDK, Zephyr SDK, etc.) are not recommendations or endorsement, the same is true for build system choice (Make, CMake, SwiftPM, shell scripts). Embedded Swift aims to be versatile and allowing integration into existing SDKs and build systems, and the example projects show some of the possibilities. @@ -48,18 +48,18 @@ Note that the SDK integration examples (Pico SDK, Zephyr SDK, etc.) are not reco | Name | Platform | Description | | ---- | -------- | ----------- | -| [swift-matter-examples](https://github.com/apple/swift-matter-examples) | ESP32 | An Embedded Swift Matter application running on ESP32-C6. | +| [swift-matter-examples](https://github.com/swiftlang/swift-matter-examples) | ESP32 | An Embedded Swift Matter application running on ESP32-C6. | | [swift-flipperzero-hello](https://github.com/Sameesunkaria/swift-flipperzero-hello) | Flipper Zero | A demonstration of running Swift apps on the Flipper Zero. | | [EmbeddedSwift nRF52 Examples](https://github.com/nelcea/EmbeddedSwift-nRF52-Examples) | nRF52840 (Development Kit) | A collection of examples using Embedded Swift on top of nRF Connect SDK (Zephyr). | | [Swatak](https://github.com/nelcea/EmbeddedSwift-nRF52-Swatak) | nRF52840 (Seeed Studio XIAO) | A reaction time game inspired by BATAK© boards, implemented in Embedded Swift using nRF Connect SDK. | | [swift-picosystem-example](https://github.com/jerrodputman/swift-picosystem-example) | PicoSystem | An Embedded Swift demo running on the Pimoroni PicoSystem | | [PlaydateKit](https://github.com/finnvoor/PlaydateKit) | Playdate | A full featured framework for building Playdate games using Embedded Swift. | -| [swift-playdate-examples](https://github.com/apple/swift-playdate-examples) | Playdate | An Embedded Swift game running on Playdate by Panic. | +| [swift-playdate-examples](https://github.com/swiftlang/swift-playdate-examples) | Playdate | An Embedded Swift game running on Playdate by Panic. | | [swift-stm32c011-examples](https://github.com/xtremekforever/swift-stm32c011-examples) | STM32 | Examples of running Embedded Swift on the STM32C011, which is a tiny MCU with only 6KB of SRAM and 32KB of flash. | | [flappy-swift](https://github.com/sliemeobn/flappy-swift) | Web | A WebAssembly game written in Swift in ~100 KB. | -| [swift-for-wasm-examples](https://github.com/apple/swift-for-wasm-examples) | Web | A "Swift Audio Workstation" example built with Swift for WebAssembly running in the browser using Embedded Swift. | +| [swift-for-wasm-examples](https://github.com/swiftlang/swift-for-wasm-examples) | Web | A "Swift Audio Workstation" example built with Swift for WebAssembly running in the browser using Embedded Swift. | -Please note that the presence of community repositories and devices in this list does not constitute a recommendation or endorsement. If there's a project you'd like to see included here, please [submit an issue](https://github.com/apple/swift-embedded-examples/issues/new) with the details. +Please note that the presence of community repositories and devices in this list does not constitute a recommendation or endorsement. If there's a project you'd like to see included here, please [submit an issue](https://github.com/swiftlang/swift-embedded-examples/issues/new) with the details. ## Contributing to this repository diff --git a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/PicoGuide.md b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/PicoGuide.md index 386dd85b..b210dc38 100644 --- a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/PicoGuide.md +++ b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/PicoGuide.md @@ -23,7 +23,7 @@ $ export PICO_SDK_PATH=... # location to your Pico SDK $ export PICO_TOOLCHAIN_PATH=... # location to the Arm Embedded Toolchain ``` -If you have the Wi-Fi enabled Pico W board instead of the regular Pico, note that you will need a slightly different setup described in the [Pico W example project](https://github.com/apple/swift-embedded-examples/tree/main/rpi-picow-blink-sdk), and just specifying `PICO_BOARD=pico_w` is not going to work. +If you have the Wi-Fi enabled Pico W board instead of the regular Pico, note that you will need a slightly different setup described in the [Pico W example project](https://github.com/swiftlang/swift-embedded-examples/tree/main/rpi-picow-blink-sdk), and just specifying `PICO_BOARD=pico_w` is not going to work. Install [CMake 3.29](https://cmake.org/) or newer. @@ -48,7 +48,7 @@ bin/ libexec/ ## Building a "blinky" embedded app -The standard "Hello, World" in embedded development is a program that repeatedly blinks an LED. Let's build one. The following setup can be also found in [swift-embedded-examples](https://github.com/apple/swift-embedded-examples/blob/main/rpi-pico-blink-sdk/README.md), but we're going to show below that all you need is just three files. +The standard "Hello, World" in embedded development is a program that repeatedly blinks an LED. Let's build one. The following setup can be also found in [swift-embedded-examples](https://github.com/swiftlang/swift-embedded-examples/blob/main/rpi-pico-blink-sdk/README.md), but we're going to show below that all you need is just three files. Let's create a new empty directory and prepare a simple structure for a CMake-based project that can be used on top of the Pico SDK: ``` diff --git a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/STM32BaremetalGuide.md b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/STM32BaremetalGuide.md index c80b19e0..fa3e4691 100644 --- a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/STM32BaremetalGuide.md +++ b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/STM32BaremetalGuide.md @@ -89,7 +89,7 @@ let package = Package( .executable(name: "STM32BlinkLED", targets: ["STM32BlinkLED"]) ], dependencies: [ - .package(url: "https://github.com/apple/swift-mmio", branch: "main"), + .package(url: "https://github.com/swiftlang/swift-mmio", branch: "main"), ], targets: [ .executableTarget( @@ -119,7 +119,7 @@ First, we'll build the SVD2Swift tool from the swift-mmio package we added as a ```shell $ swift build --product SVD2Swift -$ curl -L "https://github.com/apple/swift-embedded-examples/raw/refs/heads/main/Tools/SVDs/stm32f7x6.patched.svd" -O +$ curl -L "https://github.com/swiftlang/swift-embedded-examples/raw/refs/heads/main/Tools/SVDs/stm32f7x6.patched.svd" -O $ .build/debug/SVD2Swift --input stm32f7x6.patched.svd --output Sources/Registers --access-level public \ --peripherals RCC USART1 GPIOA GPIOB GPIOC GPIOD GPIOE GPIOF GPIOG GPIOH GPIOI GPIOJ GPIOK ``` @@ -363,7 +363,7 @@ as published by the Free Software Foundation; either version Then let's fetch the elf2hex tool: ```shell -$ curl -L "https://raw.githubusercontent.com/apple/swift-embedded-examples/refs/heads/main/Tools/elf2hex.py" -O +$ curl -L "https://raw.githubusercontent.com/swiftlang/swift-embedded-examples/refs/heads/main/Tools/elf2hex.py" -O $ chmod +x elf2hex.py ``` diff --git a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/macOSGuide.md b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/macOSGuide.md index c1c7c5bb..cc604e8d 100644 --- a/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/macOSGuide.md +++ b/Sources/EmbeddedSwift/Documentation.docc/GuidedExamples/macOSGuide.md @@ -66,7 +66,7 @@ HelloEmbedded: ## Where to go next - The [Embedded Swift Vision Document](https://github.com/swiftlang/swift-evolution/blob/main/visions/embedded-swift.md) will give you an overview of the approaches and goals of Embedded Swift, and also what exactly is in the Embedded Swift language subset. -- The [collection of Embedded Swift example projects](https://github.com/apple/swift-embedded-examples) on GitHub shows on which embedded devices can Swift work today, and the examples can also be used as templates for your own projects. +- The [collection of Embedded Swift example projects](https://github.com/swiftlang/swift-embedded-examples) on GitHub shows on which embedded devices can Swift work today, and the examples can also be used as templates for your own projects. - The [Embedded Swift User Manual](https://github.com/swiftlang/swift/blob/main/docs/EmbeddedSwift/UserManual.md) describes how to use the Embedded Swift compilation mode and how to interact with the compiler. - The [Tools page](https://www.swift.org/tools/#editors) has guides for setting up Swift integration in your editor to enable features like indexing, autocomplete, jump-to-definition, and others. - The [Swift forums](https://forums.swift.org/) are the best place to ask questions, give feedback or share your cool projects. diff --git a/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md b/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md index bb91bbb4..0956b359 100644 --- a/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md +++ b/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/Baremetal.md @@ -67,7 +67,7 @@ Swift MMIO provides strongly-typed access to memory-mapped hardware and can auto gpioa.odr.write { $0.odr5 = true } // Set pin 5 high ``` -See [Swift MMIO](https://github.com/apple/swift-mmio/) for details and for a guided example of using it. +See [Swift MMIO](https://github.com/swiftlang/swift-mmio/) for details and for a guided example of using it. ## Creating a linker script and data segment relocation diff --git a/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegrateWithZephyr.md b/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegrateWithZephyr.md index 59a55bed..82930040 100644 --- a/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegrateWithZephyr.md +++ b/Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegrateWithZephyr.md @@ -2,7 +2,7 @@ Integrating Swift with Zephyr RTOS for embedded systems development -The following document outlines how to setup a Swift to Zephyr project for an emulated ARM Cortex M0, explaining a few key concepts along the way. For a complete working example on real hardware, however, refer to the [nrfx-blink-sdk](https://github.com/apple/swift-embedded-examples/tree/main/nrfx-blink-sdk) project that is compatible with nRF or other boards. +The following document outlines how to setup a Swift to Zephyr project for an emulated ARM Cortex M0, explaining a few key concepts along the way. For a complete working example on real hardware, however, refer to the [nrfx-blink-sdk](https://github.com/swiftlang/swift-embedded-examples/tree/main/nrfx-blink-sdk) project that is compatible with nRF or other boards. > Note: Embedded Swift is experimental. Public releases of Swift do not support Embedded Swift, yet. See for details. diff --git a/esp32-led-strip-sdk/README.md b/esp32-led-strip-sdk/README.md index 6f63294c..4f50c021 100644 --- a/esp32-led-strip-sdk/README.md +++ b/esp32-led-strip-sdk/README.md @@ -2,7 +2,7 @@ This example demonstrates how to integrate with the ESP-IDF SDK via CMake and how to use the existing LED strip library to control WS8212 lights from Swift. This example is specifically made for the RISC-V MCUs from ESP32 (the Xtensa MCUs are not currently supported by Swift). - + ## Requirements diff --git a/harmony/README.md b/harmony/README.md index 07645959..9e8a55f9 100644 --- a/harmony/README.md +++ b/harmony/README.md @@ -45,7 +45,7 @@ The firmware for Harmony is built using CMake and requires the Raspberry Pi Pico 2. Clone the swift-embedded-examples repository (if not already done): ```bash - git clone https://github.com/apple/swift-embedded-examples.git + git clone https://github.com/swiftlang/swift-embedded-examples.git cd harmony ``` diff --git a/nrfx-blink-sdk/README.md b/nrfx-blink-sdk/README.md index 4ae17344..8a8de074 100644 --- a/nrfx-blink-sdk/README.md +++ b/nrfx-blink-sdk/README.md @@ -2,7 +2,7 @@ This example demonstrates how to integrate with the Zephyr SDK via CMake and how to build a Swift firmware application on top of the SDK and the libraries from it. The example was tested on a nRF52840-DK board, but it should also work on other Zephyr-supported boards. - + ## Requirements diff --git a/rpi-pico-blink-sdk/README.md b/rpi-pico-blink-sdk/README.md index 4d0b27be..bd6d9e85 100644 --- a/rpi-pico-blink-sdk/README.md +++ b/rpi-pico-blink-sdk/README.md @@ -2,7 +2,7 @@ This example demonstrates how to integrate with the Pico SDK which is using CMake as its build system -- the simplest way to integrate with it is to also use CMake to build a Swift firmware application on top of the SDK and the libraries from it. - + ## Requirements diff --git a/rpi-pico-blink/README.md b/rpi-pico-blink/README.md index e2c5766d..12ed0a5f 100644 --- a/rpi-pico-blink/README.md +++ b/rpi-pico-blink/README.md @@ -1,6 +1,6 @@ # rpi-pico-blink - + ## Requirements diff --git a/rpi-picow-blink-sdk/README.md b/rpi-picow-blink-sdk/README.md index bae041fa..d4305678 100644 --- a/rpi-picow-blink-sdk/README.md +++ b/rpi-picow-blink-sdk/README.md @@ -2,7 +2,7 @@ This example demonstrates how to integrate with the Pico SDK which is using CMake as its build system -- the simplest way to integrate with it is to also use CMake to build a Swift firmware application on top of the SDK and the libraries from it. - + ## Requirements diff --git a/stm32-blink/README.md b/stm32-blink/README.md index 84a551f0..12797e03 100644 --- a/stm32-blink/README.md +++ b/stm32-blink/README.md @@ -2,7 +2,7 @@ This example shows a simple baremetal firmware for an STM32 board that blinks an LED repeatedly. The example does not use any vendor SDKs or external toolchains, the entire firmware is only built from code in this example directory. - + ## Requirements diff --git a/stm32-lcd-logo/README.md b/stm32-lcd-logo/README.md index a0e9d151..764f5998 100644 --- a/stm32-lcd-logo/README.md +++ b/stm32-lcd-logo/README.md @@ -1,6 +1,6 @@ # stm32-lcd-logo - + ## How to build and run this example: diff --git a/stm32-neopixel/README.md b/stm32-neopixel/README.md index 07d8dd4f..d006b5da 100644 --- a/stm32-neopixel/README.md +++ b/stm32-neopixel/README.md @@ -1,6 +1,6 @@ # stm32-neopixel - + This demo is designed to run on an STM32 microcontroller and some additional hardware, detailed below: