Skip to content

Create new pins_arduino.h and update boards.txt to add Heltec Wireless Tracker board #8725

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

Merged
merged 11 commits into from
Jan 23, 2024

Conversation

jhiggason
Copy link
Contributor


Description of Change

Add Heltec Wireless Tracker to variants and boards.txt using https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/releases as a source.

This is my first time doing this- not sure if I need to include the libraries they have or not. (GNSS and LORA are the two that come to mind)

Tests scenarios

Please describe on what Hardware and Software combinations you have tested this Pull Request and how.

I'm not 100% sure how to test this but happy to do it since I have a board.

Related links

#8464
platformio/platform-espressif32#1148

@CLAassistant
Copy link

CLAassistant commented Oct 5, 2023

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jhiggason, please take a look on my comment.
Added suggestions for easier fixing.

@jhiggason
Copy link
Contributor Author

I'll take a look at this today/tomorrow sometime =) Thanks for your help.

@jhiggason
Copy link
Contributor Author

@P-R-O-C-H-Y I made the requested changes- can you check them out for me? Do you see anything else wrong with it?

@P-R-O-C-H-Y
Copy link
Member

@jhiggason Hi, you did not followed up the suggestion or required change for the erase flash menu. Can you fix that and place it on correct place of the board definition (the end, like all other boards have it)?

Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jhiggason PTAL

@jhiggason
Copy link
Contributor Author

@P-R-O-C-H-Y Ok let's try again. Is there a way for me to build this and test it before we merge it into master? Could you point me to a doc if yes? (Sorry, I'm just starting my programming journey with ESP32's and some of this, like source building and library control is new to me) Thank you for your help with this- I really do appreciate it.

boards.txt Outdated
heltec_wireless_tracker.build.defines=-D{build.band} {build.psram_val} -DLoRaWAN_DEBUG_LEVEL={build.LoRaWanDebugLevel} -DACTIVE_REGION=LORAMAC_{build.band} -DLORAWAN_PREAMBLE_LENGTH={build.LORAWAN_PREAMBLE_LENGTH} -DLORAWAN_DEVEUI_AUTO={build.LORAWAN_DEVEUI_AUTO} -D{build.board}
heltec_wireless_tracker.build.extra_libs=-lheltec_{build.cdc_on_boot}

heltec_wireless_tracker.menu.EraseFlash.none=Disabled
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this line as it was added to the end of the file.

Suggested change
heltec_wireless_tracker.menu.EraseFlash.none=Disabled

boards.txt Outdated
Comment on lines 16066 to 16067
heltec_wireless_tracker.build.defines=-D{build.band} {build.psram_val} -DLoRaWAN_DEBUG_LEVEL={build.LoRaWanDebugLevel} -DACTIVE_REGION=LORAMAC_{build.band} -DLORAWAN_PREAMBLE_LENGTH={build.LORAWAN_PREAMBLE_LENGTH} -DLORAWAN_DEVEUI_AUTO={build.LORAWAN_DEVEUI_AUTO} -D{build.board}
heltec_wireless_tracker.build.extra_libs=-lheltec_{build.cdc_on_boot}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please come this part to the end of the board definition just right above EraseFlash menu?

@P-R-O-C-H-Y
Copy link
Member

@P-R-O-C-H-Y Ok let's try again. Is there a way for me to build this and test it before we merge it into master? Could you point me to a doc if yes? (Sorry, I'm just starting my programming journey with ESP32's and some of this, like source building and library control is new to me) Thank you for your help with this- I really do appreciate it.

@jhiggason Yes you can build na test the board configuration. You can just add the changes you are adding to the ESP32 core.
If you install ESP32 Arduino Core through Boards manager in Arduino IDE, you can find the location of esp32 by going to Arduino15 folder located here:

   Windows: C:\Users\{username}\AppData\Local\Arduino15
   macOS: /Users/{username}/Library/Arduino15
   Linux: home/{username}/.arduino15

and than go to /packages/esp32/hardware/esp32/<version>/... and there is the boards.txt file and variants folder you are editing :).

If you Installed manually from GitHub, it is located in Documents/Arduino/hardware/.
After you add the changes there, you may need to restart the Arduino IDE to see the new board you added (better to use old IDE 1.8.x).

@P-R-O-C-H-Y P-R-O-C-H-Y added the Resolution: Awaiting response Waiting for response of author label Oct 18, 2023
@VojtechBartoska VojtechBartoska added this to the 3.0.0-Aplha3 milestone Nov 28, 2023
@VojtechBartoska
Copy link
Contributor

any updates on this @jhiggason?

@jhiggason
Copy link
Contributor Author

Sorry! Completely forgot about this- I'll try to test and get back to you today.

@me-no-dev me-no-dev modified the milestones: 3.0.0-Aplha3, 3.0.0-RC1 Dec 5, 2023
@Lapporatory992
Copy link

Hi,
Would it possible to add the HeltecESP32 "wireless_paper" board to the list of Espressif supported boards ?
https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/blob/master/esp32/boards.txt

Thank you,

@songpola
Copy link

songpola commented Jan 13, 2024

@jhiggason Hello! Just to let you know that they just released 1.0.0 release. :D
https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/releases/tag/1.0.0

Copy link
Contributor

github-actions bot commented Jan 15, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message ""Addressed feedback from the review"":
    • summary looks empty
    • type/action looks empty
  • the commit message "Create pins_arduino.h":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update boards.txt":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update boards.txt":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update boards.txt":
    • summary looks empty
    • type/action looks empty
  • the commit message "fix(heltec): Remove extra libs":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

⚠️ Please consider squashing your 11 commits (simplifying branch history).

👋 Hello jhiggason, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against d3711e0

@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Resolution: Awaiting response Waiting for response of author labels Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged Type: 3rd party Boards
Projects
Development

Successfully merging this pull request may close these issues.

7 participants