From da46d4ca0ecbd664d90a59c69d47216af50275d1 Mon Sep 17 00:00:00 2001 From: Dafeman <47490997+Dafeman@users.noreply.github.com> Date: Thu, 6 Aug 2020 19:44:42 +1200 Subject: [PATCH 1/3] Update build-instructions.md --- docs/software/build-instructions.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/software/build-instructions.md b/docs/software/build-instructions.md index 5074fbaf1..5b8d269e3 100644 --- a/docs/software/build-instructions.md +++ b/docs/software/build-instructions.md @@ -1,9 +1,19 @@ # Build instructions -This project uses the simple PlatformIO build system. You can use the IDE, but for brevity -in these instructions I describe use of their command line tool. +This project uses the simple PlatformIO build system. PlatformIO is an extension to Microsoft VSCode. -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. `ttgo-lora32-v2, ttgo-lora32-v1, tbeam, heltec` (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) 3. Download this git repo and cd into it 4. Run `git submodule update --init --recursive` to pull in dependencies this project needs. From 8b1fb39ce167c160fad2f101f87a54150ae6350a Mon Sep 17 00:00:00 2001 From: Dafeman <47490997+Dafeman@users.noreply.github.com> Date: Thu, 6 Aug 2020 22:06:38 +1200 Subject: [PATCH 2/3] Update build-instructions.md --- docs/software/build-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/build-instructions.md b/docs/software/build-instructions.md index 5b8d269e3..2989d173f 100644 --- a/docs/software/build-instructions.md +++ b/docs/software/build-instructions.md @@ -9,7 +9,7 @@ This project uses the simple PlatformIO build system. PlatformIO is an extension 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. `ttgo-lora32-v2, ttgo-lora32-v1, tbeam, heltec` (boards are listed further down in the 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 @@ -19,7 +19,7 @@ This project uses the simple PlatformIO build system. PlatformIO is an extension 4. Run `git submodule update --init --recursive` to pull in dependencies this project needs. 5. If you are outside the USA, edit [platformio.ini](/platformio.ini) to set the correct frequency range for your country. The line you need to change starts with `hw_version` and instructions are provided above that line. Options are provided for `EU433`, `EU835`, `CN`, `JP` and `US` (default). Pull-requests eagerly accepted for other countries. 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. ## Decoding stack traces From 05531b26841f7a391d2bbd2e9860a1b21caa4e9b Mon Sep 17 00:00:00 2001 From: Dafeman <47490997+Dafeman@users.noreply.github.com> Date: Sun, 9 Aug 2020 14:07:42 +1200 Subject: [PATCH 3/3] Update build-instructions.md --- docs/software/build-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/build-instructions.md b/docs/software/build-instructions.md index 2989d173f..c5962cef1 100644 --- a/docs/software/build-instructions.md +++ b/docs/software/build-instructions.md @@ -15,7 +15,7 @@ This project uses the simple PlatformIO build system. PlatformIO is an extension ## Command Line 1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information). 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. `git clone https://github.com/meshtastic/Meshtastic-device.git` and `cd Meshtastic-device` 4. Run `git submodule update --init --recursive` to pull in dependencies this project needs. 5. If you are outside the USA, edit [platformio.ini](/platformio.ini) to set the correct frequency range for your country. The line you need to change starts with `hw_version` and instructions are provided above that line. Options are provided for `EU433`, `EU835`, `CN`, `JP` and `US` (default). Pull-requests eagerly accepted for other countries. 6. Plug the radio into your USB port