Added basic blink example for Esp32-C6 #21

allexoK · 2024-06-26T14:35:49Z

Hello,

When learning about embedded-Swift, I was surprised that there was no basic blink example (only the LED strip one). So, I decided to create one.

I used the ESP32-C6-Bug board, but it doesn’t really matter as long as there is a normal LED on-board. Alternatively, an external LED can be connected.

Added pictures and added more specific instructions

rauhul

Thanks for the PR there are some hopefully simple changes we need to make before merging this addition :)

Lastly could you also update the README at the repo root to list this example

rauhul · 2024-06-26T16:07:22Z

esp32-led-blink-sdk/CMakeLists.txt

@@ -0,0 +1,3 @@
+cmake_minimum_required(VERSION 3.16)


Could you increase this to 3.29 and ensure everything still works?

done, everything works

rauhul · 2024-06-26T16:07:51Z

esp32-led-blink-sdk/README.md

@@ -0,0 +1,39 @@
+# esp32-led-strip-sdk


I think this name is copy-pasted, could you update it?

rauhul · 2024-06-26T16:08:10Z

esp32-led-blink-sdk/README.md

+
+This example demonstrates how to integrate with the ESP-IDF SDK via CMake and how to use the standard GPIO library to control LED from Swift. This example is specifically made for the RISC-V MCUs from ESP32 (the Xtensa MCUs are not currently supported by Swift).
+
+![Led on](https://github.com/allexoK/swift-embedded-examples/assets/50021377/c40d4b3a-670b-4743-a8ae-a90c90b905b4)


These links appear to point out of tree, could you fix them?

I created the pics directory in the project folder and uploaded the pictures there, is it fine?

rauhul · 2024-06-26T16:08:26Z

esp32-led-blink-sdk/README.md

+- If needed, run export.sh to get access to the idf.py script from ESP-IDF.
+- Specify the nightly toolchain to be used via the `TOOLCHAINS` environment variable and the target board type by using `idf.py set-target`.
+``` console
+$ cd esp32-led-strip-sdk


copied folder name

rauhul · 2024-06-26T16:09:09Z

esp32-led-blink-sdk/README.md

+
+## Running
+
+- Connect the Esp32-C6-Bug board(Or any other board with integrated LED on GPIO pin 8) over a USB cable to your Mac. Alternatively you can just connect external LED to GPIO pin 8 on any other board.


could you adjust the formatting here slightly: "...board (or any..."

rauhul · 2024-06-26T16:09:59Z

esp32-led-blink-sdk/main/Main.swift

+//
+// This source file is part of the Swift open source project
+//
+// Modified by Karavaev Aleksei


sure, fixed

rauhul · 2024-06-26T16:10:16Z

esp32-led-blink-sdk/main/BridgingHeader.h

+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2023 Apple Inc. and the Swift project authors.


Could you make sure to use 2024 as the copyright date on these new additions

changed in all files of the project

rauhul · 2024-06-26T16:10:45Z

esp32-led-blink-sdk/main/Led.swift

+      fatalError("cannot reset led")
+    }
+
+    guard gpio_set_direction(ledPin,GPIO_MODE_OUTPUT) == ESP_OK else {


nit: add a space after the comma

rauhul · 2024-06-26T16:10:52Z

esp32-led-blink-sdk/main/Main.swift

+//
+//===----------------------------------------------------------------------===//
+
+// The code will blink a led attached to GPIO8, to change the led pin change the Led(gpioPin: 8) to something else


nit: wrap to 80 characters

rauhul · 2024-06-26T16:11:32Z

esp32-led-blink-sdk/README.md

+## Running
+
+- Connect the Esp32-C6-Bug board(Or any other board with integrated LED on GPIO pin 8) over a USB cable to your Mac. Alternatively you can just connect external LED to GPIO pin 8 on any other board.
+- Connect RX pin of USB-UART converter to TX0 pin of your board if you need serial ouput.(You may also need to connect GND converter pin to the GND pin of the board)


same here could you add a space after output and remove the parens "...output. You may..."

…anged copyright date and removed my name, changed copy-pasted names, changed pics location, added example description to root README.

allexoK · 2024-06-27T14:26:07Z

Hi @rauhul, thanks for the review! :)

I think I fixed everything. I was not sure which table to add the example to (Catalog of Examples or Community Examples). The 'Community Examples' table points to external repositories, so I decided to go with 'Catalog of Examples'.

Let me know if any other changes are required. :)

rauhul

@allexoK one last change and were good to go!

rauhul · 2024-06-28T17:11:15Z

esp32-led-blink-sdk/README.md

+
+This example demonstrates how to integrate with the ESP-IDF SDK via CMake and how to use the standard GPIO library to control LED from Swift. This example is specifically made for the RISC-V MCUs from ESP32 (the Xtensa MCUs are not currently supported by Swift).
+
+![Led on](pics/ledon.jpg)


last nit: could you change this path to assets/images/...

Sure, changed it :)

rauhul

fantastic, thank you for the contribution!

allexoK and others added 2 commits June 26, 2024 16:03

Addind standard blink example on GPIO8

89086c8

Update README.md

248097f

Added pictures and added more specific instructions

allexoK requested review from kubamracek and rauhul as code owners June 26, 2024 14:35

rauhul requested changes Jun 26, 2024

View reviewed changes

allexoK added 2 commits June 27, 2024 16:11

Tested when changed CMAKE to 3.29, cleaned grammar and formatting, ch…

a7c9f23

…anged copyright date and removed my name, changed copy-pasted names, changed pics location, added example description to root README.

Rotate the images

1b3195e

allexoK requested a review from rauhul June 27, 2024 14:38

rauhul requested changes Jun 28, 2024

View reviewed changes

rauhul added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 28, 2024

rauhul self-assigned this Jun 28, 2024

change pictures location to 'assets/images/...'

1faeeb4

rauhul approved these changes Jun 28, 2024

View reviewed changes

rauhul merged commit 52eb879 into apple:main Jun 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added basic blink example for Esp32-C6 #21

Added basic blink example for Esp32-C6 #21

allexoK commented Jun 26, 2024

rauhul left a comment

rauhul Jun 26, 2024

allexoK Jun 27, 2024 •

edited

Loading

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

rauhul Jun 26, 2024

allexoK Jun 27, 2024

allexoK commented Jun 27, 2024 •

edited

Loading

rauhul left a comment

rauhul Jun 28, 2024

allexoK Jun 28, 2024

rauhul left a comment


		This example demonstrates how to integrate with the ESP-IDF SDK via CMake and how to use the standard GPIO library to control LED from Swift. This example is specifically made for the RISC-V MCUs from ESP32 (the Xtensa MCUs are not currently supported by Swift).

		![Led on](https://github.com/allexoK/swift-embedded-examples/assets/50021377/c40d4b3a-670b-4743-a8ae-a90c90b905b4)


		## Running

		- Connect the Esp32-C6-Bug board(Or any other board with integrated LED on GPIO pin 8) over a USB cable to your Mac. Alternatively you can just connect external LED to GPIO pin 8 on any other board.


		This example demonstrates how to integrate with the ESP-IDF SDK via CMake and how to use the standard GPIO library to control LED from Swift. This example is specifically made for the RISC-V MCUs from ESP32 (the Xtensa MCUs are not currently supported by Swift).

		![Led on](pics/ledon.jpg)

Added basic blink example for Esp32-C6 #21

Added basic blink example for Esp32-C6 #21

Conversation

allexoK commented Jun 26, 2024

rauhul left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allexoK Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allexoK commented Jun 27, 2024 • edited Loading

rauhul left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rauhul left a comment

Choose a reason for hiding this comment

allexoK Jun 27, 2024 •

edited

Loading

allexoK commented Jun 27, 2024 •

edited

Loading