Skip to content

Add Xcc flags that fixes crash on ESP32-C3. #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 11, 2024
Merged

Add Xcc flags that fixes crash on ESP32-C3. #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6fcccb
Add `Xcc` flags that fixes crash on ESP32-C3.
cheif Jul 10, 2024
596cfee
Set `march`/`mabi` based on target device.
cheif Jul 12, 2024
4483287
Update README:s to mention ESP32C3
cheif Aug 13, 2024
549fe9c
Update readme after PR feedback
cheif Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Build a Matter accessory using Embedded Swift

<!-- Image -->

This repository contains an example simple Embedded Swift application that implements a Matter smart light accessory and can be used from HomeKit. The examples use an ESP32-C6 (RISC-V) microcontroller and build on top of the ESP-IDF and ESP-Matter SDKs.
This repository contains an example simple Embedded Swift application that implements a Matter smart light accessory and can be used from HomeKit. The examples use an ESP32-C6 or ESP32-C3 (RISC-V) microcontroller and build on top of the ESP-IDF and ESP-Matter SDKs.

> [!NOTE]
> This repository is associated with WWDC24 session 10197: [Go small with Embedded Swift](https://developer.apple.com/wwdc24/10197).
Expand Down Expand Up @@ -37,7 +37,7 @@ Before running the examples, ensure you have the following tools available:

- Hardware:
- [ESP32-C6-DevKitC-1-N8](https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/user_guide.html)
- Software
- Software
- [Swift Nightly Toolchain](https://www.swift.org/download)
- [CMake 3.29+](https://cmake.org/download)
- [ESP-IDF 5.2.1](https://docs.espressif.com/projects/esp-idf/en/v5.2.1/esp32c6/get-started/index.html)
Expand All @@ -59,17 +59,17 @@ Ensure your shell has access to the tools listed above, see [Get started on macO
$ cd swift-matter-examples/smart-light
```

2. Configure the build system for your microcontroller.
2. Configure the build system for your microcontroller, the `smart-light` example should also be runnable on `esp32c3`.
```shell
$ idf.py set-target esp32c6
```

3. Build and deploy the application to your device.
3. Build and deploy the application to your device.
```shell
$ idf.py build flash monitor
```

Explore the implementation, see [Explore the LED Blink example](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-led-blink#Understand-the-code) and
Explore the implementation, see [Explore the LED Blink example](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-led-blink#Understand-the-code) and
[Explore the Smart Light example](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-smart-light#Understand-the-code) for guided walkthroughs.

## Contributing to Swift Matter Examples
Expand Down
10 changes: 5 additions & 5 deletions smart-light/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Embedded Swift Matter Example: Smart Light example

This directory contains an example implementation of a Matter smart LED light accessory in Embedded Swift, and it can be built using the ESP IDF and ESP Matter SDKs, and uploaded to an ESP32C6 development board.
This directory contains an example implementation of a Matter smart LED light accessory in Embedded Swift, and it can be built using the ESP IDF and ESP Matter SDKs, and uploaded to an ESP32C6 or ESP32C3 development board.

Breakdown of the files included:

Expand All @@ -27,7 +27,7 @@ Breakdown of the files included:
For full steps how to build the example code, follow the [Setup Your Environment](https://apple.github.io/swift-embedded/swift-matter-examples/tutorials/tutorial-table-of-contents#setup-your-environment) tutorials and the [Explore the Smart Light example](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-smart-light) tutorial. In summary:

- Ensure your system has all the required software installed and your shell has access to the tools listed in the top-level README file.
- Plug in the ESP32C6 development board via a USB cable.
- Plug in the ESP32C6/C3 development board via a USB cable.
- Have a set up HomeKit or other Matter-enabled smart home ecosystem.
- For HomeKit, this includes a configured home, a Wi-Fi network which additional devices can join, a [home hub](https://support.apple.com/en-us/102557), and an iOS device for managing the home.

Expand All @@ -37,17 +37,17 @@ For full steps how to build the example code, follow the [Setup Your Environment
$ cd swift-matter-examples/smart-light
```

2. Configure the build system for your microcontroller.
2. Configure the build system for your microcontroller, this example should also be runnable on `esp32c3`.
```shell
$ idf.py set-target esp32c6
```

3. Build and deploy the application to your device.
3. Build and deploy the application to your device.
```shell
$ idf.py build flash monitor
```

4. Register the device in your home network. See [Connect-using-Matter](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-smart-light#Connect-using-Matter) for detailed pairing instructions with HomeKit.
4. Register the device in your home network. See [Connect-using-Matter](https://apple.github.io/swift-matter-examples/tutorials/swiftmatterexamples/run-example-smart-light#Connect-using-Matter) for detailed pairing instructions with HomeKit.

5. You can now control the smart light. In case of a HomeKit network, the Home app, and Siri can both be used to turn the light on, off, change colors, etc.

Expand Down
15 changes: 15 additions & 0 deletions smart-light/main/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ foreach(dir ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
string(CONCAT SWIFT_INCLUDES ${SWIFT_INCLUDES} "-I${dir} ")
endforeach()

# Set device-specific march/mabi flags
idf_build_get_property(target IDF_TARGET)
if(${target} STREQUAL "esp32c2" OR ${target} STREQUAL "esp32c3")
set(march_flag "rv32imc_zicsr_zifencei")
set(mabi_flag "ilp32")
elseif(${target} STREQUAL "esp32p4")
set(march_flag "rv32imafc_zicsr_zifencei")
set(mabi_flag "ilp32f")
else()
set(march_flag "rv32imac_zicsr_zifencei")
set(mabi_flag "ilp32")
endif()

# Swift compiler flags to build in Embedded Swift mode, optimize for size, choose the right ISA, ABI, C++ language standard, etc.
target_compile_options(${COMPONENT_LIB} PUBLIC "$<$<COMPILE_LANGUAGE:Swift>:SHELL:
-target riscv32-none-none-eabi
Expand All @@ -46,6 +59,8 @@ target_compile_options(${COMPONENT_LIB} PUBLIC "$<$<COMPILE_LANGUAGE:Swift>:SHEL
-Xcc -D_GLIBCXX_HAVE_POSIX_SEMAPHORE
-Xcc -D_GLIBCXX_USE_POSIX_SEMAPHORE
-Xcc -D_POSIX_READER_WRITER_LOCKS
-Xcc -march=${march_flag}
-Xcc -mabi=${mabi_flag}

-pch-output-dir /tmp
-Xfrontend -enable-single-module-llvm-emission
Expand Down