DriverExtensionAbility

DriverExtensionAbility is an ExtensionAbility of the driver type that provides driver-related extension framework. If the capabilities of a device can be expanded by inserting an external hardware module, you can install the driver of the hardware module through an application. DriverExtensionAbility can be used to develop such applications.

You can bind a DriverExtensionAbility object to an application through DriverExtensionManager so that related transactions can be processed in the background based on the application request information. Each type of ExtensionAbility has its own context. The DriverExtensionAbility provides related capabilities through the DriverExtensionContext.

This topic describes how to use DriverExtensionAbility in the following scenarios:

How to Develop

To implement a driver, create a DriverExtensionAbility in the DevEco Studio project. The procedure is as follows:

  1. In the ets directory of a module in the project, right-click and choose New > Directory to create a directory named driverextability.

  2. In the driverextability directory, right-click and choose New > ArkTS File to create a file named DriverExtAbility.ets.

  3. Open the DriverExtAbility.ets file, import the RPC module, and overload the onRemoteMessageRequest() method to receive messages from the application and return the processing result to the application. REQUEST_VALUE is used to verify the service request code sent by the application.

    import rpc from '@ohos.rpc';

const REQUEST_CODE = 99;

class StubTest extends rpc.RemoteObject {
  constructor(des: string) {
    super(des);
  }
  
  // Receive the message sent from the application and return the processing result to the application.
  onRemoteMessageRequest(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence,
                         option: rpc.MessageOption) {
    if (code === REQUEST_CODE) {
      // Receive the data sent from the application.
      // When the application calls data.writeInt() multiple times to write data, the driver can receive the corresponding data by calling data.readInt() for multiple times.
      let optFir: number = data.readInt();
      let optSec: number = data.readInt();
      // The driver returns the data processing result to the application.
      // In the example, two pieces of data are received, and the sum of the two pieces of data is returned to the application.
      reply.writeInt(optFir + optSec);
    }
    return true;
  }
}

  4. In the DriverExtAbility.ets file, import the dependency package DriverExtensionAbility, which provides the onInit(), onRelease(), onConnect(), and onDisconnect() lifecycle callbacks. Then, customize a class to inherit from DriverExtensionAbility and override the lifecycle callbacks as required.

    import DriverExtensionAbility from '@ohos.app.ability.DriverExtensionAbility';
import Want from '@ohos.app.ability.Want';
import rpc from '@ohos.rpc';

const TAG: string = '[Example].[Entry].[DriverExtAbility]';
const REQUEST_CODE = 99;

class StubTest extends rpc.RemoteObject {
  // ...
}

export default class DriverExtAbility extends DriverExtensionAbility {
  onInit(want: Want) {
    console.info(TAG, `onInit, want: ${want.abilityName}`);
  }

  onRelease() {
    console.info(TAG, `onRelease`);
  }

  onConnect(want: Want) {
    console.info(TAG, `onConnect, want: ${want.abilityName}`);
    return new StubTest("test");
  }

  onDisconnect(want: Want) {
    console.info(TAG, `onDisconnect, want: ${want.abilityName}`);
  }

  onDump(params: Array<string>) {
    console.info(TAG, `onDump, params:` + JSON.stringify(params));
    return ['params'];
  }
}

  5. Register DriverExtensionAbility in the module.json5 file of the module in the project. Set type to service and srcEntry to the code path of DriverExtensionAbility.

    {
  "module": {
    // ...
    "extensionAbilities": [
      {
        "name": "DriverExtAbility",
        "icon": "$media:icon",
        "description": "driver",
        "type": "driver",
        "exported": true,
        "srcEntry": "./ets/driverextability/DriverExtAbility.ets",
        "metadata": [
         {
           "name": "bus", // The bus is mandatory.
           "value": "USB",
         },
         {
           "name": "desc", // Description of the driver, which is mandatory.
           "value": "the sample of driverExtensionAbility",
         },
         {
           "name": "vendor", // Driver vendor name, which is mandatory.
           "value": "string",
         },
         {
           "name": "vid", // List of supported USB vendor IDs, separated by commas (,). The value cannot be empty.
           "value": "string, string",
         },
         {
           "name": "pid", // List of supported USB product IDs, separated by commas (,). The value cannot be empty.
           "value": "string, string",
         }
        ]
      }
    ]
  }
}