iInstruments App - Amazon Web Services
17
USER’S MANUAL iInstruments App Turnkey Instruments Ltd. August, 2018
Transcript of iInstruments App - Amazon Web Services
User’s Manual Page ii
User’s Manual
Authorization Memorandum
I have carefully assessed the User’s Manual for iInstruments App. This document has been completed in
accordance with the requirements of the Turnkey Instruments Development Methodology.
MANAGEMENT CERTIFICATION - Please check the appropriate statement.
______ The document is accepted.
______ The document is accepted pending the changes noted.
______ The document is not accepted.
We fully accept the changes as needed improvements and authorize initiation of work to proceed. Based
on our authority and judgment, the continued operation of this system is authorized.
_______________________________ _____________________
Mike Leck DATE
Managing Director
_______________________________ _____________________
Dave Brooks DATE
General Manager
_______________________________ _____________________
Alan Taylor DATE
Director
User’s Manual Page iii
USER'S MANUAL
TABLE OF CONTENTS
Page #
1.0 GENERAL INFORMATION ............................................................................................................ 1
1.1 iInstruments Overview ................................................................................................................. 1
1.2 Authorized Use Permission ......................................................................................................... 1
1.3 Points of Contact ......................................................................................................................... 1 1.3.1 Information/Help Desk .......................................................................................................................... 1
1.4 Organization of the Manual ........................................................................................................ 1
2.0 SYSTEM SUMMARY ....................................................................................................................... 2
2.1 System Architecture ..................................................................................................................... 2
2.2 Data Flows .................................................................................................................................. 2
2.3 User Access ................................................................................................................................. 2
2.4 Contingencies and Alternate Modes of Operation ...................................................................... 2
3.0 GETTING STARTED ....................................................................................................................... 4
3.1 Main Panel .................................................................................................................................. 4
4.0 USING iINSTRUMENTS APP ......................................................................................................... 8
4.1 Wi-Fi Connection ........................................................................................................................ 8
4.2 Add Instrument ............................................................................................................................ 8
4.3 Download Data ........................................................................................................................... 9
4.4 Live Data ................................................................................................................................... 10
4.5 Visualise Data ........................................................................................................................... 10
4.6 Export Data ............................................................................................................................... 11
4.7 Operations ................................................................................................................................. 12
4.8 Configuration ........................................................................................................................... 13
4.9 App Settings ............................................................................................................................... 14
4.10 Exit ............................................................................................................................................. 14
4.11 Caveats and Exceptions............................................................................................................. 14
1.0 General Information
User’s Manual
1.0 GENERAL INFORMATION
1.0 General Information
User’s Manual
1.0 GENERAL INFORMATION
1.1 iInstruments Overview
iInstruments app lets you control the Turnkey's instruments including iGAS, iVIBE, iDB, iDUST, iMET,
Osiris, Topas, DustMate over the Wi-Fi. You can download the data from the instruments, change the
instrument configurations, start/stop sampling, monitor live data readings and perform other operations.
The app also allows you to visualize the data in dynamic charts. You can also synchronize your local data
with cloud database to visualize data on the web and generate reports etc. (under development).
1.2 Authorized Use Permission
Usage of this software is limited to its owner via the terms of its development. iInstruments is wholly
owned by Turnkey Instruments Ltd. and may not be updated or amended without their express consent.
1.3 Points of Contact
1.3.1 Information/Help Desk
For additional information and/or support, Turnkey Instruments Ltd. can be contacted via email
[email protected] or phone (+44) 1606 330020.
1.4 Organization of the Manual
Section 2 describes the system architecture of the application including the data flow. Section 3 explains
the main panel of the application. Section 4 gives details on how to use the application with the help of
screenshots.
2.0 System Summary
User’s Manual
2.0 SYSTEM SUMMARY
2.0 System Summary
User’s Manual
2.0 SYSTEM SUMMARY
iInstruments App connects to the Turnkey instruments via Wi-Fi to collect data from the instruments.
The application can also be used to upload data to the cloud database and visualise the historic data from
the cloud database.
2.1 System Architecture
Figure 2.1
2.2 Data Flows
The above diagram shows how iInstruments App interacts with Turnkey instruments and the central data
centre. The data flow in the architecture is as follows:
1. The application shows the options on the main menu.
2. Once an option is selected, the application shows the list of the registered instruments in the app.
3. It starts wireless communication with the Turnkey iInstruments to collect data.
4. iInstruments App stores the data in a database locally in the mobile device.
5. (Optionally) It can upload the collected data to the cloud database.
2.3 User Access
You must have a instruments secret key and Wi-Fi access to add the iInstrument to the app and if you
don’t already have the key or Wi-Fi details, please contact support via email to techsupport@turnkey-
instruments.com
2.4 Contingencies and Alternate Modes of Operation
In case the app crashes, please check the log.txt file in your device’s local storage
(‘/storage/emulated/0/iInstruments/log.txt’) and try to resolve the issue. If you are unable to resolve the
issue, please contact support via email at [email protected]
3.0 Getting Started
User’s Manual
3.0 GETTING STARTED
3.0 Getting Started
User’s Manual
3.0 GETTING STARTED
3.1 Main Panel
Once you have installed the app successfully, the app shows the main panel when you open the app. This
screen has the main features available in the app as shown in the figure below. Each option is explained
in detail in section 4.
Figure 3.1
The app asks for permissions including file write access and location access. Please allow access as they
are mandatory for the app to work properly.
4.0 Using iInstruments App
User’s Manual
4.0 USING iINSTRUMENTS APP
4.0 Using iInstruments App
User’s Manual
4.0 USING iINSTRUMENTS APP
This section explains all the main panel options in detail with the help of screenshots.
4.1 Wi-Fi Connection
If the instrument does not have a SIM card or public IP SIM card, you need to connect to the instruments
Wi-Fi to communicate with the instrument.
Please go to your Android devices Settings > Connections > Wi-Fi > Select instruments Wi-F and enter
password to connect.
If you are unsure about the instruments Wi-Fi name or password, please contact Turnkey at
4.2 Add Instrument
Before you add an instrument, please make sure you have the secret key for the instrument, if you are
unsure contact Turnkey support.
1. Select the instrument from the
drop-down menu.
2. Enter the last 4 digits of the
instrument ID (instrument ID can
be found inside the power portal or
from the paper work).
3. If you are using instruments Wi-Fi,
please enter 192.168.1.115,
otherwise enter the provided public
IP.
4. Press Get Current Location button
to automatically get the location or
enter the location manually.
5. Press Add Instrument button.
6. Once the connection is established
with the instrument, a pop window
will appear to authenticate that you
have the right to connect to the
instrument, please enter the secret
key for the instrument.
Figure 4.1
Once the correct key is provided, the instrument will be added to the database, you can now communicate
with the instrument.
4.0 Using iInstruments App
User’s Manual
4.3 Download Data
If you want to download data from the instrument,
1. Select Download Data option from the Main Menu.
2. Select the instrument from the list.
3. Select Download Data and select Yes when the pop-up message appears.
If the connection is established with the instrument, this will start download data process and show the
progress in text box below.
Figure 4.2
4.0 Using iInstruments App
User’s Manual
4.4 Live Data
If you want to view live data from the instrument,
1. Select Live Data option from the Main Menu.
2. Select the instrument from the list and select Yes from the pop-up message.
If the connection is established, this will collect instrument configuration and
start live data monitoring. You will have multiple tabs on the screen to show data tables and line charts.
You can switch between tabs to see different representations of the data.
This will collect data from the instrument at the interval set in the instrument configurations and save it
to the database.
You will also have a menu option on the top-left corner of the screen.
You can press the Home Button to run the Live Data in background or turn off the screen if you want to
save the battery.
4.5 Visualise Data
If you want to visualise the historic data that has been collected from the instrument,
1. Select Visualise Data option from the Main Menu.
2. Select the instrument from the list.
3. Select from and to dates to view the data, touch date text box to open calendar to select date and touch
time text box to select time.
4. Click Search Data button to search data.
If the data is available in the database for the selected date range, the app will display data in tables and
line charts.
If the instrument is storing histograms you can view the histogram chart by long press a report
(data row in the table chart) and select yes from the pop-up message.
Figure 4.3
4.0 Using iInstruments App
User’s Manual
4.6 Export Data
If you want to export the data that has been collected from the instrument to an Excel/CSV file or share
it,
1. Select Export Data option from the Main Menu.
2. Select the instrument from the list.
3. Select from and to dates to view the data, touch date text box to open calendar to select date and touch
time text box to select time.
4. Click Search Data button to search data.
5. Select the type of file you want to generate (Excel or CSV).
If the data is available in the database for the selected date range, the app will
generate a report and give you the option to open the file or share it with sharing options.
Figure 4.4
4.0 Using iInstruments App
User’s Manual
4.7 Operations
You can perform some basic operations on the instruments such as
Check Status, Start Sampling, Stop Sampling, Update Time, Clear Memory.
Select Operations from Main Menu > Select instrument > Select the operation you want to perform.
Figure 4.5
4.0 Using iInstruments App
User’s Manual
4.8 Configuration
Using this option, you can change instruments configurations, such as
Reporting interval, Units, histogram, channels to measure, etc.
Figure 4.6
4.0 Using iInstruments App
User’s Manual
4.9 App Settings
You have 3 options in App settings
Log in as Admin enables admin options (under development)
Log in as Admin allows you to sync data with cloud database (under development).
Chart Settings allows you to change the default chart settings.
Figure 4.7
4.10 Exit
This will exit the application and close all the Bluetooth connections.
4.11 Caveats and Exceptions
If the application crashes or does not display the data, please contact support.
