Get access to every info about the device software and hardware!
npm install @danyalwe/capacitor-systeminfoGet access to every info about the device software and hardware!
Supported Android version: 23+\
Supported iOS version: Not supported\
Supported Browsers: Chromium-based
``bash`
npm install @danyalwe/capacitor-systeminfo
npx cap sync
- [ ] Add support for iOS
- [ ] Add CPU usage
The following example demonstrates how to use the SystemInfo plugin to access the device's info:
`ts
import { SystemInfo } from '@danyalwe/capacitor-systeminfo'
// Get all system informations
const info = await SystemInfo.getInfos()
// Add a listener to receive used ram, hdd and sd every second
SystemInfo.addListener('runtimeChange', (data) => {
console.log('Runtime data:', data)
})
// Be sure to start ALWAYS AFTER adding the listener
await SystemInfo.start()
// Stop the listener
await SystemInfo.stop()
`
| 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 | ✅ | ❌ | ❌ |
⚠️: Not real total, it's the available
| RuntimeInfos | Android | iOS | Web |
| :------------ | :------ | :-- | :-- |
| usedRAM | ✅ | ❌ | ❌ |
| usedHDD | ✅ | ❌ | ❌ |
| usedSD | ✅ | ❌ | ❌ |
Interface for the System Info plugin
#### SoftwareInfo
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. |
| sdkName | string | The name of the SDK. |
| securityPatch | string | The security patch level. |
| uiVersion | string | The version of the UI. |
| deviceID | string | The unique identifier of the device. |
| boardName | string | The name of the device board. |
| bootloaderVersion | string | The version of the bootloader. |
| supportedABIs | {} | The list of supported ABIs. |
| locales | {} | The list of locales used by the device |
| timezone | string | The timezone of the device |
#### HardwareInfo
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 | { maxFreq: {}; minFreq: {}; } | 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 | {} | The features supported by the device. |
#### RuntimeInfo
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. |
#### PluginListenerHandle
| Prop | Type |
| ------------ | ------------------------- |
| remove` | () => any |
#### SystemInformation
Represents a collection of system information, including both software and hardware information.
#### Features
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'