Class Display

Hierarchy

Display

Constructors

constructor

new Display(opniz: any): Display
Parameters
- opniz: any
Returns Display
- Defined in src/devices/m5unified/Display.ts:9

Properties

FontType

FontType: {
    ft_bdf: 6;
    ft_bmp: 3;
    ft_gfx: 5;
    ft_glcd: 2;
    ft_rle: 4;
    ft_ttf: 9;
    ft_u8g2: 8;
    ft_unknown: 1;
    ft_vlw: 7;
} = FontType

Type declaration

ft_bdf: 6
ft_bmp: 3
ft_gfx: 5
ft_glcd: 2
ft_rle: 4
ft_ttf: 9
ft_u8g2: 8
ft_unknown: 1
ft_vlw: 7

FontTypeList

FontTypeList: {
[key: number]: string;
} = FontTypeList

Type declaration

[key: number]: string

TextDatumType

TextDatumType: {
    baseline_center: 17;
    baseline_centre: 17;
    baseline_left: 16;
    baseline_right: 18;
    bottom_center: 9;
    bottom_centre: 9;
    bottom_left: 8;
    bottom_right: 10;
    middle_center: 5;
    middle_centre: 5;
    middle_left: 4;
    middle_right: 6;
    top_center: 1;
    top_centre: 1;
    top_left: 0;
    top_right: 2;
} = TextDatumType

Type declaration

baseline_center: 17
baseline_centre: 17
baseline_left: 16
baseline_right: 18
bottom_center: 9
bottom_centre: 9
bottom_left: 8
bottom_right: 10
middle_center: 5
middle_centre: 5
middle_left: 4
middle_right: 6
top_center: 1
top_centre: 1
top_left: 0
top_right: 2

TextDatumTypeList

TextDatumTypeList: {
[key: number]: string;
} = TextDatumTypeList

Type declaration

[key: number]: string

`Private` opniz

opniz: any

Methods

`Private` _convertColor16

_convertColor16(color24: undefined | number): undefined | number
Parameters
- color24: undefined | number
Returns undefined | number
- Defined in src/devices/m5unified/Display.ts:16

`Private` _convertNumberColorcode

_convertNumberColorcode(color: undefined | string | number): undefined | number
Parameters
- color: undefined | string | number
Returns undefined | number
- Defined in src/devices/m5unified/Display.ts:11

clear

clear(color?: Display.Color): Promise<undefined | boolean>
Parameters
- Optional color: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:95

clearDisplay

clearDisplay(color?: Display.Color): Promise<undefined | boolean>
Parameters
- Optional color: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:158

clearScrollRect

clearScrollRect(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:303

color332

color332(r: number, g: number, b: number): Promise<undefined | number>
Parameters
- r: number
- g: number
- b: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:44

color565

color565(r: number, g: number, b: number): Promise<undefined | number>
Parameters
- r: number
- g: number
- b: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:49

color888

color888(r: number, g: number, b: number): Promise<undefined | number>
Parameters
- r: number
- g: number
- b: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:54

drawCentreString

drawCentreString(string: string, x: number, y: number, font?: FontType): Promise<undefined | number>
Parameters
- string: string
- x: number
- y: number
- Optional font: FontType
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:66

drawRightString

drawRightString(string: string, x: number, y: number, font?: FontType): Promise<undefined | number>
Parameters
- string: string
- x: number
- y: number
- Optional font: FontType
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:72

drawString

drawString(string: string, x: number, y: number, font?: FontType): Promise<undefined | number>
Parameters
- string: string
- x: number
- y: number
- Optional font: FontType
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:60

fillScreen

fillScreen(color?: Display.Color): Promise<undefined | boolean>
Parameters
- Optional color: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:89

fontHeight

fontHeight(font?: number): Promise<undefined | number>
Parameters
- Optional font: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:164

fontWidth

fontWidth(font?: number): Promise<undefined | number>
Parameters
- Optional font: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:170

getBaseColor

getBaseColor(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:175

getBrightness

getBrightness(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:127

getColorDepth

getColorDepth(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:180

getCursorX

getCursorX(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:185

getCursorY

getCursorY(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:190

getRawColor

getRawColor(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:195

getRotation

getRotation(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:200

getScrollRect

getScrollRect(): Promise<undefined | [number, number, number, number]>
Returns Promise<undefined | [number, number, number, number]>
- Defined in src/devices/m5unified/Display.ts:298

getTextDatum

getTextDatum(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in src/devices/m5unified/Display.ts:205

getTextPadding

getTextPadding(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:210

getTextSizeX

getTextSizeX(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:215

getTextSizeY

getTextSizeY(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:220

getTextStyle

getTextStyle(): Promise<undefined | TextStyle>
Returns Promise<undefined | TextStyle>
- Defined in src/devices/m5unified/Display.ts:308

height

height(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:23

powerSave

powerSave(flg: boolean): Promise<undefined | boolean>
Parameters
- flg: boolean
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:142

powerSaveOff

powerSaveOff(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:152

powerSaveOn

powerSaveOn(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:147

print

print(str: string): Promise<undefined | number>
Parameters
- str: string
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:77

println

println(c?: string): Promise<undefined | number>
Parameters
- Optional c: string
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:83

progressBar

progressBar(x: number, y: number, w: number, h: number, val: number): Promise<undefined | boolean>
Parameters
- x: number
- y: number
- w: number
- h: number
- val: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:277

qrcode

qrcode(string: string, x?: number, y?: number, width?: number, version?: number): Promise<undefined | boolean>
Parameters
- string: string
- Optional x: number
- Optional y: number
- Optional width: number
- Optional version: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:283

scroll

scroll(dx: number, dy: number): Promise<undefined | boolean>
Parameters
- dx: number
- dy: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:288

setBaseColor

setBaseColor(c: Display.Color): Promise<undefined | boolean>
Parameters
- c: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:225

setBrightness

setBrightness(brightness: number): Promise<undefined | boolean>
Parameters
- brightness: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:122

setColor

setColor(color: Display.Color): Promise<undefined | boolean>
Parameters
- color: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:230

setColorDepth

setColorDepth(depth: number): Promise<undefined | boolean>
Parameters
- depth: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:235

setCursor

setCursor(x: number, y: number, font?: FontType): Promise<undefined | boolean>
Parameters
- x: number
- y: number
- Optional font: FontType
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:39

setRawColor

setRawColor(c: Display.Color): Promise<undefined | boolean>
Parameters
- c: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:240

setRotation

setRotation(rotation: number): Promise<undefined | boolean>
Parameters
- rotation: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:33

setScrollRect

setScrollRect(x: number, y: number, w: number, h: number): Promise<undefined | boolean>
Parameters
- x: number
- y: number
- w: number
- h: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:293

setTextColor

setTextColor(fgcolor: Display.Color, bgcolor?: Display.Color): Promise<undefined | boolean>
Parameters
- fgcolor: Display.Color
- Optional bgcolor: Display.Color
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:101

setTextDatum

setTextDatum(datum: TextDatumType): Promise<undefined | boolean>
Parameters
- datum: TextDatumType
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:106

setTextFont

setTextFont(f: FontType): Promise<undefined | boolean>
Parameters
- f: FontType
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:111

setTextPadding

setTextPadding(paddingX: number): Promise<undefined | boolean>
Parameters
- paddingX: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:245

setTextScroll

setTextScroll(scroll: boolean): Promise<undefined | boolean>
Parameters
- scroll: boolean
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:250

setTextSize

setTextSize(sx: number, sy?: number): Promise<undefined | boolean>
Parameters
- sx: number
- Optional sy: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:117

setTextStyle

setTextStyle(textStyle: TextStyle): Promise<undefined | boolean>
Parameters
- textStyle: TextStyle
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:313

setTextWrap

setTextWrap(wrapX: boolean, wrapY?: boolean): Promise<undefined | boolean>
Parameters
- wrapX: boolean
- Optional wrapY: boolean
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:256

showFont

showFont(td?: number): Promise<undefined | boolean>
Parameters
- Optional td: number
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:262

sleep

sleep(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:132

textLength

textLength(string: string, width: number): Promise<undefined | number>
Parameters
- string: string
- width: number
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:267

waitDisplay

waitDisplay(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:272

wakeup

wakeup(): Promise<undefined | boolean>
Returns Promise<undefined | boolean>
- Defined in src/devices/m5unified/Display.ts:137

width

width(): Promise<undefined | number>
Returns Promise<undefined | number>
- Defined in src/devices/m5unified/Display.ts:28

Class Display

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

opniz: any

Returns Display

Properties

FontType

Type declaration

ft_bdf: 6

ft_bmp: 3

ft_gfx: 5

ft_glcd: 2

ft_rle: 4

ft_ttf: 9

ft_u8g2: 8

ft_unknown: 1

ft_vlw: 7

FontTypeList

Type declaration

[key: number]: string

TextDatumType

Type declaration

baseline_center: 17

baseline_centre: 17

baseline_left: 16

baseline_right: 18

bottom_center: 9

bottom_centre: 9

bottom_left: 8

bottom_right: 10

middle_center: 5

middle_centre: 5

middle_left: 4

middle_right: 6

top_center: 1

top_centre: 1

top_left: 0

top_right: 2

TextDatumTypeList

Type declaration

[key: number]: string

Private opniz

Methods

Private _convertColor16

Parameters

color24: undefined | number

Returns undefined | number

Private _convertNumberColorcode

Parameters

color: undefined | string | number

Returns undefined | number

clear

Parameters

Optional color: Display.Color

Returns Promise<undefined | boolean>

clearDisplay

Parameters

Optional color: Display.Color

Returns Promise<undefined | boolean>

clearScrollRect

Returns Promise<undefined | boolean>

color332

Parameters

r: number

g: number

b: number

Returns Promise<undefined | number>

color565

Parameters

r: number

g: number

b: number

Returns Promise<undefined | number>

color888

`Private` opniz

`Private` _convertColor16

`Private` _convertNumberColorcode

`Optional` color: Display.Color

`Optional` color: Display.Color

`Optional` font: FontType

`Optional` font: FontType

`Optional` font: FontType

`Optional` color: Display.Color

`Optional` font: number

`Optional` font: number