From c0138f5f8250f0e19e853008b701b4a9f5eb35ed Mon Sep 17 00:00:00 2001 From: Dominic Clifton Date: Sun, 12 Jul 2015 21:35:25 +0100 Subject: [PATCH] Sprinkle some help for common causes of error to reduce burned on developers and community. --- _locales/en/messages.json | 24 +++++++++++++++++++----- tabs/configuration.html | 9 +++++++++ tabs/ports.html | 5 +++++ tabs/receiver.css | 6 ++++++ tabs/receiver.html | 4 ++++ 5 files changed, 43 insertions(+), 5 deletions(-) diff --git a/_locales/en/messages.json b/_locales/en/messages.json index 962b09ad..cf9456fe 100755 --- a/_locales/en/messages.json +++ b/_locales/en/messages.json @@ -211,7 +211,7 @@ "message": "Request Optional Permissions" }, "defaultWelcomeText": { - "message": "Welcome to Cleanflight - Configurator, a utility designed to simplify updating, configuring and tuning of your flight controller.

The application supports all hardware that can run cleanflight (SPRacingF3, Vortex, Sparky, CC3D/EVO, Air Hero 32, Flip32/+/Deluxe, CJMCU Microquad, Chebuzz F3, STM32F3Discovery, Hermit, Naze32 Tricopter Frame, Skyline32, Naze/32/Mini/Pro/Blackbox etc)

The firmware source code can be downloaded from here
The newest binary firmware image is available here

Latest CP210x Drivers can be downloaded from here
" + "message": "Welcome to Cleanflight - Configurator, a utility designed to simplify updating, configuring and tuning of your flight controller.

The application supports all hardware that can run cleanflight (SPRacingF3, Vortex, Sparky, CC3D/EVO, Air Hero 32, Flip32/+/Deluxe, CJMCU Microquad, Chebuzz F3, STM32F3Discovery, Hermit, Naze32 Tricopter Frame, Skyline32, Naze/32/Mini/Pro/Blackbox etc)

The firmware source code can be downloaded from here
The newest binary firmware image is available here, development builds available here

Latest CP210x Drivers can be downloaded from here
" }, "defaultContributingHead": { "message": "Contributing" @@ -426,6 +426,10 @@ "configurationFeaturesHelp": { "message": "Note: Not all combinations of features are valid. When the flight controller firmware detects invalid feature combinations conflicting features will be disabled.
Note: Configure serial ports before enabling the features that will use the ports." }, + + "configurationSerialRXHelp": { + "message": "Note: Rememer to configure a Serial Port (via Ports tab) and choose a Serial Receiver Provider when using RX_SERIAL feature." + }, "configurationBoardAlignment": { "message": "Board Alignment" @@ -511,6 +515,10 @@ "configurationGPSubxSbas": { "message": "Ground Assistance Type" }, + "configurationGPSHelp": { + "message": "Note: Rememer to configure a Serial Port (via Ports tab) when using GPS feature." + }, + "configurationSerialRX": { "message": "Serial Receiver Provider" }, @@ -522,7 +530,10 @@ }, "portsHelp": { - "message": "Configure serial ports. Note: not all combinations are valid. When the flight controller firmware detects this the serial port configuration will be reset." + "message": "Note: not all combinations are valid. When the flight controller firmware detects this the serial port configuration will be reset." + }, + "portsMSPHelp": { + "message": "Note: Do NOT disable MSP on the first serial port unless you know what you are doing. You may have to reflash and erase your configuration if you do." }, "portsFirmwareUpgradeRequired": { "message": "Firmware upgrade required. Serial port configurations of firmware < 1.8.0 is not supported." @@ -613,6 +624,9 @@ "message": "EEPROM saved" }, + "receiverHelp": { + "message": "Please read receiver chapter of the documentation. Configure serial port (if required), receiver mode (serial/ppm/pwm), provider (for serial receivers), bind receiver, set channel map, configure channel endpoints/range on TX so that all channels go from ~1000 to ~2000. Set midpoint (default 1500), trim channels to 1500, configure stick deadband, verify behaviour when TX is off or out of range.
IMPORTANT: Before flying read failsafe chapter of documentation and configure failsafe." + }, "receiverThrottleMid": { "message": "Throttle MID" }, @@ -1042,7 +1056,7 @@ "message": "Attempt to flash the board automatically (triggered by newly detected serial port)" }, "firmwareFlasherFullChipErase": { - "message": "Full Chip Erase" + "message": "Full chip erase" }, "firmwareFlasherFullChipEraseDescription": { "message": "Wipes all configuration data currently stored on the board" @@ -1054,7 +1068,7 @@ "message": "Flash most recent (untested) development firmware" }, "firmwareFlasherManualBaud": { - "message": "Manual Baud Rate" + "message": "Manual baud rate" }, "firmwareFlasherManualBaudDescription": { "message": "Manual selection of baud rate for boards that don't support the default speed or for flashing via bluetooth." @@ -1099,7 +1113,7 @@ "message": "Warning" }, "firmwareFlasherWarningText": { - "message": "Please do not try to flash non-cleanflight hardware with this firmware flasher (it wont work).
Do not disconnect the board or turn off your computer while flashing.

Note: STM32 bootloader is stored in ROM, it cannot be bricked.
Note: Auto-Connect is always disabled while you are inside firmware flasher.
Note: This can wipe your configuration including but not limited to PIDs, Auxiliary, and FEATURES. Make sure you have a backup.
" + "message": "Please do not try to flash non-cleanflight hardware with this firmware flasher.
Do not disconnect the board or turn off your computer while flashing.

Note: STM32 bootloader is stored in ROM, it cannot be bricked.
Note: Auto-Connect is always disabled while you are inside firmware flasher.
Note: Make sure you have a backup; some upgrades/downgrades will wipe your configuration.
Note: If you have problems flashing try disconnecting all cables from your FC.

Note: If you have lost comminication with your board then power off the board, jumper the bootloader pins, power on, enable 'No reboot sequence', enable 'Full chip erase', re-flash, then power off, remove bootloader jumper, power on and connect (For all firmware except OPBL firmware)." }, "firmwareFlasherButtonLeave": { "message": "Leave Firmware Flasher" diff --git a/tabs/configuration.html b/tabs/configuration.html index 6dfde182..4428f99a 100644 --- a/tabs/configuration.html +++ b/tabs/configuration.html @@ -127,6 +127,10 @@ +
+

+
+
@@ -275,6 +279,11 @@ + +
+

+
+
diff --git a/tabs/ports.html b/tabs/ports.html index 15362f98..09fed270 100644 --- a/tabs/ports.html +++ b/tabs/ports.html @@ -18,6 +18,11 @@
+ +
+

+
+
diff --git a/tabs/receiver.css b/tabs/receiver.css index 91d2b7b9..fe1a3c4f 100644 --- a/tabs/receiver.css +++ b/tabs/receiver.css @@ -3,6 +3,12 @@ .tab-receiver input[type="number"]::-webkit-inner-spin-button { border: 0; } +.tab-receiver .help { + padding: 10px; + background-color: #ffcb18; + margin-bottom: 10px; +} + .tab-receiver .bars { float: left; width: 45%; diff --git a/tabs/receiver.html b/tabs/receiver.html index 196f4c04..f562050c 100644 --- a/tabs/receiver.html +++ b/tabs/receiver.html @@ -1,5 +1,9 @@
+
+

+
+