Snobal SDK provides libraries and developer tools necessary to build, test, and integrate your VR/AR apps with Snobal . Snobal SDK is made available under license by Snobal.
You need to have a Snobal account before you can use the Snobal SDK. Reach out to get started.
Glossary of Terms
Activity – An activity is a group of tasks the attendee needs to complete. For example, a virtual CPR training experience might contain multiple tasks that need to be completed in order to successfully complete the experience for e.g clear the mouth from debris, roll the person onto their side. An activity generally has a pass or fail. That is, if an attendee fails 50% of the tasks then they fail the activity.
Attendees – Attendees typically do not have access to the Snobal dashboard. Typically an attendee is an end-user of a virtual experience.
Login – Connecting to Snobal backend using pairing information. Needs to be called each time the application starts.
Pairing – The process of assigning a VR device to Snobal backend. Typically done only once when installing VR/ AR application via Snobal deployment.
Session – A session is a collection of attendees with an assigned VR/AR experience or VR meeting. For example, assigning an attendee called James a session to do a virtual CPR training experience. Or assigning multiple attendees to a meeting.
Task – This is a single thing the attendee is required to do. Generally, a task has a pass or fail. For eg in a virtual CPR training experience, did the attendee check for debris in the mouth before rolling the CPR victim onto their side?
Users – People that have access and login to Snobal dashboard.
Before you start
Typically a normal flow for a VR application using the Snobal SDK would be:
- Snobal app asks for the pairing code. From this, it installs all the required applications & creates a settings file uses to login.
- Attendee runs the application, it logs in using the settings file.
- Application checks for sessions for attendee.
- Application allows attendee to select which activity they want to do. Any order of activities is allowed.
- Application opens the selected activity.
- Application opens the first task.
- Attendee passes or fails the task. Application closes the tasks with this outcome.
- Application can reopen the same task or move on to the next.
- The process repeats until the application deems the activity is over.
- Application closes the activity with an outcome. That is, lower than 50% of tasks completed is a fail.
- Application closes the session. This moves the session from the Inprogress to the completed tab.
- Application logs out. This also happens automatically when the application closes.
- Application terminates.
In the example below the attendee (Snobal: Nigel) has two activities, DTC Activity1 Name & DTC Activity2 Name. Define the number of activities and task names you require. Each has the required tasks listed with a tick for a pass, a cross for a fail, and a grey circle to show the task has been opened but not closed yet.
This attendee has passed activity 1 (green button) and failed activity 2 (red button). The attempt column shows the number of times the attendee tried on this session, you can repeat the same task again & again.
Example session in progress:
Quick Start Guide
This SDK comes with a sample scene for quick setup and examples. It is recommended to use the SDK in a Unity test project to get familiar before trying to integrate it into an existing project.
It is also recommended to get familiar with your Snobal dashboard before starting, create a new attendee, create a new device, create a new session.
Steps to get started:
- Create new a Unity project
- Import the latest SnobalCloudSDK Unity package
- Goto the sample scene (PairingScene)
- Go to your Snobal admin dashboard, and create a new device to get a device pairing token.
- Run the sample scene, enter your pairing code & click pair. The pairing code is used to map this device to a tenant & session. If everything worked well it should create a SnobalCloudSettings.json file in your unity persistent data path. Normally on Android applications, the Snobal app would do these steps but for development on a PC you can write your own pairing UI like this. This only happens once, you can skip the pairing next time.
- Login with the button, this should display the Snobal tenant or workspace you are paired with.
- Create a session on your Snobal admin dashboard. Click the Get session button & you should see the session details displayed.
- Enter the activity name and press Open Activity. View session details on your Snobal admin dashboard, including the open activity. Continue to watch the session details after each step below.
- Enter a task name and press Open Task.
- Close the task with a pass or fail.
- Repeat 9 and 10 for all tasks.
- Close activity with a pass or fail.
- Repeat step 8 for all activities and tasks.
- Close session.
- Log out.
Sample scene from the SDK:
Snobal writes out a settings file called SnobalCloudSDK.json in the persistent data path. It also requires internet access.
Ensure you enable write permission & internet access for your application inside Unity.
1) Check the pairing example script for examples on calling the Snobal functions to pair, login, get a session, open and close activities, and tasks.
2) The SnobalCloudMono game object is the only thing required in order for Snobal to work in any project. Reference the SnobalCloudInstance for access to all the cloud functionality.
Remember not to delete it if you switch scenes.
Snobal SDK works with any platform supported by Unity including Android & PC.
Latest release: SnobalCloud SDK1.0.4 unitypackage
Request to download
Release date: 14 October 2021
- Added a help page.
- Added sessions on demand which includes ValidatePasscode, GetAvailableExperiences, and CreateSession
SnobalCloud SDK1.0.3 unitypackage
Release date: 08 October 2021
- Bug fix. Copying the MDM settings into the application’s persistent data path wasn’t working.
- Results in the app running & not being paired even though it was installed via the MDM.
- Bug fix. Crash on shutdown. – Added version number into sample scene.
- Made changes to enable sample scene to be run on a standalone PC build.
- Added console output into the sample scene.
- Added compatibility with the Pico Neo 3
SnobalCloud SDK1.0.2 unitypackage
Release date: 20 September 2021