gomaomao/DIY-Multiprotocol-TX-Module
1
0
Fork 0
mirror of https://github.com/pascallanger/DIY-Multiprotocol-TX-Module.git synced 2025-02-04 16:28:10 +00:00
Code Issues Projects Releases Wiki Activity

Move Arduino IDE boards doc to /doc (#139)

Browse Source 
* Create Arduino_IDE_Boards.md
* Update README.md
* Update links to Arduino IDE board instructions (#138)
This commit is contained in:
Ben Lye 2018-01-09 08:06:17 +00:00 committed by GitHub
parent cd235bbcde
commit 499e854275
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
BootLoaders/README.md
View File

@ -1,48 +1,2 @@
# Arduino IDE board definitions for Multi 4-in-1
Board definitions are available for the Atmega328p, STM32, and OrangeRX modules. The board definitions make it easier to compile and install the multiprotocol module firmware.
**Note:** The Orange RX module is now included in the **Multi 4-in-1 AVR Boards** package, it no longer has a dedicated package. If you have the dedicated OrangeRX package installed you should remove it and install the most recent AVR package (v1.0.2 or newer).
## Installing
The board definitions are installed using the Arduino IDE Boards Manager.
1. Open the Arduino IDE
2. Go to **File -> Preferences**, or press Ctrl+Comma
3. Locate the **Aditional Boards Manager URLs** field and paste in this URL: `https://raw.githubusercontent.com/pascallanger/DIY-Multiprotocol-TX-Module/master/BootLoaders/package_multi_4in1_board_index.json`
**Note:** Multiple URLs are comma-separated.
<p align="center">
<img src="/docs/images/ide-prefs.jpg">
</p>
4. Click **OK** to save the change
5. Click **Tools -> Board -> Boards Manager**
6. Type **multi** into the search box to see the Multi 4-in-1 boards
<p align="center">
<img src="/docs/images/multi-boards.jpg">
</p>
7. Click on the board you require and click the **Install** button. Repeat for both boards, if required. If you are installing the STM32 board for the first time, and you have not installed any STM32 or SAMD boards before (such as Arduino Due or Zero) the dependency toolchain will also be downloaded and installed.
7. Click **Close** to close the Boards Manager
## Verify the boards are installed
1. Click **Tools -> Board**
2. Scroll down the list to the **Multi 4-in-1** board headings verify that the boards you installed are available:
![Image](/docs/images/boards-menu.jpg)
* **Multi 4-in-1 (STM32F103CB)** for the STM32 module
* **Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)** for the Atmega module
* **Multi 4-in-1 (OrangeRX)** for the OrangeRX module
## Compiling and Uploading
Refer to the hardware-specific pages for information on compiling the firmware and uploading it to the multiprotocol module:
* [Compiling for Atmega](/docs/Compiling.md)
* [Compiling for STM32](/docs/Compiling_STM32.md)
* [Compiling for OrangeRX](/docs/Compiling_OrangeTx.md)
## Page Moved
Moved to [/docs/Arduino_IDE_Boards.md](/docs/Arduino_IDE_Boards.md).

48
docs/Arduino_IDE_Boards.md Normal file
View File

@ -0,0 +1,48 @@
# Arduino IDE board definitions for Multi 4-in-1
Board definitions are available for the Atmega328p, STM32, and OrangeRX modules. The board definitions make it easier to compile and install the multiprotocol module firmware.
**Note:** The Orange RX module is now included in the **Multi 4-in-1 AVR Boards** package, it no longer has a dedicated package. If you have the dedicated OrangeRX package installed you should remove it and install the most recent AVR package (v1.0.2 or newer).
## Installing
The board definitions are installed using the Arduino IDE Boards Manager.
1. Open the Arduino IDE
2. Go to **File -> Preferences**, or press Ctrl+Comma
3. Locate the **Aditional Boards Manager URLs** field and paste in this URL: `https://raw.githubusercontent.com/pascallanger/DIY-Multiprotocol-TX-Module/master/BootLoaders/package_multi_4in1_board_index.json`
**Note:** Multiple URLs are comma-separated.
<p align="center">
<img src="/docs/images/ide-prefs.jpg">
</p>
4. Click **OK** to save the change
5. Click **Tools -> Board -> Boards Manager**
6. Type **multi** into the search box to see the Multi 4-in-1 boards
<p align="center">
<img src="/docs/images/multi-boards.jpg">
</p>
7. Click on the board you require and click the **Install** button. Repeat for both boards, if required. If you are installing the STM32 board for the first time, and you have not installed any STM32 or SAMD boards before (such as Arduino Due or Zero) the dependency toolchain will also be downloaded and installed.
7. Click **Close** to close the Boards Manager
## Verify the boards are installed
1. Click **Tools -> Board**
2. Scroll down the list to the **Multi 4-in-1** board headings verify that the boards you installed are available:
![Image](/docs/images/boards-menu.jpg)
* **Multi 4-in-1 (STM32F103CB)** for the STM32 module
* **Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)** for the Atmega module
* **Multi 4-in-1 (OrangeRX)** for the OrangeRX module
## Compiling and Uploading
Refer to the hardware-specific pages for information on compiling the firmware and uploading it to the multiprotocol module:
* [Compiling for Atmega](/docs/Compiling.md)
* [Compiling for STM32](/docs/Compiling_STM32.md)
* [Compiling for OrangeRX](/docs/Compiling_OrangeTx.md)

2
docs/Compiling.md
View File

@ -51,7 +51,7 @@ The 6-pin header needs to be soldered onto the board as indicated by the red rec
1. Double-click the **Multiprotocol.ino** file in the **Multiprotocol** folder to open the project in the Arduino IDE
### Install the Multi 4-in-1 board
1. Follow [these instructions](/BootLoaders/README.md) to install the **Multi 4-in-1 AVR Board** in the Arduino IDE
1. Follow [these instructions](Arduino_IDE_Boards.md) to install the **Multi 4-in-1 AVR Board** in the Arduino IDE
### Configure the Arduino IDE
1. Under **Tools -> Board** select **'Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)**

2
docs/Compiling_OrangeTx.md
View File

@ -36,7 +36,7 @@ Flashing the bootloader is outside the scope of this documentation. Full instru
1. Double-click the **Multiprotocol.ino** file in the **Multiprotocol** folder to open the project in the Arduino IDE
### Install the Multi 4-in-1 board
1. Follow [these instructions](/BootLoaders/README.md) to install the **Multi 4-in-1 OrangeRX Board** in the Arduino IDE
1. Follow [these instructions](Arduino_IDE_Boards.md) to install the **Multi 4-in-1 OrangeRX Board** in the Arduino IDE
### Configure the Arduino IDE
1. Under **Tools -> Board** select **'Multi 4-in-1 (OrangeRX)'**

6
docs/Compiling_STM32.md
View File

@ -55,7 +55,7 @@ The 4-pin header needs to be soldered onto the board as indicated by the red rec
1. Double-click the **Multiprotocol.ino** file in the **Multiprotocol** folder to open the project in the Arduino IDE
### Install the Multi 4-in-1 board
1. Follow [these instructions](/BootLoaders/README.md) to install the **Multi 4-in-1 STM32 Board** in the Arduino IDE
1. Follow [these instructions](Arduino_IDE_Boards.md) to install the **Multi 4-in-1 STM32 Board** in the Arduino IDE
### Configure the Arduino IDE
1. Under **Tools -> Board** select **Multi 4-in-1 (STM32FC103)**
@ -199,7 +199,7 @@ In order for these devices to be correctly identified in Windows it is necessary
**NOTE:** If you have installed the drivers and your module is not detected as a Maple device it most likely does not have a USB bootloader installed. Ready-made modules from Banggood **do not** come with a USB bootloader installed. You will need to follow the procedure to [Burn a USB bootloader](#burn-the-bootloader) before you can upload firmware.
### Upload the firmware via USB
**Note:** Power to the module will be supplied via the USB cable. If the module is installed in a transmitter, the transmitter should be switched off.
**Note:** Some modules require external power in order for the USB port to work. If your module does not power on with USB power alone, install it in the transmitter and switch the transmitter on. It is generally safe for the module to recieve power from both USB and the transmitter.
1. Connect the USB cable to the Multiprotocol module
1. Verify that a Maple device appears in Device Manager (**Maple DFU** for a module with only a bootloader, **Maple Serial** for a module with a bootloader and firmware)
@ -240,8 +240,6 @@ For subsequent firmware uploads you need only repeat steps 1-3 above, ensuring t
<p align="center"><img src="images/maple-serial-port-select.jpg"/></p>
If the module is installed in a transmitter, disconnect the USB cable before powering on the transmitter.
## Upload via Serial
Upload via Serial follows the same process as burning the bootloader and uses the same USB-to-TTL adapter.