Interface KernelDevice

Interface representing a kernel device. This essentially "wraps" one or many zenfs devices and provides metadata and a CLI interface for it.

interface KernelDevice {
    pkg: {
        author?: string;
        description?: string;
        homepage?: string;
        name: string;
        version: string;
    };
    cli(options: KernelDeviceCLIOptions): Promise<number>;
    getDrivers(kernel: Kernel): Promise<DeviceDriver<any>[]>;
}

Properties

pkg

Methods

cli? getDrivers

Properties

pkg

pkg: {
    author?: string;
    description?: string;
    homepage?: string;
    name: string;
    version: string;
}

Package metadata for the device

Type declaration

  • Optionalauthor?: string

    Optional author of the device

  • Optionaldescription?: string

    Optional description of the device

  • Optionalhomepage?: string

    Optional homepage URL for the device

  • name: string

    Name of the device

  • version: string

    Version of the device

Methods

Optionalcli

getDrivers

  • getDrivers(kernel: Kernel): Promise<DeviceDriver<any>[]>

  • Get device drivers supported by this device This allows the device to declare one or many individual devices in /dev

    Parameters

    • kernel: Kernel

      Kernel instance

    Returns Promise<DeviceDriver<any>[]>

    Promise resolving to array of device drivers

Settings

Member Visibility

On This Page

Properties
Methods