diff --git a/docs/Arduino_IDE_Boards.md b/docs/Arduino_IDE_Boards.md index 17b08bc..799a031 100644 --- a/docs/Arduino_IDE_Boards.md +++ b/docs/Arduino_IDE_Boards.md @@ -40,6 +40,54 @@ The board definitions are installed using the Arduino IDE Boards Manager. * **Multi 4-in-1 (Atmega328p, 3.3V, 16MHz)** for the Atmega module * **Multi 4-in-1 (OrangeRX)** for the OrangeRX module +## Install device drivers + +### Windows 7 or newer: +1. If you haven't already done so, clone or download and unpack the Multiprocol source +1. Open the folder where you unzipped or cloned the Multiprotocol project +1. Browse to **\BootLoaders\Boards\Windows** +1. Run **install-drivers.bat** +1. Follow the prompts to install the two drivers + +### Windows XP or older +1. Download and install the legacy Windows XP drivers from [here](https://github.com/rogerclarkmelbourne/Arduino_STM32/tree/master/drivers/win/win_xp_legacy) + +**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 upload using a USB-to-serial adapter one time before you can upload firmware using the USB port. + +### Jumper JP4IN1 drivers +The driver for the Jumper JP4IN1 module, the Silicon Labs CP210x driver, can be downloaded from here: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers + +### Other USB-to-serial device drivers +Other drivers may be needed if you are using an external USB-to-serial adapter. Consult the documentation for your adapter. + +Windows 10 includes drivers for many common serial devices, including many USB-to-serial adapters, so check Device Manager to see if your device is recognised. + +### Mac OS X +Uploading via USB requires the [libusb library](https://libusb.info/) to be installed. The easiest way to install the library is using the [Homebrew package manager for macOS](https://brew.sh/) by executing the two lines given below in a Terminal. + +Install Homebrew: + + `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` + +Once Homebrew is installed, use it to install libusb: + + `brew install libusb` + +### Linux +Permissions must be configured to allow access to serial devices. +1. If you haven't already done so, clone or download and unpack the Multiprocol source +1. Open a Terminal and change to the directory where you have cloned or unzipped the Multiprotocol source +1. Run the following commands: + + ``` + sudo cp -v BootLoaders/Boards/Linux/45-maple.rules /etc/udev/rules.d/45-maple.rules + sudo chown root:root /etc/udev/rules.d/45-maple.rules + sudo chmod 644 /etc/udev/rules.d/45-maple.rules + sudo udevadm control --reload-rules + sudo usermod -a -G plugdev $USER + sudo usermod -a -G dialout $USER + ``` + ## Compiling and Uploading Refer to the hardware-specific pages for information on compiling the firmware and uploading it to the multiprotocol module: