installing the oatedge edge controller -...

24
OATedge Controller Installation Guide Version 7.2 OATSystems, Inc. May 2010 Document Number: OATedge_Controller_IG_7.2

Upload: others

Post on 25-Jun-2020

13 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide

Version 7.2 OATSystems, Inc.

May 2010 Document Number: OATedge_Controller_IG_7.2

Page 2: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide

Copyright © 2010 OATSystems Inc. All Rights Reserved.

This document contains proprietary information that is owned by OATSystems. Copying or reproduction

of any material either in part or full from this document to any other location for further reproduction or

redistribution is expressly prohibited. Any reproduction or redistribution of the files not in accordance

with the terms of the License Statement is a violation of copyright law.

OAT and Senseware are registered trademarks of OATSystems, Inc.

Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the

United States and other countries. OATSystems is independent of Sun Microsystems, Inc.

IBM is a registered trademark of International Business Machines Corporation.

Linux is a registered trademark of Linus Torvalds.

MicroStrategy 8, MicroStrategy Intelligence Server, MicroStrategy Web Universal, and MicroStrategy

Desktop are registered trademarks or trademarks of MicroStrategy Incorporated.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the

United States and/or other countries.

All other trade names and trademarks are the property of their respective owners.

OATSystems makes no warranties, express or implied, with regards to its products in this document.

Support Information

You can contact the OAT Support Center (OSC) for technical support at

OATSystems, Inc.

309 Waverley Oaks Road, Suite 306

Waltham, MA 02452

USA

Phone: 877-OAT-SUPPORT or 781-907-6081

Fax: 781-907-6098

Email: [email protected]

Web site: https://support.oatsystems.com

Page 3: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide

Table of Contents Chapter 1 Introduction ......................................................... 4

1.1 Features .........................................................................................4

1.2 Specifications ..................................................................................4

1.3 Pre-installation Requirements ..............................................................5

Chapter 2 Installation of OATedge Controller ............................. 7

2. 1 Installation using User Interface ............................................................7

2.1.1 OATxpress Information for this Install Session ...........................................9

2.1.2 OATedge Controller-Specific Information .................................................10

2. 2 Installation using Command Line ...........................................................12

Chapter 3 OATedge Controller Setup Verification ........................ 15

3. 1 Installation Verification ......................................................................15

3. 2 Status Verification ............................................................................15

3. 3 Hardware Verification ........................................................................16

3. 4 Upgrading OATedge Controller on Arcom Zeus ...........................................18

3. 5 Adding OATedge Controller to OATxpress .................................................19

Chapter 4 Accessing the Administration Page ............................. 20

4. 1 The OATedge Controller Properties ........................................................21

4.1.1 General ..........................................................................................22

4.1.2 Log Settings.....................................................................................23

4. 2 Deployed Scenarios ...........................................................................23

4. 3 View Logs .......................................................................................24

Page 4: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide 4

Chapter 1 Introduction

This guide describes the installation of OATedge Controller software on both the Arcom Zeus and Linux

device. Installation can be done using the command line or the user interface.

1.1 Features The Arcom Zeus and Linux device are supported target platforms for OATedge Controller installations.

The features of Arcom Zeus and Linux device are as follows:

Arcom Zeus is a single-board computer, based on Intel's 520 MHz processor. For OATedge Controller

usage, it is typically deployed in an Industrial Compact Enclosure (ICE) configuration, outfitted with

64MB flash memory, and at least 128MB RAM. For more information, see http://www.arcom.com/pxa270-

xscale-zeus.htm

Arcom Zeus can be provisioned for Digital IO. The Arcom AIM-104/Relay-8 device provides opto-

isolated circuitry for controlling up to 8 on-off output points (for example, lights), and processing changes

in the state of up to 8 input signals (for example, switches or sensors). These device features are

frequently used for control and provide feedback on deployed RFID solutions.

Linux device as OATedge Controller is deployed with the standard Linux configuration. Linux device

has no provision for Digital IO, though external Digital IO device can be added to the Linux device.

1.2 Specifications The required specifications in Arcom Zeus and Linux Device for the use of OATedge Controller are as

follows:

1.2.1 Arcom Zeus

Hardware Specifications CPU: Intel PXA270 RISC-based processor, 520 MHz

RAM: 128 MB (specific application requirements may raise this to 256MB)

Permanent Storage: 64 MB flash memory for file system

Other: One AIM Relay8 Digital IO device integrated

Typical: Cabling for light stack and input sensors or switches

Page 5: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Introduction

OATedge Controller Installation Guide 5

Software Specifications Arcom Embedded Linux (AEL). Latest rev. is “2.6.16.28-arcom2-1-zeus #7”

IBM J9 JRE rev. IVE 2.3 with jclMax J2ME profile (installed in /opt/wece6.1)

Additional jars required (in /opt/wece6.1/lib/jclMax/ext):

o dom.jar, jaxp-api.jar, sax.jar, xercesImpl.jar (JAXP 1.3.2 jars from java.net)

o aim104.jar (from Arcom)

NOTE: Patches are separately available from OAT Systems.

1.2.2 Linux Device

Hardware Specifications Standard Linux Hardware Configuration.

Software Specifications Linux device

o Redhat Linux 4.0 AS and ES

o Linux Core 2.6

Sun JDK 1.6

1.3 Pre-installation Requirements Ensure that the following information is available before installation of either Arcom Zeus or Linux

device:

An OATedge ID for the new OATedge Controller.

NOTE: The new OATedge ID should be unique among your network of OAT servers and

OATedge Controllers. If an OATedge Controller configuration does not already exist for this

OATedge ID in the OATxpress server database, then it will be necessary to first create this

configuration using the OAT Enterprise Administrator Web UI (or the OATxpress server Web

UI).

The IP address of the OATxpress server to which this OATedge Controller is being assigned.

The port number for the web application on the OATxpress server.

The IP address for the OATedge controller hardware, whether already configured on the Arcom

Zeus/ Linux device, or assigned for configuration during this setup.

The root or superuser account password on the Arcom Zeus/Linux device.

If the network has not been setup on the Arcom Zeus, then a null-modem serial cable and

terminal emulation software is needed for initial access to the Arcom Zeus and Linux

Page 6: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Introduction

OATedge Controller Installation Guide 6

environment for network setup. In the case of Linux device, the network configuration can be

setup by logging in to the device directly.

Ensure the date and time in OATedge Controller is set same as the server in which OAT

Foundation Suite is running. To set the date and Time in OATedge Controller, in the command

prompt type for example:

date 11181527.00

Where the date is set to "Wed Nov 18 15:27:00 IST 2010" using the format

"MMDDhhmm[[CC]YY][.ss]"

NOTE: The rest of this document assumes that a usable network configuration has already been established for the

Arcom Zeus/ Linux device and Linux platform. These instructions are also available through OAT System support.

Page 7: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide 7

Chapter 2 Installation of OATedge Controller

Installation of OATedge Controller can be done on Arcom Zeus and Linux device in one of following

ways:

Installation using User Interface

Installation using Command Line

2. 1 Installation using User Interface Steps to install the OATedge Controller using the User Interface are as follows:

1. Login to OATxpress server.

NOTE: It is also possible to obtain an OATedge Controller installation page through the OAT Enterprise

Administrator User Interface, if available. For more information, refer to the OAT Enterprise User Guide.

Figure 1 : Login Screen

2. Enter a valid username and password with administrative privileges. Click Log In to display the

Configuration page.

Page 8: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 8

Figure 2 : Configuration Menu

3. Click OATedge Controllers icon to display a list of OATedge Controllers.

Figure 3 : OATedge Controllers List

Page 9: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 9

4. Click Install OATedge Controllers link to display the Install OATedge Controllers page.

Figure 4 : Install OATedge Controllers Page

5. Fill in the required details in the text fields as explained below. Those marked with an asterisk are

mandatory fields.

2.1.1 OATxpress Information for this Install Session

Parameter Description

IP Address Enter the IP address of the OATxpress server to which

the OATedge Controller(s) is being installed in this

session.

NOTE: When installing OATedge Controllers from the OAT

Enterprise Administrator User Interface, the IP address

should be of the OATxpress server specifically assigned for

this set of OATedge Controllers and not the IP address of

OAT Enterprise Administrator server.

Port number Enter the port number for the Web application on the

OATxpress server to which the OATedge Controller(s)

installed will be assigned.

Server Port for Bridge/ Messaging System Enter the port number of the messaging communication

system running on the OATxpress server. It allows

communication between OATedge Controllers and the

OATxpress server. The default Server Port for

Bridge/Messaging System is 1884 for Arcom Zeus, and

for Linux device it is 61616.

Page 10: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 10

2.1.2 OATedge Controller-Specific Information

Parameter Description

OATedge ID Enter a unique numeric identifier of 4 or 5 digit number

for the new OATedge Controller, for example, 0001

IP Address Enter the IP address of the OATedge Controller host.

Platform Select Arcom or Linux.

Login ID Enter “root”- for the Arcom platform.

Enter an appropriate login ID - for a generic Linux

installation.

Password Enter the password.

Local Port for Bridge/ Messaging System Enter the port number of the messaging communication

system running on the OATxpress server allows

communication between the OATedge Controller and

OATxpress server. For Arcom Zeus it is 1884 and for

Linux device it is 61616.

Device Agent Model Select one of the following Device Kits to install:

ArcomDio

None

NOTE: Choose “Arcom Dio”to install on an Arcom Zeus

specifically set up with the Arcom AIM-104 Relay-8 Digital

IO device.

Device Kit is an Open Source project hosted by

Eclipse.org, which provides a software framework for

integrating RFID devices into OSGi-based RFID

software applications and frameworks such as the

OATedge Controller.

NOTE: This parameter is not applicable for Linux device

installations.

Copy Location Enter the temporary storage location on the Arcom

Zeus or Linux device where the installer archive is

copied before extraction and installation. The default is

/tmp.

Install Location (optional) Enter the location where OATedge Controller files are

installed on the target platform.

Page 11: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 11

Parameter Description

NOTE: This is set internally to “/opt” for Arcom Zeus, and

the same directory as Copy Location for Linux device if left

empty.

Binary Version (optional) Select from the dropdown list of installable image

versions.

6. Click Add to display the following screen:

Figure 5 : Location Information

7. Click Install for the following screen.

Figure 6 : Installation Result

On completion of installation, the Result column displays the success or failure of the installation.

Page 12: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 12

2. 2 Installation using Command Line The Arcom Zeus and Linux device has an “sshd” service available when it is running Linux as the

operating system. You can use SSH (Secure Shell) client utilities to copy files onto the device, as well as to

obtain a command interpreter shell on the device. Available SSH clients for Windows include:

PuTTY (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)

A Cygwin-based SSH client (http://pigtail.net/LRP/printsrv/cygwin-ssh.html and

http://www.udel.edu/topics/connect/sw/exceed/docs/cygwin.html offer instructions on how to

install the SSH client utilities).

Steps to install the OATedge Controller using the command-line are as follows:

1. Copy the installer archive oatNano_Arcom.tar.gz to a temporary folder on the Arcom Zeus

device. The screen displays the use of the scp utility to copy the installer archive from a folder on

a Windows system to the /tmp folder on the Arcom Zeus device.

NOTE: For Linux device copy the installer archive oatNano_Linux_AMQ.tar.gz to a temporary folder on

the Linux device. The scp (secure copy) utility is a part of the SSH client utilities.

If you are using PuTTY, the secure copy utility is named pscp.exe.

NOTE: The screenshot uses a Cygwin SSH client on a Windows system.

Figure 7 : Copy installer file to the Arcom box

2. Open a command interpreter shell as root (the superuser) on the Arcom Zeus/ Linux device,

using the SSH client. (Substitute 172.17.0.172 with the actual IP address of your Arcom Zeus/

Linux device on your network).

ssh [email protected]

3. You will be prompted to enter the password for the root user. Enter the valid password to get a

root shell on the Arcom Zeus/ Linux device.

4. Change your working directory to the directory in which the installer archive is copied:

cd /tmp

5. Extract the contents of the installer archive:

tar –zxvf oatNano_Arcom.tar.gz

NOTE: In case of Linux Device, extract the contents of the installer archive:

tar –zxvf oatNano_Linux_AMQ.tar.gz

Extracting the contents of the archive creates a new sub-directory called oatInstall. This contains

the files required for installation.

Page 13: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 13

Figure 8 : Extract the contents of the installer archive

6. Change your working directory to the newly created oatInstall directory:

cd oatInstall

7. To install the OATedge Controller use the following installation script:

./install.sh -c ${DISK_AGENT_TYPE} -Ml ${MB_LOCAL_PORT} -Ms

${MB_SERVER_PORT} ${OATedge_ID} ${SITESERVER_IP} ${SITESERVER_PORT}

Ensure that you choose a different port for the OATedge Controller if OATxpress is installed on

the same machine. This would create port conflict.

NOTE:

The leading “./” is required to specify, that the install.sh file in the current directory is to be

executed.

The –c parameter (DISK_AGENT_TYPE) allows you to choose whether to set up a Device Kit

profile for the Arcom Digital IO device, which works on the Arcom Zeus platform.

<MB_LOCAL_PORT> is the message broker local port.

<MB_SERVER_PORT> is the message broker OATxpress port.

<OATedge ID> is the OAT Arcom Zeus and Linux device. For Arcom Digital IO continue with

the steps listed below.

8. If you are installing on an Arcom Zeus, specifically set up with the Arcom AIM-104 Relay-8

Digital IO hardware and drivers, enter the parameter as:

-c arcomdio

You can also explicitly select the default configuration

-c none

For example:

./install.sh –c none 1000 172.17.0.214 7777

Figure 9 : OATedge controller installation progress

Page 14: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Installation of OATedge Controller

OATedge Controller Installation Guide 14

The installer will install the OATedge Controller files onto the file system.

Figure 10 : OATedge controller installation completion

When the installation is complete, the installer displays a message.

NOTE: To verify the success of your installation, you can check the contents of the /opt folder. It should

now contain a new oat sub-directory, which contains the files required to run the OATedge Controller.

9. Since the Arcom Zeus device has limited storage, after a successful installation remove the

temporary files created during installation.

cd /tmp

rm -rf oat*

NOTE: Not required if using Linux device.

10. Edit the following file to set the actual device name:

file /opt/oat/osgi/DeviceAgentConfig.xml

Edit this file, and replace the initial placeholder value GPIO_DEV_NAME with the actual device

name given to the device in the OATxpress Configuration User Interface (this configuration

should already have been done): cd /opt/oat/osgi

Use either vi or nano (on the Zeus), or the editor built into WinSCP3, to edit the following file:

DeviceAgentConfig.xml.

NOTE: OATedge Controller to be used with the Arcom Digital IO device has to be set up either during

installation, or later by using the setup.sh command.

11. Replace every occurrence of the text GPIO_DEV_NAME (or the previous device name, if this is a

rename) with the actual name given to this device. There are 15 occurrences in this file.

Perform the following platform verification steps:

Use the test_profile.sh command to verify that the library pre-requisites for Arcom Digital IO are

present.

After testing the library pre-requisites, use the test_relays.sh command to verify that the

hardware is set up correctly.

NOTE: See Hardware Verification for more information about setup.sh and the other utility commands mentioned

in this section.

Page 15: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide 15

Chapter 3 OATedge Controller Setup Verification

To verify the OATedge Controller setup, after opening a superuser (root) command interpreter shell on

the device (using SSH as described at the beginning of the command-line installation procedure), perform

the following tasks:

Installation Verification

Status Verification

Hardware Verification

3. 1 Installation Verification Verify the contents of the OATedgeConfig.xml file in the /opt/oat/osgi folder. If certain settings were not

supplied during the installation procedure, or were incorrectly specified, you can edit this file to correct

the settings. The critical settings to verify are:

edge.id

edge.premises.ip

edge.premises.port

3. 2 Status Verification You can control the OATedge Controller service or check its status by issuing the following commands:

Command Action

cd /opt/oat/osgi

./oatedge start

Starts the OATedge Controller software (starts the OSGi

runtime).

Though OSGi runs in the background, log output is still

provided to the console used to issue this command.

cd /opt/oat/osgi

./oatedge stop

Stops the OATedge Controller (stops OSGi).

cd /opt/oat/osgi

./oatedge restart

Restarts the OATedge Controller (stops, then restarts OSGi)

cd /opt/oat/osgi

./oatedge is running

Prints a message telling you if the service is running.

cd /opt/oat/osgi Enables autorun, which means the OATedge Controller will be

started as a background process, automatically, when the

Page 16: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Setup Verification

OATedge Controller Installation Guide 16

Command Action

./oatedge enableautorun platform is rebooted.

cd /opt/oat/osgi

./oatedge disableautorun

Disables autorun, so that on subsequent platform reboots the

OATedge Controller software will not automatically be started

as a background process.

cd /opt/oat/osgi

./oatedge testautorun

Prints an indication of whether autorun is enabled or disabled.

3. 3 Hardware Verification Several tools are provided for validating the configuration of the OATedge Controller platform, and, in

particular, to test hardware integrated with the Arcom Digital IO drivers, before attempting to use the

drivers in the running OATedge Controller application. These tools are described below:

Command Action

cd /opt/oat/bin

./test_profile.sh

Tests if the JVM and libraries profile are correctly set up. A

successful test should produce output like the following:

root@zeus2 bin# ./test_profile.sh

J9 v2.3 in expected location:

/opt/wece6.1/bin/j9 --OK

jclMax is the installed profile. Testing

profile...

Success!!!

Checking for additional installed

components...

aim-104 jar is correctly installed --OK

root@zeus2 bin#

NOTE: This test performs a rudimentary check on the aim-104.jar

file, necessary for using the Arcom Digital IO device with the

OATedge Controller software.

This feature is not available for the Linux device.

cd /opt/oat/bin

./test_relays.sh

Tests if the Arcom Digital IO is correctly set up (to test that the

hardware and software for Arcom Digital IO is correctly set

up, after verifying the presence of the aim-104.jar file using the

JVM test above). When the test starts, watch the output

hardware (light stack, diodes, etc.), each of which should flash

in turn. As each output point is flashed, a status line like

“Relay status = 0x1” is printed.

After all output points have been flashed once each, the script

Page 17: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Setup Verification

OATedge Controller Installation Guide 17

Command Action

continuously reads from inputs until the script is terminated

with a Ctrl-C key press. If an input pin is triggered during

this time, the displayed value changes, indicating that the

state change has been "seen." A correct test should produce

output like the following:

root@zeus2 bin# ./test_relays.sh

Starting Relay8 Test

Relay status = 0x1

Relay status = 0x2

Relay status = 0x4

Relay status = 0x8

Relay status = 0x10

Relay status = 0x20

Relay status = 0x40

Relay status = 0x80

Inputs(0x180) = 0x2 [Pin 1 high]

Inputs(0x180) = 0x2

Inputs(0x180) = 0x2

Inputs(0x180) = 0x2

Inputs(0x180) = 0x0 [Motion detected, Pin 1

goes low]

Inputs(0x180) = 0x0

Inputs(0x180) = 0x0

Inputs(0x180) = 0x0

Inputs(0x180) = 0x0

Inputs(0x180) = 0x0

Inputs(0x180) = 0x2 [Pin 1 goes high again]

Inputs(0x180) = 0x2

Inputs(0x180) = 0x2

Inputs(0x180) = 0x2 [Ctrl-C pressed here]

At the level of the AIM-104/Relay8 Linux driver (exercised by

this test), the input (and output) pin settings are read (or

written to) by performing binary I/O directly on the character-

based file /dev/arcom/aim104/relay8/0. The test script

repeatedly samples the instantaneous values of the input pins

by reading a byte from this file. The values displayed are hex

values, representing the aggregate settings of all 8 input pins.

The example shows 1 motion sensor on Pin 1, which is wired

Page 18: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Setup Verification

OATedge Controller Installation Guide 18

Command Action

to be high by default (i.e. in its untriggered state the

connection is closed), and transition to low (connection open)

when sensing an object's presence:

NOTE: This is not supported for Linux.

cd /opt/oat/osgi

./setup.sh <CONFIG>

Switches configuration to the one specified by <CONFIG>.

Available choices are “none” or “arcomdio.” Edits to the

properties files applicable to the current configuration is

preserved, so they can be re-used later if necessary.

NOTE: This is not supported for Linux.

3. 4 Upgrading OATedge Controller on Arcom Zeus

To upgrade the OATedge Controller on Arcom Zeus follow the steps listed below:

Backup the following files before upgrading:

/opt/oat/osgi/configuration/config.ini

/opt/oat/osgi/DeviceAgentConfig.xml

/opt/oat/osgi/EdgeConfig.properties

/opt/oat/osgi/savant.properties

/opt/oat/osgi/startosgi

Follow the Arcom Zeus installation. Refer to Installation using User Interface or Installation using

Command Line for details.

After successful installation, restore all the backed up files to their original location except for the

following:

/opt/oat/osgi/startosgi.

Edit the new /opt/oat/osgi/startosgi file and update the following parameters from the backup

startosgi file:

o LOCAL_PORT

o REMOTE_PORT

Page 19: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Setup Verification

OATedge Controller Installation Guide 19

3. 5 Adding OATedge Controller to OATxpress The following screen displays a sample Add/Edit OATedge Controller Page:

Figure 11 : Add/Edit OATedge Controller

Fill in the required details in the text fields as explained below. Those marked with an asterisk are

mandatory fields.

Parameter Description

OATedge Controller Name Name given to the OATedge Controller installation.

IP Address IP address of the Arcom Zeus/ Linux device.

Port Number HTTP port number of the OATedge Controller on the Arcom

Zeus/ Linux device.

Server that Controller connected to OATedge Controller ID on OATxpress.

OATedge Controller ID ID of the OATedge Controller used in the OATedge

Controller installation.

Page 20: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

OATedge Controller Installation Guide 20

Chapter 4 Accessing the Administration Page

There are two ways to access the Administration page of an OATedge Controller:

Navigate to the OATedge Controller from the OATxpress server.

NOTE: The identity of the user is the same on OATedge Controller as the OATxpress server.

Log in directly to the OATedge Controller Administration User Interface.

NOTE: The username and password must be independently entered in the OATedge Controller Login

User Interface, and the OATedge Controller validates the login credentials with the OATxpress.

Figure 12 : Login Page

The screenshot above displays the login screen for the OATedge Controller's User Interface.

Enter a Username and Password valid for OATxpress server to successfully log in. The OATedge

Controller's Administration page is displayed, as shown below:

Page 21: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Accessing the Administration Page

OATedge Controller Installation Guide 21

Figure 13 : Administration Menu

Options in the Administration page are explained in the following pages:

4. 1 The OATedge Controller Properties

The following screen displays a sample of the OATedge Controller Properties page.

Figure 14 : OATedge Controller Properties

Page 22: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Accessing the Administration Page

OATedge Controller Installation Guide 22

Configuration of the General and Log Settings of OATedge Control Properties are as follows:

4.1.1 General

The basic OATedge Controller properties can be maintained through the Web Admin user interface, if

necessary.

Parameter Description

OATedge Controller ID Enter a numeric identifier for this OAT Controller. This

id should match the one created in the installation and

add OATedge Controller step

Server IP address or host name Enter the IP address of OATxpress server to which the

OATedge Controller is assigned.

Server Port Number Enter the port number for the web application on the

OATxpress server to which this OATedge Controller is

assigned.

Enable Auto Start Select Yes - for the OATedge Controller software to be

started automatically when the host platform is

powered on or rebooted.

Enable EPC Forwarding Select Yes – for RFID tags inventoried by any reader

device that is assigned to this OATedge Controller, to

be forwarded and logged in the OATxpress server

database.

Restart Now Click this button to initiate restart of the OATedge

Controller software. This causes the OSGi runtime to be

restarted.

NOTE: This does not reboot the Linux platform.

It may be necessary to restart the OATedge Controller for the following reasons if you have:

Changed the OATedge ID for the controller.

Assigned the OATedge Controller to a different OATxpress server.

Changed the device configuration for the OATedge Controller (using the OATxpress server User

Interface).

Deployed a new device to the OATedge controller.

Downloaded a new or updated custom component onto the OATedge Controller (for example,

scenario primitives or User Interface components, or a device support bundle).

Page 23: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Accessing the Administration Page

OATedge Controller Installation Guide 23

4.1.2 Log Settings

The OATedge Controller can be configured to forward log entries to the OATxpress server, for storage

and offline access. Each OATedge Controller gets a separate log file on the OATxpress server, with a

name such as:

ofs/log/edges/edge.<edgeid

NOTE: <edgeid> is the OATedge ID of the respective OATedge Controller whose log output is stored in that file.

On the OATxpress server, the log4j settings can be modified to control the maximum number of

OATedge Controller log files, and the maximum size to which each file can grow.

The Log Settings section on the OATedge Controller Properties page has the following settings:

Parameter Description

Console Logging Threshold Select from the dropdown list, the threshold severity

level of log entries to be posted to a console window, if

one is in use for this OATedge Controller (typically

ignored, since the OATedge Controller will be running

as a background process on the host platform).

Buffer Logging Threshold Select from the dropdown list, the threshold severity

level of log retained in the memory, circular logging

buffer.

Buffer Size Enter the maximum number of log entries to be

retained in memory, in a circular buffer. This is the

number of entries that can be paged through using the

online log viewer, or downloaded to a file from the

Logging User Interface..

Forwarder Logging Threshold Select from the dropdown list, the threshold severity

level of log messages to be forwarded to the server (if

log message forwarding is not disabled).

Disable log message forwarding Deselect this box to forward the log messages to

OATxpress server for logging to a file. This can impact

the performance, especially if there are many OATedge

Controllers associated with a given OATxpress server.

Selected as default - to disable forwarding.

4. 2 Deployed Scenarios

The screen below displays the lists of deployed scenario processes on the OATedge Controller:

Page 24: Installing the OATedge Edge Controller - OATSystemssupport.oatsystems.com/training/oat70_docs/7.2/EdgeController/OA… · OATedge Controller Installation Guide 10 2.1.2 OATedge Controller-Specific

Accessing the Administration Page

OATedge Controller Installation Guide 24

Figure 15 : Deployed Scenario Processes

4. 3 View Logs

The OATedge Controller's internal logging buffer displays the efficiency and responsiveness of OATedge

Controllers. The logs can be refreshed to get the latest information. The internal logging buffer is

available online, which can be downloaded for offline viewing, support purposes etc. The screen below

displays a sample of the Log Messages.

Figure 16 : Log Messages

This completes installation for the OATedge Controller. For more details refer to the OAT Foundation

Suite Installation and Configuration Guide.