jbenden / node-pmset

OS X Power Management for Node.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Dependency Status NPM version Code Climate Coverage Status node-pmset

OS X Power Management for Node.js

This module enables the control over power management functionality within Mac OS X 10.6 or newer. For additional information regarding this functionality, please see my blog post about this topic at:

http://www.benden.us/

Installation

$ npm install pmset

Installation via source

$ git clone https://github.com/jbenden/node-pmset.git node-pmset.git
$ cd node-pmset.git
$ npm install

Example Usage

> pmset = require("pmset");
{ noIdleSleep: [Function],
noDisplaySleep: [Function],
release: [Function] }
> a = pmset.noDisplaySleep("Node.js testing");
1248
> pmset.release(a);
0
>
(^C again to quit)
>

Notes

If you are unable to install the module, due to errors about missing Xcode header files or related, then follow the source installation instructions and change the include path in binding.gyp.

Methods Available

The module supports the following methods:

  • (int) noIdleSleep(string)
  • (int) noDisplaySleep(string)
  • (int) noSystemSleep(string)
  • (int) noUserIdleSystemSleep(string)
  • (int) noUserIdleDisplaySleep(string)
  • (int) noDiskIdle(string)
  • release(int)

To get a better understanding of what these different options mean, see the Apple header file pwr_mgt/IOPMLib.h inside of the platform SDK folder. Additionally, check out the local unit-tests for more information about the correct usage of these functions.

About

OS X Power Management for Node.js

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:JavaScript 51.8%Language:C++ 44.9%Language:Python 3.2%