Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HMC5883L

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

address

address: any

i2cinfo

i2cinfo: I2cInfo

keys

keys: string[]

params

params: any

requiredKeys

requiredKeys: string[]

Methods

char2short

  • char2short(val1: number, val2: number): any

  • Parameters

    • val1: number
    • val2: number

    Returns any

clearFlagWait

  • clearFlagWait(address: number, index: number): Promise<void>

  • Parameters

    • address: number
    • index: number

    Returns Promise<void>

get

  • get(): Promise<Xyz>
  • deprecated

    Returns Promise<Xyz>

getAdcArrayWait

  • getAdcArrayWait(): Promise<number[]>

getAdcWait

  • getAdcWait(): Promise<Xyz>

getArrayWait

  • getArrayWait(): Promise<number[]>

getRange

  • getRange(): string

getUnit

getWait

  • getWait(): Promise<Xyz>

i2cInfo

init

  • init(): void

  • Returns void

readWait

  • readWait(command: number, length: number): Promise<number[]>

  • Parameters

    • command: number
    • length: number

    Returns Promise<number[]>

reset

  • reset(): void

  • Returns void

setRange

  • setRange(index: number): void

  • Parameters

    • index: number

    Returns void

setUnit

wired

  • wired(obniz: Obniz): void

write

  • write(command: any, buf: any): void

  • Parameters

    • command: any
    • buf: any

    Returns void

writeFlagWait

  • writeFlagWait(address: number, index: number): Promise<void>

  • Parameters

    • address: number
    • index: number

    Returns Promise<void>

Static calibrateWait

  • calibrateWait(): Promise<void>

Static charArrayToInt16

  • charArrayToInt16(values: [number, number], endian?: string): number

  • Parameters

    • values: [number, number]
    • Default value endian: string = "b"

    Returns number

Static charArrayToXyz

  • charArrayToXyz(data: number[], endian?: string, scaleFunc?: (Anonymous function)): Xyz

  • Parameters

    • data: number[]
    • Default value endian: string = "b"
    • Default value scaleFunc: (Anonymous function) = (d: number): number => d

    Returns Xyz

Static headingWait

  • headingWait(): Promise<void>

Static info

  • Returns ObnizPartsInfo

Generated using TypeDoc