Skip to content

Commit 5046808

Browse files
tp1550tp1550
committedApr 27, 2012
Adding ReadMe and Compile Build Guide
1 parent c75f348 commit 5046808

File tree

2 files changed

+191
-0
lines changed

2 files changed

+191
-0
lines changed
 

‎ARO Compilation and Build Guide.pdf

555 KB
Binary file not shown.

‎README

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
All works distributed in this package are covered by the Apache 2.0 License unless otherwise stated.
2+
3+
Copyright 2012 AT&T Intellectual Property
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
17+
18+
AT&T Application Resource Optimizer contains the following open source libraries or binaries within its distribution package. For more information on any item listed below, please contact developer.program@att.com.
19+
====================================================================
20+
21+
JFreeChart
22+
The AT&T Application Resource Optimizer(ARO) uses Open Source Software that is licensed under the GNU Lesser General Public License (LGPL) version 3 (the "License"), and you may not use this file except in compliance with the License. You may obtain a copy of the Licenses at: http://www.jfree.org/jfreechart/. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
23+
====================================================================
24+
25+
JCommon
26+
The AT&T Application Resource Optimizer(ARO) uses Open Source Software that is licensed under the GNU Lesser General Public License (LGPL) version 2.1 (the "License"), and you may not use this file except in compliance with the License. You may obtain a copy of the Licenses at: http://www.jfree.org/jcommon/. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
27+
====================================================================
28+
29+
FFmpeg
30+
The AT&T Application Resource Optimizer(ARO) uses Open Source Software that is licensed under the GNU Lesser General Public License (LGPL) version 2.1 (the "License"), and you may not use this file except in compliance with the License. You may obtain a copy of the Licenses at: http://ffmpeg.org/download.html. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
31+
====================================================================
32+
33+
TCPDUMP/LIBPCAP
34+
The AT&T Application Resource Optimizer(ARO) uses Open Source Software that is licensed under the following BSD (the "License"), and you may not use this file except in compliance with the License. You may obtain a copy of the Licenses at: http://www.tcpdump.org/#contribute. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.License: BSD Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditionsare met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The names of the authors may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
35+
====================================================================
36+
37+
Android Open Source Project
38+
The AT&T Application Resource Optimizer(ARO) uses Open Source Software that is licensed under the Apache Software License 2.0 (the "License"), and you may not use this file except in compliance with the License. You may obtain a copy of the Licenses at: http://source.android.com/source/licenses.html. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
39+
====================================================================
40+
41+
42+
43+
Application Resource Optimizer (ARO) Open Source Code Package
44+
45+
The AT&T Application Resource Optimizer (ARO) is a diagnostic tool for analyzing mobile web application performance. AT&T ARO allows you to automatically profile an application to optimize performance, make battery utilization more efficient, and reduce network impact.
46+
47+
The ARO Data Collector is the component of the ARO application that captures the data traffic of a mobile device and stores that information in trace files that can be analyzed using the ARO Data Analyzer.
48+
49+
The ARO Data Analyzer is the component of the ARO application that evaluates the trace data collected from an application and generates statistical and analytical results based on recommended best practices.
50+
51+
This Open Source Code Package contains all of the code needed to build both of these ARO components.
52+
53+
54+
AT&T ARO Web Resources:
55+
AT&T Application Resource Optimizer (ARO): http://developer.att.com/ARO
56+
Forum: http://developerboards.att.lithium.com/t5/AT-T-Application-Resource/bd-p/ARO
57+
Blog: http://developerboards.att.lithium.com/t5/AT-T-Developer-Program-Blogs/bg-p/Blogs
58+
FAQ: http://developer.att.com/developer/forward.jsp?passedItemId=10100053
59+
Contact Us: http://developer.att.com/developer/contact_us.jsp
60+
61+
62+
Version:
63+
ARO Data Collector 1.2.1.10
64+
ARO Data Analyzer 1.2.1.10
65+
66+
New Features:
67+
This is the first open source release of ARO.
68+
69+
Known Issues:
70+
This release contains the following known issues.
71+
72+
1. When analyzing trace data collected using the Android Emulator, for which video was recorded, the user input displayed in the chart is not completely in sync with the activity in the video. This makes it difficult to determine which user input in the trace data corresponds to the actions in the video.
73+
74+
75+
Documentation:
76+
ARO Compilation and Build Guide.docx - How to compile and build the ARO components.
77+
ARO Data Collector API Reference - Open index.html in the folder ARODataCollector\docs\api
78+
ARO Data Analyzer API Reference - Open index.html in the folder ARODataAnalyzer\docs\api
79+
80+
81+
Contents:
82+
The ARO Open Source code package contains the following:
83+
84+
ARODataCollector - Main folder for the ARO Data Analyzer open source code.
85+
docs - API reference for the ARO Data Collector (Open docs\api\index.html)
86+
external - Source code for external dependencies: tcpdump and libpcap.
87+
res - Resources for an Android project.
88+
src - Source code for the ARO Data Collector.
89+
AndroidManifest.xml - Manifest file for an Android project.
90+
91+
ARODataAnalyzer - Main folder for the ARO Data Analyzer open source code.
92+
bin - Contains the Jpcap dlls.
93+
c - Contains C code used to build the Jpcap dlls in the bin folder.
94+
docs - API reference for the ARO Data Analyzer. (Open docs\api\index.html)
95+
lib - .jar files for ARO and its dependencies (ddmlib, jcommon, jfreechart, and jmf).
96+
src - Source code for the ARO Data Analyzer.
97+
build.xml - Used to build the .jar file for the ARO Data Analyzer.
98+
99+
ARO Compilation and Build Guide.docx - Detailed information for compiling and building ARO components.
100+
101+
README - This file.
102+
103+
104+
105+
Compiling and Building ARO
106+
The following sections describe the basic steps for compiling and building the ARO Data Collector and ARO Data Analyzer. For more detailed information, see the ARO Compilation and Build Guide.
107+
108+
109+
ARO Data Collector
110+
This section describes how to setup the development environment, and then compile and build the ARO Data Collector into an Android Application Package (APK) using the Android SDK and Apache Ant. The APK file can then be installed on a device via the Android Debug Bridge (ADB).
111+
112+
Note: In order for the ARO Data Collector to be fully functional, it must be installed on a rooted device.
113+
114+
115+
Setup the Development Environment:
116+
117+
Step 1: Download and setup the Android SDK. Go to the Android Developers website http://developer.android.com/sdk/index.html, download the Android package for your platform, and follow the steps to setup the Android SDK.
118+
119+
Step 2: Add additional components. Follow the installation instructions at http://developer.android.com/sdk/installing.html, especially the step: Adding Platforms and Other Components.
120+
121+
Step 3: Download Apache ANT. Go to http://ant.apache.org and follow the download instructions.
122+
123+
124+
Compile and Build the ARO Data Collector:
125+
126+
Step 1: Checkout the ARO Data Collector source code from the ARODataCollector folder to a local folder.
127+
128+
Step 2: Update the project.properties to match your local configuration and generate a build.xml by using the following command syntax:
129+
130+
android update project --name <project_name> --target <target_ID> --path <path_to_your_project>
131+
132+
Note: ARO Data Collector supports Android 2.1 and above, so the target id should be set to a value greater than 2.1. In the following example, it is set to 7.
133+
134+
android update project --name ARODataCollector --target 7 --path ../ARODataCollector
135+
136+
Step 3: Build the ARO Data Collector project for debug using the command "ant debug", or for release using the command "ant release".
137+
138+
Step 4: Transfer the ARO Data Collector APK file to a rooted device using the ADB, with the command: "adb aro"
139+
140+
141+
142+
ARO Data Analyzer
143+
To build the ARO Data Analyzer, follow these steps to setup the development environment for your OS and compile and build the code.
144+
145+
Note: A build of the ARO Data Analyzer application (aro.jar) is included in the ARODataAnalyzer\lib directory.
146+
147+
Windows
148+
The system requirements for compiling, building, and running the ARO Data Analyzer on the Windows OS are:
149+
150+
A computer running Windows XP, Windows Vista, or Windows Seven.
151+
152+
At least 1GB of RAM.
153+
154+
Java Runtime Environment (JRE) version 1.6 or greater is required to run the
155+
ARO Data Analyzer. To compile and build the ARO Data Analyzer in the same
156+
environment, install the Java Development Kit (JDK) version 1.6 or greater
157+
which includes the JRE.
158+
159+
WinPcap, the "industry-standard windows packet capture library".
160+
161+
ANT, An Apache Java build tool.
162+
163+
Note: If needed, configure the JAVA_HOME system variable so that it points to your Java installation directory. This can be done in the Advanced tab of System Properties, by editing the Environment Variables.
164+
165+
Mac
166+
The system requirements for compiling, building, and running the ARO Data Analyzer on the Mac OS are:
167+
168+
A computer running Mac OS X 10.6 and above.
169+
170+
At least 1GB of RAM.
171+
172+
Java Runtime Environment (JRE) version 1.6 or greater is required to run the
173+
ARO Data Analyzer. To compile and build the ARO Data Analyzer in the same
174+
environment, install the Java Development Kit (JDK) version 1.6 or greater
175+
which includes the JRE.
176+
177+
ANT, An Apache Java build tool.
178+
179+
180+
Compile and Build the ARO Data Analyzer
181+
To compile and build the open source ARO Data Analyzer code for Java, do the following:
182+
183+
Checkout the ARO Data Analyzer source code including the build.xml file, from the ARODataAnalyzer folder to a local folder, and use ANT to compile and build the application.
184+
185+
The build.xml file builds the .jar file that contains the compiled classes for the ARO Data Analyzer.
186+
187+
The files aro.bat and aro are included in the ARODataAnalyzer\lib directory of the ARO Open Source Package to help you run the .jar file with default run settings:
188+
189+
To launch the .jar file in the Windows OS, run aro.bat from the command line.
190+
191+
To launch the .jar file in the Mac OS, run aro.

0 commit comments

Comments
 (0)
Please sign in to comment.