Merge pull request #8690 from sakisdog/rename_functions
[inav.git] / docs / Display.md
blob952f9b08661465bf2c947039eb22c8693c6cceac
1 # Display
3 INAV supports displays to provide information to you about your aircraft and INAV state.
5 When the aircraft is armed, an "Armed" message is displayed. When it is disarmed, a summary page is displayed. Page cycling has been removed and no other information is currently available
7 ![Stick Positions](assets/images/inav_display_armed.jpg)
9 ![Stick Positions](assets/images/inav_display_status.jpg)
11 There is currently no way to change the information on the display
13 ## Supported Hardware
14 I2c IIC Serial Oled LCD LED Module 12864 (<a href="http://a.co/5hxXEvZ">http://a.co/5hxXEvZ</a> used in status image above)
16 SSD1306
18 UG-2864HSWEG01
20 ## Configuration
22 From the CLI enable the `DASHBOARD` feature
24 ```
25 feature DASHBOARD
26 ```
29 ### SSD1306 OLED displays
31 The SSD1306 display is a 128x64 OLED display that is visible in full sunlight, small and consumes very little current.  
32 This makes it ideal for aircraft use.
34 There are various models of SSD1306 boards out there, they are not all equal and some require addtional modifications
35 before they work.  Choose wisely!
37 Links to displays:
39  * [banggood.com](https://inavflight.com/shop/s/bg/958196) 0.96 Inch 4Pin White IIC I2C OLED Display Module 12864 LED For Arduino
40  * [banggood.com](https://inavflight.com/shop/s/bg/969147) 0.96 Inch 4Pin IIC I2C Blue OLED Display Module For Arduino
41  * [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
42  * [witespyquad.gostorego.com](http://witespyquad.gostorego.com/accessories/readytofly-1-oled-128x64-pid-tuning-display-i2c.html) ReadyToFlyQuads 1" OLED Display
43  * [multiwiicopter.com](http://www.multiwiicopter.com/products/1-oled) PARIS 1" OLED 128x64 PID tuning screen AIR
45 The banggood.com display is the cheapest at the time of writing and will correctly send I2C ACK signals.
47 #### Crius CO-16
49 This display is best avoided but will work if you modify it.
51 Step 1
53 As supplied the I2C ack signal is not sent because the manufacturer did not bridge D1 and D2 together.  To fix this solder
54 the two pins together as they enter the screen.  Failure to do this will result is a screen that doesn't display anything.
56 Step 2
58 Pin 14 must be disconnected from the main board using a scalpel. Then connect a 10nF or 100nF capacitor between pins 30 and the
59 lifted pin 14.
61 Step 3
63 Connect a 100K resistor between Pin 9 and the lifted Pin 14.
65 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
66 or other display corruption.
68 More can be read about this procedure here: http://www.multiwii.com/forum/viewtopic.php?f=6&t=2705&start=10
70 ![Crius CO-16 Diagram](Wiring/Crius CO-16 OLED diagram.png)
71 ![Crius CO-16 Modification](Wiring/Crius CO-16 OLED modifications.jpg)
73 ## Connections
75 Connect +5v, Ground, I2C SDA and I2C SCL from the flight controller to the display.