A library to make it easier to communicate with a V1connection or V1connection LE.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ESPLibrary
Hello_V1
Specification
.gitattributes
.gitignore
LICENSE.md
README.md
RELEASE-NOTES.md

README.md

Android ESP Library

The Extended Serial Protocol (ESP) is a communications protocol defined by Valentine Research. It enables two-way communication and data sharing between the Valentine One (V1) radar locator and other ESP-enabled devices. In addition to handling the setup and teardown of Bluetooth connections, this library will do the work of handling the ESP requirements and parsing the ESP packet data into a more usable format.

ESP Android Basics

The main interface to the Android ESP Library is through the ValentineClient class. The ValentineClient will handle all Bluetooth system calls and all ESP packet construction and parsing. The library will use its own threads to send requests to the V1connection and to read the ESP data from the V1connection. Data is transferred from the library to the host app using callbacks. Continuous data, such as alert and display data, requires the app to register a callback method. The registered display callback method will be called whenever the data is received. The registered alert callback method will be called whenever a complete alert table is recieved, not for each alert data packet. One time data, such as a version request, does not require a separate registration method. Instead, the request method takes the callback as a parameter.

Sample Integration

The Hello V1 app offers a sample integration to demonstrate how easy it is to start communicating with the V1. The following functionality is demonstrated:

  • Determine if the Android device supports Bluetooth Low Energy (BLE).
  • Display the library's device selection screen and retrieve the device the user selects.
  • Connect and disconnect from a V1connection or V1connection LE.
  • Register for display data and implement the display data callback method.
  • Register for alert data and implement the alert data callback method.
  • Read the firmware version and current custom sweeps from the V1. This demonstrates the techniques used to send a request to the V1 and to receive the response.