pohui_pohui/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-06-17 10:32:07 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Merge pull request #310 from Dafeman/PlatformIO-build-guide-update

Browse Source 
PlatformIO build guide update
This commit is contained in:
Kevin Hester 2020-08-10 09:12:11 -07:00 committed by GitHub
commit f37dc9c776
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/software/build-instructions.md
View File

@ -1,9 +1,19 @@
# Build instructions # Build instructions
This project uses the simple PlatformIO build system. You can use the IDE, but for brevity This project uses the simple PlatformIO build system. PlatformIO is an extension to Microsoft VSCode.
in these instructions I describe use of their command line tool.
1. Purchase a suitable radio (see above) ## GUI
1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information).
2. Install [PlatformIO](https://platformio.org/platformio-ide).
3. Click the PlatformIO icon on the side bar. ![platformio icon](https://user-images.githubusercontent.com/47490997/89482668-77c7ea00-d7ee-11ea-8785-5faf8ff99800.png)
4. Under `Quick Access, Miscellaneous, Clone Git Project` enter the URL of the Meshtastic repo found [here](https://github.com/meshtastic/Meshtastic-device). ![image](https://user-images.githubusercontent.com/47490997/89483047-4c91ca80-d7ef-11ea-91f4-1d53d4e8acd9.png)
5. Select a file location to save the repo.
6. Once loaded, open the `platformio.ini` file.
7. At the line `default_envs` you can change it to the board type you are building for ie. `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7` (boards are listed further down in the file).
8. Click the PlatformIO icon on the side bar. Under `Project Tasks` you can now build or upload.
## Command Line
1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information).
2. Install [PlatformIO](https://platformio.org/platformio-ide) 2. Install [PlatformIO](https://platformio.org/platformio-ide)
3. Download this git repo and cd into it: 3. Download this git repo and cd into it:
@ -11,11 +21,10 @@ in these instructions I describe use of their command line tool.
git clone https://github.com/meshtastic/Meshtastic-device.git git clone https://github.com/meshtastic/Meshtastic-device.git
cd Meshtastic-device cd Meshtastic-device
``` ```
4. Run `git submodule update --init --recursive` to pull in dependencies this project needs. 4. Run `git submodule update --init --recursive` to pull in dependencies this project needs.
5. If you are outside the USA, run "export COUNTRY=EU865" (or whatever) to set the correct frequency range for your country. Options are provided for `EU433`, `EU865`, `CN`, `JP` and `US` (default). Pull-requests eagerly accepted for other countries. 5. If you are outside the USA, run "export COUNTRY=EU865" (or whatever) to set the correct frequency range for your country. Options are provided for `EU433`, `EU865`, `CN`, `JP` and `US` (default). Pull-requests eagerly accepted for other countries.
6. Plug the radio into your USB port 6. Plug the radio into your USB port
7. Type `pio run --environment XXX -t upload` (This command will fetch dependencies, build the project and install it on the board via USB). For XXX, use the board type you have (either `tbeam`, `heltec`, `ttgo-lora32-v1`, `ttgo-lora32-v2`). 7. Type `pio run --environment XXX -t upload` (This command will fetch dependencies, build the project and install it on the board via USB). For XXX, use the board type you have (either `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7`).
8. Platform IO also installs a very nice VisualStudio Code based IDE, see their [tutorial](https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html) if you'd like to use it. 8. Platform IO also installs a very nice VisualStudio Code based IDE, see their [tutorial](https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html) if you'd like to use it.
## Decoding stack traces ## Decoding stack traces