View source for NanoPi NEO2

[[NanoPi NEO2/zh|查看中文]]

==Introduction==
[[File:NanoPi NEO2-1.jpg|thumb|frameless|300px|Overview]]
[[File:NanoPi NEO2-2.jpg|thumb|frameless|300px|Front]]
[[File:NanoPi NEO2-3.jpg|thumb|frameless|300px|Back]]
* The NanoPI NEO2 is a newly released super tiny ARM board by FriendlyElec. It uses Allwinner’s 64-bit H5 quad-core SoC (ARM Cortex-A53). It has internal hexa-core Mail450 GPU, 512M DDR3 RAM. A UbuntuCore and Armbian image files are ready for it. 
* The NanoPi NEO2 inherits NEO's form factor and has compatible interfaces and ports with NEO. In addition in such a small dimension it has Gbps Ethernet and one USB host port. These features make it especially suitable for applications that require high data throughput , speedy data transmission and high performance. Hobbyists and makers will just love it.

==Hardware Spec==
* CPU: Allwinner H5, Quad-core 64-bit high-performance Cortex A53
* DDR3 RAM: 512MB
* Connectivity: 10/100/1000M Ethernet, RTL8211E-VB-CG chip
* USB Host: USB Type A x 1 and USB pin header x 2
* MicroSD Slot: MicroSD x 1 for system boot and storage
* LED: Power LED x 1, System LED(Blue) x 1
* GPIO1: 2.54mm pitch 24 pin-header, compatible with Raspberry Pi's GPIO pin1 - pin 24. It includes UART, SPI, I2C, IO etc
* GPIO2: 2.54mm pitch 12 pin-header. It includes USB, IR receiver, I2S, IO etc
* Serial Debug Port: 2.54mm pitch 4pin-header
* Audio In/Out: 2.0mm pitch 5 pin-header
* MicroUSB: Power input(5V/2A) and OTG 
* PCB Dimension: 40 x 40mm
* Working Temperature: -30℃ to 70℃
* Weight: 13g(WITHOUT Pin-headers)
* OS/Software: u-boot,Ubuntu Core

==Software Features==
===uboot===
* mainline uboot released on May 2017
<!---
* supports fastboot to update uboot
--->

===UbuntuCore 16.04===
* 64-bit system
* mainline kernel: Linux-4.11.2
* rpi-monitor: check system status and information
* npi-config: system configuration utility for setting passwords, language, timezone, hostname, SSH and auto-login,and enabling/disabling i2c, spi, serial and PWM. When enabling PWM it will prompt that Serial debug port will be disabled.
* software utility: wiringNP to access GPIO pins
* software utility: RPi.GPIO_NP to access GPIO pins
* networkmanager: manage network
* system log output from serial port
<!---
* nano editor
* auto-login with user account "pi" with access to npi-config 
* sudoers include "fa"
* on first system boot file system will be automatically extended. 
* supports file system auto check and repair on system boot.
* supports FriendlyElec's [http://wiki.friendlyarm.com/wiki/index.php/NanoHat_PCM5102A NanoHat-PCM5102A]  
--->
* supports USB WiFi module: refer to [[#Connect USB WiFi to NEO]]
* supports audio recording and playing with 3.5mm audio jack
* supports I2C 0/1
<!---
* supports dynamic frequency scaling and voltage regulation
* relieves overheat compared to kernel Linux-3.4
--->
* fixed MAC address

===Ubuntu OLED===
* mainline kernel: Linux-4.11.2
* supports FriendlyElec's OLED module

===Debian===
* welcome window with basic system information and status

===Debian for NAS Dock===
* mainline kernel: Linux-4.11.2
* supports FriendlyElec's NAS Dock
* optimized OpenMediaVault configuration options
* allocated swap section

==Diagram, Layout and Dimension==
===Layout===
[[File:NanoPi-NEO2-layout.jpg |thumb|600px|NanoPi NEO2 Layout]]
[[File:NEO2 pinout-02.jpg|thumb|frameless|600px|pinout]]

* '''GPIO Pin Description'''
::{| class="wikitable"
|-
|Pin# || Name || Linux gpio ||Pin#  || Name || Linux gpio       
|-
|1    || SYS_3.3V   ||     ||2     || VDD_5V ||
|-
|3    || I2C0_SDA/GPIOA12 || 12   ||4     || VDD_5V ||
|- 
|5    || I2C0_SCL/GPIOA11 || 11    ||6     || GND    ||
|-
|7    || GPIOG11    || 203 ||8     || UART1_TX/GPIOG6 || 198
|-
|9    || GND        ||     ||10    || UART1_RX/GPIOG7 || 199  
|-
|11   || UART2_TX/GPIOA0  || 0      ||12    || GPIOA6 || 6
|-
|13   || UART2_RTS/GPIOA2 || 2      ||14    || GND || 
|-
|15   || UART2_CTS/GPIOA3 || 3      ||16    || UART1_RTS/GPIOG8 || 200
|-
|17   || SYS_3.3V         ||        ||18    || UART1_CTS/GPIOG9 || 201
|-
|19   || SPI0_MOSI/GPIOC0 || 64     ||20    || GND              ||
|-
|21   || SPI0_MISO/GPIOC1 || 65     ||22    || UART2_RX/GPIOA1  || 1
|-
|23   || SPI0_CLK/GPIOC2 || 66     ||24    || SPI0_CS/GPIOC3   || 67
|}

* '''USB/Audio/IR Pin Descripton'''
::{| class="wikitable"
|-
| style="background: PaleTurquoise; color: black" colspan="3"| '''NanoPi-NEO2''' 
|-
|Pin# || Name     ||    Description            
|-
|1    || VDD_5V   ||    5V Power Out
|-
|2    || USB-DP1  ||    USB1 DP Signal
|- 
|3    || USB-DM1  ||    USB1 DM Signal
|-
|4    || USB-DP2  ||    USB2 DP Signal
|-
|5    || USB-DM2  ||    USB2 DM Signal
|-
| 6     || GPIOL11/IR-RX  || GPIOL11 or IR Receive
|-
| 7     || SPDIF-OUT/GPIOA17  || GPIOA17 or SPDIF-OUT
|-
| 8  || PCM0_SYNC/I2S0_LRC   ||  I2S/PCM Sample Rate Clock/Sync
|-
| 9  || PCM0_CLK/I2S0_BCK   || I2S/PCM Sample Rate Clock
|-
| 10  || PCM0_DOUT/I2S0_SDOUT || I2S/PCM Serial Data Output
|-
| 11  || PCM0_DIN/I2S0_SDIN || I2S/PCM Serial Data Input
|-
| 12    || GND       || 0V
|}

* '''Audio'''
::{| class="wikitable"
|-
|Pin# || Name      ||  Description  
|-
|1    || MICIN1P   ||  Microphone Positive Input 
|-
|2    || MICIN1N    ||  Microphone Negative Input    
|- 
|3    || LINEOUTR  || LINE-OUT Right Channel Output 
|-
|4    || GND       || 0V 
|-
|5    || LINEOUTL  || LINE-OUT Left Channel Output
|}

* '''Debug Port（UART0）'''
[[File:NEO2 DBG_UART.jpg|thumb|frameless|300px|DBG_UART]]
::{| class="wikitable"
|-
|Pin# || Name       
|-
|1    || GND    
|-
|2    || VDD_5V    
|- 
|3    || UART_TXD0    
|-
|4    || UART_RXD0 
|}

:'''Note'''
::#SYS_3.3V: 3.3V power output
::#VDD_5V: 5V power input/output. The input range is 4.7V ~ 5.6V. It can take power input from the MicroUSB.
::#All pins are 3.3V and output current is 5mA
::#For more details refer to the document: [http://wiki.friendlyarm.com/wiki/images/a/a1/Schematic_NanoPi_NEO2-v1.0_1701.pdf NanoPi_NEO2-1701-Schematic.pdf]

===Dimensional Diagram===
[[File:NanoPi-NEO2-1701-dimensions.png|frameless|400px|]]

::For more details refer to [http://wiki.friendlyarm.com/wiki/index.php/File:NanoPi_NEO_2_Dimesions(dxf).rar pcb file in dxf format]

==Get Started==
===Essentials You Need===
Before starting to use your NanoPi NEO2 get the following items ready
* NanoPi NEO2
* microSD Card/TFCard: Class 10 or Above, minimum 8GB SDHC
* microUSB power. A 5V/2A power is a must
* A Host computer running Ubuntu 16.04 64 bit system

===TF Cards We Tested===
To make your NanoPi NEO2 boot and run fast we highly recommend you use a Class10 8GB SDHC TF card or a better one. The following cards are what we used in all our test cases presented here:
*SanDisk TF 8G Class10 Micro/SD TF card:
[[File:SanDisk MicroSD.png|frameless|100px|SanDisk MicroSD 8G]]
*SanDisk TF128G MicroSDXC TF 128G Class10 48MB/S:
[[File:SanDisk MicroSD-01.png|frameless|100px|SanDisk MicroSD 128G]]
*川宇 8G C10 High Speed class10 micro SD card:
[[File:SanDisk MicroSD-02.png|frameless|100px|chuanyu MicroSD 8G]]

===Make an Installation TF Card===
====Get Image File====
Get the following files from [http://dl.friendlyarm.com/nanopineo2 download link] to download image files (under the officail-ROMs directory) and the flashing utility(under the tools directory):<br />
<!---
::{| class="wikitable"
|-
|colspan=2|Image Files:
|-
|nanopi-neo2-ubuntu-core-qte-sd4g.img.zip      || FriendlyCore (base on UbuntuCore) Image File                   
|-
|colspan=2|Flash Utility:  
|-
|win32diskimager.rar || Windows utility. Under Linux users can use "dd"
|- 
|}
--->
::{| class="wikitable"
|-
|colspan=2|Image Files:
|-
|nanopi-neo2_friendlycore-xenial_3.10.y_YYYYMMDD.img.zip || FriendlyCore (base on UbuntuCore) Image File, kernel:Linux-3.10                  
|-
|nanopi-neo2_friendlycore-xenial_4.x.y_YYYYMMDD.img.zip || FriendlyCore (base on UbuntuCore) Image File, kernel:Linux-4.x                   
|-
|nanopi-neo2_debian-nas-jessie_4.x.y_YYYYMMDD.img.zip  || Image File with Support for NAS Dock, Kernel: Linux-4.x, applicable to [[1-bay NAS Dock v1.2 for NanoPi NEO/NEO2|1-bay NAS Dock]]                   
|-
|nanopi-neo2_ubuntu-oled_4.x.y_YYYYMMDD.img.zip  || Image File with Support for OLED Module, Kernel: Linux-4.x, applicable to [[NanoHat OLED|NanoHat OLED]]
|-
|colspan=2|Flash Utility:  
|-
|win32diskimager.rar || Windows utility. Under Linux users can use "dd"
|- 
|}

====Make FriendlyCore Image Card====
* Extract the UbuntuCore file. Insert a TF card(at least 8G) into a Windows PC and run the win32diskimager utility as administrator. On the utility's main window select your TF card's drive, the wanted image file and click on "write" to start flashing the TF card.
* After this writing process is done insert this card into your NanoPi NEO2's TF card slot and power on (with a 5V/2A power source). If the blue LED is blinking this indicates your NanoPi NEO2 has successfully booted.<br />
Note:you can make both a Debian and a Ubuntu image card in this way.

{{FriendlyCoreGeneral|NanoPi-NEO2}}
{{FriendlyCoreAllwinnerH5|NanoPi-NEO2}}

===Play & Record Audio===
The NanoPi NEO2 has an audio interface (2.0mm pitch 5-pin header) whose pin description is as follows:
::{| class="wikitable"
|-
|Pin# || Name      ||  Description  
|-
|1    || MICIN1P   ||  Microphone Positive Input 
|-
|2    || MICIN1N    ||  Microphone Negative Input    
|- 
|3    || LINEOUTR  || LINE-OUT Right Channel Output 
|-
|4    || GND       || Ground 
|-
|5    || LINEOUTL  || LINE-OUT Left Channel Output
|}
Here is a hardware setup on how to connect an audio device to a NEO2:<br>
[[File:耳麦标注.jpg|frameless|400px| Earphone]]<br>
Before begin to play or record a audio make sure your NEO2 is connected to an audio device.<br>
Check a recognized audio device:
<syntaxhighlight lang="bash">
$ aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: Codec [H3 Audio Codec], device 0: CDC PCM Codec-0 []
  Subdevices: 1/1
  Subdevice #0: subdevice #0
</syntaxhighlight>
Both Allwinner's H5 and H3 have an internal codec which is named as [H3 Audio Codec] in mainline kernels.<br>

Play an audio file:
<syntaxhighlight lang="bash">
$ aplay /root/Music/test.wav -D plughw:0
</syntaxhighlight>

Record an audio file:
<syntaxhighlight lang="bash">
$ arecord -f cd -d 5 test.wav
</syntaxhighlight>

==Make Your Own FriendlyCore==
===Mainline U-boot & Linux(64 bit)===
Now the NanoPi NEO2 can run a 64-bit Linux kernel with 64-bit Ubuntu Core 16.04. Here is a detailed reference on how to run mainline U-boot and Linux on H5: [[Mainline U-boot & Linux/zh|Mainline U-boot & Linux]] <br>

===Use Allwinner's BSP===
====Preparations====
Visit this link [http://dl.friendlyarm.com/nanopineo2 download link] and enter the "sources/nanopi-H5-bsp" directory and download all the source code.Use the 7-zip utility to extract it and a lichee directory and an Android directory will be generated.You can check that by running the following command:
<syntaxhighlight lang="bash">
$ ls ./
$ lichee
</syntaxhighlight>

Or you can get it from our github:
<syntaxhighlight lang="bash">
$ git clone https://github.com/friendlyarm/h5_lichee.git lichee
</syntaxhighlight>
Note: "lichee" is the project name named by Allwinner for its CPU's source code which contains the source code of U-boot, Linux kernel and various scripts.

====Install Cross Compiler====
Visit this site [http://dl.friendlyarm.com/nanopineo2 download link], enter the "toolchain" directory, download the cross compiler "gcc-linaro-arm-4.6.3.tar.xz" and "gcc-linaro-aarch64.tar.xz" and copy them to the "lichee/brandy/toochain/" directory.<br> 
"gcc-linaro-arm-4.6.3.tar.xz"is for compiling u-boot and "gcc-linaro-aarch64.tar.xz" is for compiling Linux kernel.

====Compile lichee Source Code====
Compilation of the H5's BSP source code must be done under a PC running a 64-bit Linux.The following cases were tested on Ubuntu-14.04 LTS-64bit:
<syntaxhighlight lang="bash">
$ sudo apt-get install gawk git gnupg flex bison gperf build-essential \
zip curl libc6-dev libncurses5-dev:i386 x11proto-core-dev \
libx11-dev:i386 libreadline6-dev:i386 libgl1-mesa-glx:i386 \
libgl1-mesa-dev g++-multilib mingw32 tofrodos \
python-markdown libxml2-utils xsltproc zlib1g-dev:i386
</syntaxhighlight>

Enter the lichee directory and run the following command to compile the whole package:
<syntaxhighlight lang="bash">
$ cd lichee/fa_tools
$ ./build.sh -b nanopi-neo2 -p linux -t all
</syntaxhighlight>
After this compilation succeeds a u-boot, Linux kernel and kernel modules will be generated.<br>
Note: the lichee directory contains cross-compilers we have setup. When the build.sh script runs it will automatically call these cross-compilers.

The following commands can be used to update the u-boot on an installation TF card:
<syntaxhighlight lang="bash">
$ cd lichee/fa_tools/
$ ./fuse.sh -d /dev/sdx -p linux -t u-boot
</syntaxhighlight>
Note: you need to replace "/dev/sdx" with the device name in your system.<br>
The boot.img and kernel modules are under the "linux-3.10/output" directory. You can copy the new boot.img file to your TF card's boot partition.

====Compile U-boot====
Note:you need to compile the whole lichee directory before you can compile U-boot individually.<br>
You can run the following commands to compile u-boot individually:
<syntaxhighlight lang="bash">
$ cd lichee/fa_tools/
$ ./build.sh -b nanopi-neo2 -p linux -t u-boot
</syntaxhighlight>

====Compile Linux Kernel====
Note:you need to compile the whole lichee directory before you can compile Linux kernel individually.<br>
You can run the following commands to compile Linux kernel individually:
<syntaxhighlight lang="bash">
$ cd lichee/fa_tools/
$ ./build.sh -b nanopi-neo2 -p linux -t kernel
</syntaxhighlight>
The boot.img and kernel modules are under the "linux-3.10/output" directory. You can copy the new boot.img file to your TF card's boot partition.

====Clean Source Code====
<syntaxhighlight lang="bash">
$ cd lichee/fa_tools/
$ ./build.sh -b nanopi-neo2 -p linux -t clean
</syntaxhighlight>

==Connect External Modules to NEO2==
===DIY NAS Server with 1-bay NAS Dock & NEO2===
The 1-bay NAS Dock is an expansion board which can be used to connect an external hard disk to a NanoPi NEO2.It uses JSM568 USB3.0 to SATA IC and communicates with a NanoPi NEO2 via USB interface. It works with a 2.5" SATA hard disk.It uses TI's DC-DC chipset to convert a 12V input to 5V. It has a power switch for users to turn on/off the device.It supports an onboard RTC battery. FriendlyElec migrated mainline Linux-4.11 kernel and Debian-Jessie with OpenMediaVault. Together with FriendlyElec's customized aluminum case you can quickly assemble a storage server. Here is a hardware setup :[[1-bay NAS Dock v1.2 for NanoPi NEO/NEO2]]<br />
[[File:step4.png | frameless|300px| Step 4]]

===Connect Python Programmable NanoHat OLED to NEO2===
The NanoHat OLED module is a small and cute monochrome OLED module with low power consumption. It has three user buttons. We provide its driver's source code and a user friendly shell interface on which you can check system information and status.A customized aluminum case is made for it. You cannot miss this lovely utility! Here is a hardware setup:[[NanoHat OLED]]<br />
[[File:NanoHat OLED_nanopi_NEO.jpg|frameless|300px|NanoHat OLED_nanopi_NEO]]

===Connect Python Programmable NanoHat Motor to NEO2===
The NanoHat Motor module can drive four 5V PWM steering motors and four 12V DC motors or four 5V PWM steering motors and two 12V four-wire step motors.Here is a hardware setup: [[NanoHat Motor]]<br />
[[File:NanoHat Motor_nanopi_NEO.jpg|frameless|300px|NanoHat Motor_nanopi_NEO]]

===Connect NanoHat PCM5102A to NEO2===
The NanoHat PCM5102A module uses TI's DAC audio chip PCM5102A, a convenient and easy-to-use audio module for hobbyists. Here is a hardware setup:[[NanoHat PCM5102A]]<br />
[[File:Matrix - NanoHat PCM5102A_nanopi_NEO.jpg|frameless|300px|Matrix - NanoHat PCM5102A_nanopi_NEO]]

===Connect Arduino Compatible UNO Dock to NEO2===
The UNO Dock module is an Arduino board compatible with Arduino UNO and works with Arduino programs.You can use Arduino IDE to run all Arduino programs on the Dock.It also exposes the NanoPi NEO2's pins.It converts 12V power input to 5V/2A output.You can search for various code samples from Ubuntu's ecosystem and run on the Dock. These features make it a powerful platform for IOT projects and cloud related applications. Here is a hardware setup:[[UNO Dock for NanoPi NEO v1.0]]<br />
[[File:Matrix-UNO_Dock_NEO.jpg|frameless|300px|Matrix-UNO_Dock_NEO]]

===Connect Power Dock to NEO2===
The Power Dock for NanoPi NEO2 is a high efficiency power conversion module. It provides stable and reliable power source. Here is a hardware setup:[[Power Dock for NanoPi NEO]]<br />
[[File:Power Dock for NanoPi NEO_nanopi_NEO.jpg|frameless|300px|Power Dock for NanoPi NEO_nanopi_NEO]]

===Connect NanoHat Proto to NEO2===
The NanoHat Proto is an expansion board which exposes NEO2's various pins.It has an onboard EEPROM for data storage.Here is a hardware setup:[[NanoHat Proto]]<br />
[[File:Matrix - NanoHat Proto_nanopi_NEO.jpg|frameless|300px|Matrix - NanoHat Proto_nanopi_NEO]]

===Connect Matrix - 2'8 SPI Key TFT to NanoPi NEO2===
The Matrix-2'8_SPI_Key_TFT module is a 2.8" TFT LCD with resistive touch. It uses the ST7789S IC and XPT2046 resistive touch IC. It has SPI interface and three configurable user keys.Here is its wiki page [[Matrix - 2'8 SPI Key TFT]]<br />
[[File:Matrix-2'8_SPI_Key_TFT-1706.jpg|frameless|300px|File:Matrix-2'8_SPI_Key_TFT-1706]]

==3D Printing Files==
[[File:NanoPi NEO2-3D.jpg|thumb|frameless|300px]]
[http://www.thingiverse.com/thing:2180624 downloadfile]

==Resources==
===Datasheet & Schematics===
* Schematics
** [http://wiki.friendlyarm.com/wiki/images/a/a1/Schematic_NanoPi_NEO2-v1.0_1701.pdf NanoPi-NEO2-1701-Schematic.pdf]
* Dimensional Diagram
** [http://wiki.friendlyarm.com/wiki/index.php/File:NanoPi_NEO_2_Dimesions(dxf).rar NanoPi-NEO2-1701 pcb in dxf format]
* H5 Datesheet [http://wiki.friendlyarm.com/wiki/images/d/de/Allwinner_H5_Datasheet_V1.0.pdf Allwinner_H5_Datasheet_V1.0.pdf]

==Update Log==
===March-14-2017===
* Released English Version

===April-5-2017===
* Added sections 5.2 and 5.8

===May-7-2017===
* Added sections 7: mainline support for H5
* Added sections 8: support for external modules

===May-17-2017===
* Added sections 5.9: WiringNP support for H5

===May-24-2017===
* Added section 3: Software Features

===June-4-2017===
* Updated section 5.3.1
* Updated section 3: added more OS features

===June-8-2017===
* Updated section 3.2: added support for RPi.GPIO_NP
* Added section 6.10:  added support for RPi.GPIO_NP

===July-5-2017===
* Updated sections 5.3.2, 6.5 and 6.8
* Added section 8.8:  connect 2.8"TFT to NEO2

===July-9-2017===
* Updated section 7.2