Merge pull request #9481 from phobos-/nfe-racemode
[betaflight.git] / docs / Display.md
blob8004ec8225d9dd55eca82bdea7b93d86947e79e4
1 # Display
3 Cleanflight supports displays to provide information to you about your aircraft and cleanflight state.
5 When the aircraft is armed the display does not update so flight is not affected.  When disarmed the display cycles between various pages.
7 There is currently no way to change the information on the pages, the list of pages or the time between pages - Code submissions via pull-requests are welcomed!
9 ## Supported Hardware
11 At this time no other displays are supported other than the SSD1306 / UG-2864HSWEG01.
13 ## Configuration
15 From the CLI enable the `DISPLAY` feature
17 ```
18 feature DISPLAY
19 ```
22 ### SSD1306 OLED displays
24 The SSD1306 display is a 128x64 OLED display that is visible in full sunlight, small and consumes very little current.  
25 This makes it ideal for aircraft use.
27 There are various models of SSD1306 boards out there, they are not all equal and some require addtional modifications
28 before they work.  Choose wisely!
30 Links to displays:
32  * [banggood.com](http://www.banggood.com/0_96-Inch-4Pin-White-IIC-I2C-OLED-Display-Module-12864-LED-For-Arduino-p-958196.html) 0.96 Inch 4Pin White IIC I2C OLED Display Module 12864 LED For Arduino 
33  * [banggood.com](http://www.banggood.com/0_96-Inch-4Pin-IIC-I2C-Blue-OLED-Display-Module-For-Arduino-p-969147.html) 0.96 Inch 4Pin IIC I2C Blue OLED Display Module For Arduino
34  * [wide.hk](http://www.wide.hk/products.php?product=I2C-0.96%22-OLED-display-module-%28-compatible-Arduino-%29) I2C 0.96" OLED display module
35  * [witespyquad.gostorego.com](http://witespyquad.gostorego.com/accessories/readytofly-1-oled-128x64-pid-tuning-display-i2c.html) ReadyToFlyQuads 1" OLED Display
36  * [multiwiicopter.com](http://www.multiwiicopter.com/products/1-oled) PARIS 1" OLED 128x64 PID tuning screen AIR
38 The banggood.com display is the cheapest at the time fo writing and will correctly send I2C ACK signals.
40 #### Crius CO-16
42 This display is best avoided but will work if you modify it.
44 Step 1
46 As supplied the I2C ack signal is not sent because the manufacturer did not bridge D1 and D2 together.  To fix this solder
47 the two pins together as they enter the screen.  Failure to do this will result is a screen that doesn't display anything.
49 Step 2
51 Pin 14 must be disconnected from the main board using a scalpel. Then connect a 10nF or 100nF capacitor between pins 30 and the
52 lifted pin 14.
54 Step 3
56 Connect a 100K resistor between Pin 9 and the lifted Pin 14.
58 Failure to perform steps 2 and 3 will result in a display that only works on power up some of the time any may display random dots
59 or other display corruption.
61 More can be read about this procedure here: http://www.multiwii.com/forum/viewtopic.php?f=6&t=2705&start=10
63 ![Crius CO-16 Diagram](Wiring/Crius%20CO-16%20OLED%20diagram.png)
64 ![Crius CO-16 Modification](Wiring/Crius%20CO-16%20OLED%20modifications.jpg)
66 ## Connections
68 Connect +5v, Ground, I2C SDA and I2C SCL from the flight controller to the display.
70 On Naze32 rev 5 boards the SDA and SCL pads are underneath the board.