Elaborated in docs; added glossary

This commit is contained in:
JC Staudt 2018-06-20 13:49:13 -07:00
parent 7d8a941189
commit 33d70c8f15
3 changed files with 45 additions and 16 deletions

7
doc/web/glossary.md Normal file

@ -0,0 +1,7 @@
# Glossary
| Term | Description |
|----------|---------------------------------------|
| eMMC | Internal memory storage of the device |
| micro SD | Removable memory storage |
| uSD | See microSD |

@ -1,9 +1,13 @@
# Installing a fresh official image to TERES-I
# Installing a fresh image on your TERES-I
In certain cases you might want to update the Linux on the eMMC memory (if the eMMC got corrupted; or if the original installation got damaged; or if there are no other means to update to the latest software release; etc).
The typical way of installing the operating system of TERES-I is via a micro SD card (there is a micro SD card slot at the right side of the TERES-I).
## Linux
You may sometimes wish to update Linux on the [eMMC memory](glossary.md).
This may be if the eMMC got corrupted, the original installation got damaged, or if there are no other means to update to the latest software releases, etc).
The standard method for installing an operating system onto the TERES-I is via a [micro SD](glossary.md) card.
(There is a micro SD card slot at the right side of the TERES-I).
You would also need SD card writer.
Note that the whole procedure takes considerable amount of time and requires good internet connection.
Note that the entire procedure takes a considerable amount of time and requires stable internet connection.
The procedure is as follows:
1. Download and extract the latest image provided by Olimex.
@ -13,28 +17,46 @@ It looks like this:
![Official OS Download](../images/TERES-I/software/screenshot-official-os.png "Official OS Download")
2. Remember to extract the image from the archive.
3. Download the img file to a micro SD card (8GB or bigger) using a micro SD card writer hardware.
If you don't know how, use free software like [Etcher](https://etcher.io/) - it has builds for Linux, Windows, and MacOS.
Download the installer for your operating system and start the software.
3. "Burn" the img file to a micro SD card (8GB or larger) using a micro SD card writer method of your choice.
The ``dd`` command works great for this task.
For the following example, everything between ``<>`` needs to be modified to fit your situation:
```bash
lsblk
```
Note the ``/dev`` path to your eMMC device.
```bash
sudo dd if=</path/to/image-to-load.img> of=/dev/<eMMC-device-name> bs=1M status=progress
```
If you are not comfortable with this procedure, graphical tools are available such as [Etcher](https://etcher.io).
Etcher is compatible with Linux, Windows, and MacOS, and you may download the installer for your host operating system and start the software.
To use Etcher:
Select the image that you extracted.
Then point to the drive of the micro SD card.
It looks like this:
![Etcher Download](../images/TERES-I/software/screenshot-etcher.png "Etcher Download")
4. Insert the card in the laptop and start the laptop from the power button; it will boot from the micro SD card.
4. Insert the micro SD card into your TERES-I and power on the laptop using the power button; it will boot from the micro SD card.
5. You will be asked for a username and password in a command line.
Username is ``olimex`` and the password is also ``olimex``.
Username=``olimex``, password=``olimex``
6. Once you login execute the eMMC install script, that would move the files from the card to the built-in eMMC memory inside.
Type:
6. Once you log in, execute the eMMC installer script.
This script copies the contents from the microSD card to the built-in eMMC memory inside your TERES-I.
To do this, type:
```bash
sudo install_emmc.sh
```
You will be asked for confirmation and then you would be prompted to select the emmc drive.
Select the defaults and wait until the install script completes (it might take up to 15 minutes).
Select the defaults and wait until the install script completes.
This script may take up to 15 minutes to complete.
7. Remove the card so TERES-I can now boot from the fresh image on the eMMC memory.
7. Remove the micro SD card in order for your TERES-I to boot from the freshly-loaded image in its eMMC memory.
#### Congratulations - task complete!

@ -1,6 +1,6 @@
# Updating the image
# Updating the image (Linux)
Once the Linux boots, connect to the Internet (either via the on-board WIFI adapter or using Ethernet cable).
Once Linux boots, connect to the Internet either via on-board Wi-Fi adapter or by using an Ethernet cable.
You might use the graphical network manager or edit the configuration files via command line.
Then open a console terminal (press ALT+CTRL+T) and type:
@ -11,4 +11,4 @@ sudo apt upgrade
Insert your password if prompted and wait until each of the commands succeeds.
If you decide to completely re-write the image at the eMMC memory, follow the advice in the next chapter.
If you decide to completely re-write the image on the on-board [eMMC memory](glossary.md), follow the advice in the [next section](sw_fresh-os.md).