Releases: mobiledgex/edge-cloud-sdk-unity
Releases · mobiledgex/edge-cloud-sdk-unity
MobiledgeX SDK 3.0.0 GRPC
What's new:
- New SDK version that leverages gRPC bidirectional streaming for sending and receiving EdgeEvents to ensure you are always connected to the best server.
- Add EdgeEventsManager component to any active game object in your scene to ensure you are always connected to the best server.
- MobiledgeXIntegration constructors now have an EdgeEventsManager parameter.
- MobiledgeXIntegration now has a new NewFindCloudletHandler action, Add your HandleFindCloudlet function to NewFindCloudletHandler, see the examples for more details.
- EdgeEvents works only on Android and iOS, gRPC bidirectional streaming is not supported in UnityEditor yet.
- Added Support for non-cellular devices, see ExampleNonCellular.cs.
Setup Instructions :
https://developers.mobiledgex.com/sdks/unity-sdk/edge-events/
MobiledgeX SDK 3.0.0
What's New
- NEW Added Support for non-cellular devices, see ExampleNonCellular.cs.
- Call MobiledgeXIntegration.Dispose() to avoid memory leakage, see the examples for more details.
- LocationService updated with more robust behavior on Android and iOS.
MobiledgeX SDK 2.4.1
What's New
Unity
- NEW Add an option to get location based on IP Address instead of GPS.
- NEW Added option to switch logging between development and production in MobiledgeX Settings
- On mobile, if a user rejects the Location Permission prompt, a
Location Exceptionis thrown. - Added support for non-cellular devices such as VR Headsets like Oculus Quest.
- Support for multiple connections to different Applications with new MobiledgeXIntegration Constructor
- Local Network permission on iOS is set to false by default to avoid triggering the Local Network permission prompt.
Android
- NEW API Docuementation for the Android SDKs.
- Fixed: Throwing
RegisterClientException if RegisterClient fails to provide the reasoning behind the failure. - Added extra Logging for GRPC Exceptions to help debug.
Known Issues
If you receive the following error and cannot compile your Unity project, restart Unity.
MobiledgeX Unity SDK 2.4.0
What's New
Unity
- Added two new scripts for UDP support by the SDK
- MobiledgeXUDPClient.cs is a client implementation to simplify handling UDP connections.
- ExampleUDP.cs is an example of how to use MobiledgeXUDPClient.
- Location based on IP address added as an option for FindCloudlet to determine the closest application instance.
- Added a useSelectedRegionInProduction to enable the Region Override selector in mobile phone builds.
- DeviceInfoIntegration added as part of the PlatformIntegration constructor.
- Join The Community added to MobiledgeX Menu links to "MobiledgeX Community" Discord server.
ALL SDKs
- Added a new CreateURI / GetHost function to make it easier to get the Uri from the FindCloudlet Request.
- LProto.HTTP Enum has been removed. Please use LProto.TCP for SDK methods instead.
Samples
- NEW Multiplayer Example : EdgeMultiplay provided in the MobieldgeX Menu Sample using Websockets & UDP (EdgeMultiplay), to be found under MobiledgeX Menu (MobiledgeX/Examples).
- NEW Video Example on how to use Edge Multiplay.
- NEW Example of the MobiledgeX Ping Pong sample application using Edge Multiplay.
- NEW Open Source NodeJS Multiplayer Game Server for Edge Multiplay
- Computer Vision Example updated to support 2.4 SDK and includes more supported Servers.
- Open Source Magic Leap Sample connecting to the MobiledgeX Computer Vision Server
Documention
- NEW API Documentation for the Unity SDK
- NEW API Documentation for the C# SDK
- NEW API Documentation for Unity Edge Multiplay
- How to Stress Test an Application Instance on MobiledgeX
Known Issues
If you receive the following error and cannot compile your Unity project, restart Unity.
MobiledgeX Unity SDK 2.1.3
What's New
Unity
- SDK Version displayed in MobiledgeX Editor Window.
- You can use fallback location in production, if your device doesn't support Location Services use mobiledgeXIntegration.useFallBackLocation = true.
- ComputerVision Example added to the SDK.
- Optional region selection to connect to an app instance in a specific region (works in Unity Editor Only).
- Easier support for Magic Leap and non-mobile devies.
Android
- Added a log message to clarify that the SDK can only be used after granting location permissions and then calling MatchingEngine.setMatchingEngineLocationAllowed(true).
ALL
- LProto.UDP has been fixed and now returns the correct mapped UDP Port.
Computer Vision
- Deployed GPU specific Computer Vision app instances with the App Name ComputerVision-GPU for Object and Pose Detection
Known Issues
If you receive the following error and cannot compile your Unity project, restart Unity.
MobiledgeX Unity SDK 2.1.2
With every release, MobiledgeX endeavors to make our platform more accessible and efficient for developers to build cutting edge applications. We look to our developer community to help inform which features we should prioritize as the MobiledgeX platform continues to advance. If you have any feedback or questions when using our platform, please contact Vasanth Mohan or Wonho Park in the MobiledgeX Slack Community.
What's New
Unity
- Added .NET 4.x support for the SDK.
- Added a Remove Function to the SDK Menu to make it easy to uninstall our SDK and upgrade to a newer version.
- Added an optional auhentication token field to the MobiledgeXSettings asset.
- For iOS Builds, added a fallback on to the wifi dme when on a roaming network. This is because iOS does not provide information about the roaming carrier network.
- Added an EnsureLocation function to LocationServices. If you are using Location Services, please wait on this function for your app to get valid GPS location data from your device.
- Renamed MobiledgeXSocketClient to MobiledgeXWebsocketClient
- MobiledgeXWebsocketClient now sends Binary instead of Text
iOS
- Added a fallback on to the wifi dme when on a roaming network. This is because iOS does not provide information about the roaming carrier network.
- Renamed getHTTPConnection to getHTTPClient
Bug Fixes
- Fixed an issue where the Unity SDK passed the wrong carrier name when searching for any carrier in Find Cloudlet
- Fixed an issue where Find Cloudlet Performance mode was not returning location data
Upgrade From 2.1.0
Unity
In order to upgrade to the latest version of the SDK, you will need to do the following:
- Delete the following files & folders from the Assets folder of the project. In future updates, you can use the new Remove menu function instead.
- Assets/link.xml
- Assets/Plugins/MobiledgeX/*
- Assets/Resources/MobiledgeXSettings.asset
- Re-add the Unity Git Package to your project by going to the Unity Package Manager and re-inputting the Git URL (https://github.com/mobiledgex/edge-cloud-sdk-unity.git). For more detailed instructions on this procedure, take a look at the Unity SDK guide.
Documentation
New Guides Have Been Added on how to use the mcctl tool:
- The Ping Pong tutorial was updated to use the latest version the Unity SDK
Known Issues
If you receive the following error and cannot compile your Unity project, restart Unity.
MobiledgeX Unity SDK 2.1.0
With every release, MobiledgeX endeavors to make our platform more accessible and efficient for developers to build cutting edge applications. We look to our developer community to help inform which features we should prioritize as the MobiledgeX platform continues to advance. If you have any feedback or questions when using our platform, please contact Vasanth Mohan or Wonho Park in the MobiledgeX Slack Community.
Upgrade
In order to upgrade to the latest version of the SDK, you will need to do the following:
- Delete the following files & folders from the Assets folder of the project. In future updates, we plan to automatically delete these for you.
- Assets/link.xml
- Assets/Plugins/MobiledgeX/*
- Assets/Resources/MobiledgeXSettings.asset
- Re-add the Unity Git Package to your project by going to the Unity Package Manager and re-inputting the Git URL (https://github.com/mobiledgex/edge-cloud-sdk-unity.git). For more detailed instructions on this procedure, take a look at the Unity SDK guide.
Additionally, a few function names have changed on the MobiledgeXIntegration class. If you were using any of the following functions, here is what you need to update:
- Major: FindCloudlet now returns a bool instead of the FindCloudletReply.
- Major : GetLocationFromDevice is now a private function. If you need to get Location data, please use the Location Services class.
- Major : GetWebsocketConnection no longer calls RegisterAndFindcloudlet on behalf of developers. You will now need to call that function first, followed by calling the newly added GetAppPort function in order to use GetWebsocketConnection.
- Major : The GetURI function has now been renamed to GetURL. GetURL now returns an L7 url as a string, given an L7 protocol i.e. http, https, ws, etc.
- Minor: The useWifiOnly function has now been renamed to UseWifiOnly
- Minor : The function IsEdgeEnabled is now a private function.
New Features
- FindCloudlet now has an optional parameter called FindCloudletMode, which is an enum that supports two modes: Proximity and Performance. By default, FindCloudlet will use Proximity, which will return the same App Instance that is served via the DME. In Performance mode, the SDK will test all App Instances on a cloudlet and return back the App Instance with the lowest latency.
- New public functions for all SDKs on the Matching Engine Class : getHost(FindCloudletReply, AppPort) & getPort(AppPort). Together, both functions can be used to create the URI for the application instance returned via FindCloudlet.
- The SDK automatically fills in the App Name in the MobiledgeXSettings Window based on the Application Name in your Unity Project. If the App Name you deployed to MobiledgeX does not match the Application Name of your Unity project, please update the App Name in the MobiledgeXSettings Window to match the App Name that has been deployed to MobiledgeX.
Documentation
- New Guide documenting the API of Computer Vision Sample Application. Useful if you want to deploy the open source Computer Vision server to one of the MobiledgeX cloudlets and connect to it with a client app.
- The Unity Ping Pong Sample Application has been updated to use the 2.1 Unity SDK and new import procedure. We have also updated the Ping Pong Guide to walk you through how to setup the Unity SDK using the package manager.
Known Issues
If you receive the following error and cannot compile your Unity project, restart Unity.