Skip to main content

Technical FAQs

We've put together a list of technical questions asked about the Esper platform. 

In this article: 

APIs

  • Where can I find the Group ID?

You can find the Group ID in the URL when inspecting the Group settings page of a particular Group. To get to the Group settings page, visit the "Devices & Groups" page. Find the Group you want the ID for, then click the Group name.

You'll find the Group ID between group and directory. 

https://{tenant-name}.esper.cloud/onboarding/group/{group-ID}/directory

group-id-in-url.png

  • Where do I find the Device ID?

You can find the device ID in the URL when inspecting the device settings page of a particular device. To get to the device settings page, visit the "Devices & Groups" page. Find the device you want the ID for, then click the device name.

You'll find the Device ID between devices and information. 
https://{tenant-name}.esper.cloud/devices/{device-ID}/information

device-id-in-url.png

Can I transfer an API key?

  • API keys cannot be transferred. Whenever you try to delete a user that has an API key, you'll receive a warning message asking you to replace the API key with a new key. So we recommend storing API keys in accounts that aren't tied to a specific user. 

Device Info

  • What is the default device font size? Can I increase or decrease it using JSON?

The default font size is 1. You can use the following JSON code in the Template or the Blueprint to customize the font size.

{  
     "settings": {  
          "system": [  
           {  
            "key": "font_scale",  
             "value": "1.15"  
         }  
        ]  
     }  
}

1.15 and 0.9 are predefined values that Android uses, but the OS accepts any value from 0.01 to 1000+

  • Can I export the MAC address?

Use the following parameter in the get device info SDK to fetch the Wi-Fi MAC address for the device.

String wifiMacAddress = esperDeviceInfo.getWifiMacAddress()

Alternatively, you can use Esper’s open-source tool to generate a report containing the Wi-Fi MAC ID and some other fields found on the Device information page. You can find a link to an executable of the tool here: Esper API Support Tool. 

JSON Settings

  • Can I apply JSON settings at a Device level?

No, JSON settings are only applied at a Group level. Via the Console, they are a part of the Blueprint/Provisioning Template. However, you can use our API to apply JSON settings to the device.

{  
   "command_type": "DEVICE",  
   "command": "UPDATE_DEVICE_CONFIG",  
   "command_args": {  
   "custom_settings_config": {  
   "dpcParams": [  
      {  
        JSON key-value pair  
      }  
     ]  
    }  
  },  
"devices": [  
"Device ID"  
],  
"device_type": "all"  
}
  • Can I enable USB tethering via JSON?

The USB configuration is not editable via JSON as these settings are hidden under developer settings. During provisioning, we disable it. You can choose from the tethering options available under the Android settings or use the mobile hotspot for wireless connections.

Device SDK

  • Can I set Wi-Fi credentials via the SDK?

Currently, you cannot directly set the Wi-Fi credentials. However, follow these steps to obtain the ‘write’ access and enable/disable Wi-Fi settings.

For enabling Wi-Fi:

 WifiManager wifi = (WifiManager) getSystemService(Context.WIFI_SERVICE); wifi.setWifiEnabled(true);

For disabling Wi-Fi:

WifiManager wifi = (WifiManager) getSystemService(Context.WIFI_SERVICE); wifi.setWifiEnabled(false);

Custom Boot Animation

  • Can my organization provide a custom boot animation?

Your organization can provide a custom boot animation in the Template or Blueprint for select Lenovo tablets running Android 10 or above. Not supported for the P11, P11 Pro, or K11 models.

For Templates, go to Settings > Extra Settings for Android and Enable JSON. 

For Blueprints, go to Esper Settings > Enable .json. 

For devices already provisioned, you can send this through the Commands API.

Then input the following:


{
  "commands": [
    {
      "type": "Simple",
      "command": "SET_BOOT_LOGO",
      "commandId": "Set boot logo",
      "bootLogoUrl": "{Boot log URL}"
    },
    {
      "type": "Simple",
      "command": "SET_BOOT_ANIMATION",
      "commandId": "Set boot animation",
      "bootAnimationUrl": "{Boot animation URL}"
    },
    {
      "type": "Simple",
      "command": "SET_SHUTDOWN_ANIMATION",
      "commandId": "Set shutdown animation",
      "shutdownAnimationUrl": "{Shutdown animation URL}"
    }
  ]
}

Reach out to Esper with your device model(s) so we can provide the requirements for the animations.

Animation files may need the following naming conventions: 

  • Boot animation file: "bootanimation.zip"
  • Shutdown animation file: "shutdownanimation.zip"
  • Boot logo file: "logo.bin"

Related articles

Featured content