第3章 Before Turning on Armadillo

3.1. Preparation

Before using Armadillo, please prepare the following as required.

Work PC

A PC that runs either Linux or Windows which has a network interface and at least one USB port. Please refer to 「Setup of Environment for Development and Operational Checks」 and set up the development and operational check environment on the work PC.

Network Environment

Please connect the Armadillo and Work PC so that they can communicate via a network.

SD Card

Used when checking the operation of the SD slot.

USB Memory

Used when checking USB operation.

MicroSIM (UIM Card) and APN Information

These are used to confirm 3G/LTE operation. A contract with a telecommunications carrier is required. In order to check the operation of SMS, a MicroSIM (UIM card) with SMS function is required.

Software to Extract tar.xz Format Files

Used when creating the development and operational check environment. On Linux, tar[4] can be used for the extraction. For Windows, 7-Zip and Lhaz etc can be used.

3.2. Setup of Environment for Development and Operational Checks

A VMware virtual machine data image is provided to allow easier software development and operational checks of Atmark Techno products. The VMware virtual machine data image is referred to as ATDE (Atmark Techno Development Environment). To start ATDEm, VMware virtualization software is used. The ATDE image data is compressed in the tar.xz format. Please extract it with the tools suitable for your environment.

[ティップ]

In addition to VMware, Oracle VM VirtualBox is also a well know virtualization program. Oracle VM VirtualBox has the following features.

  • Provided under GPL v2 (General Public License version 2)[5]

  • Supports VMware virtual disk (.vmdk) files

It is possible to start ATDE with Oracle VM and use it as the software development environment,

The Atmark Techno products supported differ depending on the ATDE version. The ATDE compatible with this product is ATDE7 v20180621 or later.

ATDE7 is based on Debian GNU/Linux 9 (codename stretch) and the cross development tools necessary for software development and performing the operational checks of Armadillo-IoT Gateway are preinstalled.

3.2.1. ATDE Setup

3.2.1.1. Installing VMware

In order to use ATDE, VMware must be installed on the work PC. Please refer to the VMware web page (http://www.vmware.com/) and install the VMware product that most suits the purpose of use. Also, as the image data of ATDE is compressed in the tar.xz format, please extract it with a tool suitable for your environment.

[警告]

VMware offers a number of products, from free versions for non-commercial use to paid commercial use versions. Separate licenses and end-user license agreements (EULA) exist for each product, so please choose the most appropriate product after having fully checked these.

[警告]

In order to avoid VMware and ATDE not working correctly, please check the following items from the VMware documentation.

  • Hardware requirements of the host system

  • Software requirements of the host system

  • Processor requirements of the guest operating system

The documentation can be obtained from the VMware web site (http://www.vmware.com/).

3.2.1.2. Obtaining the ATDE Archive

The ATDE archive can be obtained from the Armadillo site (http://armadillo.atmark-techno.com).

[警告]

ATDE may not work properly depending on the operating environment of the work PC (hardware, VMware, ATDE supported architecture, etc). Please refer to the documentation for the VMware software you are using on the VMware web site (http://www.vmware.com/) and check the operating environment.

3.2.1.3. Extracting the ATDE Archive

Extract the ATDE archive. The ATDE archive is a compressed file in the tar.xz format.

The extraction method for Windows is shown in 手順3.1「Extracting the ATDE Archive on Windows」, and the method for Linux is shown in 手順3.2「Extracting the tar.xz Format File on Linux」.

手順3.1 Extracting the ATDE Archive on Windows

  1. Installing 7-Zip

    Install 7-Zip. 7-Zip can be obtained from the 7-Zip website (http://sevenzip.sourceforge.jp).

  2. Starting 7-Zip

    Start 7-Zip.

  3. Selecting the xz Compressed File

    Extract the xz compressed file into a file in the tar format. Select the tar.xz file and click "Extract".

  4. Specifying the xz Compressed File Extraction Destination

    Specify where to extract the file to and click "OK".

  5. Extracting the xz Compressed File

    The extraction begins.

  6. Selecting the tar Archive File

    Once the extraction of the xz compressed file has completed, a file in the tar format is created.

    Output the ATDE data image from the tar archive file with the same procedure as used for the tar archive file. Select the tar format file, click "Extract", specify the "Extracted location", and click "OK".

  7. Confirming Completion of the Extraction

    When extraction of the tar archive file is finished, the extraction of the ATDE archive is complete. The ATDE data image is output to the folder specified with "Extracted location".

手順3.2 Extracting the tar.xz Format File on Linux

  1. Extracting the tar.xz Compressed File

    Use the tar command with the Jxf options to extract the tar.xz compressed file.

    [PC ~]$ tar Jxf atde-i386-[version].tar.xz
  2. Confirming Completion of the Extraction

    When extraction of the tar archive file is finished, the extraction of the ATDE archive is complete. The ATDE data image is output to the atde-i386-[version] folder.

    [PC ~]$ ls atde-i386-[version]/
    atde-i386.nvram      atde-i386-s005.vmdk  atde-i386.vmdk
    atde-i386-s001.vmdk  atde-i386-s006.vmdk  atde-i386.vmsd
    atde-i386-s002.vmdk  atde-i386-s007.vmdk  atde-i386.vmx
    atde-i386-s003.vmdk  atde-i386-s008.vmdk  atde-i386.vmxf
    atde-i386-s004.vmdk  atde-i386-s009.vmdk
    

3.2.1.4. Starting ATDE

ATDE can be started by opening the virtual machine configuration (.vmx) file in the directory where you extracted the ATDE archive. Users which can be used to log on to ATDE are shown in 表3.1「Usernames and Passwords」[6].

表3.1 Usernames and Passwords

UsernamePasswordPermissions
atmarkatmarkGeneral user
rootrootPrivileged user

[ティップ]

ATDE can be used more effectively by increasing the memory size and number of processors assigned to it. For details on how to change the hardware settings of the virtual machine, refer to the documentation for the VMware software you are using on the VMware site (http://www.vmware.com/).

3.2.2. Using Removable Devices

VMware supports the use of removable devices (such as USB devices and DVDs) with the guest operating system (ATDE). Depending on the device, these devices cannot be used simultaneously by the host operating system (the operating system running VMware) and the guest operating system. In order to use such a device in the guest operating system, it must be connected to the guest operating system.

[ティップ]

For details on how to use removable devices, please refer to the documentation for the VMware software you are using on the VMware site (http://www.vmware.com/).

In order to perform the operational checks of Armadillo-IoT, the devices shown in 表3.2「Removable Devices Used for Operational Checks」 must be connected to the guest operating system.

表3.2 Removable Devices Used for Operational Checks

DeviceDevice Name
USB serial converterFuture Devices FT232R USB UART
Work PC physical serial portSerial port

3.2.3. Starting the Command Line Terminal (GNOME Terminal)

In ATDE, we start a command line terminal that provides a CUI (Character-based User Interface) environment. Various commands to be run on ATDE are input and executed with the command line terminal. While there are several types of command line terminals, here we start the GNOME terminal installed by default in the GNOME desktop environment.

To start the GNOME terminal, please enter terminal from the activityin the upper left of the desktop like 図3.1「Starting the GNOME Terminal」 and select Terminal.

Starting the GNOME Terminal

図3.1 Starting the GNOME Terminal


A window opens as shown in 図3.2「GNOME Terminal Window」.

GNOME Terminal Window

図3.2 GNOME Terminal Window


3.2.4. Using Serial Communication Software (minicom)

Set the serial communication settings of the serial communication software (minicom) as shown in 表3.3「Serial Communication Configuration」. Also, please set the width of the terminal used to start minicom to 80 or more characters. The display may become disordered when entering commands if the width is less than 80 characters.

表3.3 Serial Communication Configuration

ItemConfiguration
Baud rate115,200bps
Data Length8-bit
Stop Bit1-bit
ParityNone
Flow ControlNone

To start minicom configuration, please do as shown in 図3.3「Configuring minicom」. After configuration is completed, save it to the default setting (dfl) and exit.

[PC ~]$ LANG=C minicom --setup

図3.3 Configuring minicom


To start minicom, please do as shown in図3.4「Starting minicom」.

[PC ~]$ LANG=C minicom --wrap --device /dev/ttyUSB0

図3.4 Starting minicom


[注記]

Depending on the environment, the device file name may differ from that in the examples in this document and for example may be /dev/ttyS0 or /dev/ttyUSB1.

To quit minicom, first enter Ctrl+a followed by the q key. After that, when the following is displayed, move the cursor to "Yes" and press Enter to quit minicom.

                                   +-----------------------+
                                   | Leave without reset?  |
                                   |     Yes       No      |
                                   +-----------------------+

図3.5 Minicom Quit Confirmation


[ティップ]

Enter Ctrl+a followed by the z key to display minicom's command help.

3.3. Interface Layout

Interface Layout DiagramWhether they are mounted or not depends on the product model.

図3.6 Interface Layout Diagram[7]


表3.4 Interfaces[8]

Part NumberInterface NameFormNotes
CON1Add-on Interface 1Board-to-board connector 60 pin (0.5mm pitch)Connection cycles: 40 times[a]
CON2Add-on Interface 2Board-to-board connector 60 pin (0.5mm pitch)Connection cycles: 40 times[a]
CON4SD InterfaceSD slot 
CON6LAN InterfaceRJ-45 Connector 
CON7USB Host InterfaceType A connector 
CON9Debug Serial InterfacePin header 7 pin (1.25mm pitch)Connection cycles: 40 times[a]
CON10WWAN Expansion InterfaceBoard-to-board connector 30 pin (0.5mm pitch)Connection cycles: 50 times
CON11MicroSIM InterfaceMicroSIM Slot 
CON13RTC Backup Interface 1Battery boxCompatible battery: CR1220 etc
CON14Power Input Interface 1DC jackPlug: Inner diameter 2.1mm, outer diameter 5.5mm
CON15Power Input Interface 2Pin header 2 pin (2mm pitch) 
CON16Power Output InterfacePin header 2 pin (2mm pitch) 
CON173G/LTE Antenna Interface1Small coaxial connectorConnection cycles: 30 times[a]
CON183G/LTE Antenna Interface2Small coaxial connectorConnection cycles: 30 times[a]
CON20WLAN InterfacePCI Express Mini Card connector 
CON22RTC Backup Interface 2Pin header 2 pin (1.25mm pitch)Connection cycles: 20 times[a]
JP1Boot Device Configuration JumperPin header 2 pin (2.54mm pitch) 
SW1User Switch 1Tact switch 
SW2User Switch 2Tact switch 
SW3User Switch 3Tact switch 
SW4Reset SwitchTact switch 
LED1WWAN LEDLED (green, surface mounted) 
LED2User LED2LED (green, surface mounted) 
LED3User LED1LED (green, surface mounted) 
LED4User LED3LED (green, surface mounted) 
LED5User LED4LED (green, surface mounted) 

[8] Whether they are mounted or not depends on the product model.

[a] The connection life cycle count is a guideline at the time of product shipment, and it is not guaranteed to be the actual number of times the connection/disconnection can be performed.


3.4. Connections

The following shows an example of connections between Armadillo-IoT Gateway and peripheral devices.

Armadillo-IoT Gateway Connection Example

1

Armadillo-IoT Gateway

2

AC adapter (12V)[9]

3

Work PC

4

USB serial converter[9]

5

USB2.0 cable (A-miniB type)[9]

6

LAN hub

7

LAN cable

8

USB Memory

9

SD Card

10

MicroSIM card

図3.7 Armadillo-IoT Gateway Connection Example


[警告]

When using the AC adapter, connect the DC plug of the AC adapter to the Armadillo-IoT first and then plug the AC plug into the outlet.Wait at least 3 senconds after replugging power supply.

[警告]

The microSIM interface not support hot swapping.Turning off the power when insert and remove the microSIM card.

3.5. Slide Switch Configuration

The bootloader startup mode can be changed by operating the slide switch of the USB serial converter.

Slide Switch Configuration

1

The bootloader will be in maintenance mode.[10]

2

The bootloader will be in auto boot mode.[11]

図3.8 Slide Switch Configuration


3.6. Using the vi Editor

The vi editor is a text editor that is installed by default on Armadillo. In this document the vi editor is used for editing the Armadillo's configuration files.

Unlike the text editors such as gedit and emacs installed in ATDE, a major feature of the vi editor is that it has operating modes. It has a command mode and an input mode. All characters entered in command mode are treated as commands. In input mode, characters can be entered as text.

Although the command examples shown in this chapter are written to be executed in ATDE, they can be executed on Armadillo in a similar way.

3.6.1. Starting vi

To start vi, enter the following command.

[PC ~]# vi [file]

図3.9 Starting vi


When the path of the filename is specified with file, the file will be edited (and the file will be created if file does not exist). vi starts in the command mode state.

3.6.2. Character Input

To enter characters, it is necessary to switch from command mode to input mode. To make this switch, enter the command shown in 表3.5「Commands to Enter Input Mode」. After entering input mode, characters are input as-is when their key is pressed.

表3.5 Commands to Enter Input Mode

CommandOperation
iStart character input from the place where the cursor is located
aStart character input from after the cursor

To return from the input mode to the command mode, press the ESC key. If you ever lose track of the current mode, just press the ESC key and return to the command mode once to avoid confusion.

[警告]Turning Off Japanese Conversion Functionality

When entering a vi command please turn off the ATDE Japanese input system (Mozc). Turning the Japanese input system on and off can be done with half-width / full-width key.

The starting position of character input when the "i" and "a" commands are entered is shown in 図3.10「Explanation of Commands for Switching to Input Mode」.

Explanation of Commands for Switching to Input Mode

図3.10 Explanation of Commands for Switching to Input Mode


[ティップ]Delete Characters in vi

Depending on the environment of the console, characters may not be deleted when using the BS (Backspace) key, with the "^ H" characters entered instead. In this case, delete characters using the command described in 「Deleting Characters」.

3.6.3. Moving the Cursor

The cursor can be moved with the arrow keys, but it is also possible to move the cursor by entering the commands shown in 表3.6「Commands to Move the Cursor」 in command mode.

表3.6 Commands to Move the Cursor

CommandOperation
hMove one character to the left
jMove one character down
kMove one character up
lMove one character to the right

3.6.4. Deleting Characters

To delete a character, enter the command shown in 表3.7「Commands to Delete Characters」 in command mode.

表3.7 Commands to Delete Characters

CommandOperation
xDelete the character under the cursor
ddDelete the current line

The characters deleted when the "x" and "dd" commands are entered are shown in 図3.11「Explanation of Commands for Deleting Characters」.

Explanation of Commands for Deleting Characters

図3.11 Explanation of Commands for Deleting Characters


3.6.5. Saving and Quitting

The commands for saving the file and quitting are shown in表3.8「Commands for Saving and Quitting」.

表3.8 Commands for Saving and Quitting

CommandOperation
:q!Quit without saving changes
:w [file]Save with the filename specified in file
:wqSave by overwriting the file and then quit

Commands for saving and quitting start with ":" (colon). When entering the ":" key the cursor will move to the bottom of the screen and the entered command will be displayed. After entering the command, press Enter to execute the command.



[4] Specify the Jxf options to expand tar.xz format files.

[5] PUEL (VirtulBox Personal Use and Evaluation License) may be applied up to version 3.x.

[6] It is not possible to log in with the GUI as the privileged user.

[7] Whether they are mounted or not depends on the product model.

[9] Armadillo-IoT Gateway development set accessories

[10] The bootloader command prompt starts.

[11] The operating system automatically boots.