@arvaintelligence/compass

Read from device sensors to extract true north azimuth

Install

npm install @arvaintelligence/compass
npx cap sync

API

• streamCompassHeading(...)
• stopCompassStream()
• readCompassHeading()
• Interfaces
• Type Aliases

streamCompassHeading(...)

streamCompassHeading(options: StreamCompassOptions, callback: StreamCompassCallback) => Promise<void>

Param	Type
options	StreamCompassOptions
callback	StreamCompassCallback

---

stopCompassStream()

stopCompassStream() => Promise<BaseResponse>

Returns: Promise<BaseResponse>

---

readCompassHeading()

readCompassHeading() => Promise<AzimuthResponse>

Returns: Promise<AzimuthResponse>

---

Interfaces

StreamCompassOptions

Prop	Type
interval	number

AzimuthResponse

Prop	Type
trueNorthAzimuth	number

BaseResponse

Prop	Type
ok	boolean
msg	string

Type Aliases

StreamCompassCallback

(success: AzimuthResponse, error?: any): void