Express 中文文档

ExpressLRS Configurator


ExpressLRS Configurator is a cross-platform build & configuration tool for the ExpressLRS - open source RC link for RC applications.

Need help? Confused? Join the Community!


Discord Chat
Facebook Group
Documentation

Support ExpressLRS


Supporting ExpressLRS is as easy as contributing a feature, either code or just a fleshed out idea. Coding not your thing? Testing a Pull Request using the convenient Configurator tab and providing feedback is essential as well. We're all working together.

If you don't have the time to contribute in that way, consider making a small donation. Donations are used to buy test equipment, software licenses, and certificates needed to further the project and make it securely accessible. ExpressLRS accepts donations through Open Collective, which provides recognition of donors and transparency on how that support is utilized.

Quick Start Guide


If you have hardware that you want to flash, please refer to our guides on the website, and our FAQ

Installation


We provide a standalone program for 64bit Windows, Linux and Mac.

Download the installer from Releases page.

Notes


Windows


The minimum required version of windows is Windows 8.

macOS


Changes to the security model used in the latest versions of MacOS X 10.14 (Mojave) and 10.15 (Catalina) mean that the operating system will show an error message ('"ExpressLRS Configurator.app" cannot be openend because the developer cannot be verified') when trying to install the application.

To work around this, click ExpressLRS Configurator.app while pressing control key, and click Open. In the popup, you'll be able to forcefully open the application. (you may need to try this twice.)

Alternatively, run the following command in a terminal after installing:

  1. ``` sh
  2. sudo xattr -rd com.apple.quarantine /Applications/ExpressLRS\ Configurator.app

  4. ```

Linux


Linux users have to install udev rules for PlatformIO supported boards/devices. The latest version of rules may be found at https://raw.githubusercontent.com/platformio/platformio-core/master/platformio/assets/system/99-platformio-udev.rules

This file must be placed at /etc/udev/rules.d/99-platformio-udev.rules (preferred location) or /lib/udev/rules.d/99-platformio-udev.rules (required on some broken systems).

Please open system Terminal and type:

  1. ``` shell
  2. # Recommended
  3. curl -fsSL https://raw.githubusercontent.com/platformio/platformio-core/master/platformio/assets/system/99-platformio-udev.rules | sudo tee /etc/udev/rules.d/99-platformio-udev.rules

  5. # OR, manually download and copy this file to destination folder
  6. sudo cp 99-platformio-udev.rules /etc/udev/rules.d/99-platformio-udev.rules
  7. ```

Restart "udev" management tool:

  1. ``` shell
  2. sudo service udev restart
  3. # or
  4. sudo udevadm control --reload-rules
  5. sudo udevadm trigger
  6. ```

Ubuntu/Debian users may need to add own "username" to the "dialout" group if they are not "root", doing this issuing:

  1. ``` sh
  2. sudo usermod -a -G dialout $USER
  3. sudo usermod -a -G plugdev $USER

  5. ```

Similarly, Arch users may need to add their user to the “uucp” group

  1. ``` shell
  2. sudo usermod -a -G uucp $USER
  3. sudo usermod -a -G lock $USER
  4. ```

Ubuntu 18.XX / Older Debian installs troubleshooting

On Ubuntu 18.XX you are not able to get recent git version by default, and some other system dependencies are missing.

Read more about this in issue #26.

To work around that you can manually install required packages:

  1. ``` sh
  2. # install missing sys packages
  3. sudo apt update
  4. sudo apt-get install gconf2 gconf-service python3-distutils

  6. # install git version >= 2.25
  7. sudo add-apt-repository ppa:git-core/ppa
  8. sudo apt update
  9. sudo apt install git

  11. ```

Architecture


  1. ``` sh
  2. - - - - - - - - - - - - - - - - - - - -
  3. |          ExpressLRS-Configurator      |
  4. |                   |                   |
  5. |     renderer      |        main       |
  6. |                   |                   |
  7. |   configurator <----->  api-server    |
  8. |                   |          |        |
  9. |                   |          V        |
  10. |                   |      platformio   |
  11. |_ _ _ _ _ _ _ _ _ _|_ _ _ _ _ | _ _ _ _|
  12.                                V
  13.                       ExpressLRS hardware

  15. ```

This Electron application is split into two parts: a local API server that does all the work, and a UI layer. Both of these application layers communicate within each other using Graphql protocol.

Heavy use of TypeScript and @graphql-codegen/cli is made throughout the repository to ensure the datatypes transmitted between the API and UI layers are consistent at compile-time and Graphql ensuring the datatypes are consistent at runtime.

Starting Development


Prerequisites

node >=16.0
git >= 2.25
python >= 3.6
platformio >= 5.0

Start the app in the dev environment:

  1. ``` shell
  2. yarn install --frozen-lockfile
  3. yarn start
  4. ```

In order to simulate WI-FI devices on your local network you can start application with MULTICAST_DNS_SIMULATOR_ENABLED environment variable:

  1. ``` sh
  2. npx cross-env MULTICAST_DNS_SIMULATOR_ENABLED=true yarn start

  4. ```

Other useful cli commands


Generate TypeScript types from Graphql schema and Queries located in src/ui/gql/queries :

  1. ``` shell
  2. yarn run gql-codegen
  3. ```

Screenshots


Main screen

Compile result

Credits


electron-react-boilerplate

Legal disclaimer


The use and operation of this type of device may require a license, and some countries may forbid its use. It is entirely up to the end user to ensure compliance with local regulations. This is experimental software / hardware and there is no guarantee of stability or reliability. USE AT YOUR OWN RISK.

Join the community!