Skip to content

Bellafaire/Android-Companion-App-For-BLE-Devices

Repository files navigation

Android Companion App For BLE Devices

Project forked off of my ESP32 Smartwatch project (https://github.com/Bellafaire/ESP32-Smart-Watch) to its own repo. This project is a simple Android app which uses BLE to send notification data and spotify song information to a connected BLE device. Also allows for other functionality such as song control and calendar reading. This project is intended to work alongside my ESP32 Smartwatch project but this could be useful for anyone working on a similar project.

Installation

Sources can be compiled in android studio once cloned from this repo. There is a compiled .apk file available under the "releases" tab of this repo you can use that to install the app or compile the app yourself from source. Be sure to grant notification permission and check "Device Broadcast Status" setting in spotify for all features to work properly in the app.

On newer versions of android power management can kill the foreground process rendering the app inoperable. To prevent this navigate to Settings > Apps > App Management > ESP32 Smartwatch Companion App > Battery Usage then toggle "Allow background activity".

Usage example

Once the app is running on the android device an ESP32 can connect to it by matching the service and characteristic UUIDs in the example sketch. Calling initBLE() will begin advertisements and allow the app to connect to the ESP32 device. Below is a list of commands that can be issued and their functionality. The initial connection can be lengthy sometimes, however once it is connected the device will automatically reconnect as long as the app is active. In order to connect the app should be opened to start the scanning activity, once the scanning activity is started the app can be closed and a foreground service will continue to run.

      /notifications - gets current android notifications as a string format "appName,Title;ExtraText,ExtraInfoText,ExtraSubText,ExtraTitle;Description;"
      /calendar - returns a string of calender events for the next 24 hours in format "title;description;startDate;startTime;endTime;eventLocation;"
      /time - returns a string representing the time
      /isPlaying - returns "true" or "false" indicating whether spotify is playing on the android device
      /currentSong - returns the current song name and artist playing on spotify as one string
      /play - hits the media play button on the android device
      /pause - hits the media pause button on the android device
      /nextSong - hits the media next song button on the android device
      /lastSong - hits the media previous song button on the android device
      /icon:<app_name> - returns a base64 encoded 32x32 app icon for the requested application.

The example sketch provided in the repo will connect to the Android app and print the current notifications present on the notification bar to the serial terminal. If everything's configured correctly the output should look something like this for notification data:

Notification Updates

The app is also capable of updating the connected device in the event that a new notification is posted. The ESP32 example provides an example callback for this function.