AadamZ5 / node-smartctl-wrapper

A wrapper for smartmontools 7 with typed responses

node-smartctl-wrapper

A wrapper for smartmontools 7 with typed responses

I'm not entirely sure the exact direction this is headed yet, but I'm working around to figure out the exact form of this package. Currently, the goal is to create the ability to manage SmartDevices for an object-oriented approach. This package also allows for just using the SmartCtlWrapper namespace functions to directly interface with popular smartctl uses with typed responses.

Please feel free to contribute!

Pros

• Structured and typed responses from smartctl
• Object-oriented device testing
• Flexible interfaces for modularity

Cons

• Requires smartctl from smartmontools v7.0^ to be installed
• Usually requires sudo or root privledges to execute smartctl

Pros/Cons

• Uses RxJS for data pushing (primarily progress from tests)

Install

Currently, this package is not in the npm registry, because it is not ready for it. This is still in active development.

To install:
npm i AadamZ5/node-smartctl-wrapper#master

Example Usage

Test a device

import { SmartCtl } from "node-smartctl-wrapper";

SmartCtl.initialize().then(() => { // `initialize()` is a static and instance-bound function. You can use it either way.
    let smartctl = new SmartCtl();
    smartctl.get_device('dev/sda').then((s) => {
        console.log(s);
        let t = s.test("short");
        t.progress_observable.subscribe((p) => {
            console.log("Progress: " + p);
        }, (e) => {
            console.error("Error during test: " + e);
        }, () => {
            console.log("Test completed. Result: " + t.passed);
        })
    });
})

Known bugs

• Won't install properly on WSL due to node-userid package