DevKit quick start

You have got your hands on our DevKit!
We prepared a step-by-step tutorial for quick start. Follow the instructions below.

Devkit quick start

You have got your hands on our DevKit!
We prepared a step-by-step tutorial for quick start. Follow the instructions below.

Prepare for setup Tracking area setup Software setup Placement Wireless devices Download SDK Run samples Troubleshooting

Wireless devices

Device properties

Basically, there are 4 kinds of Antilatency devices:

  • Alt tracker

  • USB socket (w/o radio)

  • HMD Radio socket

  • Wireless radio sockets (Bracer and Tag)

Alt tracker can be used with any of these devices. A HMD Radio socket can be used as a typical USB socket without radio. If it’s not needed, or can be used with radio enabled to establish connection to the Tags and/or Bracers. Currently up to 2 slave devices can be connected to 1 HMD Radio socket (2 Bracers or 2 Tags or 1Bracer and 1 Tag). If you need to connect more slave devices, you can add an additional HMD Radio socket.

Antilatency devices properties

Any Antilatency device has a properties list. Some of these properties are read-only, for  example, hardware serial number. Some can be overwritten by the user, for example, “Tag”. Currently you can’t add or remove any properties. There is the Property Manager application in the SDK, that allows you to view and edit device properties.

HMD Radio socket initial setup

If you plan to use Tags or Bracers in your project, first of all you need to set up a HMD Radio socket:

  1. Choose a radio channel that will be used by this socket by setting the “RadioChannel” property. The default value is -1 – in this case the socket will choose the first free radio channel. Also, you can set a specific channel in the range of 0 - 32, that will be used. To know how the channel id is mapped to a radio frequency, take a look at the table at the end of this document.

  2.  Set a connection limit by applying the corresponding value to the “ConnLimit” property. If you don’t need to use radio on this socket, set the value to 0. If you plan to use only 1 wireless device, set it to 1. If you plan to connect 2 wireless devices to this socket, set it to 2. You can keep this setting at 2 while using only one wireless device, but some of the radio traffic will be used looking for a 2nd device. In case of an unstable radio connection caused by the distance between the USB socket and the wireless socket, some obstacles between these sockets, or additional radio noise on this channel from other emitters. In this case, some packets from the wireless socket may be lost which will lead to tracking task being restarted on the Alt tracker that connected to the wireless socket.

  3. Optional: set the “Tag” for the socket – a user device identifier, for example, “LeftHand”, “Pistol”, etc. Please, check the corresponding section about how to use the “Tag” property.

To apply these settings to a HMD Radio socket, you need to:

  1. Connect the HMD Radio socket to your PC

  2. Run the Property Manager application

  3. Apply the settings to the HMD Radio socket (check the Property Manager manual to see details)

HMD Radio socket LED signals

LED signal

Socket state

Blinking green light (on/off)

Radio is disabled (connection limit is 0)

Green to blue cyclic change

Searching for a free radio channel or the radio channel is set to a specific value and this channel is occupied by another device

Blinking <color> (on/off)

The HMD Radio socket found a channel to work with and now waits for wireless sockets. <color> is the channel identification, different channels will have different colors

Smoothly blinking <color>

HMD Radio socket has at least one other wireless socket connected to it, <color> will be equal on these devices

Bright red to pale red cyclic change

Bootloader mode

Constant red light

Device error, it will be restarted in a few seconds

Red blinking (on/off) for N times

Hardware error, N – error code

Additional Pico G2 socket indication

Short green flash

External USB cable connected. Radio and Alt tracker is turned off

 

Working with wireless sockets

There are 2 properties that can be controlled by the user on Tags and Bracers:

  • Master serial number (MasterSN) – you can define the HMD Radio socket serial number to allow the bracer or the tag to connect only to that socket.

  • Tag – some user device identifier, for example, “LeftHand”, “Pistol”, etc. Please, check the corresponding section about how to use the “Tag” property.

Basically, wireless sockets try to connect to the nearest HMD Radio socket. This behavior is quite simple and good for local testing purposes or when you have only one active HMD Radio socket at a time. But if you plan to create a multi-user game, this characteristic can cause some initial user setup issues and so on. So, you can allow a wireless socket to connect only to a specific HMD Radio socket. There are 2 ways to apply this setting:

Using Property Manager app:

  1. Run the Property Manager

  2. Connect the HMD Radio socket to your PC

  3. Power up the wireless socket

  4. Click on the HMD Radio socket node in the Property Manager

  5.  Select the “sys/HardwareSerialNumber” property value and press Ctrl+C

  6. Click on the wireless radio socket node in the Property Manager (Alt Bracer or Alt Tag)

  7. Select the “MasterSN” property value, press Ctrl+V, and click on the Set button

Using a wireless socket power button:

  1. Power up the HMD Radio socket

  2. Power up the wireless socket by the single-click power on button

  3.  Check that the wireless socket is connected to the HMD Radio socket (both device LEDs will be blinking smoothly with the same color)

  4. Press and hold the power button on the wireless socket for about 5 seconds, after that the wireless socket will be restarted and save the HMD Radio socket’s hardware serial number in the “MasterSN” property.

To reset this property:

Power up the wireless socket and press the power button for 5 seconds, after that the wireless socket will be restarted and the “MasterSN” property will be erased. In this case you don’t need to connect this wireless socket to the HMD Radio socket.

Using the Property Manager:

  1.  Run the Property Manager

  2. Connect the HMD Radio socket to your PC

  3. Power up the wireless socket

  4. Click on the wireless radio socket node in the Property Manager

  5. Clear the “MasterSN” property value (“Enter property…” will be shown)

  6. Click on the Set button

Using the “Tag” property

The “Tag” property can be edited on any socket. It is quite useful if you plan to work with multiple trackers at one time: 2 or more Alt trackers connected to 2 or more USB Sockets, or Bracers, or Tags. In this case you may need some info about what a specific tracker is responsible for. For example, you plan to use 1 HMD Radio socket and 2 Bracers, one on the left hand, the other on the right hand. So, you can set the “Tag” property value for the first bracer as “LeftHand”, and the second as “RightHand”, and then setup your project to search for tracker nodes that connected to the socket with a specific “Tag” property. You can find exactly the same usage in our base Unity package scene “AltBracerSample”.

Wireless socket LED signals

Led signal

Socket state

Green to blue cyclic change

Wireless socket is trying to find any HMD Radio socket to connect

Green to blue quick cyclic change

Wireless socket is trying to find a specific HMD Radio socket (“MasterSN” property is not empty)

Smoothly blinking <color>

Wireless socket is connected to the HMD Radio socket. <color> should be identical on both devices.

Constant red light

Device error, it will be restarted in a few seconds

Red blinking (on/off) for N times

Hardware error, N – error code

Additional Tag’s signals

Cyclic 5 second red light – 5 seconds off

Socket is charging

Constant green

Socket is fully charged

Additional Bracer charger’s signals

Blinking green

Bracer is charging

Constant green

Bracer is fully charged

A property manager is a simple app that allows you to read from and write to Antilatency device properties. In a future release, this functionality will be moved to AltSystem. Currently, there is no way to add or remove any user-defined properties, but you can already read from and write to predefined properties. 

In most cases, this app is used to set a “Tag” property for Sockets, Bracers, and Tags. Also, you can set a radio channel and connection limit settings for HMD Radio Sockets using this app. The “Tag” property acts as a kind of device identifier, that can be used by your application to determine how this device should be used. For example, you can mark one bracer with the “LeftHand” tag and other with “RightHand”, and set your app to look for such devices. Our BracerSample scene uses the same setup as in the SDK base Unity package.

When you start the Property Manager, you will see this: 

 

If there are no devices listed in Property Manager, check that your devices are connected to the host and there are no other application running which are using the Antilatency SDK. Only one application at a time can work with Device Network.

Using the image above we can see that 4 devices are currently connected: HMD Radio Socket, Bracer, and 2 Alt Trackers. One of the trackers is plugged in to Socket and one into Bracer. To open the device properties, click on any device, for example, such properties are used for HMD Radio Socket:

Common properties

  • sys/HardwareName – hardware device name

  • sys/HardwareSerialNumber – unique device hardware serial number

  • sys/HardwareVersion – device hardware version

  • sys/SoftwareName – device firmware name

  • sys/SoftwareVersion – device software version

 

HMD Radio Sockets properties

  • Connection Limit (ConnLimit) – is the maximum number of radio devices that can be connected to this radio socket simultaneously. Possible values: 0, 1, 2.

  • Radio Channel allows you to set a radio channel that will be used for this device, using these possible values:

    • -1 – automatic channel selection. The device will scan all channels and select the best one

    • 0, 1, 2, …, 32 – one of 33 channels that will be used by the device

  • Tag – a user defined device identifier, for example, “LeftHand”, “Pistol”, etc., possible values of any string consists of 63 or fewer symbols.

 

Bracers and Tags properties

  • MasterSN can define a socket serial number to allow the Bracer to connect only to that socket. 

  • Tag is a user device identifier, for example, “LeftHand”, “Pistol”, etc.

  • Vbat is the bracer's battery voltage. Currently, this value updates only at startup. We will fix that in a future SDK update.

For your convenience, we and our partners use cookies on this website. If you do not change the settings, we will treat this as consent with data usage policy on antilatency.com