Licensing
The SpeedTree Pipeline SDK requires a valid license to execute. Without a valid license, the primary API entry point, StpLoadSpeedTreeFile()
, will fail.
The Pipeline SDK utilizes RLM from Reprise Software, Inc. to manage all licensing. Reprise provides an RLM End-User Manual that may be useful if you are having licensing issues.
The SDK checks several sources to find a potential license in the following order:
- Locate the primary license through the
idvinc_LICENSE
environment variable. - Use the SpeedTree Modeler's RLM license as a fallback.
- Initiate a one-time 30-day demo license.
Please contact licensing@speedtree.com if you are having trouble licensing a SpeedTree product.
Check your license status
To check the Pipeline SDK license status, use RLM's license tools or one of the following methods:
Method | Description |
---|---|
SpeedTree Viewer | Run the SpeedTree Viewer executable provided with the SDK and select the "Pipeline SDK License" option. |
SDK function | Call StpGetLicenseStatus() from your application. |
Both provide the following information:
- If the SDK is licensed.
- How many days until the current license expires.
- The source of the license (environment variable, the Modeler, or demo).
- Any errors encountered trying to acquire the license.
Request a Pipeline SDK license
To request a Pipeline SDK license from the SpeedTree team, email licensing@speedtree.com and specify:
- "Pipeline SDK license" somewhere in the email subject or body,
- Your contact/company name,
- Your node-locked or floating license preference, and
- The host ID of the machine that's going to run the Pipeline SDK.
Find your host ID
To determine the Host ID for the machine that's going to run the Pipeline SDK, use one of the following methods:
Method | Description |
---|---|
SpeedTree Modeler | Since the Modeler is a companion application to the SDK, you may have it already installed. Run the Modeler, select the Help menu and then Edit license data. The dialog that pops up displays one or more host IDs for your system. Any will work. |
MAC Address | If you already know your computer's MAC address or a ready way to retrieve it, this will also work. |
RLM Utility | Download the “RLM End User Bundle” that matches your platform. Once installed, run the command rlmutil rlmhostid on a command-line to get the Host ID. |
SDK function | Call StpGetLicenseStatus() from your application. Once called, with or without a valid license in place, StpLicenseDetails::info contains a list of valid host IDs. |
License types and configuration
Primary license
Once you get a primary license for the Pipeline SDK, you need to set up the idvinc_LICENSE
environment variable according to the Reprise/RLM website specifications.
To set the idvinc_LICENSE
environment variable value, use one of the following methods:
Method | Description |
---|---|
Path to folder | The path to the folder containing your RLM .lic file (provided by the SpeedTree team). For example, if you've saved my_license.lic to c:/users/john_smith/my_license.lic , set idvinc_LICENSE to c:/users/john_smith . |
Full license filename | The full path name of your RLM .lic file. For example, if you've saved my_license.lic to c:/users/john_smith/my_license.lic , set idvinc_LICENSE to c:/users/john_smith/my_license.lic . |
Full license text | The actual text included in the RLM .lic file. See the example below. |
Port@host | The port@host of the license server.For example, if your license server is running on my_server with port 5053 , set idvinc_LICENSE to 5053@my_server . |
To help establish the license, use the license diagnostic messages provided by SpeedTree Viewer or the SDK function StpGetLicenseStatus()
to navigate through any problems that may occur.
The RLM .lic file can describe either a node-locked or floating license.
Node-locked licenses
A node-locked license is designed to work on a single machine. Node-locked licenses are the simplest and quickest way to get the Pipeline SDK up and running.
A node-locked RLM .lic file looks like the following:
LICENSE idvinc speedtree_pipeline_sdk 10.0 01-jul-2026 uncounted
hostid=4a2b3c8d9efa customer=johndoe issued=01-may-2024
_ck=b42dc67430 sig="60P0453SJEFKSG0Q1SEKBF1CB4SGKRX2Q6QRK8822HBMF3D0
B2NV9N8D7AHR2C88FC849U2AP8"
Floating licenses
Floating licenses are designed to be hosted on a license server accessible by multiple Pipeline SDK installations. A license server is typically a machine of your network designated to be the license host for your company.
To set up a license server, ask someone from your IT department to contact licensing@speedtree.com. We will walk you through the process, which involves these steps:
Select the machine that will be the license server for your company.
Download the “End User Bundle” that matches the platform of your license server from Reprise Software (https://reprisesoftware.com/support/admin/).
Send the server's host ID along with the name of the license server to licensing@speedtree.com.
You will receive two files from the SpeedTree team:idvinc.set
andcustomer.lic
(wherecustomer.lic
is a license file unique to your company).Place the received files in the “End User Bundle” folder and run the rlm binary.
The license server is now running.Once the license server is running, make each installation of the Pipeline SDK know where to get its license: for example, copy the .lic file into the folder stored in your
idvinc_LICENSE
environment variable.To administer the license server, open a browser and enter
myhostmachine:5054
in the address bar.
This will open the license server's embedded web interface for checking license usage, license server status, and all other administration utilities. For more details about license server management, refer to RLM's end-user manual.
A floating RLM .lic file looks like the following:
HOST my_server_name 4a2b3c8d9efa 5053
ISV idvinc port=50160
LICENSE idvinc speedtree_pipeline_sdk 10.0 16-jul-2025 1 share=uh
min_timeout=300 customer=johndoe issued=01-may-2024
_ck=28d63647d8 sig="60P0453K90K78404AJ743583N4KKBEHQBBK4RV822G4ATT3N
51Q8YGVG1VCY9551UMSPNU7J60"
Fallback to Modeler's license
When no official Pipeline SDK license is available, the SDK looks for the RLM license that the SpeedTree Modeler on the same computer may be using. This license is intended for prototyping and evaluation only, not production.
For more details about a Modeler license installation, refer to the Modeler's user manual.
Demo license (temporary)
If no Pipeline SDK or Modeler fallback license is available, a one-time 30-day demo license is automatically created. Once this license expires on your computer, you can't activate it again.
The demo license file speedtree_demo.lic
is created in the folder where you launched the program that uses the SDK for the first time. If you always launch your program from that folder, the program automatically finds the demo license file. However, if you need to run the program from different folders, you must configure your idvinc_LICENSE
environment variable to point to the speedtree_demo.lic
file in the original folder. If you don't have write permission to that folder, the license file is created in a temporary folder and removed afterward.
NOTE: If you don't ensure that the demo license file is reused, it will cause slow license checkouts and possible instability (particularly on Linux).