@danyalwe/capacitor-systeminfo

Capacitor Plugin - SystemInfo

Get access to every info about the device software and hardware!

Supported Android version: 21+
Supported iOS version: Not supported
Supported Browsers: Chromium-based

Install

npm install @danyalwe/capacitor-systeminfo
npx cap sync

Todos

• Improve documentation, add JSDoc strings
• Add support for iOS
• Add CPU usage

Supported methods

Name	Android	iOS	Web
getInfos	✅	❌	✅
start	✅	❌	❌
stop	✅	❌	❌
addListener	✅	❌	❌
removeAllListeners	✅	❌	❌

Supported properties

SoftwareInfos	Android	iOS	Web
osName	✅	❌	✅
osVersion	✅	❌	✅
brandName	✅	❌	✅
sdkVersion	✅	❌	❌
sdkName	✅	❌	❌
securityPatch	✅	❌	❌
uiVersion	✅	❌	❌
deviceID	✅	❌	❌
boardName	✅	❌	❌
bootloaderVersion	✅	❌	❌
supportedABIs	✅	❌	❌

HardwareInfos	Android	iOS	Web
manufacturer	✅	❌	✅
features	✅	❌	✅
totalCores	✅	❌	✅
totalRAM	✅	❌	✅
totalHDD	✅	❌	✅
totalSD	✅	❌	❌
modelID	✅	❌	❌
modelCodeName	✅	❌	❌
cpuModel	✅	❌	❌
cpuCores	✅	❌	❌

RuntimeInfos	Android	iOS	Web
usedRAM	✅	❌	❌
usedHDD	✅	❌	❌
usedSD	✅	❌	❌

API

• getInfos()
• start()
• stop()
• addListener('runtimeChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

getInfos()

getInfos() => Promise<SystemInformations>

Returns: Promise<SystemInformations>

---

start()

start() => Promise<void>

---

stop()

stop() => Promise<void>

---

addListener('runtimeChange', ...)

addListener(eventName: 'runtimeChange', listenerFunc: (event: RuntimeInfos) => void) => Promise<PluginListenerHandle>

Param	Type
eventName	'runtimeChange'
listenerFunc	(event: RuntimeInfos) => void

Returns: Promise<PluginListenerHandle>

---

removeAllListeners()

removeAllListeners() => Promise<void>

---

Interfaces

SoftwareInfos

Prop	Type
osName	string
osVersion	string
brandName	string
sdkVersion	number
sdkName	string
securityPatch	string
uiVersion	string
deviceID	string
boardName	string
bootloaderVersion	string
supportedABIs	string[]

HardwareInfos

Prop	Type
modelID	string
modelCodeName	string
cpuModel	string
cpuCores	[number, number][]
totalSD	number
totalHDD	number
totalRAM	number
totalCores	number
manufacturer	string
features	Features[]

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

RuntimeInfos

Prop	Type
usedRAM	number
usedHDD	number
usedSD	number

Type Aliases

SystemInformations

SoftwareInfos & HardwareInfos

Features

'bluetooth' | 'bluetoothLowEnergy' | 'microphone' | 'speaker' | 'nfc' | 'camera' | 'gamepad' | 'gps' | 'touchscreen' | 'wifi' | 'fingerprint' | 'face' | 'ethernet'