Introduction

HumanOS® License Manger is a command line tool to manage the HumanOS® Licenses, especially for HumanOS IoT Gateways with its devices and device licenses.

Installation

The installer provided by CyberTech Engineering is named in the following way:

HumanOS.SAL.LicenseManager-$(os)-$(platform-$(version)-$(build-nr)

• $(os) Currently, only windows is available (win)
• $(platform) Currently, only x64 platform is supported
• $(version) HumanOS IoT Designer version
• $(build-nr) Build number

Example: HumanOS.SAL.LicenseManager-win-x64-v1.3.7-015.exe

Installation Path

Default installation: C:\Program Files (x86)\CyberTech\HumanOS.SAL.LicenseManager \

Configuration

The License Manager does not need any specific configuration. Make sure the tool has access to https://portal.humanos.ch.

Add the installation path (above) to your environment variables. The value must be added to the Path variable in the system variables.

Usage

Usage of license manager.

Authentication

The License Manager needs uses the personal portal login and the ID of the product license. Ask CyberTech to get the login and license information.

--LicenseId=$(id) sets the program license
--UserName=$(uid) sets user name
--Password=$(pw) sets user password

Commands

Different commands are used to read or manipulate licenses.

Reading Device Licenses

--ListAll lists all devices license ids
--GetDeviceInfo shows the details of a license.
--DeviceId=$(id) id of the device license or --ListAll for all devices

Examples:

Lists all device license ids

HumanOS.SAL.LicenseManager.exe --UserName=$(name) --Password=$(password) --LicenseId=$(licid) --ListAll

Lists all device licenses with details

HumanOS.SAL.LicenseManager.exe --UserName=$(name) --Password=$(password) --LicenseId=$(licid) --ListAll --GetDeviceInfo

Lists only a specific device license with details

HumanOS.SAL.LicenseManager.exe --UserName=$(name) --Password=$(password) --LicenseId=$(licid) --DeviceId=$(deviceid) --GetDeviceInfo

Creating a new Device License

--NewDevice generates a new device license
--Template=$(file) device file as template. The address, device type and machine information are taken from that template
--OutDir=$(dir) output directory of license and generated device file

Combine with the Argument --DownloadDeviceLicense to download the device license from the portal.

Template Device Info File

The Template is a device info file. Set the needed information previously before calling the license manager.

{
  "Id": "{6826dfc1-e9d1-48b8-95dd-b574251e5f2d}",
  "Name": "Millx500-2",
  "DriverId": "B3CCD1A7-A49B-46FC-B983-5284992F6444",
  "Address": "CNC-1",
  "Properties": [
    {
      "Name": "DeviceType",
      "Value": "Fanuc 0iF"
    },
    {
      "Name": "MachineInventoryNumber",
      "Value": "MACH-102-02921-3723B"
    },
    {
      "Name": "MachineSerialNumber",
      "Value": "1022-00021"
    },
    {
      "Name": "MachineName",
      "Value": "Millx500"
    },
    {
      "Name": "MachineType",
      "Value": "Milling Machine"
    },
    {
      "Name": "SupplierName",
      "Value": "CTE"
    }
  ]
}

Following data are immutable (cannot be changed afterwards):

• Id: the current id of the template is ignored. The Id is automatically set in the generated device info file which is put in the output directory.
• Name: name of the device
• DriverId: id of the driver needed to connect to the device.
• DeviceType: type of the device

Following data can be changed without deleting the device license (see [Change License Meta Data])

• Address: Connecting address
• MachineName: [Optional] name of the complete machine
• MachineType: [Optional] machine type, like Milling Machine
• SupplierName: [Optional] name of the supplier or machine builder
• MachineSerialNumber: [Optional] serial number from the supplier
• MachineInventoryNumber: [Optional] inventory number of the machine

Output Directory Structure

All data is stored in the OutDir folder.

"$(OutDir)\Config\Devices\" contains the generated device info file.
"$(OutDir)\Licenses\" contains the program license
"$(OutDir)\Licenses\Devices\" contains the device licenses.

Examples:

Creates a new device license and downloads the device license and program licenses into the OutDir folder.

HumanOS.SAL.LicenseManager.exe --LicenseId=$(licid) --UserName=$(name) --Password=$(password) --NewDevice --Template=C:\myfile.json --OutDir=C:\Temp\licenses –DownloadDeviceLicense --DownloadProgramLicense

Release a License (Free)

The device license is released (not deleted). It can be used in the future for other devices.

--FreeDevice releases an existing device license
--DeviceId=$(id) id of the device license

Note, that a device license can be released only five times. After that, the license is inactive and cannot be used anymore.

Examples:

Releases an existing device license:

HumanOS.SAL.LicenseManager.exe --LicenseId=$(licid) --UserName=$(user) --Password=$(pw) --FreeDevice --DeviceId=$(id)

Change License Meta Data

Some of the license meta data can be changed without releasing the device license, like

• address of the device
• machine and supplier information

The new meta data can be changed directly in the device file before calling the license manager.

--UpdateDevice updates the license
--DeviceFile=$(file) device file containing the data to update.

Examples:

HumanOS.SAL.LicenseManager.exe --LicenseId=$(licid) --UserName=$(user) --Password=$(pw) --UpdateDevice --DeviceFile=C:\myfile.json

Downloading Device License

The device license can be downloaded directly from the portal.

--DownloadDeviceLicense downloads a device license
--DeviceId=$(id) id of the device license or --ListAll to download all licenses.
--OutDir=$(dir) output directory of license.

Examples:

Downloading a single device license:

HumanOS.SAL.LicenseManager.exe --LicenseId=$(licid) --UserName=$(user) --Password=$(pw) --DownloadDeviceLicense --DeviceId=$(id) --OutDir=C:\Temp\licenses

Downloading all devices license at once:

HumanOS.SAL.LicenseManager.exe --LicenseId=$(licid) --UserName=$(user) --Password=$(pw) --DownloadDeviceLicense --ListAll --OutDir=C:\Temp\licenses

Downloading Program License

The program license can be downloaded directly from the portal

--DownloadProgramLicense downloads a device license
--OutDir=$(dir) output directory of license.