-
Notifications
You must be signed in to change notification settings - Fork 117
Add documentation for Seeed XIAO ESP32C3 Create xiao-esp32c3.md #420
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.
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
base: dev
Are you sure you want to change the base?
Conversation
To build your TinyGo program without flashing it to the board, you can use the following command: | ||
|
||
```shell | ||
tinygo build -o blinky.elf -size=short -gc=leaking --panic=trap -target=xiao-esp32c3 [PATH TO YOUR PROGRAM] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tinygo build -o blinky.elf -size=short -gc=leaking --panic=trap -target=xiao-esp32c3 [PATH TO YOUR PROGRAM] | |
tinygo build -o blinky.elf -target=xiao-esp32c3 [PATH TO YOUR PROGRAM] |
I don't think these extra flags should be given, unless you specifically want those?
To compile and flash your program to the board in one step, use: | ||
|
||
```shell | ||
tinygo flash -port /dev/ttyUSB0 -target=xiao-esp32c3 [PATH TO YOUR PROGRAM] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this command repeated? A similar command is already listed above.
|
||
- The XIAO ESP32C3 supports both WiFi and Bluetooth functionality. However, TinyGo's support for Bluetooth on this board may be limited or in development. | ||
- The USB port on the XIAO ESP32C3 can be used as a serial port for debugging and communication. | ||
- When using WiFi functionality, be mindful of power consumption as it can significantly affect battery life in portable projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A line like this seems to imply we support WiFi on this device, which we do not. I would suggest removing it, to avoid confusion.
uart := machine.UART0 | ||
uart.Configure(machine.UARTConfig{ | ||
BaudRate: 115200, | ||
TX: machine.D6, // UART_TX_PIN for XIAO ESP32C3 | ||
RX: machine.D7, // UART_RX_PIN for XIAO ESP32C3 | ||
}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Normally it's not needed to configure the UART at startup, you can just use fmt.Println
. Is this different for this board?
To compile and flash this program: | ||
|
||
```shell | ||
tinygo flash -port /dev/ttyUSB0 -target=xiao-esp32c3 uart.go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is the extra -port
parameter needed? TinyGo should detect it automatically.
Dear TinyGo maintainers,
This PR introduces the following improvements:
Key additions include:
These additions aim to make it easier for TinyGo users to work with the XIAO ESP32C3 board, potentially broadening TinyGo's reach in the ESP32 ecosystem.
I have tested the provided information and example on the actual hardware to ensure accuracy. However, I welcome any feedback or suggestions for improvement.
Thank you for considering this contribution. I look forward to your review and am happy to make any necessary adjustments.