removing .gitignore

This commit is contained in:
nurix 2020-02-13 11:38:14 +07:00
parent 88f6f3d2d1
commit b57ade1304
33 changed files with 831 additions and 0 deletions

68
docs/helios64/download.md Normal file
View file

@ -0,0 +1,68 @@
disqus:
## Latest OS Images
All the following images are generated by [Armbian](https://www.armbian.com/helios4/) build framework.
### Armbian Buster (Debian 10)
[![Debian Stretch](/helios64/img/os/debian10.png)](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_buster_current_4.19.84.7z)<br>
*MD5SUM : cdb4463097190de35a2e58b1b12223f9<br>
Build date : 19/11/2019<br>
Size : 274 MB<br>*
[Direct Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_buster_current_4.19.84.7z)
!!! important
OMV5 (OpenMediaVault 5) for Debian 10 Buster is still in beta and unstable. If you wand to use OMV, then you should use Debian 9 Stretch with OMV 4 for now.
### Armbian Stretch (Debian 9)
[![Debian Stretch](/helios64/img/os/debian9.png)](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_stretch_legacy_4.14.154.7z)<br>
*MD5SUM : cb7124089b8e1ff6feed32a5c5b768af<br>
Build date : 19/11/2019<br>
Size : 258 MB<br>*
[Direct Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_stretch_legacy_4.14.154.7z)
!!! note
OMV4 (OpenMediaVault 4) can be installed with the **armbian-config** tool as explained [here](/helios4/omv/#install-openmediavault).
### Armbian Bionic (Ubuntu 18.04)
[![Ubuntu Bionic](/helios64/img/os/ubuntu.png)](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_bionic_current_4.19.84.7z)<br>
*MD5SUM : 7d0f80524bf2d24a3de403a6233a655b<br>
Build date : 19/11/2019<br>
Size : 192 MB<br>*
[Direct Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_bionic_current_4.19.84.7z)
## Known Limitations
- SDcard High Speed timing have compatibility issue with some brands.
**Temporary workaround :** Disable UHS option/support.
*Can be manually enable, refer to the following [page](/helios4/sdcard).*
- During SATA heavy load, accessing SPI NOR Flash will generate ATA errors.
**Temporary workaround :** Disable SPI NOR flash.
*Can be manually enable, refer to the following [page](/helios4/spi).*
## Image List
!!! note
7Z archives can be uncompressed with 7-Zip on Windows, Keka on OS X and 7z on Linux (apt-get install p7zip-full). XZ archives and RAW images can be directly written to microSD card with Etcher (all OS).
Filename | Download | MD5
---------|----------|----
**Armbian_19.11.3_Helios4_buster_current_4.19.84.7z**<br>Armbian 19.11.3 Debian 10 Buster (Kernel 4.19.84)<br>Build date : 19/11/2019<br>Size : 274 MB|[Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_buster_current_4.19.84.7z)|cdb4463097190de35a2e58b1b12223f9
**Armbian_19.11.3_Helios4_stretch_legacy_4.14.154.7z**<br>Armbian 19.11.3 Debian 9 Stretch (Kernel 4.14.154)<br>Build date : 19/11/2019<br>Size : 258 MB|[Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_stretch_legacy_4.14.154.7z)|cb7124089b8e1ff6feed32a5c5b768af
**Armbian_19.11.3_Helios4_bionic_current_4.19.84.7z**<br>Armbian 19.11.3 Ubuntu 18.04 Bionic (Kernel 4.19.84)<br>Build date : 19/11/2019<br>Size : 192 MB|[Download](https://dl.armbian.com/helios4/archive/Armbian_19.11.3_Helios4_bionic_current_4.19.84.7z)|7d0f80524bf2d24a3de403a6233a655b
**Armbian_5.91_Helios4_Debian_buster_next_4.19.63.7z**<br>Armbian 5.91 Debian 10 Buster (Kernel 4.19.63)<br>Build date : 02/08/2019<br>Size : 261 MB|[Download](https://cdn.kobol.io/files/Armbian_5.91_Helios4_Debian_buster_next_4.19.63.7z)|9c48344c208dfa50b5868debe6fae629
**Armbian_5.91_Helios4_Debian_stretch_default_4.14.135.7z**<br>Armbian 5.91 Debian 9 Stretch (Kernel 4.14.135)<br>Build date : 02/08/2019<br>Size : 252 MB|[Download](https://cdn.kobol.io/files/Armbian_5.91_Helios4_Debian_stretch_default_4.14.135.7z)|e8416b359a7620bb01b5a13c6a10612f
**Armbian_5.91_Helios4_Ubuntu_bionic_next_4.19.63.7z**<br>Armbian 5.91 Ubuntu 18.04 Bionic (Kernel 4.19.63)<br>Build date : 02/08/2019<br>Size : 192 MB|[Download](https://cdn.kobol.io/files/Armbian_5.91_Helios4_Ubuntu_bionic_next_4.19.63.7z)|62983d7519f15e67355d6dd5e60ee353
**Armbian_5.77_Helios4_Debian_stretch_next_4.14.106.7z**<br>Armbian 5.77 Debian 9 Stretch (Kernel 4.14.106)<br>Build date : 14/03/2019<br>Size : 238 MB|[Download](https://cdn.kobol.io/files/Armbian_5.77_Helios4_Debian_stretch_next_4.14.106.7z)|5f2e19d6ecf8a35de89c881fb06bd56e
**Armbian_5.77_Helios4_Ubuntu_bionic_next_4.14.106.7z**<br>Armbian 5.77 Ubuntu 18.04 Bionic (Kernel 4.14.106)<br>Build date : 14/03/2019<br>Size : 177 MB|[Download](https://cdn.kobol.io/files/Armbian_5.77_Helios4_Ubuntu_bionic_next_4.14.106.7z)|90805f23c5c6491bbf1b251f4d3d74a0
**Armbian_5.75_Helios4_Ubuntu_bionic_next_4.14.98.7z**<br>Armbian 5.75 Ubuntu 18.04 Bionic (Kernel 4.14.98)<br>Build date : 10/02/2019<br>Size : 193 MB|[Download](https://dl.armbian.com/helios4/archive/Armbian_5.75_Helios4_Ubuntu_bionic_next_4.14.98.7z)|d70b2d51b29e6729c33bbec90825f47a

165
docs/helios64/hardware.md Normal file
View file

@ -0,0 +1,165 @@
## Block Diagram
### Helios64 Carrier Board
![!Block Diagram](/helios64/img/hardware/helios64-block-diagram.png)
### RK3399 System-On-Chip
![!Block Diagram](/helios64/img/hardware/RK3399_block_diagram.png)
This block diagram is cited from the RK3399 website documentation. [1](http://opensource.rock-chips.com/wiki_File:RK3399_Block_Diagram.png)
## Connector / Interface List
![!Board Legend](/helios64/img/hardware/helios64_board_labeled.jpg)
Name |Peripheral Type|Connector Type|Details
-----|---------------|--------------|-------
P10|eMMC|2x1 Pin Male Header|Disable eMMC boot
P11|SPI Flash|2x1 Pin Male Header|Disable SPI Flash
P13|HS Select|2x1 Pin Male Header|USB-C HS Select (Close = Type C HS, Open = Console)
J1|USB3|USB 3.0| USB 3.0 Port Header
J3|SATA|SATA 3.0|Port 0 (SATA1)
J4|SATA|SATA 3.0|Port 1 (SATA2)
J5|SATA|SATA 3.0|Port 2 (SATA3)
J6|SATA|SATA 3.0|Port 3 (SATA4)
J7|HDD Power|8 Pin ATX 12V|Rated for 5x HDD
J8|SATA|SATA 3.0|Port 4 (SATA5)
J9|Battery Power|6 Pin ATX 12V|Battery Backup
J10|ATX Power Supply|4 Pin ATX 12V|4 Pin ATX Power Connector
J11|LAN1|RJ45|Gigabit Ethernet
J12|LAN2|RJ45|2.5 Gigabit Ethernet
J13|USB 3.0|Dual Port USB3.0|Type A
J14|microSD|Push-Push card connector|Support SDHC and SDXC
J15|Serial port|Micro-USB Connector|Via onboard FTDI USB-to-UART0 bridge
J16|DC connector|Kycon 4-Pin Mini-DIN|DC input 12V / 8A
FAN1|Fan|4x1 Pin Male Header|PWM and RPM support
FAN2|Fan|4x1 Pin Male Header|PWM and RPM support
P1|I2C|4x1 Pin Male Header|I2C Bus 1
P2|UEXT|2x5 Pin Male Header|Universal EXTension Support [2]
P3|Front Panel|12x1 Pin Male Header|PWM and RPM support
P4|Buzzer|2x1 Pin Header|Buzzer Speaker Support
P5|GPIO|7x2 Pin Male Header|GPIO configurable as input or output<br>Via IO Expander on I2C Bus 0
SW1|Power|Push Button|Power Button
SW2|Boot Mode|Push Button|Boot mode selector :<br> SPI,MMC,UART,SATA
SW3|Reset|Push Button|Reset Button
## Boot Modes
Helios64 supports at least **3 (TBD)** boot modes that can be chosen by using the jumper configuration.
Please see above figure for the connector/interface list. Following jumper are available in the Helios64 board to configure the boot modes:
- P11 Jumper to disable SPI Flash, when this jumper is shorted/close it means disable the SPI Flash (Open = enable)
- Disable eMMC, Close = disable, Open = enable eMMC (P10)
- USB Mux, HS select, Close = type C HS, Open = Console (P13)
by default your USB C cabel will will connected to the serial Console of The Helios64 board. By closing this connection the USB-C connection will become the HS mode, the eMMC will be detected as the USB Mass storage in your PC, and you can directly flash the Armbian image to it.
![Dipswitch modes](/helios4/img/hardware/dipswitch_modes.jpg)
All the ready-to-use images we provide are for the **SD Card** boot mode.
Please refer to [U-boot](/helios4/uboot) section to know how to use the other modes.
## LED indicators
LED Name|Color|Description
---|---|---
LED1|green|System heartbeat
LED2|red|Error status
LED3|green|SATA1 activity
LED4|green|SATA2 activity
LED5|green|SATA3 activity
LED6|green|SATA4 activity
LED7|green|USB activity
LED8|green|Power indicator
Helios4 board was designed to either use the on-board LEDs or use an expansion panel (not-available). To use the on-board LEDs insure to switch to ON the dipswitch SW2.
![Dipswitch LED](/helios4/img/hardware/dipswitch_led_on.jpg)
## Reset Button
Helios4 board provides a RESET push button (U16) to hard reset the SoC (System-On-Chip).
![Reset Button](/helios4/img/hardware/reset_button.jpg)
!!! Important
This button only resets the SoC and not the overall board. For instance it won't reset the HDD.
## I2C Interface
Helios4 board exposes on header J9 the SoC I2C Bus 1. Below is the header pin-out, the little arrow on the PCB indicates the ground pin.
![I2C Pinout](/helios4/img/hardware/i2c_pinout.png)
## Power Consumption
**Board only**
* Idle : 3.6 Watts
* Active : 5.6 Watts
**Full Kit (with 4x HDDs)**
| State | AC calculated<br>power consumption | DC measured<br>power consumption | Remarks |
|---------------------|----------------------|----------------------|---------------------|
| Idle | 19.3 W | 16.8 W | |
| HDD Read Access | 27.4 W | 22.8 W | |
| HDD Write Access | 30.3 W | 25.2 W | |
| Standby | 8.0 W | 6.7 W | HDD in Standby mode |
| Suspend-to-Ram | 7.2 W | 6.0 W | HDD in Standby mode |
!!! note
Measures were done using a Current Clamp Meter on the Helios4 12V DC input. AC Power consumption is calculated based on a AC/DC conversion efficiency of 85%.
* Meter tool : Extech 380942 - 30A True RMS AC/DC Mini Clamp
* AC/DC Adapter : yczx1268 (efficiency : 85%)
* AC Input Voltage: 220V
* HDD: 4x WD Red 2TB (WD20EFRX) configured as RAID10
* Network : Connected at 1000Mb/s
* OS: ARMBIAN 5.73 stable Debian GNU/Linux 9 (stretch) 4.14.98-mvebu
## HDD Recommendation List
We recommend HDD which are designed for NAS (Network Attached Storage). Those NAS HDD are specially conceived for reliable 24/7 operation and offers lower power consumption and dissipation, less vibration and noise, and finally better warranty. We recommend the following models :
**Western Digital** : WD Red NAS (1, 2, 3, 4, 6, 8 and 10TB)
- WD10EFRX
- WD20EFRX
- WD30EFRX
- WD40EFRX
- WD60EFRX
- WD80EFZX
- WD100EFAX
**Seagate** : IronWolf NAS (1, 2, 3, 4, 6, 8 and 10TB)
- ST1000VN002
- ST2000VN004
- ST3000VN007
- ST4000VN008
- ST6000VN0041
- ST8000VN0022
- ST10000VN0004
**HGST** : Deskstar NAS (4, 6 and 8TB)
- 0S04005
- 0S04007
- 0S04012
!!! note
We recommend to order from different shop to avoid having all the drives from the same factory batch. For instance, you should order 2x HDDs from one shop, then the 2 others from another shop.
## HDD / SSD Compability List
Please refer to [Synology DS416j Compatibility List](https://www.synology.com/en-global/compatibility?search_by=products&model=DS416j&category=hdds&p=1) that covers a large number of tested drives. The DS416j used the same SoC family than Helios4.
## References
1. http://opensource.rock-chips.com/wiki_File:RK3399_Block_Diagram.png
2. https://en.wikipedia.org/wiki/UEXT

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 407 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 616 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

197
docs/helios64/install-1.md Normal file
View file

@ -0,0 +1,197 @@
## **Step 1** - Download Helios4 OS image
Before we start, you will need to download the Armbian Image for Helios64 build.
Go to [Dowload](/helios64/download) section and chose one of the latest stable build.
!!! note
Images with .7z extension can be uncompressed by using 7-Zip ([Windows](https://www.7-zip.org/)), Keka (OS X) and 7z (Linux).
On Linux machine 7z can be isntalled by : apt-get install p7zip-full.
## **Step 2** - Writing an image to a microSD Card or the eMMC
There is actually 2 way to get your operating system up:
- Write the operating system image on the microSD Card, or
- Write the OS image directly to the eMMC storage.
You will need to use an image writing tool to install on your microSD Card the image build you have downloaded.
### Under Windows, Mac OS or Linux (via Graphic Interface)
Etcher is a graphical SD card writing tool that works on Mac OS, Linux and Windows, and is the easiest option for most users. Etcher also supports writing images directly from XZ files, without any prerequired decompression. To write your image with Etcher:
- [Download Etcher](http://etcher.io) and install it on your computer.
- Insert the microSD Card inside your SD card reader (microSD to SD adapter might be needed).
- Open Etcher and select from your local storage the Helios4 file you wish to write to the microSD Card.
- Select the microSD Card you wish to write your image to.
- Review your selections and click 'Flash!' to begin writing data to the microSD Card.
![Etcher](/helios4/img/install/etcher_flash.png)
### Under Linux (via Terminal)
```bash
7z e Armbian_5.90_Helios4_Debian_buster_next_4.19.59.7z
sudo dd bs=4M if=Armbian_5.90_Helios4_Debian_buster_next_4.19.59.img of=/dev/sdX conv=fsync
```
*Replace the filename by the image file name you downloaded.*
!!! note
/dev/sdX is where the microSD is mapped in your Linux machine, change the 'X' to your corresponding mapped device. If you set /dev/sdX to a wrong device then you might risk erasing a hard drive or different device than the designated microSD.
## **Step 3** - Power-up Helios4
**Before powering-up insure :**
1. You inserted the microSD Card that you prepared in the previous step.
2. You connected your computer to the serial port with the Micro-USB to USB cable.
3. You connected Helios4 to your home network with the Ethernet cable.
4. You plugged-in properly the DC power connector before powering-up the AC adapter.
![Connections](/helios4/img/install/connections.png)
**Now you can plug-in / power-up the AC adapter.**
!!! warning
Always proceed with caution when manipulating 110/220V appliance.
## **Step 4** - Connect to Helios4 serial console
!!! Important
For Windows and Mac OS you will need to install the FTDI driver in order to access the USB to serial bridge used by Helios4. You can find the driver [here](https://www.ftdichip.com/Drivers/VCP.htm).
### Under Windows
1. [Download PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) and install it on your computer.
2. Select connection type **serial**.<br>
![Putty connect](/helios4/img/install/putty_config.png)
3. Setup serial port settings (Serial line : **COM1** and Speed : **115200**), then press **'Open'**<br>
![Putty config](/helios4/img/install/putty_connect.png)
!!! note
If you computer already has a serial port then COM1 might not be the correct serial line to connect to Helios4. Check this [link](https://tnp.uservoice.com/knowledgebase/articles/172101-determining-the-com-port-of-a-usb-to-serial-adapte) to learn how to determine the right COM port.
### Under Linux (via Terminal)
**1.** Install picocom
Use apt-get under Debian/Ubuntu
$ sudo apt-get install picocom
Use yum under RHEL / CentOS / Fedora Linux
$ sudo yum install picocom
**2.** Connect to serial with picocom
$ sudo picocom -b 115200 /dev/ttyUSB0
![Picocom](/helios4/img/install/picocom.png)
To exit picocom do **Ctrl-a** then **Ctrl-x**
!!! note
Using command _ls -la /dev/ttyUSB*_ you should be able the find the USB to serial bridge device used by Helios4. Under Linux the device will be named **/dev/ttyUSBx**, where **x** is a digit.
### Under Mac OS (via Terminal)
Connect serial using the *screen* command
$ screen /dev/tty.usbserial-XXXXXXXX 115200 -L
To exit the session do **Ctrl-a** then **Ctrl-k**
!!! note
Using command _ls -la /dev/tty.usb*_ you should be able the find the USB to serial bridge device used by Helios4. Under Mac OS the device will be named **/dev/tty.usbserial-xxxxxxxx**, where **xxxxxxxx** is some serial number.
## **Step 5** - Log in
!!! note
You might need to press **Enter** for the login prompt to come up.
**Default credential for Debian image**
```bash
helios4 login: root
Password: 1234
```
You will be prompted to change the root password and then create a new user account.
![First Login](/helios4/img/install/first_login.png)
## **Step 6** - Check/Set IP address
### Check IP address
By default Helios4 will try to obtain an IP address via DHCP. To figure out what is the allocated IP address you will need to type the following command in the console.
```bash
ip addr show dev eth0
```
![Network Config](/helios4/img/install/network_config.png)
Here the IP address of Helios4 is **10.10.10.1**.
### Set IP address
If you wish to manually configure your IP address you can use the **armbian-config** tool.
```bash
armbian-config
```
![Armbian-config](/helios4/img/install/armbian-config.png)
![Armbian-config](/helios4/img/install/armbian-config_network.png)
![Armbian-config](/helios4/img/install/armbian-config_ip-static.png)
![Armbian-config](/helios4/img/install/armbian-config_ip.png)
Press **ESC** till you exit armbian-config tool.
You will have to reboot for the network settings to take effect.
```bash
sudo reboot
```
!!! info
You can also refer to the following Debian Wiki [Page](https://wiki.debian.org/NetworkConfiguration#Setting_up_an_Ethernet_Interface) for advanced network settings.
## **Step 7** - Connect to Helios4 via SSH
You can now connect by SSH to your Helios4 to carry on with your configuration.
![SSH Login](/helios4/img/install/ssh_login.png)
![Putty SSH](/helios4/img/install/putty_ssh.png)
## **What to do next ?**
If you want to install OpenMediaVault, the next-gen network attached storage (NAS) software, refer to the [OMV](/helios4/omv) page.
If you have assembled an OLED Display as part of your Helios4 setup, it can be the right time to set it up. Refer to the following [section](/helios4/i2c/#sys-oled-application) that will explain you how to install the **sys-oled** application which control the OLED display.
For other software you can use **armbian-config** which provides an easy way to install 3rd party applications. You can also refer to our *Software* section to find tutorials that will help you to setup manually your Helios4.
```bash
sudo armbian-config
```
![!armbian-config Main Menu](/helios4/img/omv/install-1.png)
![!armbian-config Software](/helios4/img/omv/install-2.png)
![!armbian-config Selection](/helios4/img/install/softy.png)

211
docs/helios64/install-3.md Normal file
View file

@ -0,0 +1,211 @@
## **Step 1** - Download Helios64 OS image
Before we start, you will need to download the Armbian Image for Helios64 build.
Go to [Dowload](/helios64/download) section and chose one of the latest stable build.
!!! note
Images with .7z extension can be uncompressed by using 7-Zip ([Windows](https://www.7-zip.org/)), Keka (OS X) and 7z (Linux).
On Linux machine 7z can be installed by : apt-get install p7zip-full.
## **Step 2** - Setup your Helios64 Hardware
Make sure the system in the powered off condition. Plug the USB-C cable from the device to your PC/Mac.
Turn on the Helios64 device while pushing the Recovery Button (see [Hardware Page](/helios64/hardware/overview) for the location of the button).
## **Step 3** - Choosing the USB Mass Storage USB-C Cable
Push the recovery button at least **TBD** seconds to enter the recovery mode, after this the Helios64 board will detected as the USB Mass storage from your PC/Mac.
In this condition, actually the eMMC of the Helios64 board is the one detected as the USB mass storage. From this stage, you can write your image to this USB mass storage.
## **Step 4** - Writing an image directly to the eMMC via USB-C Cable
In this section we will write the OS image directly to the eMMC storage.
To perform this step, you will need an image writing tool to flash the downloaded image.
We recommend Etcher as the writing tools software, that can be downloaded from [Etcher download pages](https://etcher.download/). In our experience Etcher works in almost every host Operating System.
Aside from this software, built in linux program (command) such as **dd** also can be used as an alternative to Etcher.
### Under Windows, Mac OS or Linux (via Graphic Interface)
Etcher is a graphical SD card writing tool that works on Mac OS, Linux and Windows, and is the easiest option for most users. Etcher also supports writing images directly from XZ files, without any prerequired decompression. To write your image with Etcher:
- [Download Etcher](http://etcher.io) and install it on your computer.
- Insert the microSD Card inside your SD card reader (microSD to SD adapter might be needed).
- Open Etcher and select from your local storage the Helios4 file you wish to write to the microSD Card.
- Select the microSD Card you wish to write your image to.
- Review your selections and click 'Flash!' to begin writing data to the microSD Card.
![Etcher](/helios4/img/install/etcher_flash.png)
### Under Linux (via Terminal)
```bash
7z e Armbian_5.90_Helios4_Debian_buster_next_4.19.59.7z
sudo dd bs=4M if=Armbian_5.90_Helios4_Debian_buster_next_4.19.59.img of=/dev/sdX conv=fsync
```
*Replace the filename by the image file name you downloaded.*
!!! note
/dev/sdX is where the microSD is mapped in your Linux machine, change the 'X' to your corresponding mapped device. If you set /dev/sdX to a wrong device then you might risk erasing a hard drive or different device than the designated microSD.
## **Step 3** - Power-up Helios64
**Before powering-up up your device, make sure following requirement are statisfied :**
1. The prepared microSD Card is already inserted to the board
2. The USB-C Cable from your Helios64 board already connected to USB-C in your PC/Mac.
3. The Ethernet cable from your home network is already connected to either 1 Gbps Ethernet or 2.5Gbps Ethernet port.
4. The AC Adapter cable already properly connected to your Helios64 device before powering-up the power supply.
![Connections](/helios4/img/install/connections.png)
**Now you can plug-in / power-up the AC adapter.**
!!! warning
Always proceed with caution when manipulating 110/220V appliance.
## **Step 4** - Connect to Helios4 serial console
!!! Important
For Windows and Mac OS you will need to install the FTDI driver in order to access the USB to serial bridge used by Helios4. You can find the driver [here](https://www.ftdichip.com/Drivers/VCP.htm).
### Under Windows
1. [Download PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) and install it on your computer.
2. Select connection type **serial**.<br>
![Putty connect](/helios64/img/install/putty_config.png)
3. Setup serial port settings (Serial line : **COM1** and Speed : **1500000**), then press **'Open'**<br>
![Putty config](/helios64/img/install/putty_connect.png)
!!! note
If you computer already has a serial port then COM1 might not be the correct serial line to connect to Helios4. Check this [link](https://tnp.uservoice.com/knowledgebase/articles/172101-determining-the-com-port-of-a-usb-to-serial-adapte) to learn how to determine the right COM port.
### Under Linux (via Terminal)
**1.** Install picocom
Use apt-get under Debian/Ubuntu
$ sudo apt-get install picocom
Use yum under RHEL / CentOS / Fedora Linux
$ sudo yum install picocom
**2.** Connect to serial with picocom
$ sudo picocom -b 115200 /dev/ttyUSB0
![Picocom](/helios4/img/install/picocom.png)
!!! note
Helios64 use 1.5Mbps baut rate for the serial connection, picocom Ver. 1.7 will not work with this configuration. We recommend **picocom Ver 2.2** or later for Helios64 device.
To exit picocom do **Ctrl-a-q**
!!! note
Using command _ls -la /dev/ttyUSB*_ you should be able the find the USB to serial bridge device used by Helios64. Under Linux the device will be named **/dev/ttyUSBx**, where **x** is a digit.
### Under Mac OS (via Terminal)
Connect serial using the *screen* command
$ screen /dev/tty.usbserial-XXXXXXXX 1500000 -L
To exit the session do **Ctrl-a** then **Ctrl-k**
!!! note
Using command _ls -la /dev/tty.usb*_ you should be able the find the USB to serial bridge device used by Helios4. Under Mac OS the device will be named **/dev/tty.usbserial-xxxxxxxx**, where **xxxxxxxx** is some serial number.
## **Step 5** - Log in
!!! note
You might need to press **Enter** for the login prompt to come up.
**Default credential for Debian image**
```bash
helios64 login: root
Password: 1234
```
You will be prompted to change the root password and then create a new user account.
![First Login](/helios4/img/install/first_login.png)
## **Step 6** - Check/Set IP address
### Check IP address
By default Helios64 will try to obtain an IP address via DHCP. To figure out what is the allocated IP address you will need to type the following command in the console.
```bash
ip addr show dev eth0
```
![Network Config](/helios4/img/install/network_config.png)
Here the IP address of Helios64 is **10.10.10.1**.
### Set IP address
If you wish to manually configure your IP address you can use the **armbian-config** tool.
```bash
armbian-config
```
![Armbian-config](/helios4/img/install/armbian-config.png)
![Armbian-config](/helios4/img/install/armbian-config_network.png)
![Armbian-config](/helios4/img/install/armbian-config_ip-static.png)
![Armbian-config](/helios4/img/install/armbian-config_ip.png)
Press **ESC** till you exit armbian-config tool.
You will have to reboot for the network settings to take effect.
```bash
sudo reboot
```
!!! info
You can also refer to the following Debian Wiki [Page](https://wiki.debian.org/NetworkConfiguration#Setting_up_an_Ethernet_Interface) for advanced network settings.
## **Step 7** - Connect to Helios64 via SSH
You can now connect by SSH to your Helios4 to carry on with your configuration.
![SSH Login](/helios4/img/install/ssh_login.png)
![Putty SSH](/helios4/img/install/putty_ssh.png)
## **What to do next ?**
If you want to install OpenMediaVault, the next-gen network attached storage (NAS) software, refer to the [OMV](/helios4/omv) page.
If you have assembled an OLED Display as part of your Helios64 setup, it can be the right time to set it up. Refer to the following [section](/helios4/i2c/#sys-oled-application) that will explain you how to install the **sys-oled** application which control the OLED display.
For other software you can use **armbian-config** which provides an easy way to install 3rd party applications. You can also refer to our *Software* section to find tutorials that will help you to setup manually your Helios4.
```bash
sudo armbian-config
```
![!armbian-config Main Menu](/helios4/img/omv/install-1.png)
![!armbian-config Software](/helios4/img/omv/install-2.png)
![!armbian-config Selection](/helios4/img/install/softy.png)

35
docs/helios64/install.md Normal file
View file

@ -0,0 +1,35 @@
!!! note
Go to [Kit Assembly](/helios64/kit) to find out how to put together your Helios64 NAS
## **Install Method**
There is several ways to install OS to your Helios64 board:
**1. [Install to micro-SD Card](/helios64/install-1)<br>**
**2. [Install to the eMMC module via micro-SD Card](/helios64/install-2)<br>**
**3. [Install to eMMC module directly via USB-C cable](/helios64/install-3)<br>**
**4. [Install on USB drive](/helios64/install-4)<br>**
**5. [Install on M.2 NVMe drive](/helios64/install-5)<br>**
Different choice of storage resulting in different IO read/write speed, this may affect the performance of installed OS.
## **What you need before you start.**
**1. microSD Card<br>**
You need a microSD Card UHS-I with a minimum of 8GB. We recommend the following models:
- SanDisk Extreme microSDHC UHS-I Card (32GB)
- SanDisk Extreme PRO microSDHC UHS-I Card (32GB)
- Strontium Nitro MicroSD Card (16GB)
- Samsung microSDHC UHS-I Card EVO Plus (32GB)
![Recommended SDcard](/helios64/img/install/recommended_sdcard.jpg)
You might refer to the [SD Card](/helios64/sdcard/#tested-microsd-card) page to find a compatibility list of SD Card models.
**2. USB-C cable<br>**
![USB-C cable](/helios64/img/install/usb-c.jpg)
**3. Ethernet cable (cat5/6)<br>**
![Network cable](/helios64/img/install/network_cable.jpg)

155
docs/helios64/usb.md Normal file
View file

@ -0,0 +1,155 @@
![LED location](/helios4/img/led/led_location.png)
## On-Board LEDs
## Expansion Panel (J18)
Helios4 board was designed to either use the on-board LEDs or use a custom expansion panel (not-available).
If you wish to use the header, insure to switch to OFF the Dip Switch SW2.
![Dipswitch LED](/helios4/img/led/dipswitch_led_off.png)
### Pinout Table
![J18 Pinout](/helios4/img/led/gpio_pinout_j18.png)
| Pin | LED number | Remarks |
|-----|------------|---------|
| 1 | - | 3.3V supply |
| 2 | - | Not connected |
| 3 | LED1 | Active-low |
| 4 | LED2 | Active-low |
| 5 | LED3 | Active-low |
| 6 | LED4 | Active-low |
| 7 | LED5 | Active-low |
| 8 | LED6 | Active-low |
| 9 | LED7 | Active-low |
| 10 | - | GND |
!!! info
LED1 - LED7 is preconfigured for certain indicator under Linux, see [LED under Linux](#led-under-linux) section.
### Wiring Diagram
Since the signals to control the LEDs are active low, connect the pin to LED's cathode.
Below a wiring diagram example.
![Wiring Example](/helios4/img/led/led_expansion_wiring_diagram.png)
## LED under Linux
| LED | Name | Default Trigger | Remarks |
|------|----------------------|-----------------|---------|
| LED1 | helios4:green:status | heartbeat | Blinking periodically |
| LED2 | helios4:red:fault | none | See [Configuring Fault LED](#configuring-fault-led) |
| LED3 | helios4:green:ata1 | ata1 | Blinking on SATA1 activity |
| LED4 | helios4:green:ata2 | ata2 | Blinking on SATA2 activity |
| LED5 | helios4:green:ata3 | ata3 | Blinking on SATA3 activity |
| LED6 | helios4:green:ata4 | ata4 | Blinking on SATA4 activity |
| LED7 | helios4:green:usb | usb-host | Blinking on USB activity, any port |
!!! note
**ata** trigger requires additional patch to mainline kernel. The patch can be found [here](/helios4/files/led/libata_leds_trigger_mvebu.patch). **Armbian** builds are already patched, so no action is required.
The LEDs can be accessed under LEDs class in *sysfs*.
```
root@helios4:~/# ls -l /sys/class/leds/
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:ata1 -> ../../devices/platform/io-leds/leds/helios4:green:ata1
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:ata2 -> ../../devices/platform/io-leds/leds/helios4:green:ata2
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:ata3 -> ../../devices/platform/io-leds/leds/helios4:green:ata3
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:ata4 -> ../../devices/platform/io-leds/leds/helios4:green:ata4
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:status -> ../../devices/platform/system-leds/leds/helios4:green:status
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:green:usb -> ../../devices/platform/io-leds/leds/helios4:green:usb
lrwxrwxrwx 1 root root 0 Dec 4 06:57 helios4:red:fault -> ../../devices/platform/system-leds/leds/helios4:red:fault
```
### LEDs Trigger
- none
No automatic trigger. Manually control the LED by manipulating "brightness".
More info see [Configuring LED trigger](#configuring-led-trigger).
- heartbeat
LED "double" flashes at a load average based rate. The interval might change during heavy load.
If the LED no longer blinks, it means the system is locked-up or hung and has to be reset.
- ata*N*
LED blinks on any read/write activity at specific SATA port.
- usb-host
LED blinks on USB activity at any port.
- panic
This trigger allows LEDs to be configured to blink on a kernel panic.
- timer
This allows LEDs to be controlled by a programmable timer via *sysfs*. delay_on to set how long
the LED turned on and delay_off to set how long the LED turned off.
### Configuring LED trigger
To configure, simply set the trigger type. For example to set Status LED triggered by timer
```
echo timer | sudo tee -a /sys/class/leds/helios4\:green\:status/trigger
```
Some of the triggers may expose additional parameters that can be configured further.
On **none** trigger, to turn ON the LED set the brightness bigger than 0.
```
echo 1 | sudo tee -a /sys/class/leds/helios4\:green\:status/brightness
```
and to turn OFF the LED set the brightness to 0.
```
echo 0 | sudo tee -a /sys/class/leds/helios4\:green\:status/brightness
```
On **timer** trigger, it will exposed *delay_on* and *delay_off* with default value of 0.5 seconds for both.
To change the delay, set the respective parameter (value in milliseconds)
```
echo 1000 | sudo tee -a /sys/class/leds/helios4\:green\:status/delay_on
echo 200 | sudo tee -a /sys/class/leds/helios4\:green\:status/delay_off
```
!!! note
The changes is not retained across reboot. Use startup script or udev rules to make it permanent.
### Configuring Fault LED
While other LEDs are preconfigured, the fault LED remains unconfigured (trigger:**none**).
#### 1. As Kernel Panic Indicator
To configure the LED as Kernel panic indicator, set the trigger to **panic**. However this functionality might be redundant with Status LED, since if a kernel panic occurs and/or system hangs, the Status LED will no longer blink.
To trigger kernel panic to test the LED, run
```
echo c > /proc/sysrq-trigger
```
!!! warning
Triggering kernel panic can lead to data loss. Use with caution!
#### 2. As RAID Fault Indicator
To configure the LED as RAID fault indicator, please refer to [MDADM: Configure Fault LED](/helios4/mdadm/#configure-fault-led)
!!! note
On Armbian builds, this is the default setting for fault LED.