Interface SurfaceInstance

ReadonlyproductName

ReadonlysurfaceId

blank

• blank(): Promise<void>

  Clear the display, setting all pixels to black/off

  Returns Promise<void>

OptionalcheckForFirmwareUpdates

• checkForFirmwareUpdates?(
      versionsCache: SurfaceFirmwareUpdateCache,
  ): Promise<SurfaceFirmwareUpdateInfo | null>

  Check for firmware updates for this surface

  Parameters

  • versionsCache: SurfaceFirmwareUpdateCache

    Cache object to assist with caching any api calls needed to determine latest versions

  Returns Promise<SurfaceFirmwareUpdateInfo | null>

  Firmware update info, or null if no update is available

close

• close(): Promise<void>

  Clean up any resources, and close the surface

  Returns Promise<void>

draw

• draw(signal: AbortSignal, drawProps: SurfaceDrawProps): Promise<void>

  Draw to the device

  Parameters

  • signal: AbortSignal

    AbortSignal to cancel the draw operation

  • drawProps: SurfaceDrawProps

    Data to draw

  Returns Promise<void>

init

• init(): Promise<void>

  Initialize the surface for use, called after creation

  Returns Promise<void>

OptionalonVariableValue

• onVariableValue?(name: string, value: any): void

  Called when one of the 'input' transfer variables changes value

  Parameters

  • name: string

    Name of the variable

  • value: any

    New value of the variable

  Returns void

ready

• ready(): Promise<void>

  When the surface transitions into the ready state This means that it is about to begin drawing

  Returns Promise<void>

setBrightness

• setBrightness(percent: number): Promise<void>

  Set the brightness of the display

  Parameters

  • percent: number

    0-100

  Returns Promise<void>

OptionalshowLockedStatus

• showLockedStatus?(locked: boolean, characterCount: number): void

  Show the locked status of the surface for pincode entry This is only used when the surface was registered with the custom pincode map

  Parameters

  • locked: boolean

    Whether the surface is locked. When false, this will be shortly followed by draw calls

  • characterCount: number

    The number of characters of the pincode which have been entered

  Returns void

showStatus

• showStatus(
      signal: AbortSignal,
      cardGenerator: CardGenerator,
      statusMessage: string,
  ): Promise<void>

  Show a status image on the device, instead of the normal operation This is typically used for Satellite to show the "connecting" state

  Parameters

  • signal: AbortSignal

    AbortSignal to cancel the status display

  • cardGenerator: CardGenerator

    Card generator to create the status image(s)

  • statusMessage: string

  Returns Promise<void>

OptionalupdateConfig

• updateConfig?(config: Record<string, any>): Promise<void>

  If there are any config fields defined, when the user updates the config, this is called to inform the surface of the new config This will be called just before ready() with the initial config

  Parameters

  • config: Record<string, any>

  Returns Promise<void>