Difference between revisions of "Active Marker Tracking: IMU Setup"

(Blanked the page)
Line 1: Line 1:
 +
'''Page Scope'''
 +
:This page provides instructions on configuring the active components, Active Tags and/or Active Pucks, that are equipped with inertial measurement unit (IMU) sensors. By fusing the optical tracking data of the active markers with the IMU data, Motive can further stabilize the rotational tracking of the rigid bodies and accommodate for tiny jitters throughout the tracking. This is recommended for applications where the stability of rotation tracking data is important, including tracking cameras in virtual production applications, tracking drones in low camera-count setups, and more.
  
 +
'''Requirements'''
 +
<div class="padded">
 +
* Motive version 2.2 or higher
 +
* IMU Active Batch Programmer
 +
* Base Station: Firmware 2.2.2 or above
 +
* IMU Active Tags/Pucks: Firmware 2.2.1 or above
 +
</div>
 +
 +
'''Additional Information'''
 +
<div class="padded">
 +
* When configured, each Active Base Station can communicate with up to 7 IMU Tags/Pucks.
 +
* When needed, multiple Base Stations can be plugged into the same camera network; as long as they are communicating through a separate channel.
 +
* To use the IMU components, all of the devices, including the Base Station, must have firmware version 2.x or above installed. Please follow the instruction below to check the firmware versions on each device.
 +
</div>
 +
 +
 +
 +
=Active Component Setup=
 +
----
 +
For the IMU data to be used for tracking in Motive, unique Uplink IDs must be assigned onto each IMU Tag or Puck using the active batch programmer program. Then, the Uplink IDs will need to be inputted under the properties of the corresponding rigid bodies in Motive. Please follow the steps below:
 +
 +
==1) Download Active Batch Programmer==
 +
<div class="padded">
 +
Use the following link to download the batch programmer used for 2.x firmware. Once downloaded, unzip the downloaded file and launch the EXE file.
 +
 +
https://drive.google.com/file/d/1UbZ75pa6x6bs2f-75-RP71DniyJuB5Yy/view?usp=sharing
 +
</div>
 +
 +
==2) Check the firmware version and existing configuration==
 +
<div class="padded">
 +
Before setting up the components, we will want to check the existing configurations on the Base Station, Tags, and/or Pucks. To check this, enable the ‘’Read-Only Mode’’ check box at the bottom-left corner of the active batch programmer, and then connect the devices one at a time via USB. Each time a new active component is detected, existing configurations including the firmware version will get listed under the Log section. If any of the settings do not meet the below requirements, you can re-configure them in the next step.
 +
 +
====Firmware====
 +
<div class="padded">
 +
In order to use IMU Tags/Pucks, all of the active components must have firmware version 2.2.x or above installed. Please check the firmware version on the active components. If the installed firmware is an older version, please [https://optitrack.com/contact/ contact us] for assitance with upgrading the firmware.
 +
</div>
 +
 +
====RF Channel====
 +
<div class="padded">
 +
Please make sure that all of the active components are communicating through the same channel. Check this and take a note of the channel value as this will also need to be inputted into Motive for IMU data. The RF channel can be set anywhere between 11-26.
 +
</div>
 +
 +
====Label====
 +
<div class="padded">
 +
The Labels are active IDs assigned to each marker, and it's important that there are no overlapping labels, or IDs, assigned to the same batch of active Tags/Pucks. This setting is applicable to Active Tags/Pucks only.
 +
</div>
 +
 +
After checking the settings, you can unplug the device and connect the next one to check the settings.
 +
 +
{{Warning|'''Important'''
 +
:When checking the configuration, make sure the Read-Only Mode is enabled. If not, the active batch programmer will upload the settings onto the new Tags that are newly detected by the computer. This could reset the existing configuration that is already on the device.}}
 +
 +
<center><ul>
 +
<li class="thumblist">[[Image:IMU_Setup1.png|thumb|center|850px|Checking the existing settings by enabling Read-Only Mode.]]</li>
 +
<li class="thumblist">[[Image:IMU_Setup1_Firmware.png|thumb|center|850px|Checking existing configuration on an Active Base Station and the RF channel]]</li>
 +
</ul></center>
 +
</div>
 +
 +
==3) Configure the settings in the Active Batch Programmer==
 +
<div class="padded">
 +
Now that we understand the existing configurations and what needs to be changed, we can configure the active components. To do this, disable the Read-Only Mode in the batch programmer, and settings configured in the IMU batch programmer will get applied to each newly connected device. Please note that this could also reset the existing configuration, thus, make sure to configure only the settings that need to be changed.
 +
 +
====Configure Uplink ID====
 +
<div class="padded">
 +
For IMU Tags or Pucks, unique Uplink IDs need to be assigned for each of them. For doing this, simply check the box next to the Uplink ID whenever we are configuring IMU Tags or Pucks.
 +
</div>
 +
 +
====RF Channel/Label====
 +
<div class="padded">
 +
Uncheck the boxes next to the Set Marker Labels and RF Channel; unless they need to be reconfigured.
 +
 +
All of the Tags/Pucks are pre-configured for every set of devices that gets shipped out in the same order, and we also make sure none of the Labels overlap. Thus, users should not need to use this batch programmer in general. The cases when you would want to reconfigure the active components are: 1) When you have purchased new Tags/Pucks to add to the system from the previous order. 2) When there is a need to change the RF communication channel to avoid interferences.
 +
 +
In cases where marker labels or RF channels need to be reconfigured, enable the box next to the corresponding setting in the batch programmer. DO NOT check the box unless the settings need to be changed. For reconfiguring marker labels, we will need to re-configure ALL of the Tags and Pucks so that the labels do not overlap with other components in the system.
 +
 +
<center><ul>
 +
<li class="thumblist">[[Image:IMU_Setup2_1_edited.png]]</li>
 +
<li class="thumblist">[[Image:IMU_Setup2_2_edited.png]]</li>
 +
</ul></center>
 +
</div>
 +
</div>
 +
 +
==4) Connect an active component==
 +
<div class="padded">
 +
Once we have configured the settings in the batch programmer, connect Active Tags or Pucks one at a time and the programmer will apply the configured settings to the newly connected device, and it will also make sure that the IDs do not overlap in the same batch. Once the settings get applied the details will get listed under the Log.
 +
 +
It’s recommended to note the assigned Uplink IDs for each Tag/Puck so that we can track down the settings easily when needed.
 +
 +
[[Image:IMU_Setup3.png|center|thumb|850px|Uplink ID of 1 applied to a Tag]]
 +
</div>
 +
 +
==5) Disconnect and connect remaining devices==
 +
<div class="padded">
 +
Once a device is configured, disconnect and connect the next device to apply the same settings and unique IDs. Repeat this for all of the active components that need to be configured.
 +
</div>
 +
 +
 +
=Tag Attachment to Tracked Objects=
 +
----
 +
When using an IMU Active Tag to create a custom rigid body, please make sure both the PCB board of the tag and the LEDS are securely attached and rigidly constrained to the object. The attachments of the board and the markers must be rigid within the object for proper tracking.
 +
 +
 +
=Motive Setup=
 +
----
 +
Now that each of the IMU Tags/Pucks has been assigned with an Uplink ID, the next step is to input this ID into the properties of the corresponding rigid bodies in Motive. Also, the RF channel configured for each active component will need to be inputted as well. Follow the below steps to assign Active Tag ID and Active RF Channel property for each rigid body:
 +
 +
<div class="padded">
 +
====1) Launch Motive====
 +
:Make sure the configured Active Base Station is connected to the camera system and launch Motive.
 +
 +
====2) Configure Motive for tracking active markers (for 2.2)====
 +
: Make sure the camera system is calibrated and Motive is configured for tracking active markers. You can set this under the Application Settings in Motive, or directly from the viewport by clicking on the orange icon at the top.
 +
 +
[[Image:IMU_MotiveSetup1.png|center]]
 +
 +
====3) Power the IMU Tag/Puck====
 +
: Click the power button on the Tag/Puck to start the device. When the Tag/Puck first initializes, the status LEDs will start blink in red and orange rapidly. This indicates that the IMU sensor is attempting to initialize. At this stage, keep the IMU Tag/Puck stationary until the status LED blinks in green indicating that it has completed the initialization.
 +
 +
{{Indent|{{Info|Note: Do not hold down on the power button when powering up the Tag/Puck as it will put the device into a boot mode. When in boot mode, it will not track in Motive and two of the LEDs will light up in orange. If this happens, hold down on the power button again to turn off the Tag/Puck and restart it with just a single click on the button.}}}}
 +
 +
====4) Create a rigid body====
 +
:Select the active markers associated with a Tag/Puck and create a rigid body.
 +
 +
====5) Access advanced rigid properties====
 +
: Open the [[Properties pane]] and select the rigid body. Reveal the advanced properties by clicking on "..." menu at the top-right and selecting ''Show Advanced''.
 +
 +
[[Image:IMU_MotiveSetup3.png|center]]
 +
 +
====6) Input IMU Properties: Active Tag ID and RF Channel====
 +
: Scroll down to find the IMU section and input the Uplink ID for the corresponding Tag/Puck into the Active Tag ID property. Then, input the RF channel used for communication with the Base Station. Once this is done, the rigid body is configured for using the IMU tag. You can also adjust the Sensor Fusion property to balance the contribution between optical tracking data and IMU data for the rigid body solve.
 +
 +
[[Image:IMU_MotiveSetup4.png|center]]
 +
 +
====7) Check the status====
 +
: At this point, the IMU Tags and Pucks are ready to be used. The color of the rigid body indicates the status of the IMU data stream.
 +
 +
{| class = "wikitable" style="margin:auto; width: 80%; padding-left:3%;"
 +
|+IMU Rigid Body Status
 +
|-
 +
!Status
 +
!Connected
 +
!Calibrating
 +
!No incoming data
 +
|-
 +
|Viewport
 +
|[[Image:IMU_Status1.png|center|250px]]
 +
|[[Image:IMU_Status2.png|center|250px]]
 +
|[[Image:IMU_Status3.png|center|250px]]
 +
|-
 +
 +
|-
 +
|Description
 +
|style="padding:1.5%; width:35%"|When the color of rigid body is the same as the assigned rigid body color, it indicates Motive is connected to the IMU and receiving data.
 +
|style="padding:1.5%; width:35%"|If the color is orange, it indicate the IMU is attempting to calibrate. Slowly rotate the object until the IMU finishes calibrating.
 +
|style="padding:1.5%; width:35%"|If the color is red, it indicates the rigid body is configured for receiving IMU data, but no data is coming through the designated RF channel. Make sure Active Tag ID and RF channel values mat the configuration on the active Tag/Puck.
 +
|}
 +
 +
{{Indent|{{Info|'''Confirm IMU Tracking'''
 +
:It may be helpful to double-check to confirm that IMU is working properly. To do this, access the properties of the IMU rigid body, set the Min Marker Count rigid body property to 2, and set the Tracking Algorithm to Marker Based. Then, cover up all of the active markers on the Tag/Puck except for two, and make sure that Motive is still able to track the rigid body rotation.}}}}
 +
</div>

Revision as of 15:58, 11 June 2021

Page Scope

This page provides instructions on configuring the active components, Active Tags and/or Active Pucks, that are equipped with inertial measurement unit (IMU) sensors. By fusing the optical tracking data of the active markers with the IMU data, Motive can further stabilize the rotational tracking of the rigid bodies and accommodate for tiny jitters throughout the tracking. This is recommended for applications where the stability of rotation tracking data is important, including tracking cameras in virtual production applications, tracking drones in low camera-count setups, and more.

Requirements

  • Motive version 2.2 or higher
  • IMU Active Batch Programmer
  • Base Station: Firmware 2.2.2 or above
  • IMU Active Tags/Pucks: Firmware 2.2.1 or above

Additional Information

  • When configured, each Active Base Station can communicate with up to 7 IMU Tags/Pucks.
  • When needed, multiple Base Stations can be plugged into the same camera network; as long as they are communicating through a separate channel.
  • To use the IMU components, all of the devices, including the Base Station, must have firmware version 2.x or above installed. Please follow the instruction below to check the firmware versions on each device.


Active Component Setup


For the IMU data to be used for tracking in Motive, unique Uplink IDs must be assigned onto each IMU Tag or Puck using the active batch programmer program. Then, the Uplink IDs will need to be inputted under the properties of the corresponding rigid bodies in Motive. Please follow the steps below:

1) Download Active Batch Programmer

Use the following link to download the batch programmer used for 2.x firmware. Once downloaded, unzip the downloaded file and launch the EXE file.

https://drive.google.com/file/d/1UbZ75pa6x6bs2f-75-RP71DniyJuB5Yy/view?usp=sharing

2) Check the firmware version and existing configuration

Before setting up the components, we will want to check the existing configurations on the Base Station, Tags, and/or Pucks. To check this, enable the ‘’Read-Only Mode’’ check box at the bottom-left corner of the active batch programmer, and then connect the devices one at a time via USB. Each time a new active component is detected, existing configurations including the firmware version will get listed under the Log section. If any of the settings do not meet the below requirements, you can re-configure them in the next step.

Firmware

In order to use IMU Tags/Pucks, all of the active components must have firmware version 2.2.x or above installed. Please check the firmware version on the active components. If the installed firmware is an older version, please contact us for assitance with upgrading the firmware.

RF Channel

Please make sure that all of the active components are communicating through the same channel. Check this and take a note of the channel value as this will also need to be inputted into Motive for IMU data. The RF channel can be set anywhere between 11-26.

Label

The Labels are active IDs assigned to each marker, and it's important that there are no overlapping labels, or IDs, assigned to the same batch of active Tags/Pucks. This setting is applicable to Active Tags/Pucks only.

After checking the settings, you can unplug the device and connect the next one to check the settings.

Warning2.png

Important

When checking the configuration, make sure the Read-Only Mode is enabled. If not, the active batch programmer will upload the settings onto the new Tags that are newly detected by the computer. This could reset the existing configuration that is already on the device.

  • Checking the existing settings by enabling Read-Only Mode.
  • Checking existing configuration on an Active Base Station and the RF channel

3) Configure the settings in the Active Batch Programmer

Now that we understand the existing configurations and what needs to be changed, we can configure the active components. To do this, disable the Read-Only Mode in the batch programmer, and settings configured in the IMU batch programmer will get applied to each newly connected device. Please note that this could also reset the existing configuration, thus, make sure to configure only the settings that need to be changed.

Configure Uplink ID

For IMU Tags or Pucks, unique Uplink IDs need to be assigned for each of them. For doing this, simply check the box next to the Uplink ID whenever we are configuring IMU Tags or Pucks.

RF Channel/Label

Uncheck the boxes next to the Set Marker Labels and RF Channel; unless they need to be reconfigured.

All of the Tags/Pucks are pre-configured for every set of devices that gets shipped out in the same order, and we also make sure none of the Labels overlap. Thus, users should not need to use this batch programmer in general. The cases when you would want to reconfigure the active components are: 1) When you have purchased new Tags/Pucks to add to the system from the previous order. 2) When there is a need to change the RF communication channel to avoid interferences.

In cases where marker labels or RF channels need to be reconfigured, enable the box next to the corresponding setting in the batch programmer. DO NOT check the box unless the settings need to be changed. For reconfiguring marker labels, we will need to re-configure ALL of the Tags and Pucks so that the labels do not overlap with other components in the system.

  • IMU Setup2 1 edited.png
  • IMU Setup2 2 edited.png

4) Connect an active component

Once we have configured the settings in the batch programmer, connect Active Tags or Pucks one at a time and the programmer will apply the configured settings to the newly connected device, and it will also make sure that the IDs do not overlap in the same batch. Once the settings get applied the details will get listed under the Log.

It’s recommended to note the assigned Uplink IDs for each Tag/Puck so that we can track down the settings easily when needed.

Uplink ID of 1 applied to a Tag

5) Disconnect and connect remaining devices

Once a device is configured, disconnect and connect the next device to apply the same settings and unique IDs. Repeat this for all of the active components that need to be configured.


Tag Attachment to Tracked Objects


When using an IMU Active Tag to create a custom rigid body, please make sure both the PCB board of the tag and the LEDS are securely attached and rigidly constrained to the object. The attachments of the board and the markers must be rigid within the object for proper tracking.


Motive Setup


Now that each of the IMU Tags/Pucks has been assigned with an Uplink ID, the next step is to input this ID into the properties of the corresponding rigid bodies in Motive. Also, the RF channel configured for each active component will need to be inputted as well. Follow the below steps to assign Active Tag ID and Active RF Channel property for each rigid body:

1) Launch Motive

Make sure the configured Active Base Station is connected to the camera system and launch Motive.

2) Configure Motive for tracking active markers (for 2.2)

Make sure the camera system is calibrated and Motive is configured for tracking active markers. You can set this under the Application Settings in Motive, or directly from the viewport by clicking on the orange icon at the top.
IMU MotiveSetup1.png

3) Power the IMU Tag/Puck

Click the power button on the Tag/Puck to start the device. When the Tag/Puck first initializes, the status LEDs will start blink in red and orange rapidly. This indicates that the IMU sensor is attempting to initialize. At this stage, keep the IMU Tag/Puck stationary until the status LED blinks in green indicating that it has completed the initialization.

Info2.png

Note: Do not hold down on the power button when powering up the Tag/Puck as it will put the device into a boot mode. When in boot mode, it will not track in Motive and two of the LEDs will light up in orange. If this happens, hold down on the power button again to turn off the Tag/Puck and restart it with just a single click on the button.

4) Create a rigid body

Select the active markers associated with a Tag/Puck and create a rigid body.

5) Access advanced rigid properties

Open the Properties pane and select the rigid body. Reveal the advanced properties by clicking on "..." menu at the top-right and selecting Show Advanced.
IMU MotiveSetup3.png

6) Input IMU Properties: Active Tag ID and RF Channel

Scroll down to find the IMU section and input the Uplink ID for the corresponding Tag/Puck into the Active Tag ID property. Then, input the RF channel used for communication with the Base Station. Once this is done, the rigid body is configured for using the IMU tag. You can also adjust the Sensor Fusion property to balance the contribution between optical tracking data and IMU data for the rigid body solve.
IMU MotiveSetup4.png

7) Check the status

At this point, the IMU Tags and Pucks are ready to be used. The color of the rigid body indicates the status of the IMU data stream.
IMU Rigid Body Status
Status Connected Calibrating No incoming data
Viewport
IMU Status1.png
IMU Status2.png
IMU Status3.png
Description When the color of rigid body is the same as the assigned rigid body color, it indicates Motive is connected to the IMU and receiving data. If the color is orange, it indicate the IMU is attempting to calibrate. Slowly rotate the object until the IMU finishes calibrating. If the color is red, it indicates the rigid body is configured for receiving IMU data, but no data is coming through the designated RF channel. Make sure Active Tag ID and RF channel values mat the configuration on the active Tag/Puck.

Info2.png

Confirm IMU Tracking

It may be helpful to double-check to confirm that IMU is working properly. To do this, access the properties of the IMU rigid body, set the Min Marker Count rigid body property to 2, and set the Tracking Algorithm to Marker Based. Then, cover up all of the active markers on the Tag/Puck except for two, and make sure that Motive is still able to track the rigid body rotation.