Unity Edge Events (Beta)

Copy link to clipboard

Edge Events allows your Unity app to continuously send and get updates from EdgeXR in order for our platform to determine if there is a more suitable cloudlet for your client to connect to. To simplify integration, the Unity SDK provides a Default Configuration method that you may utilize, that sets parameters for when your app would like to switch to a different cloudlet. To learn more about Edge Events, refer to your guide on Maintaining Optimal Connectivity to the Edge.

These continuous events are sent through a GRPC bi-directional network connection as opposed to our REST APIs. However, current GRPC plugin support within Unity is currently experimental and as such, we offer the Edge Events feature in beta. This guide will show you how to integrate the GRPC version of the EdgeXR Unity SDK into your application to start experimenting with Edge Events.

Installation

1. First download and unzip the GRPC experimental plugin from GRPC website: GRPC Plugin 2.26.0.

2. Once you unzip it, drag and drop the Plugins into your Unity project.

3. From the Unity package manager, select the plus sign icon and then choose Add package from git URL... and paste the following link, which imports the Unity SDK from the edge-events branch: https://github.com/mobiledgex/edge-cloud-sdk-unity.git#edge-events

Setup

1. From the menu, select EdgeXR > Setup.

2. Enter the credentials specific to your application that has been deployed to the edge via the MobiledgX Console. For testing purpose, you may use any of the credentials associated with the EdgeXR Samples.

3. Then select Setup. On MacOS, this will trigger a security warning that the GRPC DLL is not signed. This warning will not be triggered on Windows.

4. After this security warning is triggered, you will need to head into MacOS secruity settings and select Allow Anyway for the grcp_csharp_ext.bundle.

5. Once the security warning has been resolved, select Setup again, which should now succeeded.

Edge Events Configs

To make using Edge Events simpler, the SDK provides a configuration to make it easier to determine what events and settings you would like to listen to. These configs are located in the EdgeXR menu under Edge Event Config.

This will open up a menu with the various settings you can use to configure EdgeXR Edge Events. You can scroll over the tooltips for each event to learn more about the specific event and how you would like to configure them.

To utilize edge events configs, need to add the EdgeEventsManager component into your scene. Then when you use MobiledgeXIntegration object, you will be able to pass the EdgeEventsManager component to the Intergration and then listen for when a better suitable cloudlet has been found.

mxi = new MobiledgeXIntegration(FindObjectOfType<EdgeEventsManager>());
mxi.NewFindCloudletHandler += HandleFindCloudlet;