Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.25 KB

README.md

File metadata and controls

86 lines (54 loc) · 3.25 KB
Raw

BlueUnity

BlueUnity is a plugin for using Bluetooth Serial with Unity3d on Android.

Installation

Import UnityAndroidBluetooth.unitypackage (V3) into a Unity project. In the Scenes folder, you will find a scene "SampleScene" to test the Bluetooth plugin. Make sure to set the minimum Android API level to API level 27 from Player Settings.

Usage

  1. Build the game using SampleScene or use the one I already built (see in 'Use this build to test/ V3').

  2. Enable bluetooth and location.

  3. Open the app.

  4. Enter the MAC address of the Bluetooth device, and click Start button to connect to BT.

  5. Enter data in the input field named "Enter Data to send" and click Send.

  6. The incoming data is displayed directly on the screen, using ReadData(string data) which is called from Java class using UnityPlayer.UnitySendMessage().

Note: The plugin parses incoming data with inputBuffer.readLine(), which reads until it reaches a new line character ('\n').

  1. To see Log messages, draw a circle in the screen with your finger to see the Log Viewer (Unity-Logs-Viewer from assets store).

  2. Do not forget to enalbe bluetooth and location access.

Supported functionality

  • Check and Request BT and location permissions (for Search Devices).
  • Search Devices.
  • Search Status.
  • Get Paired Devices.
  • Connect BT with MAC address.
  • Disconnect BT.
  • Connection Status.
  • Read Stream.
  • Write Stream.

I have Enhanced the code by using Unity3D UnityPlayer java class, this is done by adding the following line in build.gradle.kts of the Module, Here I'm using Unity 2020.3.28f1, change that to your version:

dependencies {
    ...
    compileOnly(files("C:/Program Files/Unity/Hub/Editor/2020.3.28f1/Editor/Data/PlaybackEngines/AndroidPlayer/Variations/mono/Release/Classes/classes.jar"))
    }

In the Java class you can import UnityPlayer java class:

import com.unity3d.player.UnityPlayer;

and use UnitySendMessage that searches for a GameObject by Name and calls a Function inside that GameObject and passes Arguments as String to it:

UnityPlayer.UnitySendMessage("GameObjectName", "FunctionToBeCalled", "ArgumentAsString");

This function is used for Search status, Connection status, New Device Found, and Read Data callbacks.

See this video for a full walkthrough and how to create your own plugin (for V2).

V3 demo and code explanation are coming soon, for now, I hope the code is self-explained.

Bluetooth Compatibility

BlueUnity was tested on HC-05, HC-06, BM78 Bluetooth modules, and ESP32 using the standard Bluetooth library (BluetoothSerial.h).

Note: Use println(data) or write(data+"\n"). As the plug-in expects new line ('\n') each time data is received.

Adapting to Your Project

If you want to edit the plugin and adapt it to your needs, check the "Android source code" folder, which contains the code of the plugin.

To create you own plug-in (the arr file), in Android studio go to File -> New -> New Module, and select Android Library.

To use UnitySendMessage don't forget to add the required dependency (check above) in 'build.gradle.kts' of your library

Contributing or Questions

Contact: bentalebahmed98@gmail.com

License

MIT