BLEtoMQTT

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #go #machine-learning #deep-learning #macos #windows #cli #awesome-list #pytorch #ios #open-source

(★ 17)

Android BLE to MQTT bridging service

BLEtoMQTT Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BLEtoMQTT
## Introduction
 Android foreground service to provide a bidirectional bridge between BLE devices and an MQTT broker. A setup.json file defines MQTT parameters and BLE MAC addresses to scan for.

For each BLE device detected BLEtoMQTT will discover all exposed services and characteristics creating MQTT topics for each. Those characteristics which are writeable will automatically be 'subscribed' from the MQTT broker.

Two external libraries are used :
  - org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.5
  - com.github.weliem:blessed-android

The author uses this application to connect remote custom ESP32 devices to his Home Assistant server via a Zerotier VPN. 
The GitHub repository contains an example setup.json to monitor/control a boat on a mooring or at anchor.

The app has been tried on Samsung S6, S9, S9+ and 'Galaxy Tab A'. Running Android 7.0, 10 and 11.

## Installation
Install latest release version.

Using an Android file manager create a new directory in the user root called 'bletomqtt' (/mnt/sdcard/bletomqtt) in which to place the setup.json file.
WARNING This is the phones internal SDCard (memory).

Restart app and on user screen press 'service start' button once all persmissions have been granted - a permanent notification should be generated. If no notification is generated then refer to Problems section.

## setup.json

Minimum setup.json would just contain mqtt credentials and BLE MAC addresses to scan for :
###
		{
			"bletomqtt": [{
				"mqtt": {
					"IP": "tcp://192.168.192.40:1883",
					"user": "Guest",
					"pswd": "0123456789"
				}
			},
			{
				"devices": [{
					"address": "B0:B2:1C:A6:19:BA"
				},
				
					"address": "B5:B2:1C:C6:19:11"
				}]
			}]
		}

The example setup.json included in the main directory shows how to convert UUIDs into human friendly MQTT topics. A data template formatter, called BITWISE, is also shown which can be used to convert integer (ASCII) fields into json with individual binary sensors and controls.

## BLE Pairing/Bonding

The code allows for bonding to a BLE device by including an option to store a passkey with each device definition in the setup.json file. If a device requires a passkey to BOND, and it is not included in the setup.json, then a user interface screen is presented.

On occasion I have noticed that a bonded BLE device needs to be power cycled to be seen by a new Android device.

## Permissions

RECEIVE_BOOT_COMPLETED - allows app to auto start on boot after initial manual start.
    POST_NOTIFICATIONS - warn user the app is running
    SYSTEM_ALERT_WINDOW - why ?
    READ_EXTERNAL_STORAGE - gives access to the SETUP.json file
    MANAGE_EXTERNAL_STORAGE - why ?
    ACTION_MANAGE_OVERLAY_PERMISSION - why ?
    INTERNET - access MQTT broker
    ACCESS_COARSE_LOCATION - required for bluetooth
    ACCESS_FINE_LOCATION - required for bluetooth
    FOREGROUND_SERVICE - give priority as a service
    FOREGROUND_SERVICE_LOCATION - why ?

## Problems
The code is lite on error trapping or user warnings. Initial problems will likely be due to 
  - bluetooth not enabled or location privileges not given
  - internet access not available so cannot find the MQTT broker
  - cannot find the setup.json file or file privileges have not been given
  - setup.json data format problems

For further clues view the LogCat

## Feel Good

If you find that information and/or software you obtained here is of use to you - please show some appreciation by making a contribution via :

| Paypal | Bitcoin |
| ------ | ------- |
| [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/ncp/payment/9BSAN369THJBA) | <center> [![](https://api.qrserver.com/v1/create-qr-code/?color=000000&bgcolor=FFFFFF&data=bitcoin%3A1GdXrcWKAnSoYb8tRLWF5xtMsrM9HkFBHk&qzone=1&margin=0&size=200x200&ecc=L)](bitcoin:1GdXrcWKAnSoYb8tRLWF5xtMsrM9HkFBHk)<br />[1GdXrcWKAnSoYb8tRLWF5xtMsrM9HkFBHk](bitcoin:1GdXrcWKAnSoYb8tRLWF5xtMsrM9HkFBHk)</center> |

BLEtoMQTT

BLEtoMQTT Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

BLEtoMQTT

BLEtoMQTT Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README