DOCS-1504: chardisplay

The chardisplay object lets you set the properties of characters on a display.

securestore IDL

interface chardisplay {
    Promise<void> Show(in unsigned long row, in unsigned long col, in DOMString text)
    Promise<void> Clear()
    Promise<void> SetPos(in unsigned long row, in unsigned long col)
    Promise<void> SetCursor(in unsigned long cursor) // 0=off, 1=blink, 2=underline, 3=both
    Promise<void> SetContrast(in unsigned long contrast) // 0-100
    Promise<int> GetContrast()
    Promise<void> SetBrightness(in unsigned long brightness) // 0-100
    Promise<int> GetBrightness()
}

Object Creation

To create a chardisplay object, load the @brightsign/chardisplay module using the Node.js® require() method:

var chardisplayClass = require("@brightsign/chardisplay");
var chardisplay = new chardisplayClass();

CharDisplay

Show()

Promise<void> Show(in unsigned long row, in unsigned long col, in DOMString text)

Displays text at prescribed position.

Clear()

Promise<void> Clear()

Clears the display.

SetPos()

Promise<void> SetPos(in unsigned long row, in unsigned long col)

Positions the cursor

SetCursor()

Promise<void> SetCursor(in unsigned long cursor)

Sets the cursor style: 0 is off; 1 is blink; 2 is underline; 3 is both

SetContrast()

Promise<void> SetContrast(in unsigned long contrast)

Set the display contrast in values from 0 to 100

GetContrast()

Promise<void> GetContrast()

Gets the display contrast

SetBrightness()

Promise<void> SetBrightness(in unsigned long brightness)

Set the display brightness in values from 0 to 100

GetBrightness()

Promise<int> GetBrightness()

Gets the display brightness