WiaTag 1.4. User Guide. date: January 1, 2017

Transcription

1 WiaTag 1.4 date: January 1, 2017

2 Table of Contents Overview 4 Creating a Unit for WiaTag 5 Unit Creation From the Monitoring System 5 Unit Creation From the Application 6 Starting Application and Choosing Mode 7 User Modes 7 Active 7 Standard 8 Lite 8 Custom 8 Main Screen 9 Top Block 9 Central Block 10 Bottom Block 10 GPS Connection 10 Internet Connection 10 Service Status 10 Other 10 Latest Data 11 Actions Menu 12 Scan QR code 12 Auto Sending 12 Send Photo 12 Sending from Camera 13 Sending from Library 13 Send Position 13 Send SOS 13 Emergency Number 13 Custom Statuses 14 Template Creating 14 Status Sending 15 Template Deleting 15 Settings 16 Connection Settings 16 Server 16 Unit Properties 16 Operation Mode

3 Data Collection 17 Data Sending 17 Data Settings 18 Messages Filtration 18 Additional Parameters 19 Main Screen 19 Administrative Settings 19 User Mode 19 Admin password 20 Custom Statuses 20 Remote Control 20 Share Configuration 23 Visible Settings 23 Photo Quality 23 Power Save Mode 23 Clear Black Box 23 Reset 23 Other 23 Measurement System 23 Contact us 23 Help

4 O ver view WiaTag is an application used for tracking unit's location. WiaTag can be installed on ios based mobile devices, such as cell phones, laptops, netbooks, etc. Location is tracked mainly using GPS, therefore a device should possess GPS receiver. WiaTag is compatible with GPS and GLONASS tracking systems Wialon Hosting and Wialon Local. Position data is sent from mobile device to the server of tracking system to be stored. Besides position data (coordinates, course, speed. etc.), images, alarm messages, and custom statuses can also be sent to the server. Data received from a mobile device can be processed by a tracking system and presented in different forms such as tracks of traveled routes on the map, notifications, etc

5 Cr eat ing a Unit f or W iat ag WiaTag application needs a unit to be created in the monitoring system. It can be done either from the interface of the monitoring system or from the application itself. U n i t C r e a t i o n F r o m t h e M o n i t o r i n g S y s t e m The fields to be filled in upon unit's creation are described in the documentation on Wialon Hosting and Wialon Local. So, let's just observe how to fill in the fields directly connected with the application operation. Firstly, in the 'Device type' field choose 'WiaTag' option. Then indicate a unique ID. Note that both numeric and alphabetic values can be used for it (for example, mobile device's IMEI code). The indicated identifier is used in WiaTag for a unit connection. Moreover, if you would like to use a password for a connection, then it is necessary to indicate one in the 'Device access password' field. The list of units created in the monitoring system for the work with WiaTag is available in the application after an authorization. To authorize, tap the 'Log in' at the bottom of a unit connection screen and choose the monitoring system used. Then choose a user from the list (the list contains all the users authorized from this device in any mobile application of Wialon system) or authorize as another user (corresponding button at the bottom of the screen). Afterwards, we get to the list of units any of which can be chosen to work with WiaTag

6 U n i t C r e a t i o n F r o m t h e A p p l i c a t i o n To create a unit from the application, it is also necessary to authorize first (see above). Afterwards tap the corresponding button at the bottom of the screen, fill in the appeared fields, and confirm your action by tapping 'Save'. A created unit gets into the list of units

7 S t ar t ing A pplicat ion and Choosing M ode In the top of the unit connection screen choose a tab (Wialon Hosting or Wialon Local) depending on the monitoring system used. Afterwards fill in thecorresponding fields. For Wialon Hosting it is necessary to indicate a unique ID and password (optional), for Wialon Local server address, unique ID, and password (optional). U s e r M o d e s After connecting to the monitoring system it is necessary to choose a user mode: Active, Standard, Lite, or custom one. Each mode has its own parameters of data collecting and sending. A c t i v e This mode provides you with a possibility to receive the most detailed track of unit's movements and ensures the highest accuracy of position data. This mode provides relatively high battery and traffic consumption comparing to the other modes. Data collection: continuous. Data sending: continuous. Maximum accuracy value: 30 meters

8 S t a n d a r d This mode provides you with a possibility to receive a detailed track of unit's movements with 5 minutes delay and ensures relatively high accuracy of position data. Moderate battery and traffic consumption is considered to be an advantage of the mode. Data collection: by timeout (5 minutes). Data sending: by timeout (5 minutes). Maximum accuracy value: 50 meters. L i t e This mode provides you with a possibility to control unit's location upon minimum consumption of battery and traffic. Note that track of movements received in this mode may have some imprecisions. Data collection: by timeout (5 minutes). Data sending: by timeout (5 minutes). Maximum accuracy value: 1000 meters. C u s t o m This is a mode where all parameters should be set individually according to the goals of tracking. Initially all the parameters have standard values

9 M ain S creen An interface of the application's main screen could be conditionally divided into 3 blocks: top, central, and bottom one. T o p B l o c k The top block contains 3 buttons: Arrow unloads messages from the black box. Red indicator is shown upon the availability of messages in the box; Battery turns on the power save mode upon tapping it; Gear transfers to the application settings menu

10 C e n t r a l B l o c k Central part of the screen is occupied by the block where you can view unit's latest data or (upon indicating the corresponding settings) send unit's current status (use a horizontal slide to switch from latest data viewing to current state sending). Latest data receiving and current status sending requires availability of GPS and Internet connection as well as starting unit's location determination service. B o t t o m B l o c k Upon the first launch of the application a unit's location determination service is stopped. To start it, tap the corresponding button at the top of the block. The further activity of the application depends on the settings used, availability of GPS connection (to generate location messages) as well as connection with Internet and server (to send messages from clipboard or black box). State of data collecting and sending parameters is shown in the bottom block: G P S C o n n e c t i o n Shows the availability of GPS connection I n t e r n e t C o n n e c t i o n Shows the availability of Internet connection. S e r v i c e S t a t u s Shows whether location determination service is started or stopped. A T T E N T I O N! Stopping of the service may be restricted by an administrator. For Android devices automatic start/stop of the service is also possible after reboot, while charging the battery, or by schedule. O t h e r Tap the '+' button in the bottom block in order to open the actions menu. Note that implementation of any action from this menu requires the availability of Internet connection

11 Lat est Dat a Latest data is taken from received messages. Latest data is refreshed automatically upon receiving new messages. The latest data block may contain up to 4 items on your choice: Time time of receiving the latest message; Speed unit's speed (in km/h); Altitude elevation of a unit above the sea level (in meters); Course direction of movement (in degrees). It can take on the values from 0 to 360 degrees, where 0 is a course strictly northward, and then the value increases clockwise; Position geographical latitude and longitude of unit's location; Accuracy accuracy of location data (in meters). In other words, accuracy is a radius (drawn around a current location point) within which a unit can be situated

12 A ct ions M enu This menu contains a list of actions available for a chosen user mode: S c a n Q R c o d e The scanner provides the possibility to work with either QR codes or bar codes. Note that in the 'Actions' settings you can choose whether to preview a scanned code or send it automatically. After scanning a QR code (bar code), the message containing 'qr' parameter is sent to the server. Parameter's value is saved in the system's data base and afterwards can be used for the monitoring purposes. A u t o S e n d i n g Enable/disable automatic sending of a QR code scanned. S e n d P h o t o An image sent to the server is saved in the data base of the system and afterwards can be used for the monitoring purposes. Note that unit's location info is send to the server along with the image. Before sending a photo it is recommended to indicate image quality

13 S e n d i n g f r o m C a m e r a Choose this item in order to take a picture and send it. S e n d i n g f r o m L i b r a r y Choose this item in order to send an image stored in the memory of your mobile device. S e n d P o s i t i o n Position sent to the server is saved in the data base of the system and afterwards can be used for the monitoring purposes. S e n d S O S Alarm message (SOS) can be sent in case a critical situation occurs. In the monitoring system's data message it has the following view: 'alarm=1'. Note that unit's location info is send to the server along with the alarm message. Unit's location is detected by the system at the moment of SOS sending. In case of failure to detect current location, the latest known location will be sent. E m e r g e n c y N u m b e r Indicate a telephone number alarm messages (SOS) to be sent to

14 Cust om S t at uses WiaTag application supports creating and sending of custom statuses. A user can create any number of custom statuses templates, for example, 'Template 1' can obtain such values as 'Free', 'Busy', 'Away', and 'Template 2' 'Private', 'Business', 'Unified', etc. Template creating is done in the corresponding section of the application settings. Template sending is done on the main screen of the application. T e m p l a t e C r e a t i n g To create custom statuses template, go to the application settings (main screen > top block > gear button). Afterwards, choose 'Custom statuses' item in the 'Administrative settings' section. To create template, tap the corresponding button and fill in parameters: Name indicate template name; Parameter name indicate parameter name; Message numeric format enable/disable sending of index numbers in message parameters; Values add the necessary number of values and give a name for each of them

15 S t a t u s S e n d i n g Sending custom statuses from created templates is implemented in the central block of the main screen. Using the horizontal slide switch to the necessary template and tap a status to be sent. Custom statuses appear in the tracking system as data messages containing parameter's name and value. Custom statuses are usually sent along with coordinates. If there is no access to 'fresh' position data at the moment, then the last known coordinates are used. Sent statuses can be used in the monitoring system to adjust notifications (notification type should be Message parameter control ). Sent parameters (both alarms and custom statuses) can be used in the tracking system to adjust notifications (notification type should be 'Message parameter control'). You can be notified on receiving custom statuses by , SMS, online popup message. Moreover, you can register received statuses in unit's database and generate reports on them T e m p l a t e D e l e t i n g To delete a template, go to the Settings > Administrative settings > Custom statuses, choose a template you would like to delete, tap the corresponding button in the bottom, and confirm your action in the appeared dialog

16 S et t ings User settings menu serves to configure parameters influencing the work of both the application and the location determination service. A number of settings available to a user is indicated in the 'Visible settings' item of the 'Administrative settings' section. A T T E N T I O N! Access to the settings can be restricted by the password of administrator. C o n n e c t i o n S e t t i n g s S e r v e r Host The service is compatible with GPS and GLONASS tracking systems such as Wialon Hosting and Wialon Local. For Wialon Hosting a server host is indicated automatically upon starting the application. For Wialon Local it should be done manually. For both Wialon Hosting and Local a server host can be edited manually (if necessary) in this field. Port For Wialon Hosting a server port is indicated automatically upon starting the application. For Wialon Local it should be done manually. For both Wialon Hosting and Local a server port can be edited manually (if necessary) in this field. U n i t P r o p e r t i e s Unique ID Unit's unique ID is an identification code used to recognize your mobile device in the tracking system. It can be the same as IMEI code of the mobile device or any other identifier. Password Indicate a password if it should be used for a unit access. Note that an indicated password should be duplicated in the interface of a monitoring system (corresponding field of a unit properties dialog), otherwise unit's data will not be registered on the server. Bind unit Here choose a unit to bind your application to

17 O p e r a t i o n M o d e Chosen configuration of the operation mode may influence the consumption of traffic and battery. Operation mode is defined by 3 parameters. Depending on the goals of tracking you can choose settings for data collection, data sending, and starting/stopping by event.further there is an information on each setting. D a t a C o l l e c t i o n Data Collection Method Continuous location data is collected constantly, collected data can be characterized by a high accuracy. The negative side is higher consumption of battery and traffic. By timeout location data is collected regularly over a certain period of time. This period of time (timeout) should be indicated in the corresponding field (5 minutes by default). Note that the less timeout is, the more accurate data you collect. Using this method traffic and battery consumption depends on a timeout indicated. Smart mode the key feature of the method is that data collection takes place only upon unit's movement. In other words, location determination service is automatically started upon unit's movement detection. Movement detection is made on the basis of processed data from integrated accelerometers, gyroscopes, and compasses. Timeout This option should be used if 'By timeout' method has been chosen for data collection. Here indicate time value in which data collection is implemented. D a t a S e n d i n g Data Sending Method Data can be sent continuously, by timeout, or manually. In the first case ('Continuous' option), location data is sent to the server constantly (upon arriving to the black box and upon the Internet availability). The battery is consumed actively using this method, therefore it is recommended to use it if you have the possibility to charge your battery any time. In the second case ('By timeout' option), location data is sent to the server regularly (once in the indicated time) and afterwards a mobile device returns to the sleeping mode. In the third case ('Manual' option), all collected location data messages are stored in the black box, and if necessary a user unloads the black box manually

18 Timeout This parameter is relevant only if data sending by timeout is chosen above. Timeout value should be no less than 5 minutes. Work in Roaming Depending on this checkbox state, the mobile device sends data in roaming or not. D a t a S e t t i n g s M e s s a g e s F i l t r a t i o n If you activate this option, parameters listed below will be applied to messages prepared for sending to the server. This filtration can be applied only to the messages generated by GPS, because if wireless technology is used, such data as speed, course, satellites count, etc. is unknown, and accuracy can exceed 2000 meters. The conditions of filtration are listed below. The 'logical OR' operation is applied to them, in other words, a new message is generated if any of the mentioned conditions is met. This is not applicable to the Max accuracy and Max speed parameters as they are intended to exclude messages with improbably high values (potentially invalid messages). Max Accuracy Maximum accuracy value. If exceeded, such message is considered invalid and will not be sent to the server. This parameter is utilized constantly (regardless to the state of messages filtration option). Min Time Interval Minimum time interval between messages sent to the server (in seconds). In other words, a new message is generated when the indicated time since previous message has passed. Min Distance Minimum distance between messages. In other words, a new message is generated if the unit has traveled the indicated distance since the previous message. Change in Course Indicate an angle on which a course will be changed (i.e., a motion direction) for new message sending (in degrees)

19 Change in Speed Indicate a speed change (difference between the previous and current messages) which is sufficient for sending a new message. A d d i t i o n a l P a r a m e t e r s Choose the additional parameters you would like observe in data messages: Provider name If this option is chosen, then sent messages contain parameter 'p' showing a source of location data. Accuracy If this option is chosen, then sent messages contain parameter a showing information about accuracy of a detected location (in meters). Battery Level If this option is chosen, then sent messages contain parameter 'b' showing a battery level (percentage). Last Status If this option is chosen, then sent messages contain the last indicated unit status. M a i n S c r e e n Latest Data The latest information on the key parameters of unit monitoring. Latest data block occupies the central place on the main screen of the application. Actions Here you can adjust the list of actions available to a user. A d m i n i s t r a t i v e S e t t i n g s U s e r M o d e The choice of a user mode depends on the goals of monitoring. The modes may differ by their configuration. A configuration influences both the accuracy of received data and the consumption of traffic and battery

20 A d m i n p a s s w o r d Choose the option if you would like to make configuration of WiaTag available only to those who has administration privileges. Without entering a password user will be unable to stop the service or view/change settings. In the corresponding field enter the password (active if the usage of admin password is enabled) restricting the access to the above mentioned actions. C u s t o m S t a t u s e s Choose this item to set custom statuses. R e m o t e C o n t r o l Choose this item to enable/disable remote control. Using remote control you can send a command from the interface of the monitoring system. The following commands are available: Torch (in active application mode only); Start/stop; Query position; Query configuration; Upload configuration. The 'Upload configuration' command provides you with the possibility to configure a user settings menu remotely. To do so, this command should be attached with JSON format text file containing a necessary configuration. A configuration file has the following view. A configuration file contains 'key:value' pairs where key stands for the app settings and value for the required configuration of these settings. Below is the list of keys, corresponding settings, and possible configurations: data_collection_mode data collection 0 continuous, 1 by timeout, 2 smart mode data_collection_timeout data collection timeout value custom, min data_sending_mode data sending 0 continuous, 1 by timeout, 2 manual data_sending_timeout enable_filtration data sending timeout value custom value, min filtration enabling/disabling true enable, false disable filtration_min_time min time interval custom value, sec filtration_min_distance min distance custom value, m (ft)

21 filtration_change_in_course change in course custom value, filtration_change_in_speed change in speed custom value km/h (mph) filtration_max_accuracy max accuracy custom value, m (ft) filtration_max_speed max speed custom value, km/h (mph) send_parameter_provider_name additional parameters, provider name true enable, false disable send_parameter_accuracy send_parameter_battery_level send_parameter_last_status enable_action_send_photo enable_action_send_position additional parameters, accuracy additional parameters, battery level additional parameters, last status actions menu adjustment, sending photo actions menu adjustment, sending position true enable, false disable true enable, false disable true enable, false disable true enable, false disable true enable, false disable enable_action_send_sos actions menu adjustment, true enable, false disable sending SOS visible_statistics latest data 0x1 time, 0x2 speed, 0x4 altitude, 0x8 course, 0x10 position, 0x20 accuracy user_mode user mode 0 active, 1 standard, 2 lite, 3 custom use_admin_password admin password true enable, false disable admin_password set admin password custom, both numeric and alphabetic values photo_quality photo quality 0 original, 1 high, 2 medium, 3 low enable_power_save_mode power save mode true enable, false disable statuses custom statuses this key has inclusions, because custom statuses' template contains several settings. Available settings can be found below. name template's name custom value param_name parameter's name custom value values values custom values. The maximum number of values is 6. Each value is indicated in double quotes (for example, "Value1"). Comma (,)

22 active use template on the main screen is used to separate values. true enable, false disable visible_settings visible settings this key has inclusions, because it is necessary to indicate settings' sections and values. All the possible values for each section are listed below connection_settings connection settings 0x1 server, 0x2 unit properties operation_mode operation mode 0x1 data collection, 0x2 data sending data_settings data settings 0x1 messages filtration, 0x2 additional parameters main_screen_customizer main screen 0x1 latest data, 0x2 actions administrative_settings administrative settings 0x1 user mode, 0x2 admin password, 0x4 custom statuses, 0x8 remote control, 0x40 photo quality, 0x100 power save mode, 0x200 clear black box, 0x400 reset other_items other 0x1 contact us, 0x2 help, 0x4 measurement system Note that values can be presented numerically (0, 1, 2, etc.), alphabetically (true/false), or by flags (0x1, 0x2, 0x20, etc.). Numeric and alphabetic values are used to choose single parameter/status. Using flags, you can indicate either a single parameter or multiple parameters simultaneously. Flags value can be indicated as a key after converting it into a decimal number system only. For example, it is required to show such parameters as 'Contact us' and 'Help' in the user settings menu. To do so, it is necessary to make an addition of their flags (0x1 + 0x2 = 0x3), convert a received sum into a decimal number system, and indicate a result of conversion as a value of a key. Example of a configuration file for visible settings: "visible_settings":{ "connection_settings":1, "operation_mode":1, "data_settings":4, "main_screen_customizer":0, "administrative_settings":2, "other_items":2 }

23 S h a r e C o n f i g u r a t i o n To share current configuration of the application, tap this item. In the appeared menu choose program for configuration sending and indicate an addressee. Moreover, you can save a configuration into buffer for a further usage. V i s i b l e S e t t i n g s Here you indicate the settings to be shown in the user menu. P h o t o Q u a l i t y Here you can choose image quality which will be used upon photo sending (traffic consumption depends on the chosen quality). The following variants are available: Original original image without quality loss; High original image is compressed to 3 megapixels (not more than 600 kb); Medium original image is compressed to 2 megapixels (not more than 300 kb); Low original image is compressed to 1 megapixel (not more than 100 kb). P o w e r S a v e M o d e Power save mode provides you with a possibility to decrease battery consumption. This is possible due to the changing of data sending method to manual. Enable this option in order the power save mode to be activated upon reaching low battery level (15%). C l e a r B l a c k B o x Tap the option in order to delete all the messages from the black box. R e s e t Tap the option to reset all the settings to default ones. O t h e r M e a s u r e m e n t S y s t e m WiaTag supports two systems of measurement metric and U.S. one. Here choose the system you would like to work with. If the 'Automatic' item is chosen, then the system of measurements will be set depending on the settings of your device. C o n t a c t u s This option serves to contact the application developers

24 H e l p Tap this item to view WiaTag user manual