Get access to every info about the device software and hardware!
Supported Android version: 21+
Supported iOS version: Not supported
Supported Browsers: Chromium-based
npm install @danyalwe/capacitor-systeminfo
npx cap sync
- Add support for iOS
- Add CPU usage
Name | Android | iOS | Web |
---|---|---|---|
getInfos | ✅ | ❌ | ✅ |
start | ✅ | ❌ | ❌ |
stop | ✅ | ❌ | ❌ |
addListener | ✅ | ❌ | ❌ |
removeAllListeners | ✅ | ❌ | ❌ |
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 |
✅ | ❌ | ❌ |
getInfos()
start()
stop()
addListener('runtimeChange', ...)
removeAllListeners()
- Interfaces
- Type Aliases
Interface for the System Info plugin
getInfos() => Promise<SystemInformations>
Returns a Promise that resolves with an object containing system information.
Returns: Promise<SystemInformations>
start() => Promise<void>
Starts listening for system information changes.
stop() => Promise<void>
Stops listening for system information changes.
addListener(eventName: 'runtimeChange', listenerFunc: (event: RuntimeInfos) => void) => Promise<PluginListenerHandle>
Adds a listener for the 'runtimeChange' event.
Param | Type | Description |
---|---|---|
eventName |
'runtimeChange' |
- The name of the event to listen for. |
listenerFunc |
(event: RuntimeInfos) => void |
- The function to call when the event is triggered. |
Returns: Promise<PluginListenerHandle>
removeAllListeners() => Promise<void>
Removes all event listeners.
Represents software information about a device.
Prop | Type | Description |
---|---|---|
osName |
string |
The name of the operating system. |
osVersion |
string |
The version of the operating system. |
brandName |
string |
The name of the device brand. |
sdkVersion |
number |
The version of the SDK (if applicable). |
sdkName |
string |
The name of the SDK (if applicable). |
securityPatch |
string |
The security patch level (if applicable). |
uiVersion |
string |
The version of the UI (if applicable). |
deviceID |
string |
The unique identifier of the device (if applicable). |
boardName |
string |
The name of the device board (if applicable). |
bootloaderVersion |
string |
The version of the bootloader (if applicable). |
supportedABIs |
string[] |
The list of supported ABIs (if applicable). |
Represents hardware information of a device.
Prop | Type | Description |
---|---|---|
modelID |
string |
The model ID of the device. |
modelCodeName |
string |
The code name of the device model. |
cpuModel |
string |
The model of the CPU. |
cpuCores |
[number, number][] |
The number of cores and threads of the CPU. |
totalSD |
number |
The total size of the SD card in bytes. |
totalHDD |
number |
The total size of the HDD in bytes. |
totalRAM |
number |
The total size of the RAM in bytes. |
totalCores |
number |
The total number of cores in the CPU. |
manufacturer |
string |
The manufacturer of the device. |
features |
Features[] |
The features supported by the device. |
Prop | Type |
---|---|
remove |
() => Promise<void> |
Interface for runtime information.
Prop | Type | Description |
---|---|---|
usedRAM |
number |
The amount of used RAM in bytes. |
usedHDD |
number |
The amount of used HDD in bytes. |
usedSD |
number |
The amount of used SD card storage in bytes. |
Represents a collection of system information, including both software and hardware information.
Represents the available features that can be queried using the Capacitor System Info plugin.
'bluetooth' | 'bluetoothLowEnergy' | 'microphone' | 'speaker' | 'nfc' | 'camera' | 'gamepad' | 'gps' | 'touchscreen' | 'wifi' | 'fingerprint' | 'face' | 'ethernet'