Zilogic Systems BlackKite User Manual

Vehicle tracking system

Advertisement

Quick Links

BlackKite, Vehicle Tracking System
User Manual
1.4.0, May 2016

Advertisement

Table of Contents
loading

Summary of Contents for Zilogic Systems BlackKite

  • Page 1 BlackKite, Vehicle Tracking System User Manual 1.4.0, May 2016...
  • Page 2 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 This work is licensed under the Creative Commons Attribution-Share Alike 2.5 India License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/2.5/in/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
  • Page 3: Table Of Contents

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Table of Contents 1. Introduction .......................... 1 1.1. Product Overview ....................... 1 1.2. Device Highlights ......................1 1.3. Applications ........................ 2 1.4. Specification ....................... 2 1.5. Inside the Box ......................2 2. Device Characteristics ......................4 2.1.
  • Page 4 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 B.1. LIMITED HARDWARE WARRANTY ................51 B.2. EXCLUSIONS ......................51 B.3. HARDWARE RETURN PROCEDURES ................51 B.4. HARDWARE REPLACEMENT PROCEDURES ..............52 B.5. ADDITIONAL RESPONSIBILITIES ................. 52 B.6. LIMITATION OF LIABILITY ..................52...
  • Page 5: Introduction

    Chapter 1. Introduction 1.1. Product Overview BlackKite-Fleet, is a cellular telemetry device, which collects location information of a vehicle, via GPS and transmits the data to a remote server via GPRS. The device also features multiple inputs and outputs to monitor and manage the in-vehicle parameters such as ignition state, fuel level, etc.
  • Page 6: Applications

    • 1x ignition input • 1x serial interface for external sensor or serial device • 1x USB port for configuration 1.5. Inside the Box The BlackKite-Fleet Standard Kit contains the following items that is necessary for vehicle installa- tion. Zilogic Systems Page 2...
  • Page 7 Rev. 1.4.0 • BlackKite-Fleet unit • Battery • Wire harness • Quick Start Guide The BlackKite-Fleet Starter Kit, contains the following items that is necessary for device configura- tion. • BlackKite-Fleet Unit • Battery • Wire harness • 12V Power adapter •...
  • Page 8: Device Characteristics

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Chapter 2. Device Characteristics 2.1. Handling & Safety Note The device should be installed or debugged only by trained professionals. Note Do not open the device when connected in vehicle battery. Note Use only the supplied USB cable for configuration.
  • Page 9: Mechanical

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 2.3. Mechanical H = H Table 2.1. Dimensions Dimension Measurement (mm) Length (L) Width (W) Height (H) 2.4. Electrical Parameter Unit Supply Voltage Average Supply Current 30 sec Transmission Period (at 12V supply) 15 min Transmission Period (at 12V supply)
  • Page 10: Environmental

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Parameter Unit 30 sec Transmission Period (at 12V supply) Hours 15 min Transmission Period (at 12V supply) Hours Charging Current (at 12V supply) Digital Output (Open Collector) Sink Current (at 12V supply) Digital Input &...
  • Page 11: Device Configurator

    PC through the USB cable. The BlackKite Starter Kit (needs to be purchased separately) has the required accessories like soft- ware CD-ROM and USB cable, to configure the device. Refer section Section 1.5, “Inside the Box”...
  • Page 12: User Interface

    The device has to be connected to, before any other operation can be performed. • Press the Connect button in the Connection Panel and the configurator lists the available serial devices • Select the BlackKite device from the list and press OK Figure 3.2. Connecting to Device Zilogic Systems...
  • Page 13 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Figure 3.3. Selecting Device On successful connect, the device IMEI is displayed, and the Connect button becomes a Disconnect button. Figure 3.4. Connection Status The device need to be disconnected through Disconnect button before it has been unplugged from the PC.
  • Page 14 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Figure 3.6. UI Screens in BlackKite Configurator The various configuration screens are described below. Server Configurations for GPRS and server parameters. Authentication Configurations for authorized phone numbers and their privi- leges. Vehicle Parameters Configurations for vehicle parameters that can be sent to server.
  • Page 15 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Caution Suddenly disconnecting the device from PC may lead to a partial configura- tion of the device. An pop up error would be thrown on sudden disconnec- tion. 3.5.2.2. Managing Configuration in Files Even without connecting the device to the Configurator, user can edit the in-memory configuration.
  • Page 16 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Figure 3.11. Save the Configuration to File Figure 3.12. Error on Saving Misconfigured Data Zilogic Systems Page 12...
  • Page 17: Device Features

    Chapter 4. Device Features 4.1. User Authorization BlackKite-Fleet can be configured and accessed through SMS, only by authorized users. A user’s mobile no. has to be added to the device Access Control List, to become an authorized user. The user can be configured as either a manager or an administrator. The device will respond to the request received from authorized users, in accordance to their privilege level.
  • Page 18: Vehicle Parameter Selection

    3. Send SAVE for the changes to take effect. 4.2. Vehicle Parameter Selection BlackKite-Fleet is capable of sending various vehicle parameters like location, speed and IO status to the server, periodically. Each parameter is identified by a tag. Tags for Location, Time and Vehi- cle Status are not configurable.
  • Page 19: Location Tracking

    6. Send SAVE, for the changes to take effect. 4.3. Location Tracking BlackKite-Fleet’s location tracking feature will enable the user to locate and track their vehicle through web or mobile. The device acquires the location, using the built-in GPS and makes it avail- able to the user either via GPRS or SMS.
  • Page 20 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 4.3.1. On-line via GPRS When GPRS transmission is enabled, the BlackKite-Fleet acquires and transmits the location infor- mation continuously to the configured remote server. The transmission period can be configured between 30 seconds to 2 hours.
  • Page 21: Io Monitoring And Control

    4.4.1. Digital Inputs BlackKite-Fleet’s digital inputs are active and readable when the device is connected to the vehicle battery. User can connect any digital input device and monitor its status.
  • Page 22 2. Send SAVE for the changes to take effect. 4.4.3. Digital Outputs BlackKite-Fleet digital outputs are active and available when the device is connected to the vehicle battery. User could connect and control electrical devices with the digital outputs using automotive relays.
  • Page 23 2. Send IOSET 2 0, to make the digital output 2 go low 4.4.5. Analog Inputs BlackKite-Fleet’s analog inputs are active and readable when the device is connected to the vehicle battery. The user can connect analog sensors with an output range of 0 - 30 V. The sensor could be fuel sensor, temperature sensor, load sensor etc.
  • Page 24: Alerts

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 4.5. Alerts BlackKite-Fleet, can notify the user about the change in vehicle parameters, through an alert mech- anism. The device can generate both SMS and GPRS alerts. 4.5.1. Authorization SMS alerts can be enabled for any three users, in the Access Control List. Let’s assume a scenario in which alert notification to an administrator with number "+919444118448"...
  • Page 25 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 2. Send SAVE for the changes to take effect. 4.5.3. Digital IO alerts The device continuously monitors the input and outputs and sends alerts when there is a state change from low-to-high or high-to-low. User can enable or disable alert notification for each IO.
  • Page 26 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 1. Send ADD SMSALERT DI1, to enable SMS alert for digital input 1. 2. Send ADD GPRSALERT DI1, to enable GPRS alert for digital input 1. 3. Send DEL SMSALERT DO2, to disable SMS alert for digital output 2.
  • Page 27 3. Send SAVE for the changes to take effect. 4.5.7. Over Speed BlackKite-Fleet is built with over speed monitoring feature, which continuously monitors the vehicle and triggers alerts when the speed exceeds the set threshold. SMS alerts: When enabled, the device sends out over speeding alert message to the authorized users.
  • Page 28 An emergency notification system enables the driver/passenger to notify panic situation to the fleet operator to seek help. The BlackKite-Fleet, has a dedicated SOS interface to connect a panic button. When the user presses and holds the button, for 3 seconds, the device generates both SMS and GPRS alerts.
  • Page 29 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 once the GPRS connection is restored. All data transmitted from the internal storage will be sent with Archive Indicator bit set. The device can store data for a maximum of 24 hours, and this enables the user to receive infor- mation without any data loss.
  • Page 30: Quick Start

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Chapter 5. Quick Start 5.1. Initial Device Setup 5.1.1. Opening the Device Casing For security reasons, the internal battery and SIM slot can only be accessed by opening the device casing. Unscrew the screws located at positions (1), (2), (3) and (4), as shown in picture below.
  • Page 31 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 5.1.3. Connecting the Internal Battery With the device case open, connect the internal battery (1) to the battery connector (2), as shown in the picture below. 5.1.4. Powering the Device The battery shipped with the device is not charged, and hence the device needs to operate from AC mains for configuration.
  • Page 32: Vehicle Installation

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 5.1.5. Configure the Device Parameters Connect the device to the PC, using the USB cable. Start the Device Configurator application, and configure the User Authorization, and the GPRS APN parameters. Refer section Section 4.1, “User Authorization”...
  • Page 33: Interfaces

    VOUT 6.2. Connecting Ignition The ignition input of the BlackKite-Fleet, is used to identify whether the vehicle is stationary or moving. This is used internally by the device, to determine the data transmission period. The power supply output from the ignition switch to the vehicle accessories (like dashboard, radio, etc.), can be used from this purpose.
  • Page 34: Connecting A Switch

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 6.3. Connecting a Switch AC switches and door sensors can be monitored using digital inputs. The below figure shows how to connect a switch to a digital input. 6.4. Connecting a Relay Automotive relays (12V or 24V depending on battery voltage) can be controlled using digital out- puts.
  • Page 35: Connecting An Sos Button

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 After the fuel sensor is connected to the device, calibration needs to be done, since the the voltage output does not have a linear relationship with the fuel level. A simple way to calibrate, is to fill the fuel tank at various levels —...
  • Page 36: Commands

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Chapter 7. Commands Commands can be issued to the device through SMS. Commands can either succeed or fail. When the command succeeds, an OK response indicates the completion of the command. The general syntax of the response message on success is shown below.
  • Page 37: Sos Commands

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 If the <mode> argument is not specified then the current mode is returned as response. Reboot.  The device can be rebooted using the following command. Command REBOOT Response OK: REBOOT Link Status. ...
  • Page 38: Configuration Commands

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 The field definitions are listed below. indicates which digital output is to be changed, should be in the range 1 to 4. state 0 or 1, the state to change to Get Digital Input/Output.  The state of the digital inputs and outputs can be obtained using the following command.
  • Page 39 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 The current server IP address and port settings can be obtained using the following command. Command GET SERVER Response OK: SERVER <ip>,<port> The field definitions are listed below. Server IP address. port Server port number.
  • Page 40 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Command SET OST <speed> Response OK: OST <speed> The current threshold value can be queried using the following command. Command GET OST Response OK: OST <speed> The field definitions are listed below.
  • Page 41 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Meaning Name DOUT Digital Output SMS Alerts. An SMS alert, that is required, can be enabled using the following command. Command ADD SMSALERT <alert> Response OK: SMSALERT <alert> <alert> <alert> ... An SMS alert, that is no longer required, can be disabled using the following command.
  • Page 42 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Command DEL GPRSALERT <alert> Response OK: GPRSALERT <alert> <alert> <alert> ... The current list of enabled alerts can be retrieved using the following command. Command LIST GPRSALERT Response OK: GPRSALERT <alert> <alert> <alert> ...
  • Page 43 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 FTP Server IP and Port.  The FTP server IP address and port, where the application image has to be downloaded from during upgrade, can be configured through the following command. Command SET FTP <ip>,<port>,<username>,<password>...
  • Page 44: Firmware Upgrade

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Chapter 8. Firmware Upgrade The device firmware is constantly improved and firmware releases are provided from time to time. And hence the device has a provision to upgrade the firmware over-the-air. The firmware images are made available through an FTP server located at bkup.zilogic.com.
  • Page 45 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 The firmware image filename on the server is to be provided as argument. Any error during the upgrade process is reported through an alert SMS to all users with admin privilege. The upgrade error messages have the following format.
  • Page 46: Server Protocol

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Chapter 9. Server Protocol The device makes a TCP connection to the server and sends the following messages to the server. 1. HEAD 2. MAIN 3. ALERT The same message format is used for HEAD, MAIN and ALERT messages. When a message is re- ceived by the server, the server should send an ACK to acknowledge the receipt of the message.
  • Page 47: Main Message

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 9.3. MAIN Message The MAIN message is sent by the device to the server periodically. The periodicity is configurable. Location, Status and Timestamp tags are available in the MAIN message. In addition, other vehicle information can also be added through the device configuration.
  • Page 48 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 * Returns IMEI from tag value corresponding to tag type 0x03. public static String getIMEI(byte[] bytes) { try { return new String(bytes, "UTF-8"); } catch (UnsupportedEncodingException e) { throw new RuntimeException("Unable to decode IMEI", e);...
  • Page 49 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Sub-field Value Representation Latitude 12.983199 degrees N 9F 1B C6 00 Longitude 80.255232 degrees W 00 99 C8 04 • The complete tag value representation, for the above example is 0A 9F 1B C6 00 00 99 C8 04 •...
  • Page 50 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 (byte) 0x00, (byte) 0x99, (byte) 0xC8, (byte) 0x04 }; double latitude = getLatitude(bk_coord); assert latitude == 12.983199; double longitude = getLongitude(bk_coord); assert longitude == 80.255232; Speed and Direction • Tag Type: 0x33 •...
  • Page 51 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 int direction = (b2i(bytes[3]) << 8) + b2i(bytes[2]); return direction / 10.0; public static void main(String[] args) { byte[] bk_speed_dir = new byte[] { (byte) 0x5C, (byte) 0x00, (byte) 0x48, (byte) 0x08 };...
  • Page 52: Sample Packets

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Digital Outputs • Tag Type: 0x45 • Length: 2 bytes • Format: Each bit indicates status of one digital output. Bit position 0, corresponds to digital output 1, and so on. • Example: If digital outputs 1 and 3 are low, and rest of the output are high, the field is rep- resented as FA FF.
  • Page 53: Archive

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Bytes Meaning Timestamp Tag 90 62 DA 52 Timestamp CF D8 Checksum CRC-16 (Modbus) The ACK message for the above MAIN / HEAD / ALERT message is shown below. 02 CF D8 The meaning of each byte in the packet is listed in the following table.
  • Page 54: Document Revision

    BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 Appendix A. Document Revision Revision Date Description 1.0.0 23 Oct 2015 Initial release. 1.1.0 11 Nov 2015 Added aggregate packet information. 1.2.0 09 Jan 2016 Support file changes. No content change. 1.3.0 21 Mar 2016 Added timezone setting information.
  • Page 55: Warranty

    Your sole and exclusive remedy, and Zilogic Systems' sole and exclusive liability for defective hard- ware components, shall be that Zilogic Systems, subject to the terms and conditions of this Section, and solely upon confirmation of a defect or failure of a hardware component to perform as war- ranted, shall at its sole option, either repair or replace the nonconforming hardware component.
  • Page 56: B.4. Hardware Replacement Procedures

    Systems shall be borne by you. Any transportation costs incurred in connection with the redelivery of a repaired or replacement item to you by Zilogic Systems shall be borne by Zilogic Systems; pro- vided, however, that if Zilogic Systems determines, in its sole discretion, that the allegedly defective...
  • Page 57 BlackKite, Vehicle Tracking System User Manual Rev. 1.4.0 THE PRICE PAID TO ZILOGIC SYSTEMS FOR SUCH DEFECTIVE PRODUCT(S) OR SERVICE; OR (IV) FOR ALL OTHER CLAIMS NOT RELATED TO AN ERROR, DEFECT OR NONCONFORMITY IN THE PRODUCTS, ANY AMOUNTS IN EXCESS IN THE AGGREGATE OF THE AMOUNT PAID TO ZILOGIC SYSTEMS HERE- UNDER DURING THE THREE (3) MONTHS PRECEDING THE DATE THE CAUSE OF ACTION AROSE.

Table of Contents