Skip to content
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

How can we get our board included in the Arduino boards manager official ESP32 board support #7726

Closed
1 task done
raviypujar opened this issue Jan 18, 2023 · 8 comments · Fixed by #7735
Closed
1 task done

Comments

@raviypujar
Copy link
Contributor

Related area

Board support

Hardware specification

ESP32-C3

Is your feature request related to a problem?

Hi, We have a custom board with ESP32-C3 on it, We want it to be available on Arduino boards manager when someone installs ESP32 board support from this repository. How can we do, can you guide us in right direction.

Describe the solution you'd like

Add our custom board variants to Arduino boards manager

Describe alternatives you've considered

Tried posting in forum

Additional context

https://www.youtube.com/watch?v=zTeHQJF52NQ
This is our new custom board
We will be making more boards like this

I have checked existing list of Feature requests and the Contribution Guide

  • I confirm I have checked existing list of Feature requests and Contribution Guide.
@raviypujar raviypujar added the Type: Feature request Feature request for Arduino ESP32 label Jan 18, 2023
@VojtechBartoska VojtechBartoska added Type: 3rd party Boards Type: Question Only question and removed Type: Feature request Feature request for Arduino ESP32 labels Jan 18, 2023
@VojtechBartoska
Copy link
Collaborator

VojtechBartoska commented Jan 18, 2023

Hello,

you can add your Board by sending a Pull Request.

Board folder with pins_arduino.h file needs to be added here: https://github.com/espressif/arduino-esp32/tree/master/variants and also you need to add it into board.txt file.

In your case, the board is based on ESP32-C3, so the easiest option is to copy original Espressif ESP32-C3 pins_arduino.h definition, which is here https://github.com/espressif/arduino-esp32/tree/master/variants/esp32c3 and update it so it matches specification of your board.

For example, take a look on some of the already merged Pull Requests where other boards have been added, eg. https://github.com/espressif/arduino-esp32/pull/7345/files (you can check any PR, just sort by label "Type:3rd party boards" and you will find a lot of inspiration.

@raviypujar
Copy link
Contributor Author

Thank you @VojtechBartoska for the quick response. I will try and follow your recommendations.
If you can please answer one more question,
Once we install the boards , there will be example codes available for that particular board, how do we provide that information and where the example codes need to be submitted to make them available when the boards are installed.

@VojtechBartoska
Copy link
Collaborator

@raviypujar there is not such places for examples to specific board. Examples are generic and they are located e.g. in particular library.

@raviypujar
Copy link
Contributor Author

raviypujar commented Jan 19, 2023

@VojtechBartoska In pins_arduino.h, do you have any idea how we can define the default pins for Serial1 ?
I see that there is only option for Serial only.

Will adding these two lines affect the Serial1 function default lines?
static const uint8_t TXD2 = 0;
static const uint8_t RXD2 = 1;

@raviypujar
Copy link
Contributor Author

raviypujar commented Jan 19, 2023

Thank you @VojtechBartoska & @lbernstone , I have added TX1 & RX1 definitions to pins_arduino.h & made changes to boards.txt. I merged changes in the fork i made at https://github.com/raviypujar/arduino-esp32
Now i want to test in Arduino IDE by adding the json file as below, but i don't find such file on the repository i forked, where can i find this file?
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
And, do i need to make any other changes for our board to appear in Arduino IDE?

@raviypujar
Copy link
Contributor Author

@VojtechBartoska Can you please check this pull request and approve it if everything is ok?
#7735

@VojtechBartoska VojtechBartoska added the Status: In Progress Issue is in progress label Jan 23, 2023
@VojtechBartoska
Copy link
Collaborator

@raviypujar we'll review it when possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants