systeminformation 5.33.3 → 6.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. package/README.md +873 -957
  2. package/dist/audio.d.ts +1 -0
  3. package/dist/audio.js +18 -0
  4. package/dist/baseboard.d.ts +1 -0
  5. package/dist/baseboard.js +17 -0
  6. package/dist/battery.d.ts +1 -0
  7. package/dist/battery.js +19 -0
  8. package/dist/bios.d.ts +1 -0
  9. package/dist/bios.js +17 -0
  10. package/dist/block-devices.d.ts +1 -0
  11. package/dist/block-devices.js +17 -0
  12. package/dist/bluetooth.d.ts +1 -0
  13. package/dist/bluetooth.js +17 -0
  14. package/dist/bsd/battery.d.ts +2 -0
  15. package/dist/bsd/battery.js +27 -0
  16. package/dist/bsd/cpu-cache.d.ts +1 -0
  17. package/dist/bsd/cpu-cache.js +37 -0
  18. package/dist/bsd/cpu-flags.d.ts +1 -0
  19. package/dist/bsd/cpu-flags.js +28 -0
  20. package/dist/bsd/cpu-temperature.d.ts +1 -0
  21. package/dist/bsd/cpu-temperature.js +29 -0
  22. package/dist/bsd/cpu.d.ts +1 -0
  23. package/dist/bsd/cpu.js +98 -0
  24. package/dist/bsd/index.d.ts +38 -0
  25. package/dist/bsd/index.js +85 -0
  26. package/dist/bsd/mem.d.ts +1 -0
  27. package/dist/bsd/mem.js +37 -0
  28. package/dist/bsd/network-stats.d.ts +2 -0
  29. package/dist/bsd/network-stats.js +92 -0
  30. package/dist/bsd/os-info.d.ts +21 -0
  31. package/dist/bsd/os-info.js +38 -0
  32. package/dist/bsd/uuid.d.ts +2 -0
  33. package/dist/bsd/uuid.js +30 -0
  34. package/dist/camera.d.ts +1 -0
  35. package/dist/camera.js +17 -0
  36. package/dist/chassis.d.ts +1 -0
  37. package/dist/chassis.js +17 -0
  38. package/dist/cli.d.ts +2 -0
  39. package/dist/cli.js +107 -0
  40. package/dist/common/codepage.d.ts +1 -0
  41. package/dist/common/codepage.js +43 -0
  42. package/dist/common/const.d.ts +25 -0
  43. package/dist/common/const.js +26 -0
  44. package/dist/common/cpu.d.ts +2 -0
  45. package/dist/common/cpu.js +12 -0
  46. package/dist/common/darwin.d.ts +6 -0
  47. package/dist/common/darwin.js +266 -0
  48. package/dist/common/datetime.d.ts +9 -0
  49. package/dist/common/datetime.js +161 -0
  50. package/dist/common/defaults.d.ts +25 -0
  51. package/dist/common/defaults.js +299 -0
  52. package/dist/common/exec.d.ts +10 -0
  53. package/dist/common/exec.js +69 -0
  54. package/dist/common/files.d.ts +2 -0
  55. package/dist/common/files.js +39 -0
  56. package/dist/common/filesys.d.ts +11 -0
  57. package/dist/common/filesys.js +282 -0
  58. package/dist/common/host.d.ts +2 -0
  59. package/dist/common/host.js +67 -0
  60. package/dist/common/index.d.ts +12 -0
  61. package/dist/common/index.js +146 -0
  62. package/dist/common/internet.d.ts +1 -0
  63. package/dist/common/internet.js +47 -0
  64. package/dist/common/mappings.d.ts +55 -0
  65. package/dist/common/mappings.js +4133 -0
  66. package/dist/common/network.d.ts +8 -0
  67. package/dist/common/network.js +162 -0
  68. package/dist/common/nvidia.d.ts +22 -0
  69. package/dist/common/nvidia.js +159 -0
  70. package/dist/common/parse.d.ts +13 -0
  71. package/dist/common/parse.js +157 -0
  72. package/dist/common/raspberry.d.ts +5 -0
  73. package/dist/common/raspberry.js +277 -0
  74. package/dist/common/security.d.ts +31 -0
  75. package/dist/common/security.js +241 -0
  76. package/dist/common/types.d.ts +992 -0
  77. package/dist/common/types.js +2 -0
  78. package/dist/common/windows.d.ts +58 -0
  79. package/dist/common/windows.js +292 -0
  80. package/dist/cpu-cache.d.ts +1 -0
  81. package/dist/cpu-cache.js +19 -0
  82. package/dist/cpu-current-load.d.ts +2 -0
  83. package/dist/cpu-current-load.js +249 -0
  84. package/dist/cpu-current-speed.d.ts +3 -0
  85. package/dist/cpu-current-speed.js +84 -0
  86. package/dist/cpu-flags.d.ts +1 -0
  87. package/dist/cpu-flags.js +19 -0
  88. package/dist/cpu-full-load.d.ts +1 -0
  89. package/dist/cpu-full-load.js +30 -0
  90. package/dist/cpu-temperature.d.ts +1 -0
  91. package/dist/cpu-temperature.js +19 -0
  92. package/dist/cpu.d.ts +1 -0
  93. package/dist/cpu.js +19 -0
  94. package/dist/darwin/audio.d.ts +2 -0
  95. package/dist/darwin/audio.js +46 -0
  96. package/dist/darwin/baseboard.d.ts +1 -0
  97. package/dist/darwin/baseboard.js +48 -0
  98. package/dist/darwin/battery.d.ts +2 -0
  99. package/dist/darwin/battery.js +65 -0
  100. package/dist/darwin/bios.d.ts +1 -0
  101. package/dist/darwin/bios.js +45 -0
  102. package/dist/darwin/block-devices.d.ts +2 -0
  103. package/dist/darwin/block-devices.js +101 -0
  104. package/dist/darwin/bluetooth.d.ts +3 -0
  105. package/dist/darwin/bluetooth.js +84 -0
  106. package/dist/darwin/camera.d.ts +2 -0
  107. package/dist/darwin/camera.js +55 -0
  108. package/dist/darwin/chassis.d.ts +2 -0
  109. package/dist/darwin/chassis.js +32 -0
  110. package/dist/darwin/cpu-cache.d.ts +2 -0
  111. package/dist/darwin/cpu-cache.js +29 -0
  112. package/dist/darwin/cpu-flags.d.ts +1 -0
  113. package/dist/darwin/cpu-flags.js +16 -0
  114. package/dist/darwin/cpu-temperature.d.ts +1 -0
  115. package/dist/darwin/cpu-temperature.js +44 -0
  116. package/dist/darwin/cpu.d.ts +1 -0
  117. package/dist/darwin/cpu.js +69 -0
  118. package/dist/darwin/disk-layout.d.ts +2 -0
  119. package/dist/darwin/disk-layout.js +231 -0
  120. package/dist/darwin/disks-io.d.ts +2 -0
  121. package/dist/darwin/disks-io.js +56 -0
  122. package/dist/darwin/displays.d.ts +2 -0
  123. package/dist/darwin/displays.js +98 -0
  124. package/dist/darwin/fs-open-files.d.ts +2 -0
  125. package/dist/darwin/fs-open-files.js +27 -0
  126. package/dist/darwin/fs-stats.d.ts +2 -0
  127. package/dist/darwin/fs-stats.js +47 -0
  128. package/dist/darwin/gpu.d.ts +2 -0
  129. package/dist/darwin/gpu.js +55 -0
  130. package/dist/darwin/index.d.ts +56 -0
  131. package/dist/darwin/index.js +122 -0
  132. package/dist/darwin/keyboard.d.ts +2 -0
  133. package/dist/darwin/keyboard.js +73 -0
  134. package/dist/darwin/mem-layout.d.ts +2 -0
  135. package/dist/darwin/mem-layout.js +60 -0
  136. package/dist/darwin/mem.d.ts +2 -0
  137. package/dist/darwin/mem.js +50 -0
  138. package/dist/darwin/mouse.d.ts +2 -0
  139. package/dist/darwin/mouse.js +78 -0
  140. package/dist/darwin/network-connections.d.ts +2 -0
  141. package/dist/darwin/network-connections.js +98 -0
  142. package/dist/darwin/network-gateway-default.d.ts +1 -0
  143. package/dist/darwin/network-gateway-default.js +26 -0
  144. package/dist/darwin/network-interface-default.d.ts +2 -0
  145. package/dist/darwin/network-interface-default.js +41 -0
  146. package/dist/darwin/network-interfaces.d.ts +2 -0
  147. package/dist/darwin/network-interfaces.js +205 -0
  148. package/dist/darwin/network-stats.d.ts +2 -0
  149. package/dist/darwin/network-stats.js +86 -0
  150. package/dist/darwin/npm.d.ts +1 -0
  151. package/dist/darwin/npm.js +5 -0
  152. package/dist/darwin/npu.d.ts +2 -0
  153. package/dist/darwin/npu.js +41 -0
  154. package/dist/darwin/os-info.d.ts +1 -0
  155. package/dist/darwin/os-info.js +110 -0
  156. package/dist/darwin/pci.d.ts +2 -0
  157. package/dist/darwin/pci.js +37 -0
  158. package/dist/darwin/printer.d.ts +2 -0
  159. package/dist/darwin/printer.js +45 -0
  160. package/dist/darwin/software.d.ts +2 -0
  161. package/dist/darwin/software.js +39 -0
  162. package/dist/darwin/system.d.ts +1 -0
  163. package/dist/darwin/system.js +29 -0
  164. package/dist/darwin/thunderbolt.d.ts +1 -0
  165. package/dist/darwin/thunderbolt.js +53 -0
  166. package/dist/darwin/usb.d.ts +3 -0
  167. package/dist/darwin/usb.js +69 -0
  168. package/dist/darwin/users.d.ts +2 -0
  169. package/dist/darwin/users.js +13 -0
  170. package/dist/darwin/uuid.d.ts +2 -0
  171. package/dist/darwin/uuid.js +39 -0
  172. package/dist/darwin/wifi-connections.d.ts +2 -0
  173. package/dist/darwin/wifi-connections.js +60 -0
  174. package/dist/darwin/wifi-interfaces.d.ts +2 -0
  175. package/dist/darwin/wifi-interfaces.js +27 -0
  176. package/dist/darwin/wifi-networks.d.ts +2 -0
  177. package/dist/darwin/wifi-networks.js +61 -0
  178. package/dist/disk-layout.d.ts +1 -0
  179. package/dist/disk-layout.js +17 -0
  180. package/dist/disks-io.d.ts +1 -0
  181. package/dist/disks-io.js +17 -0
  182. package/dist/displays.d.ts +1 -0
  183. package/dist/displays.js +17 -0
  184. package/dist/docker-socket.d.ts +11 -0
  185. package/dist/docker-socket.js +113 -0
  186. package/dist/docker.d.ts +102 -0
  187. package/dist/docker.js +532 -0
  188. package/dist/fs-open-files.d.ts +1 -0
  189. package/dist/fs-open-files.js +17 -0
  190. package/dist/fs-size.d.ts +1 -0
  191. package/dist/fs-size.js +23 -0
  192. package/dist/fs-stats.d.ts +1 -0
  193. package/dist/fs-stats.js +17 -0
  194. package/dist/get-data.d.ts +110 -0
  195. package/dist/get-data.js +151 -0
  196. package/dist/get.d.ts +5 -0
  197. package/dist/get.js +117 -0
  198. package/dist/gpu.d.ts +1 -0
  199. package/dist/gpu.js +17 -0
  200. package/dist/index.d.ts +59 -0
  201. package/dist/index.js +130 -0
  202. package/dist/inet-checksite.d.ts +1 -0
  203. package/dist/inet-checksite.js +11 -0
  204. package/dist/inet-latency.d.ts +1 -0
  205. package/dist/inet-latency.js +17 -0
  206. package/dist/keyboard.d.ts +1 -0
  207. package/dist/keyboard.js +17 -0
  208. package/dist/linux/audio.d.ts +2 -0
  209. package/dist/linux/audio.js +67 -0
  210. package/dist/linux/baseboard.d.ts +1 -0
  211. package/dist/linux/baseboard.js +81 -0
  212. package/dist/linux/battery.d.ts +2 -0
  213. package/dist/linux/battery.js +88 -0
  214. package/dist/linux/bios.d.ts +2 -0
  215. package/dist/linux/bios.js +55 -0
  216. package/dist/linux/block-devices.d.ts +2 -0
  217. package/dist/linux/block-devices.js +30 -0
  218. package/dist/linux/bluetooth.d.ts +2 -0
  219. package/dist/linux/bluetooth.js +86 -0
  220. package/dist/linux/camera.d.ts +2 -0
  221. package/dist/linux/camera.js +63 -0
  222. package/dist/linux/chassis.d.ts +1 -0
  223. package/dist/linux/chassis.js +41 -0
  224. package/dist/linux/cpu-cache.d.ts +1 -0
  225. package/dist/linux/cpu-cache.js +35 -0
  226. package/dist/linux/cpu-flags.d.ts +1 -0
  227. package/dist/linux/cpu-flags.js +33 -0
  228. package/dist/linux/cpu-temperature.d.ts +1 -0
  229. package/dist/linux/cpu-temperature.js +179 -0
  230. package/dist/linux/cpu.d.ts +1 -0
  231. package/dist/linux/cpu.js +135 -0
  232. package/dist/linux/disk-layout.d.ts +2 -0
  233. package/dist/linux/disk-layout.js +151 -0
  234. package/dist/linux/disks-io.d.ts +2 -0
  235. package/dist/linux/disks-io.js +58 -0
  236. package/dist/linux/displays.d.ts +2 -0
  237. package/dist/linux/displays.js +193 -0
  238. package/dist/linux/fs-open-files.d.ts +2 -0
  239. package/dist/linux/fs-open-files.js +44 -0
  240. package/dist/linux/fs-size.d.ts +2 -0
  241. package/dist/linux/fs-size.js +157 -0
  242. package/dist/linux/fs-stats.d.ts +2 -0
  243. package/dist/linux/fs-stats.js +65 -0
  244. package/dist/linux/gpu.d.ts +2 -0
  245. package/dist/linux/gpu.js +273 -0
  246. package/dist/linux/index.d.ts +56 -0
  247. package/dist/linux/index.js +122 -0
  248. package/dist/linux/inet-latency.d.ts +1 -0
  249. package/dist/linux/inet-latency.js +39 -0
  250. package/dist/linux/keyboard.d.ts +2 -0
  251. package/dist/linux/keyboard.js +61 -0
  252. package/dist/linux/mem-layout.d.ts +2 -0
  253. package/dist/linux/mem-layout.js +112 -0
  254. package/dist/linux/mem.d.ts +2 -0
  255. package/dist/linux/mem.js +61 -0
  256. package/dist/linux/mouse.d.ts +2 -0
  257. package/dist/linux/mouse.js +73 -0
  258. package/dist/linux/network-connections.d.ts +2 -0
  259. package/dist/linux/network-connections.js +114 -0
  260. package/dist/linux/network-gateway-default.d.ts +1 -0
  261. package/dist/linux/network-gateway-default.js +22 -0
  262. package/dist/linux/network-interface-default.d.ts +2 -0
  263. package/dist/linux/network-interface-default.js +46 -0
  264. package/dist/linux/network-interfaces.d.ts +3 -0
  265. package/dist/linux/network-interfaces.js +353 -0
  266. package/dist/linux/network-stats.d.ts +2 -0
  267. package/dist/linux/network-stats.js +99 -0
  268. package/dist/linux/npm.d.ts +1 -0
  269. package/dist/linux/npm.js +5 -0
  270. package/dist/linux/npu.d.ts +2 -0
  271. package/dist/linux/npu.js +77 -0
  272. package/dist/linux/os-info.d.ts +1 -0
  273. package/dist/linux/os-info.js +104 -0
  274. package/dist/linux/pci.d.ts +2 -0
  275. package/dist/linux/pci.js +56 -0
  276. package/dist/linux/printer.d.ts +2 -0
  277. package/dist/linux/printer.js +80 -0
  278. package/dist/linux/process-load.d.ts +2 -0
  279. package/dist/linux/process-load.js +164 -0
  280. package/dist/linux/processes.d.ts +2 -0
  281. package/dist/linux/processes.js +358 -0
  282. package/dist/linux/services.d.ts +2 -0
  283. package/dist/linux/services.js +222 -0
  284. package/dist/linux/software.d.ts +2 -0
  285. package/dist/linux/software.js +110 -0
  286. package/dist/linux/system.d.ts +1 -0
  287. package/dist/linux/system.js +186 -0
  288. package/dist/linux/thunderbolt.d.ts +2 -0
  289. package/dist/linux/thunderbolt.js +51 -0
  290. package/dist/linux/time.d.ts +6 -0
  291. package/dist/linux/time.js +28 -0
  292. package/dist/linux/usb.d.ts +2 -0
  293. package/dist/linux/usb.js +62 -0
  294. package/dist/linux/users.d.ts +2 -0
  295. package/dist/linux/users.js +102 -0
  296. package/dist/linux/uuid.d.ts +2 -0
  297. package/dist/linux/uuid.js +44 -0
  298. package/dist/linux/wifi-connections.d.ts +2 -0
  299. package/dist/linux/wifi-connections.js +196 -0
  300. package/dist/linux/wifi-interfaces.d.ts +2 -0
  301. package/dist/linux/wifi-interfaces.js +96 -0
  302. package/dist/linux/wifi-networks.d.ts +2 -0
  303. package/dist/linux/wifi-networks.js +176 -0
  304. package/dist/mem-layout.d.ts +1 -0
  305. package/dist/mem-layout.js +17 -0
  306. package/dist/mem.d.ts +1 -0
  307. package/dist/mem.js +19 -0
  308. package/dist/mouse.d.ts +1 -0
  309. package/dist/mouse.js +17 -0
  310. package/dist/network-connections.d.ts +1 -0
  311. package/dist/network-connections.js +17 -0
  312. package/dist/network-gateway-default.d.ts +1 -0
  313. package/dist/network-gateway-default.js +17 -0
  314. package/dist/network-interface-default.d.ts +1 -0
  315. package/dist/network-interface-default.js +17 -0
  316. package/dist/network-interfaces.d.ts +1 -0
  317. package/dist/network-interfaces.js +18 -0
  318. package/dist/network-stats.d.ts +1 -0
  319. package/dist/network-stats.js +19 -0
  320. package/dist/npm.d.ts +2 -0
  321. package/dist/npm.js +22 -0
  322. package/dist/npu.d.ts +1 -0
  323. package/dist/npu.js +17 -0
  324. package/dist/observe.d.ts +5 -0
  325. package/dist/observe.js +16 -0
  326. package/dist/os-info.d.ts +1 -0
  327. package/dist/os-info.js +21 -0
  328. package/dist/pci.d.ts +1 -0
  329. package/dist/pci.js +17 -0
  330. package/dist/printer.d.ts +1 -0
  331. package/dist/printer.js +17 -0
  332. package/dist/process-load.d.ts +1 -0
  333. package/dist/process-load.js +15 -0
  334. package/dist/processes.d.ts +1 -0
  335. package/dist/processes.js +15 -0
  336. package/dist/services.d.ts +1 -0
  337. package/dist/services.js +15 -0
  338. package/dist/shell.d.ts +1 -0
  339. package/dist/shell.js +16 -0
  340. package/dist/software.d.ts +1 -0
  341. package/dist/software.js +17 -0
  342. package/dist/sun/index.d.ts +17 -0
  343. package/dist/sun/index.js +43 -0
  344. package/dist/sun/inet-latency.d.ts +1 -0
  345. package/dist/sun/inet-latency.js +30 -0
  346. package/dist/sun/os-info.d.ts +1 -0
  347. package/dist/sun/os-info.js +26 -0
  348. package/dist/sun/users.d.ts +2 -0
  349. package/dist/sun/users.js +13 -0
  350. package/dist/system.d.ts +1 -0
  351. package/dist/system.js +17 -0
  352. package/dist/thunderbolt.d.ts +1 -0
  353. package/dist/thunderbolt.js +17 -0
  354. package/dist/time.d.ts +6 -0
  355. package/dist/time.js +28 -0
  356. package/dist/usb.d.ts +1 -0
  357. package/dist/usb.js +17 -0
  358. package/dist/users.d.ts +1 -0
  359. package/dist/users.js +21 -0
  360. package/dist/uuid.d.ts +1 -0
  361. package/dist/uuid.js +19 -0
  362. package/dist/version.d.ts +1 -0
  363. package/dist/version.js +16 -0
  364. package/dist/versions.d.ts +2 -0
  365. package/dist/versions.js +1122 -0
  366. package/dist/virtualbox.d.ts +2 -0
  367. package/dist/virtualbox.js +89 -0
  368. package/dist/wifi-connections.d.ts +1 -0
  369. package/dist/wifi-connections.js +17 -0
  370. package/dist/wifi-interfaces.d.ts +1 -0
  371. package/dist/wifi-interfaces.js +17 -0
  372. package/dist/wifi-networks.d.ts +1 -0
  373. package/dist/wifi-networks.js +17 -0
  374. package/dist/windows/audio.d.ts +2 -0
  375. package/dist/windows/audio.js +23 -0
  376. package/dist/windows/baseboard.d.ts +1 -0
  377. package/dist/windows/baseboard.js +35 -0
  378. package/dist/windows/battery.d.ts +1 -0
  379. package/dist/windows/battery.js +81 -0
  380. package/dist/windows/bios.d.ts +1 -0
  381. package/dist/windows/bios.js +37 -0
  382. package/dist/windows/block-devices.d.ts +2 -0
  383. package/dist/windows/block-devices.js +48 -0
  384. package/dist/windows/bluetooth.d.ts +2 -0
  385. package/dist/windows/bluetooth.js +31 -0
  386. package/dist/windows/camera.d.ts +2 -0
  387. package/dist/windows/camera.js +47 -0
  388. package/dist/windows/chassis.d.ts +1 -0
  389. package/dist/windows/chassis.js +29 -0
  390. package/dist/windows/cpu-cache.d.ts +2 -0
  391. package/dist/windows/cpu-cache.js +59 -0
  392. package/dist/windows/cpu-flags.d.ts +1 -0
  393. package/dist/windows/cpu-flags.js +61 -0
  394. package/dist/windows/cpu-temperature.d.ts +1 -0
  395. package/dist/windows/cpu-temperature.js +32 -0
  396. package/dist/windows/cpu.d.ts +1 -0
  397. package/dist/windows/cpu.js +96 -0
  398. package/dist/windows/disk-layout.d.ts +2 -0
  399. package/dist/windows/disk-layout.js +112 -0
  400. package/dist/windows/disks-io.d.ts +2 -0
  401. package/dist/windows/disks-io.js +43 -0
  402. package/dist/windows/displays.d.ts +2 -0
  403. package/dist/windows/displays.js +213 -0
  404. package/dist/windows/fs-open-files.d.ts +2 -0
  405. package/dist/windows/fs-open-files.js +22 -0
  406. package/dist/windows/fs-size.d.ts +2 -0
  407. package/dist/windows/fs-size.js +47 -0
  408. package/dist/windows/fs-stats.d.ts +2 -0
  409. package/dist/windows/fs-stats.js +37 -0
  410. package/dist/windows/gpu.d.ts +2 -0
  411. package/dist/windows/gpu.js +128 -0
  412. package/dist/windows/index.d.ts +56 -0
  413. package/dist/windows/index.js +122 -0
  414. package/dist/windows/inet-latency.d.ts +1 -0
  415. package/dist/windows/inet-latency.js +34 -0
  416. package/dist/windows/keyboard.d.ts +2 -0
  417. package/dist/windows/keyboard.js +47 -0
  418. package/dist/windows/mem-layout.d.ts +2 -0
  419. package/dist/windows/mem-layout.js +39 -0
  420. package/dist/windows/mem.d.ts +2 -0
  421. package/dist/windows/mem.js +33 -0
  422. package/dist/windows/mouse.d.ts +2 -0
  423. package/dist/windows/mouse.js +64 -0
  424. package/dist/windows/network-connections.d.ts +2 -0
  425. package/dist/windows/network-connections.js +93 -0
  426. package/dist/windows/network-gateway-default.d.ts +1 -0
  427. package/dist/windows/network-gateway-default.js +36 -0
  428. package/dist/windows/network-interface-default.d.ts +2 -0
  429. package/dist/windows/network-interface-default.js +56 -0
  430. package/dist/windows/network-interfaces.d.ts +2 -0
  431. package/dist/windows/network-interfaces.js +346 -0
  432. package/dist/windows/network-stats.d.ts +2 -0
  433. package/dist/windows/network-stats.js +135 -0
  434. package/dist/windows/npm.d.ts +1 -0
  435. package/dist/windows/npm.js +5 -0
  436. package/dist/windows/npu.d.ts +2 -0
  437. package/dist/windows/npu.js +29 -0
  438. package/dist/windows/os-info.d.ts +1 -0
  439. package/dist/windows/os-info.js +65 -0
  440. package/dist/windows/pci.d.ts +2 -0
  441. package/dist/windows/pci.js +33 -0
  442. package/dist/windows/printer.d.ts +2 -0
  443. package/dist/windows/printer.js +36 -0
  444. package/dist/windows/process-load.d.ts +2 -0
  445. package/dist/windows/process-load.js +121 -0
  446. package/dist/windows/processes.d.ts +9 -0
  447. package/dist/windows/processes.js +139 -0
  448. package/dist/windows/services.d.ts +2 -0
  449. package/dist/windows/services.js +83 -0
  450. package/dist/windows/shell.d.ts +1 -0
  451. package/dist/windows/shell.js +19 -0
  452. package/dist/windows/software.d.ts +2 -0
  453. package/dist/windows/software.js +53 -0
  454. package/dist/windows/system.d.ts +1 -0
  455. package/dist/windows/system.js +98 -0
  456. package/dist/windows/thunderbolt.d.ts +2 -0
  457. package/dist/windows/thunderbolt.js +34 -0
  458. package/dist/windows/usb.d.ts +2 -0
  459. package/dist/windows/usb.js +37 -0
  460. package/dist/windows/users.d.ts +2 -0
  461. package/dist/windows/users.js +151 -0
  462. package/dist/windows/uuid.d.ts +2 -0
  463. package/dist/windows/uuid.js +28 -0
  464. package/dist/windows/wifi-connections.d.ts +2 -0
  465. package/dist/windows/wifi-connections.js +56 -0
  466. package/dist/windows/wifi-interfaces.d.ts +2 -0
  467. package/dist/windows/wifi-interfaces.js +45 -0
  468. package/dist/windows/wifi-networks.d.ts +2 -0
  469. package/dist/windows/wifi-networks.js +50 -0
  470. package/package.json +78 -12
  471. package/lib/audio.js +0 -277
  472. package/lib/battery.js +0 -334
  473. package/lib/bluetooth.js +0 -315
  474. package/lib/bluetoothVendors.js +0 -1138
  475. package/lib/cli.js +0 -100
  476. package/lib/cpu.js +0 -2285
  477. package/lib/docker.js +0 -791
  478. package/lib/dockerSocket.js +0 -117
  479. package/lib/filesystem.js +0 -1832
  480. package/lib/graphics.js +0 -1321
  481. package/lib/index.d.ts +0 -1051
  482. package/lib/index.js +0 -520
  483. package/lib/internet.js +0 -259
  484. package/lib/memory.js +0 -622
  485. package/lib/network.js +0 -2008
  486. package/lib/osinfo.js +0 -1321
  487. package/lib/printer.js +0 -209
  488. package/lib/processes.js +0 -1459
  489. package/lib/system.js +0 -855
  490. package/lib/usb.js +0 -309
  491. package/lib/users.js +0 -412
  492. package/lib/util.js +0 -2824
  493. package/lib/virtualbox.js +0 -116
  494. package/lib/wifi.js +0 -839
package/README.md CHANGED
@@ -23,119 +23,65 @@
23
23
  [![NPM Downloads][downloads-image]][downloads-url]
24
24
  [![Git Issues][issues-img]][issues-url]
25
25
  [![Closed Issues][closed-issues-img]][closed-issues-url]
26
- <img src="docs/assets/no-dependencies.svg" alt="no dependencies">
26
+ [![Dependencies][nodependencies-badge]][dependencies-url]
27
27
  [![Sponsoring][sponsor-badge]][sponsor-url]
28
28
  [![Caretaker][caretaker-image]][caretaker-url]
29
29
  [![MIT license][license-img]][license-url]
30
30
 
31
31
  ## The Systeminformation Project
32
32
 
33
- This is amazing. Started as a small project just for myself, it now has > 20,000
34
- lines of code, > 750 versions published, up to 50 mio downloads per month, > 700
35
- mio downloads overall. Top 5 NPM ranking for backend packages. Thank you to all
36
- who contributed to this project!
33
+ This is amazing. Started as a small project just for myself, it now has > 17,000 lines of code, > 600 versions published, up to 6 mio downloads per month, > 150 mio downloads overall. #1 NPM ranking for backend packages. Thank you to all who contributed to this project!
37
34
 
38
- > **Version 6** beta just released ⭐️⭐️⭐️
39
- >
40
- > 🏆🏆🏆 We're proud to have just released the first beta of the new version 6 of systeminformation.
41
- > Version 6 of this package (written completely in TypeScript) is
42
- > comming with a lot of new features and improvements. We also cleaned up the API so
43
- > there will also be some breaking changes.
44
- >
45
- > **Thanks to everyone testing this new version!**
46
-
47
- ## Please support this project ... ☕️
48
-
49
- Over the past few years I spent **more than 3.000 hours** working 💻 😓 ☕️ on
50
- this project and invested in hardware to be able to test on different platforms.
51
- Currently I am working very hard on the next **new version 6.0** completely
52
- rewritten in TypeScript and with a lot of new features. Any support is highly
53
- appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)... ☕️
54
-
55
- **Your contribution** make it possible for me to keep working on this project,
56
- add new features and support more platforms. Thank you in advance!
57
-
58
- ## Node.js ✅, Bun ✅ and Deno ✅
35
+ ## New Version 6
59
36
 
60
- I tested this library with Node.js, Bun and Deno (V2.x) with no issues. There
61
- was only one problem on Denos side in version <= 2.1.4: os.freemem() pollyfill
62
- was not correct but this is now fixed with Deno >= 2.1.5.
37
+ Version 6 is a complete rewrite of the library in **TypeScript**, shipping typed
38
+ declarations (`.d.ts`) for every function while keeping the same zero-dependency
39
+ promise-based API. It is a `node.js` backend/server-side library and will not run
40
+ in a browser.
63
41
 
64
- **Attention**: This library is supposed to be used as a backend/server-side
65
- library and **will definitely not work within a browser**.
66
-
67
- ## Version 6.0 beta
68
-
69
- If you want to test the new version 6.0 (currently in beta), you can eather install it this way:
70
-
71
- ```bash
72
- npm i systeminformation@beta
73
- ```
42
+ ### New functions
74
43
 
75
- Then just test it with your existing code - be sure to check all breaking changes. Docs can be found here:
44
+ - `camera()` - detected cameras
45
+ - `keyboard()` - detected keyboards
46
+ - `mouse()` - detected pointing devices
47
+ - `thunderbolt()` - Thunderbolt controllers and devices
48
+ - `pci()` - PCI devices (experimental)
49
+ - `npu()` - detected NPUs / AI accelerators (experimental)
50
+ - `software()` - installed software / applications
51
+ - `npm()` - globally installed npm packages
76
52
 
77
- - [V6 Docs][v6-docs-url]
78
- - [V6 major changes][v6-changes-url]
53
+ ### Extended Windows support
79
54
 
80
- If you want to run the whole test locally on your machines (without writing any code):
55
+ `disksIO()`, `fsStats()`, `fsOpenFiles()` and `thunderbolt()` are now also
56
+ available on Windows (none of them was available there in version 5).
81
57
 
82
- ```bash
83
- # clone v6 branch
84
- git clone -b v6 https://github.com/sebhildebrandt/systeminformation.git
85
- cd systeminformation
58
+ ### Modular imports
86
59
 
87
- # install dev dependencies
88
- npm ci
60
+ The whole library, a single operating system, or a single function can now be
61
+ imported individually - see [Installation](#installation) and [Usage](#usage).
89
62
 
90
- # run tests
91
- npm run ci # for the whole test run
92
- npm run test # for testing individual functions
93
- ```
63
+ ### Breaking changes
94
64
 
95
- Thynk you for testing and reporting! Please report any issue with the prefix "v6.beta.0: "
96
-
97
- ## Current Version 5.0
98
-
99
- The current Version 5 - this major version release 5.0 - came with new
100
- functionality and several improvements and changes (some of them are breaking
101
- changes!):
102
-
103
- - added audio: get detailed audio device information
104
- - added bluetooth: get detailed bluetooth device information
105
- - added dockerImages, dockerVolumes: get detailed information about docker
106
- images and volumes
107
- - added printer: get information from detected printers
108
- - added usb: get detailed usb controller and device information
109
- - added wifi interfaces and connections: extended wifi information
110
- - better uuid function to get unique hardware and OS UUIDs
111
- - better/extended cpu info detection
112
- - better/extended system info detection
113
- - Apple Silicon M1/M2/M3/M4/M5 support
114
- - better Raspberry-PI detection
115
- - systeminformation website updated and extended with full documentation and
116
- examples [systeminformation.io][systeminformation-url]
117
- - lot of minor improvements
118
-
119
- Breaking Changes in version 5 (compared to version 4.x): you will see several
120
- breaking changes for the sake of a more consistent API interface and to be
121
- future proof. Read the [detailed version 5 changes][changes5-url].
122
-
123
- I did a lot of testing on different platforms and machines but of course there
124
- might be some issues that I am not aware of. I would be happy if you inform me
125
- when you discover any issues. Issues can be [opened here][new-issue].
65
+ - **`time()` and `version()` are now asynchronous** and return a promise (both
66
+ were synchronous in version 5). Since version 6 **all** functions are async.
67
+ The preferred way to consume them is `async / await`, alternatively promises.
68
+ - **Callbacks are no longer available.** The former callback style
69
+ (`si.cpu(data => ...)`) has been removed - use `async / await` or promises.
70
+ - **Minimum Node.js version is now 20.0** (older releases are no longer supported).
71
+ - **Import paths.** With the new `exports` map only the documented entry points are
72
+ importable (deep `dist/...` paths are no longer part of the public API).
126
73
 
127
74
  ## Quick Start
128
75
 
129
- Lightweight collection of 50+ functions to retrieve detailed hardware, system
130
- and OS information.
76
+ Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information.
131
77
 
132
78
  - simple to use
133
- - get detailed information about system, cpu, baseboard, battery, memory,
134
- disks/filesystem, network, docker, software, services and processes
135
- - supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and
136
- Android support
79
+ - get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes
80
+ - supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support
137
81
  - no npm dependencies
138
82
 
83
+ **Attention**: this is a `node.js` library. It is supposed to be used as a backend/server-side library and will definitely not work within a browser.
84
+
139
85
  ### Installation
140
86
 
141
87
  ```bash
@@ -145,109 +91,90 @@ npm install systeminformation --save
145
91
  or simpler
146
92
 
147
93
  ```bash
148
- npm i systeminformation
149
- ```
150
-
151
- ### Give it a try with `npx`?
152
-
153
- You just want to give it a try - right from your command line without installing
154
- it? Here is how you can call it with `npx`:
155
-
156
- ```
157
- # get basic system info (System, OS, CPU)
158
- npx systeminformation info
159
-
160
- # obtain all static data - may take up to 30 seconds
161
- npx systeminformation
94
+ npm install systeminformation
162
95
  ```
163
96
 
164
- #### Still need Version 4?
97
+ #### Still need Version 5?
165
98
 
166
- If you need version 4 (for compatibility reasons), you can install version 4
167
- (latest release) like this
99
+ If you need version 4 (for compatibility reasons), you can install version 4 (latest release) like this
168
100
 
169
101
  ```bash
170
- npm install systeminformation@4 —save
102
+ npm install systeminformation@5 —save
171
103
  ```
172
104
 
173
105
  or simpler
174
106
 
175
107
  ```bash
176
- npm install systeminformation@4
108
+ npm install systeminformation@5
177
109
  ```
178
110
 
179
111
  ### Usage
180
112
 
181
- All functions (except `version` and `time`) are implemented as asynchronous
182
- functions. Here a small example how to use them:
113
+ All functions are asynchronous (since version 6 this includes `version()` and
114
+ `time()`). The **preferred** way to consume them is `async / await`; every
115
+ function also returns a promise as an alternative. Callbacks are no longer
116
+ supported.
183
117
 
184
118
  ```js
185
119
  const si = require("systeminformation");
186
120
 
187
- // promises style - new since version 3
121
+ // async / await (preferred)
122
+ const cpu = await si.cpu();
123
+ console.log(cpu);
124
+
125
+ // promise style (alternative)
188
126
  si.cpu()
189
127
  .then((data) => console.log(data))
190
128
  .catch((error) => console.error(error));
191
129
  ```
192
130
 
131
+ #### Import the whole library, a single OS, or a single function
132
+
133
+ Since version 6 the package exposes an `exports` map so you only load what you
134
+ need. All variants work with both `require` and `import`.
135
+
136
+ ```js
137
+ // 1) whole library (all functions, all platforms)
138
+ const si = require("systeminformation");
139
+ await si.cpu();
140
+
141
+ // 2) a single function (platform is still detected at runtime)
142
+ const { cpu } = require("systeminformation/cpu");
143
+ await cpu();
144
+
145
+ // 3) a whole operating system (only that platform's implementations)
146
+ const linux = require("systeminformation/linux"); // or /darwin, /windows, /bsd, /sun
147
+ await linux.cpu();
148
+
149
+ // 4) a single function of a single operating system
150
+ const { cpu } = require("systeminformation/linux/cpu");
151
+ await cpu();
152
+ ```
153
+
154
+ Variants 2-4 keep bundles small: only the imported function (and, for the plain
155
+ function import, only the platform actually running) is pulled in, so unused OS
156
+ implementations can be tree-shaken away.
157
+
193
158
  ## News and Changes
194
159
 
195
160
  ### Latest Activity
196
161
 
197
- (last 7 major and minor version releases)
198
-
199
- - Version 5.33.0: `dockerContainer()` added status (healtthy, ...)
200
- - Version 5.32.0: `graphics()` added temperature values (macOS), `dockerContainers()` added labels
201
- - Version 5.31.0: `diskLayout()` added smartmontools support (macOS)
202
- - Version 5.30.0: `processes()` added user (windows) - needed to be reverted
203
- - Version 5.29.0: `osInfo()` added OS code name (windows)
204
- - Version 5.28.0: `cpuTemperature()` added suppurt for macos-temperature-sensor (macOS)
205
- - Version 5.27.0: `mem()` added reclaimable memory
206
- - Version 5.26.0: `getStatic()`, `getAll()` added usb, audio, bluetooth, printer
207
- - Version 5.25.0: `versions()` added homebrew
208
- - Version 5.24.0: `versions()` added bun and deno
209
- - Version 5.23.0: `usb()` added serial number (linux)
210
- - Version 5.22.0: `wifiConnections()` added signal quality
211
- - Version 5.21.0: `graphics()` added subVendor (linux)
212
- - Version 5.20.0: `mem()` added writeback and dirty (linux)
213
- - Version 5.19.0: `currentLoad()` added steal and guest time (linux)
214
- - Version 5.18.0: `fsSize()` added optional drive parameter
215
- - Version 5.17.0: `graphics()` added positionX, positionY (macOS)
216
- - Version 5.16.0: `fsSize()` added rw property
217
- - Version 5.15.0: `blockDevices()` added device
218
- - Version 5.14.0: `blockDevices()` added raid group member (linux)
219
- - Version 5.13.0: `networkConnections()` added process name (macOS)
220
- - Version 5.12.0: `cpu()` added performance and efficiency cores
221
- - Version 5.11.0: `networkInterfaces()` added default property and default
222
- parameter
223
- - Version 5.10.0: basic `android` support
224
- - Version 5.9.0: `graphics()` added properties (macOS)
225
- - Version 5.8.0: `disksIO()` added waitTime, waitPercent (linux)
226
- - Version 5.7.0: `diskLayout()` added S.M.A.R.T for Windows (if installed)
227
- - Version 5.6.0: `cpuTemperature()` added socket and chipset temp (linux)
228
- - Version 5.5.0: `dockerVolumes()` added
229
- - Version 5.4.0: `dockerImages()` added
230
- - Version 5.3.0: `osInfo()` added remoteSession (win only)
231
- - Version 5.2.0: `wifiInterfaces()` and `wifiConnections()` added
232
- - Version 5.1.0: `memLayout()` added ECC flag, `bios()` added language, features
233
- (linux)
234
- - Version 5.0.0: new version 5 - attention there are some breaking changes. See
235
- [detailed version 5 changes here][changes5-url].
236
- - ...
237
-
238
- You can find all changes here: [detailed changelog][changelog-url]
162
+ #### Version 6.0.0
239
163
 
240
- ## Activity
164
+ - complete rewrite in TypeScript with typed declarations for every function
165
+ - modular imports: load the whole library, a single operating system, or a single function
166
+ - new functions: `camera()`, `keyboard()`, `mouse()`, `thunderbolt()`, `pci()`, `npu()`, `software()`, `npm()`
167
+ - extended Windows support: `disksIO()`, `fsStats()`, `fsOpenFiles()`, `thunderbolt()`
168
+ - `time()` and `version()` are now asynchronous - all functions are async (async/await preferred, promises as alternative)
169
+ - callbacks are no longer supported
170
+ - minimum Node.js version is now 20.0
171
+ - see the [New Version 6](#new-version-6) chapter for all breaking changes
241
172
 
242
- ![Alt](https://repobeats.axiom.co/api/embed/60a4334f5dc5502fd04eba46892fa009d157fc5e.svg "Repobeats analytics image")
173
+ You can find all changes here: [detailed changelog][changelog-url]
243
174
 
244
175
  ## Core concept
245
176
 
246
- [Node.js][nodejs-url] comes with some basic OS information, but I always wanted
247
- a little more. So I came up to write this little library. This library is still
248
- a work in progress. It is supposed to be used as a backend/server-side library
249
- (it will definitely not work within a browser). It requires node.js version 4.0
250
- and above.
177
+ [Node.js][nodejs-url] comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still a work in progress. It is supposed to be used as a backend/server-side library (it will definitely not work within a browser). It requires Node.js version 20.0 and above.
251
178
 
252
179
  I was able to test it on several Debian, Raspbian, Ubuntu distributions as well
253
180
  as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave,
@@ -258,744 +185,772 @@ function reference in the docs to get further details.
258
185
 
259
186
  If you have comments, suggestions & reports, please feel free to contact me!
260
187
 
261
- I also created a nice little command line tool called [mmon][mmon-github-url]
262
- (micro-monitor) for Linux and macOS, also available via
263
- [github][mmon-github-url] and [npm][mmon-npm-url]
188
+ I also created a nice little command line tool called [mmon][mmon-github-url] (micro-monitor) for Linux and macOS, also available via [github][mmon-github-url] and [npm][mmon-npm-url]
264
189
 
265
190
  ## Reference
266
191
 
267
192
  ### Function Reference and OS Support
268
193
 
269
- Full function reference with examples can be found at
270
- [https://systeminformation.io][systeminformation-url].
194
+ Full function reference with examples can be found at [https://systeminformation.io][systeminformation-url].
271
195
 
272
196
  #### 1. General
273
197
 
274
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
275
- | ------------ | ------------- | ----- | --- | --- | --- | --- | --------------------------------- |
276
- | si.version() | : string | X | X | X | X | X | lib version (no callback/promise) |
277
- | si.time() | {...} | X | X | X | X | X | (no callback/promise) |
278
- | | current | X | X | X | X | X | local (server) time |
279
- | | uptime | X | X | X | X | X | uptime in number of seconds |
280
- | | timezone | X | X | X | X | X | e.g. GMT+0200 |
281
- | | timezoneName | X | X | X | X | X | e.g. CEST |
198
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
199
+ | ------------ | ------------- | ----- | --- | --- | --- | --- | ----------------------------- |
200
+ | si.version() | : string | X | X | X | X | X | systeminformation lib version |
201
+ | si.time() | {...} | X | X | X | X | X | date / time information |
202
+ | | current | X | X | X | X | X | local (server) time |
203
+ | | uptime | X | X | X | X | X | uptime in number of seconds |
204
+ | | timezone | X | X | X | X | X | e.g. GMT+0200 |
205
+ | | timezoneName | X | X | X | X | X | e.g. CEST |
282
206
 
283
207
  #### 2. System (HW)
284
208
 
285
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
286
- | ---------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------- |
287
- | si.system(cb) | {...} | X | X | X | X | | hardware information |
288
- | | manufacturer | X | X | X | X | | e.g. 'MSI' |
289
- | | model | X | X | X | X | | model/product e.g. 'MS-7823' |
290
- | | version | X | X | X | X | | version e.g. '1.0' |
291
- | | serial | X | X | X | X | | serial number |
292
- | | uuid | X | X | X | X | | UUID |
293
- | | sku | X | X | X | X | | SKU number |
294
- | | virtual | X | X | | X | | is virtual machine |
295
- | | virtualHost | X | X | | X | | virtual host (if virtual) |
296
- | | raspberry | X | | | | | optional raspberry revision data |
297
- | si.bios(cb) | {...} | X | X | X | X | | bios information |
298
- | | vendor | X | X | X | X | | e.g. 'AMI' |
299
- | | version | X | X | X | X | | version |
300
- | | releaseDate | X | X | | X | | release date |
301
- | | revision | X | X | | X | | revision |
302
- | | serial | X | | | X | | serial |
303
- | si.baseboard(cb) | {...} | X | X | X | X | | baseboard information |
304
- | | manufacturer | X | X | X | X | | e.g. 'ASUS' |
305
- | | model | X | X | X | X | | model / product name |
306
- | | version | X | X | X | X | | version |
307
- | | serial | X | X | X | X | | serial number |
308
- | | assetTag | X | X | X | X | | asset tag |
309
- | | memMax | X | | X | X | | max memory in bytes |
310
- | | memSlots | X | | X | X | | memory slots on baseboard |
311
- | si.chassis(cb) | {...} | X | X | X | X | | chassis information |
312
- | | manufacturer | X | X | X | X | | e.g. 'MSI' |
313
- | | model | X | X | X | X | | model / product name |
314
- | | type | X | X | X | X | | model / product name |
315
- | | version | X | X | X | X | | version |
316
- | | serial | X | X | X | X | | serial number |
317
- | | assetTag | X | X | X | X | | asset tag |
318
- | | sku | | | | X | | SKU number |
319
-
320
- #### 3. CPU
321
-
322
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
323
- | ---------------------- | ---------------- | ----- | --- | --- | --- | --- | ----------------------------------- |
324
- | si.cpu(cb) | {...} | X | X | X | X | | CPU information |
325
- | | manufacturer | X | X | X | X | | e.g. 'Intel(R)' |
326
- | | brand | X | X | X | X | | e.g. 'Core(TM)2 Duo' |
327
- | | speed | X | X | X | X | | in GHz e.g. '3.40' |
328
- | | speedMin | X | | X | X | | in GHz e.g. '0.80' |
329
- | | speedMax | X | X | X | X | | in GHz e.g. '3.90' |
330
- | | governor | X | | | | | e.g. 'powersave' |
331
- | | cores | X | X | X | X | | # cores |
332
- | | physicalCores | X | X | X | X | | # physical cores |
333
- | | efficiencyCores | X | | X | | | # efficiency cores |
334
- | | performanceCores | X | | X | | | # performance cores |
335
- | | processors | X | X | X | X | | # processors |
336
- | | socket | X | X | | X | | socket type e.g. "LGA1356" |
337
- | | vendor | X | X | X | X | | vendor ID |
338
- | | family | X | X | X | X | | processor family |
339
- | | model | X | X | X | X | | processor model |
340
- | | stepping | X | X | X | X | | processor stepping |
341
- | | revision | X | | X | X | | revision |
342
- | | voltage | | X | | | | voltage |
343
- | | flags | X | X | X | X | | CPU flags |
344
- | | virtualization | X | X | X | X | | virtualization supported |
345
- | | cache | X | X | X | X | | cache in bytes (object) |
346
- | | cache.l1d | X | X | X | X | | L1D (data) size |
347
- | | cache.l1i | X | X | X | X | | L1I (instruction) size |
348
- | | cache.l2 | X | X | X | X | | L2 size |
349
- | | cache.l3 | X | X | X | X | | L3 size |
350
- | si.cpuFlags(cb) | : string | X | X | X | X | | CPU flags |
351
- | si.cpuCache(cb) | {...} | X | X | X | X | | CPU cache sizes |
352
- | | l1d | X | X | X | X | | L1D size |
353
- | | l1i | X | X | X | X | | L1I size |
354
- | | l2 | X | X | X | X | | L2 size |
355
- | | l3 | X | X | X | X | | L3 size |
356
- | si.cpuCurrentSpeed(cb) | {...} | X | X | X | X | X | current CPU speed (in GHz) |
357
- | | avg | X | X | X | X | X | avg CPU speed (all cores) |
358
- | | min | X | X | X | X | X | min CPU speed (all cores) |
359
- | | max | X | X | X | X | X | max CPU speed (all cores) |
360
- | | cores | X | X | X | X | X | CPU speed per core (array) |
361
- | si.cpuTemperature(cb) | {...} | X | X | X* | X | | CPU temperature in C (if supported) |
362
- | | main | X | X | X | X | | main temperature (avg) |
363
- | | cores | X | X | X | X | | array of temperatures |
364
- | | max | X | X | X | X | | max temperature |
365
- | | socket | X | | | | | array socket temperatures |
366
- | | chipset | X | | X | | | chipset temperature |
209
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
210
+ | -------------- | ------------- | ----- | --- | --- | --- | --- | ------------------------------------------------------------------------------------ |
211
+ | si.system() | {...} | X | X | X | X | | hardware information |
212
+ | | manufacturer | X | X | X | X | | e.g. 'MSI' |
213
+ | | model | X | X | X | X | | model/product e.g. 'MS-7823' |
214
+ | | version | X | X | X | X | | version e.g. '1.0' |
215
+ | | serial | X | X | X | X | | serial number |
216
+ | | uuid | X | X | X | X | | UUID |
217
+ | | sku | X | X | X | X | | SKU number |
218
+ | | virtual | X | X | | X | | is virtual machine |
219
+ | | virtualHost | X | X | | X | | virtual host (if virtual) |
220
+ | | raspberry | X | | | | | optional raspberry revision data |
221
+ | si.bios() | {...} | X | X | X | X | | bios information |
222
+ | | vendor | X | X | X | X | | e.g. 'AMI' |
223
+ | | version | X | X | X | X | | version |
224
+ | | releaseDate | X | X | | X | | release date |
225
+ | | revision | X | X | | X | | revision |
226
+ | | serial | X | | | X | | serial |
227
+ | | iBridge | | | X | | | optional Apple iBridge / security chip data (modelName, build, bootUuid, secureBoot) |
228
+ | si.baseboard() | {...} | X | X | X | X | | baseboard information |
229
+ | | manufacturer | X | X | X | X | | e.g. 'ASUS' |
230
+ | | model | X | X | X | X | | model / product name |
231
+ | | version | X | X | X | X | | version |
232
+ | | serial | X | X | X | X | | serial number |
233
+ | | assetTag | X | X | X | X | | asset tag |
234
+ | | memMax | X | | X | X | | max memory in bytes |
235
+ | | memSlots | X | | X | X | | memory slots on baseboard |
236
+ | si.chassis() | {...} | X | X | X | X | | chassis information |
237
+ | | manufacturer | X | X | X | X | | e.g. 'MSI' |
238
+ | | model | X | X | X | X | | model / product name |
239
+ | | type | X | X | X | X | | model / product name |
240
+ | | version | X | X | X | X | | version |
241
+ | | serial | X | X | X | X | | serial number |
242
+ | | assetTag | X | X | X | X | | asset tag |
243
+ | | sku | | | | X | | SKU number |
244
+
245
+ #### 3. CPU / NPU
246
+
247
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
248
+ | -------------------- | ---------------- | ----- | --- | --- | --- | --- | ----------------------------------- |
249
+ | si.cpu() | {...} | X | X | X | X | | CPU information |
250
+ | | manufacturer | X | X | X | X | | e.g. 'Intel(R)' |
251
+ | | brand | X | X | X | X | | e.g. 'Core(TM)2 Duo' |
252
+ | | speed | X | X | X | X | | in GHz e.g. '3.40' |
253
+ | | speedMin | X | | X | X | | in GHz e.g. '0.80' |
254
+ | | speedMax | X | X | X | X | | in GHz e.g. '3.90' |
255
+ | | governor | X | | | | | e.g. 'powersave' |
256
+ | | cores | X | X | X | X | | # cores |
257
+ | | physicalCores | X | X | X | X | | # physical cores |
258
+ | | efficiencyCores | X | | X | | | # efficiency cores |
259
+ | | performanceCores | X | | X | | | # performance cores |
260
+ | | processors | X | X | X | X | | # processors |
261
+ | | socket | X | X | | X | | socket type e.g. "LGA1356" |
262
+ | | vendor | X | X | X | X | | vendor ID |
263
+ | | family | X | X | X | X | | processor family |
264
+ | | model | X | X | X | X | | processor model |
265
+ | | stepping | X | X | X | X | | processor stepping |
266
+ | | revision | X | | X | X | | revision |
267
+ | | voltage | | X | | | | voltage |
268
+ | | flags | X | X | X | X | | CPU flags |
269
+ | | virtualization | X | X | X | X | | virtualization supported |
270
+ | | cache | X | X | X | X | | cache in bytes (object) |
271
+ | | cache.l1d | X | X | X | X | | L1D (data) size |
272
+ | | cache.l1i | X | X | X | X | | L1I (instruction) size |
273
+ | | cache.l2 | X | X | X | X | | L2 size |
274
+ | | cache.l3 | X | X | X | X | | L3 size |
275
+ | si.cpuFlags() | : string | X | X | X | X | | CPU flags |
276
+ | si.cpuCache() | {...} | X | X | X | X | | CPU cache sizes |
277
+ | | l1d | X | X | X | X | | L1D size |
278
+ | | l1i | X | X | X | X | | L1I size |
279
+ | | l2 | X | X | X | X | | L2 size |
280
+ | | l3 | X | X | X | X | | L3 size |
281
+ | si.cpuCurrentSpeed() | {...} | X | X | X | X | X | current CPU speed (in GHz) |
282
+ | | avg | X | X | X | X | X | avg CPU speed (all cores) |
283
+ | | min | X | X | X | X | X | min CPU speed (all cores) |
284
+ | | max | X | X | X | X | X | max CPU speed (all cores) |
285
+ | | cores | X | X | X | X | X | CPU speed per core (array) |
286
+ | si.cpuTemperature() | {...} | X | X | X* | X | | CPU temperature in C (if supported) |
287
+ | | main | X | X | X | X | | main temperature (avg) |
288
+ | | cores | X | X | X | X | | array of temperatures |
289
+ | | max | X | X | X | X | | max temperature |
290
+ | | socket | X | | | | | array socket temperatures |
291
+ | | chipset | X | | | | | chipset temperature |
292
+ | si.npu() | [{...}] | X | | X | X | | detected NPUs / AI accelerators |
293
+ | | [0].vendor | X | | X | X | | vendor (Intel, AMD, Apple, ...) |
294
+ | | [0].name | X | | X | X | | name |
295
+ | | [0].model | | | X | | | model (SoC on Apple Silicon) |
296
+ | | [0].cores | | | X | | | number of NPU cores (or null) |
297
+ | | [0].vendorId | X | | | X | | vendor id (hex) |
298
+ | | [0].deviceId | X | | | X | | device id (hex) |
299
+ | | [0].driver | X | | | X | | kernel driver / service |
367
300
 
368
301
  #### 4. Memory
369
302
 
370
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
371
- | ---------------- | --------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
372
- | si.mem(cb) | {...} | X | X | X | X | X | Memory information (in bytes) |
373
- | | total | X | X | X | X | X | total memory in bytes |
374
- | | free | X | X | X | X | X | not used in bytes |
375
- | | used | X | X | X | X | X | used (incl. buffers/cache) |
376
- | | active | X | X | X | X | X | used actively (excl. buffers/cache) |
377
- | | buffcache | X | X | X | | X | used by buffers+cache |
378
- | | buffers | X | | | | | used by buffers |
379
- | | cached | X | | | | | used by cache |
380
- | | slab | X | | | | | used by slab |
381
- | | reclaimable | X | | X | | | reclaimable (SReclaimable) |
382
- | | available | X | X | X | X | X | potentially available (total - active) |
383
- | | swaptotal | X | X | X | X | X | |
384
- | | swapused | X | X | X | X | X | |
385
- | | swapfree | X | X | X | X | X | |
386
- | | writeback | X | | | | | |
387
- | | dirty | X | | | | | |
388
- | si.memLayout(cb) | [{...}] | X | X | X | X | | Memory Layout (array) |
389
- | | [0].size | X | X | X | X | | size in bytes |
390
- | | [0].bank | X | X | | X | | memory bank |
391
- | | [0].type | X | X | X | X | | memory type |
392
- | | [0].clockSpeed | X | X | X | X | | clock speed |
393
- | | [0].formFactor | X | X | | X | | form factor |
394
- | | [0].manufacturer | X | X | X | X | | manufacturer |
395
- | | [0].partNum | X | X | X | X | | part number |
396
- | | [0].serialNum | X | X | X | X | | serial number |
397
- | | [0].voltageConfigured | X | X | | X | | voltage conf. |
398
- | | [0].voltageMin | X | X | | X | | voltage min |
399
- | | [0].voltageMax | X | X | | X | | voltage max |
303
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
304
+ | -------------- | --------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
305
+ | si.mem() | {...} | X | X | X | X | X | Memory information (in bytes) |
306
+ | | total | X | X | X | X | X | total memory in bytes |
307
+ | | free | X | X | X | X | X | not used in bytes |
308
+ | | used | X | X | X | X | X | used (incl. buffers/cache) |
309
+ | | active | X | X | X | X | X | used actively (excl. buffers/cache) |
310
+ | | buffcache | X | X | X | | X | used by buffers+cache |
311
+ | | buffers | X | | | | | used by buffers |
312
+ | | cached | X | | | | | used by cache |
313
+ | | slab | X | | | | | used by slab |
314
+ | | available | X | X | X | X | X | potentially available (total - active) |
315
+ | | swaptotal | X | X | X | X | X | |
316
+ | | swapused | X | X | X | X | X | |
317
+ | | swapfree | X | X | X | X | X | |
318
+ | si.memLayout() | [{...}] | X | X | X | X | | Memory Layout (array) |
319
+ | | [0].size | X | X | X | X | | size in bytes |
320
+ | | [0].bank | X | X | | X | | memory bank |
321
+ | | [0].type | X | X | X | X | | memory type |
322
+ | | [0].clockSpeed | X | X | X | X | | clock speed |
323
+ | | [0].formFactor | X | X | | X | | form factor |
324
+ | | [0].manufacturer | X | X | X | X | | manufacturer |
325
+ | | [0].partNum | X | X | X | X | | part number |
326
+ | | [0].serialNum | X | X | X | X | | serial number |
327
+ | | [0].voltageConfigured | X | X | | X | | voltage conf. |
328
+ | | [0].voltageMin | X | X | | X | | voltage min |
329
+ | | [0].voltageMax | X | X | | X | | voltage max |
400
330
 
401
331
  #### 5. Battery
402
332
 
403
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
404
- | -------------- | ---------------- | ----- | --- | --- | --- | --- | --------------------------------- |
405
- | si.battery(cb) | {...} | X | X | X | X | | battery information |
406
- | | hasBattery | X | X | X | X | | indicates presence of battery |
407
- | | cycleCount | X | | X | | | numbers of recharges |
408
- | | isCharging | X | X | X | X | | indicates if battery is charging |
409
- | | designedCapacity | X | | X | X | | max capacity of battery (mWh) |
410
- | | maxCapacity | X | | X | X | | max capacity of battery (mWh) |
411
- | | currentCapacity | X | | X | X | | current capacity of battery (mWh) |
412
- | | capacityUnit | X | | X | X | | capacity unit (mWh) |
413
- | | voltage | X | | X | X | | current voltage of battery (V) |
414
- | | percent | X | X | X | X | | charging level in percent |
415
- | | timeRemaining | X | | X | | | minutes left (if discharging) |
416
- | | acConnected | X | X | X | X | | AC connected |
417
- | | type | X | | X | | | battery type |
418
- | | model | X | | X | | | model |
419
- | | manufacturer | X | | X | | | manufacturer |
420
- | | serial | X | | X | | | battery serial |
421
-
422
- - See known issues if you have a problem with macOS temperature or windows
423
- temperature
333
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
334
+ | ------------ | ---------------- | ----- | --- | --- | --- | --- | --------------------------------- |
335
+ | si.battery() | {...} | X | X | X | X | | battery information |
336
+ | | hasBattery | X | X | X | X | | indicates presence of battery |
337
+ | | cycleCount | X | | X | | | numbers of recharges |
338
+ | | isCharging | X | X | X | X | | indicates if battery is charging |
339
+ | | designedCapacity | X | | X | X | | max capacity of battery (mWh) |
340
+ | | maxCapacity | X | | X | X | | max capacity of battery (mWh) |
341
+ | | currentCapacity | X | | X | X | | current capacity of battery (mWh) |
342
+ | | capacityUnit | X | | X | X | | capacity unit (mWh) |
343
+ | | voltage | X | | X | X | | current voltage of battery (V) |
344
+ | | percent | X | X | X | X | | charging level in percent |
345
+ | | timeRemaining | X | | X | | | minutes left (if discharging) |
346
+ | | acConnected | X | X | X | X | | AC connected |
347
+ | | type | X | | X | | | battery type |
348
+ | | model | X | | X | | | model |
349
+ | | manufacturer | X | | X | | | manufacturer |
350
+ | | serial | X | | X | | | battery serial |
351
+
352
+ - See known issues if you have a problem with macOS temperature or windows temperature
424
353
 
425
354
  #### 6. Graphics
426
355
 
427
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
428
- | --------------- | ------------------------- | ----- | --- | --- | --- | --- | ------------------------------------------- |
429
- | si.graphics(cb) | {...} | X | | X | X | | arrays of graphics controllers and displays |
430
- | | controllers[] | X | | X | X | | graphics controllers array |
431
- | | ...[0].vendor | X | | X | X | | e.g. NVIDIA |
432
- | | ...[0].subVendor | X | | | | | e.g. Gigabyte |
433
- | | ...[0].vendorId | | | X | | | vendor ID |
434
- | | ...[0].model | X | | X | X | | graphics controller model |
435
- | | ...[0].deviceId | | | X | | | device ID |
436
- | | ...[0].bus | X | | X | X | | on which bus (e.g. PCIe) |
437
- | | ...[0].vram | X | | X | X | | VRAM size (in MB) |
438
- | | ...[0].vramDynamic | X | | X | X | | true if dynamically allocated ram |
439
- | | ...[0].external | | | X | | | is external GPU |
440
- | | ...[0].cores | | | X | | | Apple silicon only |
441
- | | ...[0].metalVersion | | | X | | | Apple Metal Version |
442
- | | ...[0].temperatureGpu | X | | X | X | | GPU temperature (see notes below) |
443
- | | displays[] | X | | X | X | | monitor/display array |
444
- | | ...[0].vendor | | | | X | | monitor/display vendor |
445
- | | ...[0].vendorId | | | X | | | vendor ID |
446
- | | ...[0].deviceName | | | | X | | e.g. \\\\.\\DISPLAY1 |
447
- | | ...[0].model | X | | X | X | | monitor/display model |
448
- | | ...[0].productionYear | | | X | X | | production year |
449
- | | ...[0].serial | | | X | X | | serial number |
450
- | | ...[0].displayId | | | X | X | | display ID |
451
- | | ...[0].main | X | | X | X | | true if main monitor |
452
- | | ...[0].builtin | X | | X | | | true if built-in monitor |
453
- | | ...[0].connection | X | | X | X | | e.g. DisplayPort or HDMI |
454
- | | ...[0].sizeX | X | | | X | | size in mm horizontal |
455
- | | ...[0].sizeY | X | | | X | | size in mm vertical |
456
- | | ...[0].pixelDepth | X | | X | X | | color depth in bits |
457
- | | ...[0].resolutionX | X | | X | X | | pixel horizontal |
458
- | | ...[0].resolutionY | X | | X | X | | pixel vertical |
459
- | | ...[0].currentResX | X | | X | X | | current pixel horizontal |
460
- | | ...[0].currentResY | X | | X | X | | current pixel vertical |
461
- | | ...[0].positionX | X | | X | X | | display position X |
462
- | | ...[0].positionY | X | | X | X | | display position Y |
463
- | | ...[0].currentRefreshRate | X | | X | X | | current screen refresh rate |
356
+ In v6 the former `graphics()` function was split into `si.gpu()` (graphics controllers) and `si.displays()` (monitors/displays). Both return plain arrays. `si.get()` returns a migration hint for the removed `graphics` key.
357
+
358
+ On Windows, `si.displays()` reports physical monitors: in duplicate/mirror mode each mirrored monitor gets its own entry (sharing the resolution and position of the mirrored screen).
359
+
360
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
361
+ | ------------- | ---------------------- | ----- | --- | --- | --- | --- | --------------------------------- |
362
+ | si.gpu() | [{...}] | X | | X | X | | array of graphics controllers |
363
+ | | [0].vendor | X | | X | X | | e.g. ATI |
364
+ | | [0].vendorId | | | X | | | vendor ID |
365
+ | | [0].model | X | | X | X | | graphics controller model |
366
+ | | [0].deviceId | | | X | | | device ID |
367
+ | | [0].bus | X | | X | X | | on which bus (e.g. PCIe) |
368
+ | | [0].vram | X | | X | X | | VRAM size (in MB) |
369
+ | | [0].vramDynamic | X | | X | X | | true if dynamically allocated ram |
370
+ | | [0].external | | | X | | | is external GPU |
371
+ | | [0].cores | | | X | | | Apple silicon only |
372
+ | | [0].metalVersion | | | X | | | Apple Metal Version |
373
+ | | [0].temperatureGpu | X | | X | X | | GPU temperature (see notes below) |
374
+ | si.displays() | [{...}] | X | | X | X | | array of monitors/displays |
375
+ | | [0].vendor | | | | X | | monitor/display vendor |
376
+ | | [0].vendorId | | | X | | | vendor ID |
377
+ | | [0].deviceName | | | | X | | e.g. \\\\.\\DISPLAY1 |
378
+ | | [0].model | X | | X | X | | monitor/display model |
379
+ | | [0].productionYear | | | X | X | | production year |
380
+ | | [0].serial | | | X | X | | serial number |
381
+ | | [0].displayId | | | X | X | | display ID |
382
+ | | [0].main | X | | X | X | | true if main monitor |
383
+ | | [0].builtin | X | | X | | | true if built-in monitor |
384
+ | | [0].connection | X | | X | X | | e.g. DisplayPort or HDMI |
385
+ | | [0].sizeX | X | | | X | | size in mm horizontal |
386
+ | | [0].sizeY | X | | | X | | size in mm vertical |
387
+ | | [0].pixelDepth | X | | X | X | | color depth in bits |
388
+ | | [0].resolutionX | X | | X | X | | pixel horizontal |
389
+ | | [0].resolutionY | X | | X | X | | pixel vertical |
390
+ | | [0].currentResX | X | | X | X | | current pixel horizontal |
391
+ | | [0].currentResY | X | | X | X | | current pixel vertical |
392
+ | | [0].positionX | X | | X | X | | display position X |
393
+ | | [0].positionY | X | | X | X | | display position Y |
394
+ | | [0].currentRefreshRate | X | | X | X | | current screen refresh rate |
464
395
 
465
396
  #### 7. Operating System
466
397
 
467
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
468
- | --------------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
469
- | si.osInfo(cb) | {...} | X | X | X | X | X | OS information |
470
- | | platform | X | X | X | X | X | 'linux', 'darwin', 'Windows', ... |
471
- | | distro | X | X | X | X | X | |
472
- | | release | X | X | X | X | X | |
473
- | | codename | X | | X | X | | |
474
- | | kernel | X | X | X | X | X | kernel release - same as os.release() |
475
- | | arch | X | X | X | X | X | same as os.arch() |
476
- | | hostname | X | X | X | X | X | same as os.hostname() |
477
- | | fqdn | X | X | X | X | X | FQDN fully qualified domain name |
478
- | | codepage | X | X | X | X | | OS build version |
479
- | | logofile | X | X | X | X | X | e.g. 'apple', 'debian', 'fedora', ... |
480
- | | serial | X | X | X | X | | OS/Host serial number |
481
- | | build | X | | X | X | | OS build version |
482
- | | servicepack | | | | X | | service pack version |
483
- | | uefi | X | X | X | X | | OS started via UEFI |
484
- | | hypervisor | | | | X | | hyper-v enabled? (win only) |
485
- | | remoteSession | | | | X | | runs in remote session (win only) |
486
- | si.uuid(cb) | {...} | X | X | X | X | X | object of several UUIDs |
487
- | | os | X | X | X | X | | os specific UUID |
488
- | | hardware | X | X | X | X | | hardware specific UUID |
489
- | | macs | X | X | X | X | | MAC addresses |
490
- | si.versions(apps, cb) | {...} | X | X | X | X | X | version information (kernel, ssl, node, ...)<br />apps param is optional for detecting<br />only specific apps/libs<br />(string, comma separated) |
491
- | si.shell(cb) | : string | X | X | X | X | | standard shell |
492
- | si.users(cb) | [{...}] | X | X | X | X | X | array of users online |
493
- | | [0].user | X | X | X | X | X | user name |
494
- | | [0].tty | X | X | X | X | X | terminal |
495
- | | [0].date | X | X | X | X | X | login date |
496
- | | [0].time | X | X | X | X | X | login time |
497
- | | [0].ip | X | X | X | | X | ip address (remote login) |
498
- | | [0].command | X | X | X | | X | last command or shell |
398
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
399
+ | ----------------- | ---------------- | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
400
+ | si.osInfo() | {...} | X | X | X | X | X | OS information |
401
+ | | platform | X | X | X | X | X | 'linux', 'darwin', 'win32', ... |
402
+ | | distro | X | X | X | X | X | |
403
+ | | release | X | X | X | X | X | |
404
+ | | codename | X | | X | | | |
405
+ | | kernel | X | X | X | X | X | kernel release - same as os.release() |
406
+ | | arch | X | X | X | X | X | same as os.arch() |
407
+ | | hostname | X | X | X | X | X | same as os.hostname() |
408
+ | | fqdn | X | X | X | X | X | FQDN fully qualified domain name |
409
+ | | codepage | X | X | X | X | | OS build version |
410
+ | | logofile | X | X | X | X | X | e.g. 'apple', 'debian', 'fedora', ... |
411
+ | | serial | X | X | X | X | | OS/Host serial number |
412
+ | | build | X | | X | X | | OS build version |
413
+ | | servicepack | | | | X | | service pack version |
414
+ | | uefi | X | X | X | X | | OS started via UEFI |
415
+ | | hypervisor | | | | X | | hyper-v enabled? (win only) |
416
+ | | remoteSession | | | | X | | runs in remote session (win only) |
417
+ | | installDate | X | | X | X | | OS installation date (Date object or null) |
418
+ | | displayServer | X | X | X | X | X | display server e.g. wayland, x11, quartz, dwm, surfaceflinger or '' (headless) |
419
+ | si.uuid() | {...} | X | X | X | X | X | object of several UUIDs |
420
+ | | os | X | X | X | X | | os specific UUID |
421
+ | | hardware | X | X | X | X | | hardware specific UUID |
422
+ | | macs | X | X | X | X | | MAC addresses |
423
+ | si.versions(apps) | {...} | X | X | X | X | X | version information (kernel, ssl, node, ...)<br />apps param is optional for detecting<br />only specific apps/libs<br />(string, comma separated) |
424
+ | si.shell() | : string | X | X | X | X | | standard shell |
425
+ | si.users() | [{...}] | X | X | X | X | X | array of users online |
426
+ | | [0].user | X | X | X | X | X | user name |
427
+ | | [0].tty | X | X | X | X | X | terminal |
428
+ | | [0].date | X | X | X | X | X | login date |
429
+ | | [0].time | X | X | X | X | X | login time |
430
+ | | [0].ip | X | X | X | | X | ip address (remote login) |
431
+ | | [0].command | X | X | X | | X | last command or shell |
432
+ | si.software() | [{...}] | X | | X | X | | installed software / applications |
433
+ | | [0].name | X | | X | X | | name |
434
+ | | [0].description | X | | X | | | description |
435
+ | | [0].version | X | | X | X | | version |
436
+ | | [0].installDate | X | | X | X | | install date (or null) |
437
+ | | [0].architecture | X | | X | X | | architecture |
438
+ | | [0].source | X | | X | X | | source / obtained from |
439
+ | | [0].path | X | | X | X | | install path |
440
+ | | [0].signedBy | | | X | X | | signing authorities (array) |
441
+ | si.npm() | [{...}] | X | X | X | X | X | globally installed npm packages |
442
+ | | [0].name | X | X | X | X | X | package name |
443
+ | | [0].version | X | X | X | X | X | package version |
499
444
 
500
445
  #### 8. Current Load, Processes & Services
501
446
 
502
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
503
- | ------------------------------------ | ----------------- | ----- | --- | --- | --- | --- | --------------------------------------------------------------------------------------- |
504
- | si.currentLoad(cb) | {...} | X | | X | X | X | CPU-Load |
505
- | | avgLoad | X | | X | | X | average load |
506
- | | currentLoad | X | | X | X | X | CPU load in % |
507
- | | currentLoadUser | X | | X | X | X | CPU load user in % |
508
- | | currentLoadSystem | X | | X | X | X | CPU load system in % |
509
- | | currentLoadNice | X | | X | X | X | CPU load nice in % |
510
- | | currentLoadIdle | X | | X | X | X | CPU load idle in % |
511
- | | currentLoadIrq | X | | X | X | X | CPU load system in % |
512
- | | rawCurrentLoad... | X | | X | X | X | CPU load raw values (ticks) |
513
- | | cpus[] | X | | X | X | X | current loads per CPU in % + raw ticks |
514
- | si.fullLoad(cb) | : integer | X | | X | X | | CPU full load since bootup in % |
515
- | si.processes(cb) | {...} | X | X | X | X | X | # running processes |
516
- | | all | X | X | X | X | X | # of all processes |
517
- | | running | X | X | X | | X | # of all processes running |
518
- | | blocked | X | X | X | | X | # of all processes blocked |
519
- | | sleeping | X | X | X | | X | # of all processes sleeping |
520
- | | unknown | | | | X | | # of all processes unknown status |
521
- | | list[] | X | X | X | X | X | list of all processes incl. details |
522
- | | ...[0].pid | X | X | X | X | X | process PID |
523
- | | ...[0].parentPid | X | X | X | X | X | parent process PID |
524
- | | ...[0].name | X | X | X | X | X | process name |
525
- | | ...[0].cpu | X | X | X | X | X | process % CPU usage |
526
- | | ...[0].cpuu | X | X | | X | | process % CPU usage (user) |
527
- | | ...[0].cpus | X | X | | X | | process % CPU usage (system) |
528
- | | ...[0].mem | X | X | X | X | X | process memory % |
529
- | | ...[0].priority | X | X | X | X | X | process priority |
530
- | | ...[0].memVsz | X | X | X | X | X | process virtual memory size |
531
- | | ...[0].memRss | X | X | X | X | X | process mem resident set size |
532
- | | ...[0].nice | X | X | X | | X | process nice value |
533
- | | ...[0].started | X | X | X | X | X | process start time |
534
- | | ...[0].state | X | X | X | X | X | process state (e.g. sleeping) |
535
- | | ...[0].tty | X | X | X | | X | tty from which process was started |
536
- | | ...[0].user | X | X | X | | X | user who started process |
537
- | | ...[0].command | X | X | X | X | X | process starting command |
538
- | | ...[0].params | X | X | X | | X | process params |
539
- | | ...[0].path | X | X | X | X | X | process path |
540
- | | proc | X | X | X | X | | process name |
541
- | | pid | X | X | X | X | | PID |
542
- | | pids | X | X | X | X | | additional pids |
543
- | | cpu | X | X | X | X | | process % CPU |
544
- | | mem | X | X | X | X | | process % MEM |
545
- | si.services('mysql, apache2', cb) | [{...}] | X | X | X | X | | pass comma separated string of services<br>pass "*" for ALL services (linux/win only) |
546
- | | [0].name | X | X | X | X | | name of service |
547
- | | [0].running | X | X | X | X | | true / false |
548
- | | [0].startmode | | | | X | | manual, automatic, ... |
549
- | | [0].pids | X | X | X | X | | pids |
550
- | | [0].cpu | X | X | X | | | process % CPU |
551
- | | [0].mem | X | X | X | | | process % MEM |
552
- | si.processLoad('mysql, apache2', cb) | [{...}] | X | X | X | X | | pass comma separated string of processes<br>pass "*" for ALL processes (linux/win only) |
553
- | | [0].proc | X | X | X | X | | name of process |
554
- | | [0].pids | X | X | X | X | | pids |
555
- | | [0].cpu | X | X | X | | | process % CPU |
556
- | | [0].mem | X | X | X | | | process % MEM |
447
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
448
+ | -------------------------------- | ----------------- | ----- | --- | --- | --- | --- | --------------------------------------------------------------------------------------- |
449
+ | si.currentLoad() | {...} | X | | X | X | X | CPU-Load |
450
+ | | avgLoad | X | | X | | X | average load |
451
+ | | currentLoad | X | | X | X | X | CPU load in % |
452
+ | | currentLoadUser | X | | X | X | X | CPU load user in % |
453
+ | | currentLoadSystem | X | | X | X | X | CPU load system in % |
454
+ | | currentLoadNice | X | | X | X | X | CPU load nice in % |
455
+ | | currentLoadIdle | X | | X | X | X | CPU load idle in % |
456
+ | | currentLoadIrq | X | | X | X | X | CPU load system in % |
457
+ | | rawCurrentLoad... | X | | X | X | X | CPU load raw values (ticks) |
458
+ | | cpus[] | X | | X | X | X | current loads per CPU in % + raw ticks |
459
+ | si.fullLoad() | : integer | X | | X | X | | CPU full load since bootup in % |
460
+ | si.processes() | {...} | X | X | X | X | X | # running processes |
461
+ | | all | X | X | X | X | X | # of all processes |
462
+ | | running | X | X | X | | X | # of all processes running |
463
+ | | blocked | X | X | X | | X | # of all processes blocked |
464
+ | | sleeping | X | X | X | | X | # of all processes sleeping |
465
+ | | unknown | | | | X | | # of all processes unknown status |
466
+ | | list[] | X | X | X | X | X | list of all processes incl. details |
467
+ | | ...[0].pid | X | X | X | X | X | process PID |
468
+ | | ...[0].parentPid | X | X | X | X | X | parent process PID |
469
+ | | ...[0].name | X | X | X | X | X | process name |
470
+ | | ...[0].cpu | X | X | X | X | X | process % CPU usage |
471
+ | | ...[0].cpuu | X | X | | X | | process % CPU usage (user) |
472
+ | | ...[0].cpus | X | X | | X | | process % CPU usage (system) |
473
+ | | ...[0].mem | X | X | X | X | X | process memory % |
474
+ | | ...[0].priority | X | X | X | X | X | process priority |
475
+ | | ...[0].memVsz | X | X | X | X | X | process virtual memory size |
476
+ | | ...[0].memRss | X | X | X | X | X | process mem resident set size |
477
+ | | ...[0].nice | X | X | X | | X | process nice value |
478
+ | | ...[0].started | X | X | X | X | X | process start time |
479
+ | | ...[0].state | X | X | X | X | X | process state (e.g. sleeping) |
480
+ | | ...[0].tty | X | X | X | | X | tty from which process was started |
481
+ | | ...[0].user | X | X | X | | X | user who started process |
482
+ | | ...[0].command | X | X | X | X | X | process starting command |
483
+ | | ...[0].params | X | X | X | | X | process params |
484
+ | | ...[0].path | X | X | X | X | X | process path |
485
+ | | proc | X | X | X | X | | process name |
486
+ | | pid | X | X | X | X | | PID |
487
+ | | pids | X | X | X | X | | additional pids |
488
+ | | cpu | X | X | X | X | | process % CPU |
489
+ | | mem | X | X | X | X | | process % MEM |
490
+ | si.services('mysql, apache2') | [{...}] | X | X | X | X | | pass comma separated string of services<br>pass "*" for ALL services (linux/win only) |
491
+ | | [0].name | X | X | X | X | | name of service |
492
+ | | [0].running | X | X | X | X | | true / false |
493
+ | | [0].startmode | | | | X | | manual, automatic, ... |
494
+ | | [0].pids | X | X | X | X | | pids |
495
+ | | [0].cpu | X | X | X | | | process % CPU |
496
+ | | [0].mem | X | X | X | | | process % MEM |
497
+ | si.processLoad('mysql, apache2') | [{...}] | X | X | X | X | | pass comma separated string of processes<br>pass "*" for ALL processes (linux/win only) |
498
+ | | [0].proc | X | X | X | X | | name of process |
499
+ | | [0].pids | X | X | X | X | | pids |
500
+ | | [0].cpu | X | X | X | | | process % CPU |
501
+ | | [0].mem | X | X | X | | | process % MEM |
557
502
 
558
503
  #### 9. File System
559
504
 
560
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
561
- | -------------------- | --------------------- | ----- | --- | --- | --- | --- | ------------------------------------------------------------------------ |
562
- | si.diskLayout(cb) | [{...}] | X | | X | X | | physical disk layout (array) |
563
- | | [0].device | X | | X | | | e.g. /dev/sda |
564
- | | [0].type | X | | X | X | | HD, SSD, NVMe |
565
- | | [0].name | X | | X | X | | disk name |
566
- | | [0].vendor | X | | | X | | vendor/producer |
567
- | | [0].size | X | | X | X | | size in bytes |
568
- | | [0].bytesPerSector | | | | X | | bytes per sector |
569
- | | [0].totalCylinders | | | | X | | total cylinders |
570
- | | [0].totalHeads | | | | X | | total heads |
571
- | | [0].totalSectors | | | | X | | total sectors |
572
- | | [0].totalTracks | | | | X | | total tracks |
573
- | | [0].tracksPerCylinder | | | | X | | tracks per cylinder |
574
- | | [0].sectorsPerTrack | | | | X | | sectors per track |
575
- | | [0].firmwareRevision | X | | X | X | | firmware revision |
576
- | | [0].serialNum | X | | X | X | | serial number |
577
- | | [0].interfaceType | X | | X | X | | SATA, PCIe, ... |
578
- | | [0].smartStatus | X | | X | X | | S.M.A.R.T Status (see Known Issues) |
579
- | | [0].temperature | X | | X | X | | S.M.A.R.T temperature |
580
- | | [0].smartData | X | | X | X | | full S.M.A.R.T data from smartctl<br>requires at least smartmontools 7.0 |
581
- | si.blockDevices(cb) | [{...}] | X | | X | X | | returns array of disks, partitions,<br>raids and roms |
582
- | | [0].name | X | | X | X | | name |
583
- | | [0].type | X | | X | X | | type |
584
- | | [0].fstype | X | | X | X | | file system type (e.g. ext4) |
585
- | | [0].mount | X | | X | X | | mount point |
586
- | | [0].size | X | | X | X | | size in bytes |
587
- | | [0].physical | X | | X | X | | physical type (HDD, SSD, CD/DVD) |
588
- | | [0].uuid | X | | X | X | | UUID |
589
- | | [0].label | X | | X | X | | label |
590
- | | [0].model | X | | X | | | model |
591
- | | [0].serial | X | | | X | | serial |
592
- | | [0].removable | X | | X | X | | serial |
593
- | | [0].protocol | X | | X | | | protocol (SATA, PCI-Express, ...) |
594
- | | [0].group | X | | | | | Raid group member (e.g. md1) |
595
- | | [0].device | X | | X | X | | physical device mapped to (e.g. /dev/sda) |
596
- | si.disksIO(cb) | {...} | X | | X | | | current transfer stats |
597
- | | rIO | X | | X | | | read IOs on all mounted drives |
598
- | | wIO | X | | X | | | write IOs on all mounted drives |
599
- | | tIO | X | | X | | | write IOs on all mounted drives |
600
- | | rIO_sec | X | | X | | | read IO per sec (* see notes) |
601
- | | wIO_sec | X | | X | | | write IO per sec (* see notes) |
602
- | | tIO_sec | X | | X | | | total IO per sec (* see notes) |
603
- | | rWaitTime | X | | | | | read IO request time (* see notes) |
604
- | | wWaitTime | X | | | | | write IO request time (* see notes) |
605
- | | tWaitTime | X | | | | | total IO request time (* see notes) |
606
- | | rWaitPercent | X | | | | | read IO request time percent (* see notes) |
607
- | | wWaitPercent | X | | | | | write IO request time percent (* see notes) |
608
- | | tWaitPercent | X | | | | | total IO request time percent (* see notes) |
609
- | | ms | X | | X | | | interval length (for per second values) |
610
- | si.fsSize(drive, cb) | [{...}] | X | X | X | X | | returns array of mounted file systems<br>drive param is optional |
611
- | | [0].fs | X | X | X | X | | name of file system |
612
- | | [0].type | X | X | X | X | | type of file system |
613
- | | [0].size | X | X | X | X | | sizes in bytes |
614
- | | [0].used | X | X | X | X | | used in bytes |
615
- | | [0].available | X | X | X | X | | used in bytes |
616
- | | [0].use | X | X | X | X | | used in % |
617
- | | [0].mount | X | X | X | X | | mount point |
618
- | | [0].rw | X | X | X | X | | read and write (false if read only) |
619
- | si.fsOpenFiles(cb) | {...} | X | X | X | | | count max/allocated file descriptors |
620
- | | max | X | X | X | | | max file descriptors |
621
- | | allocated | X | X | X | | | current open files count |
622
- | | available | X | X | X | | | count available |
623
- | si.fsStats(cb) | {...} | X | | X | | | current transfer stats |
624
- | | rx | X | | X | | | bytes read since startup |
625
- | | wx | X | | X | | | bytes written since startup |
626
- | | tx | X | | X | | | total bytes read + written since startup |
627
- | | rx_sec | X | | X | | | bytes read / second (* see notes) |
628
- | | wx_sec | X | | X | | | bytes written / second (* see notes) |
629
- | | tx_sec | X | | X | | | total bytes reads + written / second |
630
- | | ms | X | | X | | | interval length (for per second values) |
631
-
632
- #### 10. USB
633
-
634
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
635
- | ---------- | ---------------- | ----- | --- | --- | --- | --- | ------------------------ |
636
- | si.usb(cb) | [{...}] | X | X | X | X | | get detected USB devices |
637
- | | [0].bus | X | | | | | USB bus |
638
- | | [0].deviceId | X | | | | | bus device id |
639
- | | [0].id | X | | X | X | | internal id |
640
- | | [0].name | X | | X | X | | name |
641
- | | [0].type | X | | X | X | | name |
642
- | | [0].removable | | | X | | | is removable |
643
- | | [0].vendor | X | | X | | | vendor |
644
- | | [0].manufacturer | X | | X | X | | manufacturer |
645
- | | [0].maxPower | X | | | | | max power |
646
- | | [0].default | X | | X | X | | is default printer |
647
- | | [0].serialNumber | X | | X | | | serial number |
648
-
649
- #### 11. Printer
650
-
651
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
652
- | -------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------- |
653
- | si.printer(cb) | [{...}] | X | X | X | X | | get printer information |
654
- | | [0].id | X | | X | X | | internal id |
655
- | | [0].name | X | | X | X | | name |
656
- | | [0].model | X | | X | X | | model |
657
- | | [0].uri | X | | X | | | printer URI |
658
- | | [0].uuid | X | | | | | printer UUID |
659
- | | [0].status | X | | X | X | | printer status (e.g. idle) |
660
- | | [0].local | X | | X | X | | is local printer |
661
- | | [0].default | | | X | X | | is default printer |
662
- | | [0].shared | X | | X | X | | is shared printer |
663
-
664
- #### 12. Audio
665
-
666
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
667
- | ------------ | ----------------- | ----- | --- | --- | --- | --- | ------------------------------------- |
668
- | si.audio(cb) | [{...}] | X | X | X | X | | get printer information |
669
- | | [0].id | X | | X | X | | internal id |
670
- | | [0].name | X | | X | X | | name |
671
- | | [0].manufacturer | X | | X | X | | manufacturer |
672
- | | [0].revision | X | | | | | revision |
673
- | | [0].driver | X | | | | | driver |
674
- | | [0].default | | | X | X | | is default |
675
- | | [0].channel | X | | X | | | channel e.g. USB, HDMI, ... |
676
- | | [0].type | X | | X | X | | type e.g. Speaker |
677
- | | [0].in | | | X | X | | is input channel |
678
- | | [0].out | | | X | X | | is output channel |
679
- | | [0].interfaceType | X | | X | X | | interface type (PCIe, USB, HDMI, ...) |
680
- | | [0].status | X | | X | X | | printer status (e.g. idle) |
681
-
682
- #### 13. Network related functions
683
-
684
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
685
- | ------------------------------ | ------------------ | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
686
- | si.networkInterfaces(cb) | [{...}] | X | X | X | X | X | array of network interfaces<br>With the 'default' parameter it returns<br>only the default interface |
687
- | | [0].iface | X | X | X | X | X | interface |
688
- | | [0].ifaceName | X | X | X | X | X | interface name (differs on Windows) |
689
- | | [0].default | X | X | X | X | X | true if this is the default interface |
690
- | | [0].ip4 | X | X | X | X | X | ip4 address |
691
- | | [0].ip4subnet | X | X | X | X | X | ip4 subnet mask |
692
- | | [0].ip6 | X | X | X | X | X | ip6 address |
693
- | | [0].ip6subnet | X | X | X | X | X | ip6 subnet mask |
694
- | | [0].mac | X | X | X | X | X | MAC address |
695
- | | [0].internal | X | X | X | X | X | true if internal interface |
696
- | | [0].virtual | X | X | X | X | X | true if virtual interface |
697
- | | [0].operstate | X | | X | X | | up / down |
698
- | | [0].type | X | | X | X | | wireless / wired |
699
- | | [0].duplex | X | | X | | | duplex |
700
- | | [0].mtu | X | | X | | | maximum transmission unit |
701
- | | [0].speed | X | | X | X | | speed in MBit / s |
702
- | | [0].dhcp | X | | X | X | | IP address obtained by DHCP |
703
- | | [0].dnsSuffix | X | | | X | | DNS suffix |
704
- | | [0].ieee8021xAuth | X | | | X | | IEEE 802.1x auth |
705
- | | [0].ieee8021xState | X | | | X | | IEEE 802.1x state |
706
- | | [0].carrierChanges | X | | | | | # changes up/down |
707
- | si.networkInterfaceDefault(cb) | : string | X | X | X | X | X | get name of default network interface |
708
- | si.networkGatewayDefault(cb) | : string | X | X | X | X | X | get default network gateway |
709
- | si.networkStats(ifaces,cb) | [{...}] | X | X | X | X | | current network stats of given interfaces<br>iface list: space or comma separated<br>iface parameter is optional<br>defaults to first external network interface,<br />Pass '*' for all interfaces |
710
- | | [0].iface | X | X | X | X | | interface |
711
- | | [0].operstate | X | X | X | X | | up / down |
712
- | | [0].rx_bytes | X | X | X | X | | received bytes overall |
713
- | | [0].rx_dropped | X | X | X | X | | received dropped overall |
714
- | | [0].rx_errors | X | X | X | X | | received errors overall |
715
- | | [0].tx_bytes | X | X | X | X | | transferred bytes overall |
716
- | | [0].tx_dropped | X | X | X | X | | transferred dropped overall |
717
- | | [0].tx_errors | X | X | X | X | | transferred errors overall |
718
- | | [0].rx_sec | X | X | X | X | | received bytes / second (* see notes) |
719
- | | [0].tx_sec | X | X | X | X | | transferred bytes per second (* see notes) |
720
- | | [0].ms | X | X | X | X | | interval length (for per second values) |
721
- | si.networkConnections(cb) | [{...}] | X | X | X | X | | current network network connections<br>returns an array of all connections |
722
- | | [0].protocol | X | X | X | X | | tcp or udp |
723
- | | [0].localAddress | X | X | X | X | | local address |
724
- | | [0].localPort | X | X | X | X | | local port |
725
- | | [0].peerAddress | X | X | X | X | | peer address |
726
- | | [0].peerPort | X | X | X | X | | peer port |
727
- | | [0].state | X | X | X | X | | like ESTABLISHED, TIME_WAIT, ... |
728
- | | [0].pid | X | X | X | X | | process ID |
729
- | | [0].process | X | X | X | | | process name |
730
- | si.inetChecksite(url, cb) | {...} | X | X | X | X | X | response-time (ms) to fetch given URL |
731
- | | url | X | X | X | X | X | given url |
732
- | | ok | X | X | X | X | X | status code OK (2xx, 3xx) |
733
- | | status | X | X | X | X | X | status code |
734
- | | ms | X | X | X | X | X | response time in ms |
735
- | si.inetLatency(host, cb) | : number | X | X | X | X | X | response-time (ms) to external resource<br>host parameter is optional (default 8.8.8.8) |
736
-
737
- #### 14. Wifi
738
-
739
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
740
- | ---------------------- | --------------- | ----- | --- | --- | --- | --- | --------------------------------------------- |
741
- | si.wifiNetworks(cb) | [{...}] | X | | X | X | | array of available wifi networks |
742
- | | [0].ssid | X | | X | X | | Wifi network SSID |
743
- | | [0].bssid | X | | X | X | | BSSID (mac) |
744
- | | [0].mode | X | | | | | mode |
745
- | | [0].channel | X | | X | X | | channel |
746
- | | [0].frequency | X | | X | X | | frequency in MHz |
747
- | | [0].signalLevel | X | | X | X | | signal level in dB |
748
- | | [0].quality | X | | X | X | | quality in % |
749
- | | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
750
- | | [0].wpaFlags | X | | X | X | | array of WPA flags |
751
- | | [0].rsnFlags | X | | | | | array of RDN flags |
752
- | si.wifiInterfaces(cb) | [{...}] | X | | X | X | | array of detected wifi interfaces |
753
- | | [0].id | X | | X | X | | ID |
754
- | | [0].iface | X | | X | X | | interface |
755
- | | [0].model | X | | X | X | | model |
756
- | | [0].vendor | X | | X | X | | vendor |
757
- | | [0].mac | X | | X | X | | MAC address |
758
- | si.wifiConnections(cb) | [{...}] | X | | X | X | | array of active wifi connections |
759
- | | [0].id | X | | X | X | | ID |
760
- | | [0].iface | X | | X | X | | interface |
761
- | | [0].model | X | | X | X | | model |
762
- | | [0].ssid | X | | X | X | | SSID |
763
- | | [0].bssid | X | | (X) | X | | BSSID (mac) - macOS only on older os versions |
764
- | | [0].channel | X | | X | X | | channel |
765
- | | [0].frequency | X | | X | X | | frequency in MHz |
766
- | | [0].type | X | | X | X | | e.g. 802.11 |
767
- | | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
768
- | | [0].signalLevel | X | | X | X | | signal level in dB |
769
- | | [0].quality | X | | X | X | | quality in % |
770
- | | [0].txRate | X | | X | X | | transfer rate MBit/s |
771
-
772
- #### 15. Bluetooth
773
-
774
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
775
- | ----------------------- | ------------------ | ----- | --- | --- | --- | --- | ------------------------ |
776
- | si.bluetoothDevices(cb) | [{...}] | X | | X | X | | ... |
777
- | | [0].device | | | X | | | device name |
778
- | | [0].name | X | | X | X | | name |
779
- | | [0].macDevice | X | | X | | | MAC address device |
780
- | | [0].macHost | X | | X | | | MAC address host |
781
- | | [0].batteryPercent | | | X | | | battery level percent |
782
- | | [0].manufacturer | | | X | X | | manufacturer |
783
- | | [0].type | X | | X | X | | type of bluetooth device |
784
- | | [0].connected | X | | X | | | is connected |
785
-
786
- #### 16. Docker
787
-
788
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
789
- | ----------------------------------- | ------------------- | ----------------------------------- | --- | --- | --- | --- | ------------------------------------------------------------------------------------------------------------- |
790
- | si.dockerInfo(cb) | {...} | X | X | X | X | X | returns general docker info |
791
- | | id | X | X | X | X | X | Docker ID |
792
- | | containers | X | X | X | X | X | number of containers |
793
- | | containersRunning | X | X | X | X | X | number of running containers |
794
- | | containersPaused | X | X | X | X | X | number of paused containers |
795
- | | containersStopped | X | X | X | X | X | number of stopped containers |
796
- | | images | X | X | X | X | X | number of images |
797
- | | driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') |
798
- | | memoryLimit | X | X | X | X | X | has memory limit |
799
- | | swapLimit | X | X | X | X | X | has swap limit |
800
- | | kernelMemory | X | X | X | X | X | has kernel memory |
801
- | | cpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod |
802
- | | cpuCfsQuota | X | X | X | X | X | has CpuCfsQuota |
803
- | | cpuShares | X | X | X | X | X | has CPUShares |
804
- | | cpuSet | X | X | X | X | X | has CPUShares |
805
- | | ipv4Forwarding | X | X | X | X | X | has IPv4Forwarding |
806
- | | bridgeNfIptables | X | X | X | X | X | has BridgeNfIptables |
807
- | | bridgeNfIp6tables | X | X | X | X | X | has BridgeNfIp6tables |
808
- | | debug | X | X | X | X | X | Debug on |
809
- | | nfd | X | X | X | X | X | named data networking forwarding daemon |
810
- | | oomKillDisable | X | X | X | X | X | out-of-memory kill disabled |
811
- | | ngoroutines | X | X | X | X | X | number NGoroutines |
812
- | | systemTime | X | X | X | X | X | docker SystemTime |
813
- | | loggingDriver | X | X | X | X | X | logging driver e.g. 'json-file' |
814
- | | cgroupDriver | X | X | X | X | X | cgroup driver e.g. 'cgroupfs' |
815
- | | nEventsListener | X | X | X | X | X | number NEventsListeners |
816
- | | kernelVersion | X | X | X | X | X | docker kernel version |
817
- | | operatingSystem | X | X | X | X | X | docker OS e.g. 'Docker for Mac' |
818
- | | osType | X | X | X | X | X | OSType e.g. 'linux' |
819
- | | architecture | X | X | X | X | X | architecture e.g. x86_64 |
820
- | | ncpu | X | X | X | X | X | number of CPUs |
821
- | | memTotal | X | X | X | X | X | memory total |
822
- | | dockerRootDir | X | X | X | X | X | docker root directory |
823
- | | httpProxy | X | X | X | X | X | http proxy |
824
- | | httpsProxy | X | X | X | X | X | https proxy |
825
- | | noProxy | X | X | X | X | X | NoProxy |
826
- | | name | X | X | X | X | X | Name |
827
- | | labels | X | X | X | X | X | array of labels |
828
- | | experimentalBuild | X | X | X | X | X | is experimental build |
829
- | | serverVersion | X | X | X | X | X | server version |
830
- | | clusterStore | X | X | X | X | X | cluster store |
831
- | | clusterAdvertise | X | X | X | X | X | cluster advertise |
832
- | | defaultRuntime | X | X | X | X | X | default runtime e.g. 'runc' |
833
- | | liveRestoreEnabled | X | X | X | X | X | live store enabled |
834
- | | isolation | X | X | X | X | X | isolation |
835
- | | initBinary | X | X | X | X | X | init binary |
836
- | | productLicense | X | X | X | X | X | product license |
837
- | si.dockerImages(all, cb) | [{...}] | X | X | X | X | X | returns array of top level/all docker images |
838
- | | [0].id | X | X | X | X | X | image ID |
839
- | | [0].container | X | X | X | X | X | container ID |
840
- | | [0].comment | X | X | X | X | X | comment |
841
- | | [0].os | X | X | X | X | X | OS |
842
- | | [0].architecture | X | X | X | X | X | architecture |
843
- | | [0].parent | X | X | X | X | X | parent ID |
844
- | | [0].dockerVersion | X | X | X | X | X | docker version |
845
- | | [0].size | X | X | X | X | X | image size |
846
- | | [0].sharedSize | X | X | X | X | X | shared size |
847
- | | [0].virtualSize | X | X | X | X | X | virtual size |
848
- | | [0].author | X | X | X | X | X | author |
849
- | | [0].created | X | X | X | X | X | created date / time |
850
- | | [0].containerConfig | X | X | X | X | X | container config object |
851
- | | [0].graphDriver | X | X | X | X | X | graph driver object |
852
- | | [0].repoDigests | X | X | X | X | X | repo digests array |
853
- | | [0].repoTags | X | X | X | X | X | repo tags array |
854
- | | [0].config | X | X | X | X | X | config object |
855
- | | [0].rootFS | X | X | X | X | X | root fs object |
856
- | si.dockerContainers(all, cb) | [{...}] | X | X | X | X | X | returns array of active/all docker containers |
857
- | | [0].id | X | X | X | X | X | ID of container |
858
- | | [0].name | X | X | X | X | X | name of container |
859
- | | [0].image | X | X | X | X | X | name of image |
860
- | | [0].imageID | X | X | X | X | X | ID of image |
861
- | | [0].command | X | X | X | X | X | command |
862
- | | [0].created | X | X | X | X | X | creation time (unix) |
863
- | | [0].started | X | X | X | X | X | creation time (unix) |
864
- | | [0].finished | X | X | X | X | X | creation time (unix) |
865
- | | [0].createdAt | X | X | X | X | X | creation date time string |
866
- | | [0].startedAt | X | X | X | X | X | creation date time string |
867
- | | [0].finishedAt | X | X | X | X | X | creation date time string |
868
- | | [0].status | X | X | X | X | X | healthy, starting, unhealthy |
869
- | | [0].state | X | X | X | X | X | created, running, exited |
870
- | | [0].labels | X | X | X | X | X | object of labels (key-value pairs) |
871
- | | [0].ports | X | X | X | X | X | array of ports |
872
- | | [0].mounts | X | X | X | X | X | array of mounts |
873
- | si.dockerContainerStats(ids, cb) | [{...}] | X | X | X | X | X | statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers |
874
- | | [0].id | X | X | X | X | X | Container ID |
875
- | | [0].memUsage | X | X | X | X | X | memory usage in bytes |
876
- | | [0].memLimit | X | X | X | X | X | memory limit (max mem) in bytes |
877
- | | [0].memPercent | X | X | X | X | X | memory usage in percent |
878
- | | [0].cpuPercent | X | X | X | X | X | cpu usage in percent |
879
- | | [0].pids | X | X | X | X | X | number of processes |
880
- | | [0].netIO.rx | X | X | X | X | X | received bytes via network |
881
- | | [0].netIO.wx | X | X | X | X | X | sent bytes via network |
882
- | | [0].blockIO.r | X | X | X | X | X | bytes read from BlockIO |
883
- | | [0].blockIO.w | X | X | X | X | X | bytes written to BlockIO |
884
- | | [0].cpuStats | X | X | X | X | X | detailed cpu stats |
885
- | | [0].percpuStats | X | X | X | X | X | detailed per cpu stats |
886
- | | [0].memoryStats | X | X | X | X | X | detailed memory stats |
887
- | | [0].networks | X | X | X | X | X | detailed network stats per interface |
888
- | si.dockerContainerProcesses(id, cb) | [{...}] | X | X | X | X | X | array of processes inside a container |
889
- | | [0].pidHost | X | X | X | X | X | process ID (host) |
890
- | | [0].ppid | X | X | X | X | X | parent process ID |
891
- | | [0].pgid | X | X | X | X | X | process group ID |
892
- | | [0].user | X | X | X | X | X | effective user name |
893
- | | [0].ruser | X | X | X | X | X | real user name |
894
- | | [0].group | X | X | X | X | X | effective group name |
895
- | | [0].rgroup | X | X | X | X | X | real group name |
896
- | | [0].stat | X | X | X | X | X | process state |
897
- | | [0].time | X | X | X | X | X | accumulated CPU time |
898
- | | [0].elapsed | X | X | X | X | X | elapsed running time |
899
- | | [0].nice | X | X | X | X | X | nice value |
900
- | | [0].rss | X | X | X | X | X | resident set size |
901
- | | [0].vsz | X | X | X | X | X | virtual size in Kbytes |
902
- | | [0].command | X | X | X | X | X | command and arguments |
903
- | si.dockerVolumes(cb) | [{...}] | returns array of all docker volumes | | | | | |
904
- | | [0].name | X | X | X | X | X | volume name |
905
- | | [0].driver | X | X | X | X | X | driver |
906
- | | [0].labels | X | X | X | X | X | labels object |
907
- | | [0].mountpoint | X | X | X | X | X | mountpoint |
908
- | | [0].options | X | X | X | X | X | options |
909
- | | [0].scope | X | X | X | X | X | scope |
910
- | | [0].created | X | X | X | X | X | created at |
911
- | si.dockerAll(cb) | {...} | X | X | X | X | X | list of all containers including their stats<br>and processes in one single array |
912
-
913
- #### 17. Virtual Box
914
-
915
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
916
- | --------------- | -------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
917
- | si.vboxInfo(cb) | [{...}] | X | X | X | X | X | returns array general virtual box info |
918
- | | [0].id | X | X | X | X | X | virtual box ID |
919
- | | [0].name | X | X | X | X | X | name |
920
- | | [0].running | X | X | X | X | X | vbox is running |
921
- | | [0].started | X | X | X | X | X | started date time |
922
- | | [0].runningSince | X | X | X | X | X | running since (secs) |
923
- | | [0].stopped | X | X | X | X | X | stopped date time |
924
- | | [0].stoppedSince | X | X | X | X | X | stopped since (secs) |
925
- | | [0].guestOS | X | X | X | X | X | Guest OS |
926
- | | [0].hardwareUUID | X | X | X | X | X | Hardware UUID |
927
- | | [0].memory | X | X | X | X | X | Memory in MB |
928
- | | [0].vram | X | X | X | X | X | VRAM in MB |
929
- | | [0].cpus | X | X | X | X | X | CPUs |
930
- | | [0].cpuExepCap | X | X | X | X | X | CPU exec cap |
931
- | | [0].cpuProfile | X | X | X | X | X | CPU profile |
932
- | | [0].chipset | X | X | X | X | X | chipset |
933
- | | [0].firmware | X | X | X | X | X | firmware |
934
- | | [0].pageFusion | X | X | X | X | X | page fusion |
935
- | | [0].configFile | X | X | X | X | X | config file |
936
- | | [0].snapshotFolder | X | X | X | X | X | snapshot folder |
937
- | | [0].logFolder | X | X | X | X | X | log folder path |
938
- | | [0].hpet | X | X | X | X | X | HPET |
939
- | | [0].pae | X | X | X | X | X | PAE |
940
- | | [0].longMode | X | X | X | X | X | long mode |
941
- | | [0].tripleFaultReset | X | X | X | X | X | triple fault reset |
942
- | | [0].apic | X | X | X | X | X | APIC |
943
- | | [0].x2Apic | X | X | X | X | X | X2APIC |
944
- | | [0].acpi | X | X | X | X | X | ACPI |
945
- | | [0].ioApic | X | X | X | X | X | IOAPIC |
946
- | | [0].biosApicMode | X | X | X | X | X | BIOS APIC mode |
947
- | | [0].bootMenuMode | X | X | X | X | X | boot menu Mode |
948
- | | [0].bootDevice1 | X | X | X | X | X | bootDevice1 |
949
- | | [0].bootDevice2 | X | X | X | X | X | bootDevice2 |
950
- | | [0].bootDevice3 | X | X | X | X | X | bootDevice3 |
951
- | | [0].bootDevice4 | X | X | X | X | X | bootDevice4 |
952
- | | [0].timeOffset | X | X | X | X | X | time Offset |
953
- | | [0].rtc | X | X | X | X | X | RTC |
954
-
955
- #### 16. "Get All / Observe" - functions
956
-
957
- | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
958
- | ----------------------------------- | ------------- | ----- | --- | --- | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
959
- | si.getStaticData(cb) | {...} | X | X | X | X | X | all static data at once |
960
- | si.getDynamicData(srv,iface,cb) | {...} | X | X | X | X | X | all dynamic data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "_" for ALL services (linux/win only)<br>Pass "_" for ALL network interfaces |
961
- | si.getAllData(srv,iface,cb) | {...} | X | X | X | X | X | all data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "_" for ALL services (linux/win only)<br>Pass "_" for ALL network interfaces |
962
- | si.get(valueObject,cb) | {...} | X | X | X | X | X | get partial system info data at once<br>In valueObject you can define<br>all values, you want to get back <br>(see documentation for details) |
963
- | si.observe(valueObject,interval,cb) | - | X | X | X | X | X | Observe a defined value object<br>call callback on changes<br>polling interval in milliseconds |
964
-
965
- ### cb: Asynchronous Function Calls (callback)
966
-
967
- Remember: all functions (except `version` and `time`) are implemented as
968
- asynchronous functions! There are now three ways to consume them:
969
-
970
- **Callback Style**
505
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
506
+ | ----------------- | --------------------- | ----- | --- | --- | --- | --- | ------------------------------------------------------------------------ |
507
+ | si.diskLayout() | [{...}] | X | | X | X | | physical disk layout (array) |
508
+ | | [0].device | X | | X | | | e.g. /dev/sda |
509
+ | | [0].type | X | | X | X | | HD, SSD, NVMe |
510
+ | | [0].name | X | | X | X | | disk name |
511
+ | | [0].vendor | X | | | X | | vendor/producer |
512
+ | | [0].size | X | | X | X | | size in bytes |
513
+ | | [0].bytesPerSector | | | | X | | bytes per sector |
514
+ | | [0].totalCylinders | | | | X | | total cylinders |
515
+ | | [0].totalHeads | | | | X | | total heads |
516
+ | | [0].totalSectors | | | | X | | total sectors |
517
+ | | [0].totalTracks | | | | X | | total tracks |
518
+ | | [0].tracksPerCylinder | | | | X | | tracks per cylinder |
519
+ | | [0].sectorsPerTrack | | | | X | | sectors per track |
520
+ | | [0].firmwareRevision | X | | X | X | | firmware revision |
521
+ | | [0].serialNum | X | | X | X | | serial number |
522
+ | | [0].interfaceType | X | | | X | | SATA, PCIe, ... |
523
+ | | [0].smartStatus | X | | X | X | | S.M.A.R.T Status (see Known Issues) |
524
+ | | [0].temperature | X | | | | | S.M.A.R.T temperature |
525
+ | | [0].smartData | X | | | X | | full S.M.A.R.T data from smartctl<br>requires at least smartmontools 7.0 |
526
+ | si.blockDevices() | [{...}] | X | | X | X | | returns array of disks, partitions,<br>raids and roms |
527
+ | | [0].name | X | | X | X | | name |
528
+ | | [0].type | X | | X | X | | type |
529
+ | | [0].fstype | X | | X | X | | file system type (e.g. ext4) |
530
+ | | [0].mount | X | | X | X | | mount point |
531
+ | | [0].size | X | | X | X | | size in bytes |
532
+ | | [0].physical | X | | X | X | | physical type (HDD, SSD, CD/DVD) |
533
+ | | [0].uuid | X | | X | X | | UUID |
534
+ | | [0].label | X | | X | X | | label |
535
+ | | [0].model | X | | X | | | model |
536
+ | | [0].serial | X | | | X | | serial |
537
+ | | [0].removable | X | | X | X | | serial |
538
+ | | [0].protocol | X | | X | | | protocol (SATA, PCI-Express, ...) |
539
+ | | [0].group | X | | | | | Raid group member (e.g. md1) |
540
+ | | [0].device | X | | X | X | | physical device mapped to (e.g. /dev/sda) |
541
+ | si.disksIO() | {...} | X | | X | X | | current transfer stats |
542
+ | | rIO | X | | X | X | | read IOs on all mounted drives |
543
+ | | wIO | X | | X | X | | write IOs on all mounted drives |
544
+ | | tIO | X | | X | X | | write IOs on all mounted drives |
545
+ | | rIO_sec | X | | X | X | | read IO per sec (* see notes) |
546
+ | | wIO_sec | X | | X | X | | write IO per sec (* see notes) |
547
+ | | tIO_sec | X | | X | X | | total IO per sec (* see notes) |
548
+ | | rWaitTime | X | | | | | read IO request time (* see notes) |
549
+ | | wWaitTime | X | | | | | write IO request time (* see notes) |
550
+ | | tWaitTime | X | | | | | total IO request time (* see notes) |
551
+ | | rWaitPercent | X | | | | | read IO request time percent (* see notes) |
552
+ | | wWaitPercent | X | | | | | write IO request time percent (* see notes) |
553
+ | | tWaitPercent | X | | | | | total IO request time percent (* see notes) |
554
+ | | ms | X | | X | X | | interval length (for per second values) |
555
+ | si.fsSize(drive) | [{...}] | X | X | X | X | | returns array of mounted file systems<br>drive param is optional |
556
+ | | [0].fs | X | X | X | X | | name of file system |
557
+ | | [0].type | X | X | X | X | | type of file system |
558
+ | | [0].size | X | X | X | X | | sizes in bytes |
559
+ | | [0].used | X | X | X | X | | used in bytes |
560
+ | | [0].available | X | X | X | X | | used in bytes |
561
+ | | [0].use | X | X | X | X | | used in % |
562
+ | | [0].mount | X | X | X | X | | mount point |
563
+ | | [0].rw | X | X | X | X | | read and write (false if read only) |
564
+ | si.fsOpenFiles() | {...} | X | X | X | X | | count max/allocated file descriptors |
565
+ | | max | X | X | X | | | max file descriptors |
566
+ | | allocated | X | X | X | X | | current open files count (win: system-wide handle count) |
567
+ | | available | X | X | X | | | count available |
568
+ | si.fsStats() | {...} | X | | X | X | | current transfer stats |
569
+ | | rx | X | | X | X | | bytes read since startup |
570
+ | | wx | X | | X | X | | bytes written since startup |
571
+ | | tx | X | | X | X | | total bytes read + written since startup |
572
+ | | rx_sec | X | | X | X | | bytes read / second (* see notes) |
573
+ | | wx_sec | X | | X | X | | bytes written / second (* see notes) |
574
+ | | tx_sec | X | | X | X | | total bytes reads + written / second |
575
+ | | ms | X | | X | X | | interval length (for per second values) |
576
+
577
+ #### 10. Interfaces
578
+
579
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
580
+ | ---------------- | ---------------- | ----- | --- | --- | --- | --- | ------------------------------- |
581
+ | si.pci() | [{...}] | X | | X | X | | PCI devices (experimental) |
582
+ | | [0].slot | X | | X | | | bus address / slot |
583
+ | | [0].bus | X | | X | | | PCI bus |
584
+ | | [0].type | X | | X | X | | device class / category |
585
+ | | [0].vendor | X | | | X | | vendor name |
586
+ | | [0].vendorId | X | | X | X | | vendor id (hex) |
587
+ | | [0].model | X | | X | X | | device / product name |
588
+ | | [0].deviceId | X | | X | X | | device id (hex) |
589
+ | | [0].subVendorId | X | | X | X | | subsystem vendor id (hex) |
590
+ | | [0].subDeviceId | X | | X | X | | subsystem device id (hex) |
591
+ | | [0].revision | X | | X | X | | revision |
592
+ | | [0].driver | X | | | X | | kernel driver / service |
593
+ | si.thunderbolt() | [{...}] | X | | X | X | | Thunderbolt controllers/devices |
594
+ | | [0].name | X | | X | X | | name |
595
+ | | [0].uuid | X | | X | | | device UUID |
596
+ | | [0].bus | X | | X | | | bus number |
597
+ | | [0].type | X | | X | X | | type (e.g. hub) |
598
+ | | [0].speed | X | | X | | | speed |
599
+ | si.usb() | [{...}] | X | X | X | X | | get detected USB devices |
600
+ | | [0].bus | X | | | | | USB bus |
601
+ | | [0].deviceId | X | | | | | bus device id |
602
+ | | [0].id | X | | X | X | | internal id |
603
+ | | [0].name | X | | X | X | | name |
604
+ | | [0].type | X | | X | X | | type |
605
+ | | [0].removable | | | X | | | is removable |
606
+ | | [0].vendor | X | | X | | | vendor |
607
+ | | [0].manufacturer | X | | X | X | | manufacturer |
608
+ | | [0].maxPower | X | | | | | max power |
609
+ | | [0].default | X | | X | X | | is default printer |
610
+ | | [0].serialNumber | | | X | | | serial number |
611
+
612
+ #### 11. Devices
613
+
614
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
615
+ | ------------- | ----------------- | ----- | --- | --- | --- | --- | ------------------------------------- |
616
+ | si.camera() | [{...}] | X | | X | X | | detected cameras |
617
+ | | [0].name | X | | X | X | | name |
618
+ | | [0].model | X | | X | X | | model |
619
+ | | [0].vendor | X | | X | X | | vendor |
620
+ | | [0].serial | X | | X | X | | serial number |
621
+ | | [0].connection | X | | X | X | | connection (e.g. built-in, USB) |
622
+ | si.keyboard() | [{...}] | X | | X | X | | detected keyboards |
623
+ | | [0].name | X | | X | X | | name |
624
+ | | [0].model | X | | X | X | | model |
625
+ | | [0].vendor | X | | X | X | | vendor |
626
+ | | [0].serial | X | | X | X | | serial number |
627
+ | | [0].connection | X | | X | X | | connection |
628
+ | si.mouse() | [{...}] | X | | X | X | | detected pointing devices |
629
+ | | [0].name | X | | X | X | | name |
630
+ | | [0].type | X | | X | X | | type |
631
+ | | [0].model | X | | X | X | | model |
632
+ | | [0].vendor | X | | X | X | | vendor |
633
+ | | [0].serial | X | | X | X | | serial number |
634
+ | | [0].connection | X | | X | X | | connection |
635
+ | si.printer() | [{...}] | X | X | X | X | | get printer information |
636
+ | | [0].id | X | | X | X | | internal id |
637
+ | | [0].name | X | | X | X | | name |
638
+ | | [0].model | X | | X | X | | model |
639
+ | | [0].uri | X | | X | | | printer URI |
640
+ | | [0].uuid | X | | | | | printer UUID |
641
+ | | [0].status | X | | X | X | | printer status (e.g. idle) |
642
+ | | [0].local | X | | X | X | | is local printer |
643
+ | | [0].default | | | X | X | | is default printer |
644
+ | | [0].shared | X | | X | X | | is shared printer |
645
+ | si.audio() | [{...}] | X | X | X | X | | get audio device information |
646
+ | | [0].id | X | | X | X | | internal id |
647
+ | | [0].name | X | | X | X | | name |
648
+ | | [0].manufacturer | X | | X | X | | manufacturer |
649
+ | | [0].revision | X | | | | | revision |
650
+ | | [0].driver | X | | | | | driver |
651
+ | | [0].default | | | X | X | | is default |
652
+ | | [0].channel | X | | X | | | channel e.g. USB, HDMI, ... |
653
+ | | [0].type | X | | X | X | | type e.g. Speaker |
654
+ | | [0].in | | | X | X | | is input channel |
655
+ | | [0].out | | | X | X | | is output channel |
656
+ | | [0].interfaceType | X | | X | X | | interface type (PCIe, USB, HDMI, ...) |
657
+ | | [0].status | X | | X | X | | status (e.g. active) |
658
+
659
+ #### 12. Network related functions
660
+
661
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
662
+ | ---------------------------- | ------------------ | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
663
+ | si.networkInterfaces() | [{...}] | X | X | X | X | X | array of network interfaces<br>With the 'default' parameter it returns<br>only the default interface |
664
+ | | [0].iface | X | X | X | X | X | interface |
665
+ | | [0].ifaceName | X | X | X | X | X | interface name (differs on Windows) |
666
+ | | [0].default | X | X | X | X | X | true if this is the default interface |
667
+ | | [0].ip4 | X | X | X | X | X | ip4 address |
668
+ | | [0].ip4subnet | X | X | X | X | X | ip4 subnet mask |
669
+ | | [0].ip6 | X | X | X | X | X | ip6 address |
670
+ | | [0].ip6subnet | X | X | X | X | X | ip6 subnet mask |
671
+ | | [0].mac | X | X | X | X | X | MAC address |
672
+ | | [0].internal | X | X | X | X | X | true if internal interface |
673
+ | | [0].virtual | X | X | X | X | X | true if virtual interface |
674
+ | | [0].operstate | X | | X | X | | up / down |
675
+ | | [0].type | X | | X | X | | wireless / wired |
676
+ | | [0].duplex | X | | X | | | duplex |
677
+ | | [0].mtu | X | | X | | | maximum transmission unit |
678
+ | | [0].speed | X | | X | X | | speed in MBit / s |
679
+ | | [0].dhcp | X | | X | X | | IP address obtained by DHCP |
680
+ | | [0].dnsSuffix | X | | | X | | DNS suffix |
681
+ | | [0].ieee8021xAuth | X | | | X | | IEEE 802.1x auth |
682
+ | | [0].ieee8021xState | X | | | X | | IEEE 802.1x state |
683
+ | | [0].carrierChanges | X | | | | | # changes up/down |
684
+ | si.networkInterfaceDefault() | : string | X | X | X | X | X | get name of default network interface |
685
+ | si.networkGatewayDefault() | : string | X | X | X | X | X | get default network gateway |
686
+ | si.networkStats(ifaces) | [{...}] | X | X | X | X | | current network stats of given interfaces<br>iface list: space or comma separated<br>iface parameter is optional<br>defaults to first external network interface,<br />Pass '*' for all interfaces |
687
+ | | [0].iface | X | X | X | X | | interface |
688
+ | | [0].operstate | X | X | X | X | | up / down |
689
+ | | [0].rx_bytes | X | X | X | X | | received bytes overall |
690
+ | | [0].rx_dropped | X | X | X | X | | received dropped overall |
691
+ | | [0].rx_errors | X | X | X | X | | received errors overall |
692
+ | | [0].tx_bytes | X | X | X | X | | transferred bytes overall |
693
+ | | [0].tx_dropped | X | X | X | X | | transferred dropped overall |
694
+ | | [0].tx_errors | X | X | X | X | | transferred errors overall |
695
+ | | [0].rx_sec | X | X | X | X | | received bytes / second (* see notes) |
696
+ | | [0].tx_sec | X | X | X | X | | transferred bytes per second (* see notes) |
697
+ | | [0].ms | X | X | X | X | | interval length (for per second values) |
698
+ | si.networkConnections() | [{...}] | X | X | X | X | | current network network connections<br>returns an array of all connections |
699
+ | | [0].protocol | X | X | X | X | | tcp or udp |
700
+ | | [0].localAddress | X | X | X | X | | local address |
701
+ | | [0].localPort | X | X | X | X | | local port |
702
+ | | [0].peerAddress | X | X | X | X | | peer address |
703
+ | | [0].peerPort | X | X | X | X | | peer port |
704
+ | | [0].state | X | X | X | X | | like ESTABLISHED, TIME_WAIT, ... |
705
+ | | [0].pid | X | X | X | X | | process ID |
706
+ | | [0].process | X | X | X | | | process name |
707
+ | si.inetChecksite(url) | {...} | X | X | X | X | X | response-time (ms) to fetch given URL |
708
+ | | url | X | X | X | X | X | given url |
709
+ | | ok | X | X | X | X | X | status code OK (2xx, 3xx) |
710
+ | | status | X | X | X | X | X | status code |
711
+ | | ms | X | X | X | X | X | response time in ms |
712
+ | si.inetLatency(host) | : number | X | X | X | X | X | response-time (ms) to external resource<br>host parameter is optional (default 8.8.8.8) |
713
+
714
+ #### 13. Wifi
715
+
716
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
717
+ | -------------------- | --------------- | ----- | --- | --- | --- | --- | --------------------------------- |
718
+ | si.wifiNetworks() | [{...}] | X | | X | X | | array of available wifi networks |
719
+ | | [0].ssid | X | | X | X | | Wifi network SSID |
720
+ | | [0].bssid | X | | X | X | | BSSID (mac) |
721
+ | | [0].mode | X | | | | | mode |
722
+ | | [0].channel | X | | X | X | | channel |
723
+ | | [0].frequency | X | | X | X | | frequency in MHz |
724
+ | | [0].signalLevel | X | | X | X | | signal level in dB |
725
+ | | [0].quality | X | | X | X | | quality in % |
726
+ | | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
727
+ | | [0].wpaFlags | X | | X | X | | array of WPA flags |
728
+ | | [0].rsnFlags | X | | | | | array of RDN flags |
729
+ | si.wifiInterfaces() | [{...}] | X | | X | X | | array of detected wifi interfaces |
730
+ | | [0].id | X | | X | X | | ID |
731
+ | | [0].iface | X | | X | X | | interface |
732
+ | | [0].model | X | | X | X | | model |
733
+ | | [0].vendor | X | | X | X | | vendor |
734
+ | | [0].mac | X | | X | X | | MAC address |
735
+ | si.wifiConnections() | [{...}] | X | | X | X | | array of active wifi connections |
736
+ | | [0].id | X | | X | X | | ID |
737
+ | | [0].iface | X | | X | X | | interface |
738
+ | | [0].name | X | | X | X | | name |
739
+ | | [0].mode | X | | X | X | | model |
740
+ | | [0].bssid | X | | X | X | | BSSID (mac) |
741
+ | | [0].mode | X | | | | | mode |
742
+ | | [0].channel | X | | X | X | | channel |
743
+ | | [0].frequency | X | | X | X | | frequency in MHz |
744
+ | | [0].signalLevel | X | | X | X | | signal level in dB |
745
+ | | [0].quality | X | | X | X | | quality in % |
746
+ | | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
747
+ | | [0].txRate | X | | X | X | | transfer rate MBit/s |
748
+
749
+ #### 14. Bluetooth
750
+
751
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
752
+ | --------------------- | ------------------ | ----- | --- | --- | --- | --- | ------------------------ |
753
+ | si.bluetoothDevices() | [{...}] | X | | X | X | | ... |
754
+ | | [0].device | | | X | | | device name |
755
+ | | [0].name | X | | X | X | | name |
756
+ | | [0].macDevice | X | | X | | | MAC address device |
757
+ | | [0].macHost | X | | X | | | MAC address host |
758
+ | | [0].batteryPercent | | | X | | | battery level percent |
759
+ | | [0].manufacturer | | | X | X | | manufacturer |
760
+ | | [0].type | X | | X | X | | type of bluetooth device |
761
+ | | [0].connected | X | | X | | | is connected |
762
+
763
+ #### 15. Docker
764
+
765
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
766
+ | ------------------------------- | ------------------- | ----------------------------------- | --- | --- | --- | --- | ------------------------------------------------------------------------------------------------------------- |
767
+ | si.dockerInfo() | {...} | X | X | X | X | X | returns general docker info |
768
+ | | id | X | X | X | X | X | Docker ID |
769
+ | | containers | X | X | X | X | X | number of containers |
770
+ | | containersRunning | X | X | X | X | X | number of running containers |
771
+ | | containersPaused | X | X | X | X | X | number of paused containers |
772
+ | | containersStopped | X | X | X | X | X | number of stopped containers |
773
+ | | images | X | X | X | X | X | number of images |
774
+ | | driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') |
775
+ | | memoryLimit | X | X | X | X | X | has memory limit |
776
+ | | swapLimit | X | X | X | X | X | has swap limit |
777
+ | | kernelMemory | X | X | X | X | X | has kernel memory |
778
+ | | cpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod |
779
+ | | cpuCfsQuota | X | X | X | X | X | has CpuCfsQuota |
780
+ | | cpuShares | X | X | X | X | X | has CPUShares |
781
+ | | cpuSet | X | X | X | X | X | has CPUShares |
782
+ | | ipv4Forwarding | X | X | X | X | X | has IPv4Forwarding |
783
+ | | bridgeNfIptables | X | X | X | X | X | has BridgeNfIptables |
784
+ | | bridgeNfIp6tables | X | X | X | X | X | has BridgeNfIp6tables |
785
+ | | debug | X | X | X | X | X | Debug on |
786
+ | | nfd | X | X | X | X | X | named data networking forwarding daemon |
787
+ | | oomKillDisable | X | X | X | X | X | out-of-memory kill disabled |
788
+ | | ngoroutines | X | X | X | X | X | number NGoroutines |
789
+ | | systemTime | X | X | X | X | X | docker SystemTime |
790
+ | | loggingDriver | X | X | X | X | X | logging driver e.g. 'json-file' |
791
+ | | cgroupDriver | X | X | X | X | X | cgroup driver e.g. 'cgroupfs' |
792
+ | | nEventsListener | X | X | X | X | X | number NEventsListeners |
793
+ | | kernelVersion | X | X | X | X | X | docker kernel version |
794
+ | | operatingSystem | X | X | X | X | X | docker OS e.g. 'Docker for Mac' |
795
+ | | osType | X | X | X | X | X | OSType e.g. 'linux' |
796
+ | | architecture | X | X | X | X | X | architecture e.g. x86_64 |
797
+ | | ncpu | X | X | X | X | X | number of CPUs |
798
+ | | memTotal | X | X | X | X | X | memory total |
799
+ | | dockerRootDir | X | X | X | X | X | docker root directory |
800
+ | | httpProxy | X | X | X | X | X | http proxy |
801
+ | | httpsProxy | X | X | X | X | X | https proxy |
802
+ | | noProxy | X | X | X | X | X | NoProxy |
803
+ | | name | X | X | X | X | X | Name |
804
+ | | labels | X | X | X | X | X | array of labels |
805
+ | | experimentalBuild | X | X | X | X | X | is experimental build |
806
+ | | serverVersion | X | X | X | X | X | server version |
807
+ | | clusterStore | X | X | X | X | X | cluster store |
808
+ | | clusterAdvertise | X | X | X | X | X | cluster advertise |
809
+ | | defaultRuntime | X | X | X | X | X | default runtime e.g. 'runc' |
810
+ | | liveRestoreEnabled | X | X | X | X | X | live store enabled |
811
+ | | isolation | X | X | X | X | X | isolation |
812
+ | | initBinary | X | X | X | X | X | init binary |
813
+ | | productLicense | X | X | X | X | X | product license |
814
+ | si.dockerImages(all) | [{...}] | X | X | X | X | X | returns array of top level/all docker images |
815
+ | | [0].id | X | X | X | X | X | image ID |
816
+ | | [0].container | X | X | X | X | X | container ID |
817
+ | | [0].comment | X | X | X | X | X | comment |
818
+ | | [0].os | X | X | X | X | X | OS |
819
+ | | [0].architecture | X | X | X | X | X | architecture |
820
+ | | [0].parent | X | X | X | X | X | parent ID |
821
+ | | [0].dockerVersion | X | X | X | X | X | docker version |
822
+ | | [0].size | X | X | X | X | X | image size |
823
+ | | [0].sharedSize | X | X | X | X | X | shared size |
824
+ | | [0].virtualSize | X | X | X | X | X | virtual size |
825
+ | | [0].author | X | X | X | X | X | author |
826
+ | | [0].created | X | X | X | X | X | created date / time |
827
+ | | [0].containerConfig | X | X | X | X | X | container config object |
828
+ | | [0].graphDriver | X | X | X | X | X | graph driver object |
829
+ | | [0].repoDigests | X | X | X | X | X | repo digests array |
830
+ | | [0].repoTags | X | X | X | X | X | repo tags array |
831
+ | | [0].config | X | X | X | X | X | config object |
832
+ | | [0].rootFS | X | X | X | X | X | root fs object |
833
+ | si.dockerContainers(all) | [{...}] | X | X | X | X | X | returns array of active/all docker containers |
834
+ | | [0].id | X | X | X | X | X | ID of container |
835
+ | | [0].name | X | X | X | X | X | name of container |
836
+ | | [0].image | X | X | X | X | X | name of image |
837
+ | | [0].imageID | X | X | X | X | X | ID of image |
838
+ | | [0].command | X | X | X | X | X | command |
839
+ | | [0].created | X | X | X | X | X | creation time (unix) |
840
+ | | [0].started | X | X | X | X | X | creation time (unix) |
841
+ | | [0].finished | X | X | X | X | X | creation time (unix) |
842
+ | | [0].createdAt | X | X | X | X | X | creation date time string |
843
+ | | [0].startedAt | X | X | X | X | X | creation date time string |
844
+ | | [0].finishedAt | X | X | X | X | X | creation date time string |
845
+ | | [0].status | X | X | X | X | X | healthy, starting, unhealthy |
846
+ | | [0].state | X | X | X | X | X | created, running, exited |
847
+ | | [0].labels | X | X | X | X | X | object of labels (key-value pairs) |
848
+ | | [0].ports | X | X | X | X | X | array of ports |
849
+ | | [0].mounts | X | X | X | X | X | array of mounts |
850
+ | si.dockerContainerStats(ids) | [{...}] | X | X | X | X | X | statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers |
851
+ | | [0].id | X | X | X | X | X | Container ID |
852
+ | | [0].memUsage | X | X | X | X | X | memory usage in bytes |
853
+ | | [0].memLimit | X | X | X | X | X | memory limit (max mem) in bytes |
854
+ | | [0].memPercent | X | X | X | X | X | memory usage in percent |
855
+ | | [0].cpuPercent | X | X | X | X | X | cpu usage in percent |
856
+ | | [0].pids | X | X | X | X | X | number of processes |
857
+ | | [0].netIO.rx | X | X | X | X | X | received bytes via network |
858
+ | | [0].netIO.wx | X | X | X | X | X | sent bytes via network |
859
+ | | [0].blockIO.r | X | X | X | X | X | bytes read from BlockIO |
860
+ | | [0].blockIO.w | X | X | X | X | X | bytes written to BlockIO |
861
+ | | [0].cpuStats | X | X | X | X | X | detailed cpu stats |
862
+ | | [0].percpuStats | X | X | X | X | X | detailed per cpu stats |
863
+ | | [0].memoryStats | X | X | X | X | X | detailed memory stats |
864
+ | | [0].networks | X | X | X | X | X | detailed network stats per interface |
865
+ | si.dockerContainerProcesses(id) | [{...}] | X | X | X | X | X | array of processes inside a container |
866
+ | | [0].pidHost | X | X | X | X | X | process ID (host) |
867
+ | | [0].ppid | X | X | X | X | X | parent process ID |
868
+ | | [0].pgid | X | X | X | X | X | process group ID |
869
+ | | [0].user | X | X | X | X | X | effective user name |
870
+ | | [0].ruser | X | X | X | X | X | real user name |
871
+ | | [0].group | X | X | X | X | X | effective group name |
872
+ | | [0].rgroup | X | X | X | X | X | real group name |
873
+ | | [0].stat | X | X | X | X | X | process state |
874
+ | | [0].time | X | X | X | X | X | accumulated CPU time |
875
+ | | [0].elapsed | X | X | X | X | X | elapsed running time |
876
+ | | [0].nice | X | X | X | X | X | nice value |
877
+ | | [0].rss | X | X | X | X | X | resident set size |
878
+ | | [0].vsz | X | X | X | X | X | virtual size in Kbytes |
879
+ | | [0].command | X | X | X | X | X | command and arguments |
880
+ | si.dockerVolumes() | [{...}] | returns array of all docker volumes |
881
+ | | [0].name | X | X | X | X | X | volume name |
882
+ | | [0].driver | X | X | X | X | X | driver |
883
+ | | [0].labels | X | X | X | X | X | labels object |
884
+ | | [0].mountpoint | X | X | X | X | X | mountpoint |
885
+ | | [0].options | X | X | X | X | X | options |
886
+ | | [0].scope | X | X | X | X | X | scope |
887
+ | | [0].created | X | X | X | X | X | created at |
888
+ | si.dockerAll() | {...} | X | X | X | X | X | list of all containers including their stats<br>and processes in one single array |
889
+
890
+ #### 16. Virtual Box
891
+
892
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
893
+ | ------------- | -------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
894
+ | si.vboxInfo() | [{...}] | X | X | X | X | X | returns array general virtual box info |
895
+ | | [0].id | X | X | X | X | X | virtual box ID |
896
+ | | [0].name | X | X | X | X | X | name |
897
+ | | [0].running | X | X | X | X | X | vbox is running |
898
+ | | [0].started | X | X | X | X | X | started date time |
899
+ | | [0].runningSince | X | X | X | X | X | running since (secs) |
900
+ | | [0].stopped | X | X | X | X | X | stopped date time |
901
+ | | [0].stoppedSince | X | X | X | X | X | stopped since (secs) |
902
+ | | [0].guestOS | X | X | X | X | X | Guest OS |
903
+ | | [0].hardwareUUID | X | X | X | X | X | Hardware UUID |
904
+ | | [0].memory | X | X | X | X | X | Memory in MB |
905
+ | | [0].vram | X | X | X | X | X | VRAM in MB |
906
+ | | [0].cpus | X | X | X | X | X | CPUs |
907
+ | | [0].cpuExepCap | X | X | X | X | X | CPU exec cap |
908
+ | | [0].cpuProfile | X | X | X | X | X | CPU profile |
909
+ | | [0].chipset | X | X | X | X | X | chipset |
910
+ | | [0].firmware | X | X | X | X | X | firmware |
911
+ | | [0].pageFusion | X | X | X | X | X | page fusion |
912
+ | | [0].configFile | X | X | X | X | X | config file |
913
+ | | [0].snapshotFolder | X | X | X | X | X | snapshot folder |
914
+ | | [0].logFolder | X | X | X | X | X | log folder path |
915
+ | | [0].hpet | X | X | X | X | X | HPET |
916
+ | | [0].pae | X | X | X | X | X | PAE |
917
+ | | [0].longMode | X | X | X | X | X | long mode |
918
+ | | [0].tripleFaultReset | X | X | X | X | X | triple fault reset |
919
+ | | [0].apic | X | X | X | X | X | APIC |
920
+ | | [0].x2Apic | X | X | X | X | X | X2APIC |
921
+ | | [0].acpi | X | X | X | X | X | ACPI |
922
+ | | [0].ioApic | X | X | X | X | X | IOAPIC |
923
+ | | [0].biosApicMode | X | X | X | X | X | BIOS APIC mode |
924
+ | | [0].bootMenuMode | X | X | X | X | X | boot menu Mode |
925
+ | | [0].bootDevice1 | X | X | X | X | X | bootDevice1 |
926
+ | | [0].bootDevice2 | X | X | X | X | X | bootDevice2 |
927
+ | | [0].bootDevice3 | X | X | X | X | X | bootDevice3 |
928
+ | | [0].bootDevice4 | X | X | X | X | X | bootDevice4 |
929
+ | | [0].timeOffset | X | X | X | X | X | time Offset |
930
+ | | [0].rtc | X | X | X | X | X | RTC |
931
+
932
+ #### 17. "Get All / Observe" - functions
933
+
934
+ | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
935
+ | -------------------------------- | ------------- | ----- | --- | --- | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
936
+ | si.getStaticData() | {...} | X | X | X | X | X | all static data at once |
937
+ | si.getDynamicData(srv,iface) | {...} | X | X | X | X | X | all dynamic data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "_" for ALL services (linux/win only)<br>Pass "_" for ALL network interfaces |
938
+ | si.getAllData(srv,iface) | {...} | X | X | X | X | X | all data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "_" for ALL services (linux/win only)<br>Pass "_" for ALL network interfaces |
939
+ | si.get(valueObject) | {...} | X | X | X | X | X | get partial system info data at once<br>In valueObject you can define<br>all values, you want to get back <br>(see documentation for details) |
940
+ | si.observe(valueObject,interval) | - | X | X | X | X | X | Observe a defined value object<br>call callback on changes<br>polling interval in milliseconds |
941
+
942
+ All functions are asynchronous. The **preferred** way to consume them is
943
+ `async / await`; every function also returns a promise as an alternative.
944
+ Callbacks are no longer supported.
945
+
946
+ ### Async / Await (preferred)
971
947
 
972
948
  ```js
973
949
  const si = require("systeminformation");
974
950
 
975
- si.cpu(function (data) {
976
- console.log("CPU Information:");
977
- console.log("- manufacturer: " + data.manufacturer);
978
- console.log("- brand: " + data.brand);
979
- console.log("- speed: " + data.speed);
980
- console.log("- cores: " + data.cores);
981
- console.log("- physical cores: " + data.physicalCores);
982
- console.log("...");
983
- });
984
- ```
985
-
986
- ### Promises
987
-
988
- **Promises Style** is new in version 3.0.
989
-
990
- When omitting callback parameter (cb), then you can use all function in a
991
- promise oriented way. All functions (except of `version` and `time`) are
992
- returning a promise, that you can consume:
993
-
994
- ```js
995
- const si = require("systeminformation");
996
-
997
- si.cpu()
998
- .then((data) => {
951
+ async function cpuData() {
952
+ try {
953
+ const data = await si.cpu();
999
954
  console.log("CPU Information:");
1000
955
  console.log("- manufacturer: " + data.manufacturer);
1001
956
  console.log("- brand: " + data.brand);
@@ -1003,45 +958,33 @@ si.cpu()
1003
958
  console.log("- cores: " + data.cores);
1004
959
  console.log("- physical cores: " + data.physicalCores);
1005
960
  console.log("...");
1006
- })
1007
- .catch((error) => console.error(error));
961
+ } catch (e) {
962
+ console.log(e);
963
+ }
964
+ }
1008
965
  ```
1009
966
 
1010
- ### Async / Await
1011
-
1012
- **Using async / await** (available since node v7.6)
1013
-
1014
- Since node v7.6 you can also use the `async` / `await` pattern. The above
1015
- example would then look like this:
967
+ ### Promises (alternative)
1016
968
 
1017
969
  ```js
1018
970
  const si = require("systeminformation");
1019
971
 
1020
- async function cpuData() {
1021
- try {
1022
- const data = await si.cpu();
972
+ si.cpu()
973
+ .then((data) => {
1023
974
  console.log("CPU Information:");
1024
- console.log("- manufacturer: " + data.manufacturer);
1025
975
  console.log("- brand: " + data.brand);
1026
- console.log("- speed: " + data.speed);
1027
- console.log("- cores: " + data.cores);
1028
- console.log("- physical cores: " + data.physicalCores);
1029
976
  console.log("...");
1030
- } catch (e) {
1031
- console.log(e);
1032
- }
1033
- }
977
+ })
978
+ .catch((error) => console.error(error));
1034
979
  ```
1035
980
 
1036
981
  ## Known Issues
1037
982
 
1038
983
  #### macOS - Temperature Sensor
1039
984
 
1040
- To be able to measure temperature on macOS I created two little additional
1041
- packages. Due to some difficulties in NPM with `optionalDependencies` I
1042
- unfortunately was getting unexpected warnings on other platforms. So I decided
1043
- to drop this optional dependency for macOS - so by default, you will not get
1044
- correct values.
985
+ To be able to measure temperature on macOS I created two little additional packages. Due to some difficulties
986
+ in NPM with `optionalDependencies` I unfortunately was getting unexpected warnings on other platforms.
987
+ So I decided to drop this optional dependency for macOS - so by default, you will not get correct values.
1045
988
 
1046
989
  But if you need to detect macOS temperature just run the following additional
1047
990
  installation command:
@@ -1058,52 +1001,38 @@ For Apple Silicon (ARM) based machines install
1058
1001
  $ npm install macos-temperature-sensor --save
1059
1002
  ```
1060
1003
 
1061
- `systeminformation` will then detect this additional library and return the
1062
- temperature when calling systeminformations standard function `cpuTemperature()`.
1063
- On Apple Silicon machines `macos-temperature-sensor` also enables the GPU
1064
- temperature (`temperatureGpu`) in the `graphics()` controllers
1004
+ `systeminformation` will then detect this additional library and return the temperature when calling systeminformations standard function `cpuTemperature()`.
1005
+ On Apple Silicon machines `macos-temperature-sensor` also enables the GPU temperature (`temperatureGpu`) in `gpu()`
1065
1006
 
1066
1007
  #### Windows Temperature, Battery, ...
1067
1008
 
1068
- `get-WmiObject` - which is used to determine temperature and battery sometimes
1069
- needs to be run with admin privileges. So if you do not get any values, try to
1070
- run it again with according privileges. If you still do not get any values, your
1071
- system might not support this feature. In some cases we also discovered that
1072
- `get-WmiObject` returned incorrect temperature values.
1009
+ `get-WmiObject` - which is used to determine temperature and battery sometimes needs to be run with admin
1010
+ privileges. So if you do not get any values, try to run it again with according
1011
+ privileges. If you still do not get any values, your system might not support this feature.
1012
+ In some cases we also discovered that `get-WmiObject` returned incorrect temperature values.
1073
1013
 
1074
1014
  #### Linux Temperature
1075
1015
 
1076
- In some cases you need to install the Linux `sensors` package to be able to
1077
- measure temperature e.g. on DEBIAN based systems by running
1078
- `sudo apt-get install lm-sensors`
1016
+ In some cases you need to install the Linux `sensors` package to be able to measure temperature
1017
+ e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors`
1079
1018
 
1080
1019
  #### Linux S.M.A.R.T. Status
1081
1020
 
1082
- To be able to detect S.M.A.R.T. status on Linux you need to install
1083
- `smartmontools`. On DEBIAN based Linux distributions you can install it by
1084
- running `sudo apt-get install smartmontools`
1021
+ To be able to detect S.M.A.R.T. status on Linux you need to install `smartmontools`. On DEBIAN based Linux distributions you can install it by running `sudo apt-get install smartmontools`
1085
1022
 
1086
1023
  #### Windows Encoding Issues
1087
1024
 
1088
- I now reimplemented all windows functions to avoid encoding problems (special
1089
- chacarters). And as Windows 11 now dropped `wmic` support, I had to move
1090
- completely to `powershell`. Be sure that powershell version 5+ is installed on
1091
- your machine. On older Windows versions (7, 8) you might still see encoding
1092
- problems due to the old powershell version.
1025
+ I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now dropped `wmic` support, I had to move completely to `powershell`. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.
1093
1026
 
1094
1027
  ## *: Additional Notes
1095
1028
 
1096
- In `fsStats()`, `disksIO()` and `networkStats()` the results / sec. values
1097
- (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of
1098
- the function. It is determined by calculating the difference of transferred
1099
- bytes / IOs divided by the time between two calls of the function.
1029
+ In `fsStats()`, `disksIO()` and `networkStats()` the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning
1030
+ with the second call of the function. It is determined by calculating the difference of transferred bytes / IOs
1031
+ divided by the time between two calls of the function.
1100
1032
 
1101
- The first time you are calling one of these functions, you will get `null` for
1102
- transfer rates. The second time, you should then get statistics based on the
1103
- time between the two calls ...
1033
+ The first time you are calling one of these functions, you will get `null` for transfer rates. The second time, you should then get statistics based on the time between the two calls ...
1104
1034
 
1105
- So basically, if you e.g. need a value for network stats every second, your code
1106
- should look like this:
1035
+ So basically, if you e.g. need a value for network stats every second, your code should look like this:
1107
1036
 
1108
1037
  ```js
1109
1038
  const si = require("systeminformation");
@@ -1119,8 +1048,7 @@ Beginning with the second call, you get network transfer values per second.
1119
1048
 
1120
1049
  ## Finding new issues
1121
1050
 
1122
- I am happy to discuss any comments and suggestions. Please feel free to contact
1123
- me if you see any possibility of improvement!
1051
+ I am happy to discuss any comments and suggestions. Please feel free to contact me if you see any possibility of improvement!
1124
1052
 
1125
1053
  ## Comments
1126
1054
 
@@ -1134,10 +1062,9 @@ Sebastian Hildebrandt, [+innovations](http://www.plus-innovations.com)
1134
1062
 
1135
1063
  ## Credits
1136
1064
 
1137
- Written by Sebastian Hildebrandt
1138
- [sebhildebrandt](https://github.com/sebhildebrandt)
1065
+ Written by Sebastian Hildebrandt [sebhildebrandt](https://github.com/sebhildebrandt)
1139
1066
 
1140
- ### Contributors
1067
+ #### Contributors
1141
1068
 
1142
1069
  - Guillaume Legrain [glegrain](https://github.com/glegrain)
1143
1070
  - Riccardo Novaglia [richy24](https://github.com/richy24)
@@ -1157,39 +1084,28 @@ Written by Sebastian Hildebrandt
1157
1084
  - Ricardo Polo [ricardopolo](https://github.com/ricardopolo)
1158
1085
  - Miłosz Dźwigała [mily20001](https://github.com/mily20001)
1159
1086
  - cconley717 [cconley717](https://github.com/cconley717)
1160
- - Maria Camila Cubides
1161
- [MariaCamilaCubides](https://github.com/MariaCamilaCubides)
1087
+ - Maria Camila Cubides [MariaCamilaCubides](https://github.com/MariaCamilaCubides)
1162
1088
  - Aleksander Krasnicki [plakak](https://github.com/plakak)
1163
1089
  - Alexis Tyler [OmgImAlexis](https://github.com/OmgImAlexis)
1164
1090
  - Simon Smith [si458](https://github.com/si458)
1165
1091
 
1166
1092
  OSX Temperature: credits here are going to:
1167
1093
 
1168
- - Frank Stock [pcafstockf](https://github.com/pcafstockf) - for his work on
1169
- [smc-code][smc-code-url]
1170
-
1171
- ### Powered by
1172
-
1173
- <a href="https://plus-innovations.com"><img src="https://www.plus-innovations.com/wp-content/themes/bootstrap3/img/logo1000.png" alt="Alt Text" width="200" style="margin-bottom: 8px"></a>
1094
+ - Frank Stock [pcafstockf](https://github.com/pcafstockf) - for his work on [smc-code][smc-code-url]
1174
1095
 
1175
1096
  ## Copyright Information
1176
1097
 
1177
- Linux is a registered trademark of Linus Torvalds. Apple, macOS, OS X are
1178
- registered trademarks of Apple Inc., Windows is a registered trademark of
1179
- Microsoft Corporation. Node.js is a trademark of OpenJS Foundation, Intel is a
1180
- trademark of Intel Corporation, AMD is a trademark of Advanced Micro Devices
1181
- Inc., Raspberry Pi is a trademark of the Raspberry Pi Foundation, Debian is a
1182
- trademark owned by Software in the Public Interest, Inc., Ubuntu is a trademark
1183
- of Canonical Ltd., FreeBSD is a registered trademark of The FreeBSD Foundation,
1184
- NetBSD is a registered trademark of The NetBSD Foundation, Docker is a trademark
1185
- of Docker, Inc., Sun, Solaris, OpenSolaris and registered trademarks of Sun
1186
- Microsystems, VMware is a trademark of VMware Inc, Virtual Box is a trademark of
1187
- Oracle Corporation, Xen is a registered trademark of Xen Project, QEMU is a
1188
- trademark of Fabrice Bellard, bochs is a trademark of The Bochs Project, USB and
1189
- USB Logo are trademarks of USB Implementation Forum, Bluetooth and Bluetooth
1190
- Logo are trademarks of Bluetooth SIG, Android is a trademark of Google LLC,
1191
- Parallels is a trademarks of Parallels International GmbH. Bun is a trademark of
1192
- Codeblog Corp. Deno is a trademark of Deno Land Inc. Arm is a trademark of Arm Limited.
1098
+ Linux is a registered trademark of Linus Torvalds. Apple, macOS, OS X are registered trademarks of Apple Inc.,
1099
+ Windows is a registered trademark of Microsoft Corporation. Node.js is a trademark of Joyent Inc.,
1100
+ Intel is a trademark of Intel Corporation, AMD is a trademark of Advanced Micro Devices Inc.,
1101
+ Raspberry Pi is a trademark of the Raspberry Pi Foundation, Debian is a trademark owned by Software in the Public Interest, Inc.,
1102
+ Ubuntu is a trademark of Canonical Ltd., FreeBSD is a registered trademark of The FreeBSD Foundation,
1103
+ NetBSD is a registered trademark of The NetBSD Foundation, Docker is a trademark of Docker, Inc., Sun,
1104
+ Solaris, OpenSolaris and registered trademarks of Sun Microsystems, VMware is a trademark of VMware Inc,
1105
+ Virtual Box is a trademark of Oracle Corporation, Xen is a registered trademark of Xen Project,
1106
+ QEMU is a trademark of Fabrice Bellard, bochs is a trademark of The Bochs Project, USB and USB Logo
1107
+ are trademarks of USB Implementation Forum, Bluetooth and Bluetooth Logo are trademarks of Bluetooth SIG,
1108
+ Android is a trademark of Google LLC, Parallels is a trademarks of Parallels International GmbH.
1193
1109
 
1194
1110
  All other trademarks are the property of their respective owners.
1195
1111
 
@@ -1197,8 +1113,7 @@ All other trademarks are the property of their respective owners.
1197
1113
 
1198
1114
  > The [`MIT`][license-url] License (MIT)
1199
1115
  >
1200
- > Copyright &copy; 2014-2026 Sebastian Hildebrandt,
1201
- > [+innovations](http://www.plus-innovations.com).
1116
+ > Copyright &copy; 2014-2026 Sebastian Hildebrandt, [+innovations](http://www.plus-innovations.com).
1202
1117
  >
1203
1118
  > Permission is hereby granted, free of charge, to any person obtaining a copy
1204
1119
  > of this software and associated documentation files (the "Software"), to deal
@@ -1207,23 +1122,26 @@ All other trademarks are the property of their respective owners.
1207
1122
  > copies of the Software, and to permit persons to whom the Software is
1208
1123
  > furnished to do so, subject to the following conditions:
1209
1124
  >
1210
- > The above copyright notice and this permission notice shall be included in all
1211
- > copies or substantial portions of the Software.
1125
+ > The above copyright notice and this permission notice shall be included in
1126
+ > all copies or substantial portions of the Software.
1212
1127
  >
1213
1128
  > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1214
1129
  > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1215
1130
  > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1216
1131
  > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1217
1132
  > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1218
- > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1219
- > SOFTWARE.
1133
+ > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
1134
+ > THE SOFTWARE.
1220
1135
  >
1221
1136
  > Further details see [LICENSE](LICENSE) file.
1222
1137
 
1223
1138
  [npm-image]: https://img.shields.io/npm/v/systeminformation.svg?style=flat-square
1139
+ [npm-image2]: https://flat.badgen.net/npm/v/systeminformation?color=4c1
1224
1140
  [npm-url]: https://npmjs.org/package/systeminformation
1225
1141
  [downloads-image]: https://img.shields.io/npm/dm/systeminformation.svg?style=flat-square
1226
1142
  [downloads-url]: https://npmjs.org/package/systeminformation
1143
+ [nodependencies-badge]: https://img.shields.io/badge/Depemdencies-none-4c1.svg?style=flat-square
1144
+ [dependencies-url]: https://npmjs.org/package/systeminformation
1227
1145
  [sponsor-badge]: https://img.shields.io/badge/Support-Buy%20me%20a%20coffee-brightgreen?style=flat-square
1228
1146
  [sponsor-url]: https://www.buymeacoffee.com/systeminfo
1229
1147
  [license-url]: https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE
@@ -1240,11 +1158,9 @@ All other trademarks are the property of their respective owners.
1240
1158
  [daviddm-url]: https://david-dm.org/sebhildebrandt/systeminformation
1241
1159
  [issues-img]: https://img.shields.io/github/issues/sebhildebrandt/systeminformation.svg?style=flat-square
1242
1160
  [issues-url]: https://github.com/sebhildebrandt/systeminformation/issues
1243
- [closed-issues-img]: https://img.shields.io/github/issues-search?query=repo%3Asebhildebrandt/systeminformation+is%3Aclosed&style=flat-square&color=brightgreen&label=Issues+closed
1161
+ [closed-issues-img]: https://img.shields.io/github/issues-closed-raw/sebhildebrandt/systeminformation.svg?style=flat-square&color=brightgreen
1244
1162
  [closed-issues-url]: https://github.com/sebhildebrandt/systeminformation/issues?q=is%3Aissue+is%3Aclosed
1245
1163
  [new-issue]: https://github.com/sebhildebrandt/systeminformation/issues/new/choose
1246
1164
  [mmon-npm-url]: https://npmjs.org/package/mmon
1247
1165
  [mmon-github-url]: https://github.com/sebhildebrandt/mmon
1248
1166
  [smc-code-url]: https://github.com/pcafstockf/smc-reader
1249
- [v6-docs-url]: https://systeminformation.io/v6/
1250
- [v6-changes-url]: https://systeminformation.io/v6/changes.html