Skip to main content
Version: 4.2.x

Creating Your Own Device Package

You will find a xdk-device-dummy-package, which illustrate how to create your own device package.

Device configuration, how it looks like​

Before we start developing our own device package, we need to get used to how XDK is configured and how the configuration looks like.

xdk.config.js
import workstation from '@accedo/xdk-device-workstation';

const device = {
  packages: [workstation]
};
@accedo/xdk-workstation/src/config.js
import { DeviceConfig } from '@accedo/xdk-config';
import ID from './id';

const xdkDeviceWorkstation = {
  id: ID,
  detection: () => import('./detection.js'),
  defaultConfig: () => import('./defaultConfig.js'),
  DevicePackage: () => import('./DevicePackage.js')
};

export default new DeviceConfig(xdkDeviceWorkstation);

As you can see, the config file is wrapped on the DeviceConfig and requires 4 attributes

  • ID Device module UID. Its exported from the device module as ID
  • detection High Order Function (HOF) that expects the detection module, usually a dynamic imported one
  • defaultConfig HOF that expects the default config module, usually a dynamic imported one
  • DevicePackage HOF that expects the DevicePackage module, usually a dynamic imported one

HOF (High Order Functions) + Dynamic Import Function​

XDK modularity works thank to the declarative imports of the different modules, that can be static and dynamic, and helps our bundlers to navigate through all the code to bundle just the needed files.

dynamic imports are split by default on different bundle files, decreasing the main bundle size and helping to use lazy loading strategies.

By default our devices uses HOF that wrap the dynamic imports.

You can emulate this behaviour with actual code using the next code snippet

const xdkDeviceWorkstation = {
  // ...
  detection: () => Promise.resolve({
    default: // here the expected export of the module
  })

Implementation​

The links below pointed to the heavily annotated source.